{"info":{"_postman_id":"608bea59-f272-48d3-9ee1-89e3a46de312","name":"FundThrough API","description":"

Overview

Welcome to the FundThrough Partner API. We are built for businesses that do business with other businesses, this includes accounting software, ERPs and B2B marketplaces that facilitate the sale of goods or services. By integrating with the FundThrough's API you can get your clients paid faster by quickly providing them with working capital based on the size of their outstanding invoices, right within your platform.

How It Works

As you engage with FundThrough, we will help you determine the appropriate use of the API based on your business model and use case(s). For example:

We will agree on what we expect from you for onboarding a Supplier (the seller), versus what we can expect from them directly.
We agree on what information is required to verify invoices as being valid, and/or how work has been completed or goods received.
We agree on the funding flow, using your payment rails or ours.

Request Flow

Following outlines the recommended integration of API requests.

1. Prequalify Partner/Platform.

Provide FundThrough with information about the businesses involved to verify if either business, or their relationship, has been pre-qualified for funding. This can then be used to speed up the future onboarding or determine how FundThrough is presented within your platform.

→ Use: Supplier Pre-Qualification and Buyer Pre-Qualification to POST the pre-qualification request; then GET the response when it's ready.

2. Onboard Supplier and Buyers.

Send over available information about the supplier and their business. This can include the following: business name, address, primary contact, formation documents, Government photo ID, bank details, and payment details so that the user does not have to manually enter during onboarding.

→ Use: Add Supplier and then Add Supporting Documentation for that Supplier.

Any Buyers that will be funded can be added at this point as well.

→ Use: Add Buyer and then Add Supporting Documentation for that Buyer.

3. Share and Sync Invoices.

Once the Supplier has been onboarded, use the supplier_id that we provide to send over applicable invoice details. These invoices will be used to determine the amount of funding approved. As invoices are added or updated the changes need to be sent over to FundThrough to update qualifications and funding is up to date.

This means one of:

Invoice is sent; OR
Invoice is received/accepted (by the Buyer); OR
Invoice is approved.

→ Use: Add Invoice (Transactions + Attachments) to provide invoices and to notify us of their status. Then Add Supporting Documentation for the invoice.

\n
(TBD:) Note: In cases where an invoice is not created until after goods are delivered, FundThrough can support post-verification. Partner sends us data to support this.
\n

Funding is sent to the Supplier’s bank account, and FundThrough sends back confirmation that we have funded.

4. Invoice is paid.

Depending on whether or not the Partner has payment rails, and we’re using them:

a. The Partner indicates the invoice has been paid (and then pays FundThrough).

→ Use: Add Invoice Transaction to update invoice payment status.

b. The Buyer directly pays FundThrough.

Definitions

FundThrough Embedded (FTe): Our APIs and resources, that enable you to offer FundThrough financing to Suppliers for transactions processed through your Invoice Ecosystem.

Supplier (also called a “user” or “client”): Entity that sells goods or services via a B2B marketplace or invoice ecosystem.

Buyer (also called a “payor” or “customer”): Entity that makes purchase of goods or services via B2B marketplace or invoice ecosystem.

Partner: the platform / online environment in which the Buyer and Seller conduct their transactions.

Invoice: a record of the completed work that includes details about what was delivered, total amount due, and due date.

Transaction: one or more transfers of funds against any single invoice.

Dominion of Cash: Agreement for the Buyer to pay FundThrough directly for funded Invoices. The payment comes via one of two options;

Notice of Assignment (NOA): The Buyer knows FundThrough is involved.
\n
Lockbox: (a bank account in the Supplier’s name, but under FundThrough’s control; when the Buyer does not know that FundThrough is involved).
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20098195","collectionId":"608bea59-f272-48d3-9ee1-89e3a46de312","publishedId":"UVsQsjQL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"008080"},"publishDate":"2022-10-19T02:01:50.000Z"},"item":[{"name":"API v1","item":[{"name":"Getting Started & Authorization","item":[],"id":"ab5deece-dc2f-4080-814b-7d6c89a0b8cf","description":"

Partners must be registered to participate.
Discuss integration with our Partnerships team →

Server Authentication

Partners use a token provided by FundThrough in the authentication header with each API request. This token is a subject to a rotational change (details TBD).

Supplier Authentication

Suppliers onboarding with FundThrough directly by default can sign up with an email and a password.

\n","_postman_id":"ab5deece-dc2f-4080-814b-7d6c89a0b8cf"},{"name":"1. Request Pre-Qualification","item":[{"name":"Request Supplier Pre-Qualification","id":"a8750417-e246-468b-8336-5fe21c90f610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1234451\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/suppliers","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for the Supplier. (Note does not have to be UUID format.)
`name`	String	Y	Legal name of Supplier's company, including entity type (\"Inc.\", \"LLC\", etc.).
`address`	String	Y	Street address of Supplier headquarters; separate multiple lines with commas.
`city`	String	Y
`state`	String	Y	2-letter abbreviation.
`country`	String	Y	Please send US for USA and CA for Canada
`postcode`	String	Y	Zip or postal code of Supplier's headquarters.
`phone`	Integer	N	Contact phone for Supplier headquarters, no dashes.

","urlObject":{"path":["v1","pre-qualification","suppliers"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[],"variable":[]}},"response":[{"id":"927d6d1e-1d8b-4d07-b578-66441e655dd8","name":"Success - Request Received","originalRequest":{"method":"POST","header":[{"key":"secret","value":"Dm6AridOuCgkyBU91mg66gL9Oy9s62b6u0n2du37","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1234451\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/suppliers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:50:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"d67cdc44-80b8-479a-a6fd-c8b53e63a7f0"},{"key":"x-amz-apigw-id","value":"RVbSzE_CIAMEs-A="},{"key":"x-amzn-trace-id","value":"Root=1-659ed8de-75724d236f71ddf021103e08;Sampled=0;lineage=bf87b883:0"},{"key":"x-cache","value":"Miss from cloudfront"},{"key":"via","value":"1.1 b2179245b8d8ae2b245dd8946895eb1e.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD55-P1"},{"key":"x-amz-cf-id","value":"qy15t_lVaKmyr9eItkAz-C3kTIKIRGd7z5YmPVVE5D74lkf1cpxFFQ=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436c30d9c5739a0-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Supplier Prequalification data received\",\n \"data\": {\n \"ft_prequal_supplier_request_id\": \"d67cdc44-80b8-479a-a6fd-c8b53e63a7f0\"\n }\n}"},{"id":"a389fac8-1241-45e9-b4e7-087e7202e452","name":"Error - Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"secret","value":"Dm6AridOuCgkyBU91mg66gL9Oy9s62b6u0n2du37","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CA\",\n \"postcode\": \"ABC123\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:52:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"225"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"5e7f08ff-fb9c-4f6a-9658-3f590e859c6a"},{"key":"x-amz-apigw-id","value":"RVbijGhvIAMEZsw="},{"key":"x-amzn-trace-id","value":"Root=1-659ed943-4c9ab9ad74593b226fd6307e;Sampled=0;lineage=bf87b883:0"},{"key":"x-cache","value":"Error from cloudfront"},{"key":"via","value":"1.1 2301ef513d768666e30ce282b9045098.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"JFK50-P3"},{"key":"x-amz-cf-id","value":"MjOHAFRKZwuBXqfDv0Rz-QmqZ16No9hG4lcrAdssc_u_SNLXhlKaFg=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436c5841bd82012-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"source_uuid\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Source uuid can't be blank\",\n \"Source uuid is not unique\"\n ]\n },\n {\n \"source\": \"postcode\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Postcode format is invalid\"\n ]\n }\n ]\n}"}],"_postman_id":"a8750417-e246-468b-8336-5fe21c90f610"},{"name":"Request Buyer Pre-Qualification","id":"49c57093-d300-4cd4-812f-6f10fcc9a20c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"123451\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/buyers","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for the Buyer. (Note does not have to be UUID format.)
`name`	String	Y	Legal name of Supplier's company, including entity type (\"Inc.\", \"LLC\", etc.).
`address`	String	Y	Street address of Buyer headquarters; separate multiple lines with commas.
`city`	String	Y
`state`	String	Y	2-letter abbreviation.
`country`	String	Y	Please send US for USA and CA for Canada
`postcode`	String	Y	Zip or postal code of Supplier's headquarters.
`phone`	Integer	N	Contact phone for Supplier headquarters, no dashes.

","urlObject":{"path":["v1","pre-qualification","buyers"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[],"variable":[]}},"response":[{"id":"65421ccb-f684-4b7e-a32b-b35ac7981a17","name":"Success - Request Received","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1234451\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/buyers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:57:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"569c73fd-829a-4984-8dc4-67811c4ed7de"},{"key":"x-amz-apigw-id","value":"RVcReG0jIAMEsYQ="},{"key":"x-amzn-trace-id","value":"Root=1-659eda6f-389297974a06297878b5f50a;Sampled=0;lineage=d95730d2:0"},{"key":"x-cache","value":"Miss from cloudfront"},{"key":"via","value":"1.1 44ffe5f6f95421818455d39547956aa4.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"JFK50-P3"},{"key":"x-amz-cf-id","value":"PknrlwWBfeiiFy2jY2jy77CioT6zyDQks4HXesSEuCY4zd-OjNOZdg=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436ccd90ba8208e-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Buyer Prequalification data received\",\n \"data\": {\n \"ft_prequal_buyer_request_id\": \"569c73fd-829a-4984-8dc4-67811c4ed7de\"\n }\n}"},{"id":"fad055e5-b197-4842-a0ad-af9c6444cfc4","name":"Error - Unprocessable Entity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"\",\n \"name\": \"Fun Day\",\n \"address\": \"12344 Close SE\",\n \"city\": \"Toronto\",\n \"state\": \"Ontario\",\n \"country\": \"CAN\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4023412233\"\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification/buyers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:58:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"1a7235e7-7070-477c-8fad-78aed955d6d5"},{"key":"x-amz-apigw-id","value":"RVcbgHQQoAMEXXA="},{"key":"x-amzn-trace-id","value":"Root=1-659edaaf-52070c6967bfc92957702f4b;Sampled=0;lineage=d95730d2:0"},{"key":"x-cache","value":"Error from cloudfront"},{"key":"via","value":"1.1 a770e75e0ebdb44f23f7a7ef20bbbffa.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD55-P1"},{"key":"x-amz-cf-id","value":"nDc6ieZxjgNrCM-HVEw45vKxiJixmJcrMIq3e-wVBaZsKqKOlRz2Lw=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436ce6a1f0f1fda-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"country\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Country must be either US or CA\"\n ]\n },\n {\n \"source\": \"source_uuid\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Source uuid can't be blank\",\n \"Source uuid is not unique\"\n ]\n }\n ]\n}"}],"_postman_id":"49c57093-d300-4cd4-812f-6f10fcc9a20c"},{"name":"Get Pre-Qualification Decision","id":"391f6615-1fbf-470c-8c47-924a0f14a86d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification?ft_supplier_id=a2731c14-8a91-40fe-856a-7d8e952a5a96&ft_buyer_id=a2731c14-8a91-40fe-856a-7d8e952a5a96","description":"

Returns a decision on whether a Buyer, Supplier, or both pre-qualify or are pre-approved for funding based on information we know about them.

Response Format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Value
`source_uuid`	String	Your unique ID for the Supplier/Buyer. (Note does not have to be UUID format.)
`ft_prequal_supplier_request_id`	String	Unique ID that’s generated for this request, if a Supplier Pre-Qualification was requested.
`ft_prequal_buyer_request_id`	String	Unique ID that’s generated for this request, if a Buyer Pre-Qualification was requested.

`prequal_decision`

The pre-qualification decision.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Data Type	Value
`decision`	Object	The decision generated for the supplier/buyer. See possible decisions below.
`decision_reason`	Object	The reason for not pre-approving a supplier/buyer. See reasons below. Not set if the supplier/buyer is approved.

Possible values for decision:

\"Pre-Qualified\" - The supplier/buyer is pre-qualified as their credit history does not indicate high risk. However, the Partner will have to submit additional documentation for the Supplier/Buyer to be approved. The decision_reason indicates the reason for not pre-approving.
\"Pre-Approved\" - The supplier/buyer is pre-approved to use the FT platform for fundings.
\"Rejected\" - The supplier/buyer credit score/history indicates higher risk and rejected for funding.

Possible values for decision_reason:

\"Credit Score Threshold not met\" - The supplier/buyer does not meet the credit risk threshold set for pre-qualification, and hence is rejected.
\"Existing Liens\" - Existing liens were noted in the credit profile; the supplier/buyer needs to undergo further credit checks for pre-approval.
\"Thin File\" - Missing credit information based on the provided inputs; the supplier/buyer needs to undergo further credit checks for pre-approval.
\"Unknown\" - FundThrough was unable to produce exact reason for rejection/pre-qualification, the supplier/buyer needs to reach out to FundThrough for further checks/validation.

\n","urlObject":{"path":["v1","pre-qualification"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[{"disabled":true,"description":{"content":"

Unique ID that’s generated for this request from buyer or supplier endpoint.

\n","type":"text/plain"},"key":"request_id","value":"a2731c14-8a91-40fe-856a-7d8e952a5a96"},{"disabled":true,"description":{"content":"

Type of the request, can you supplier or buyer

\n","type":"text/plain"},"key":"request_type","value":"supplier"},{"key":"ft_supplier_id","value":"a2731c14-8a91-40fe-856a-7d8e952a5a96"},{"key":"ft_buyer_id","value":"a2731c14-8a91-40fe-856a-7d8e952a5a96"}],"variable":[]}},"response":[{"id":"1738c8d0-eae4-4678-8e11-023f063bf2ac","name":"Check - Decision","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification?ft_supplier_id=fundthrough-supplier-generated-uuid&ft_buyer_id=fundthrough-buyer-generated-uuid","protocol":"https","host":["5f2de6fd-40b8-4e21-acd5-500dd8c8cd49","mock","pstmn","io"],"path":["v1","pre-qualification"],"query":[{"key":"ft_supplier_id","value":"fundthrough-supplier-generated-uuid"},{"key":"ft_buyer_id","value":"fundthrough-buyer-generated-uuid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"source_uuid\": \"1234451\",\n \"prequal_decision\": {\n \"decision\": \"Pre-Qualified\",\n \"decision_reason\": \"Thin File\"\n },\n \"ft_prequal_supplier_request_id\": \"a2731c14-8a91-40fe-856a-7d8e952a5a96\"\n}"},{"id":"926209fa-95f3-471f-8ac3-6e4d3f142c61","name":"Empty - Supplier and Buyer Not Provided","originalRequest":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/pre-qualification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"prequal_decision\": {}\n}"}],"_postman_id":"391f6615-1fbf-470c-8c47-924a0f14a86d"}],"id":"ecb80ff2-a428-4110-b393-6089dbc7eb3a","description":"

These endpoints can provide a pre-qualification decision on whether a particular Supplier or Buyer pre-qualifies for funding.

This decision can then be used as an input for your platform to optionally present an offer to the Supplier.

\n","_postman_id":"ecb80ff2-a428-4110-b393-6089dbc7eb3a"},{"name":"2. Add Suppliers & Buyers","item":[{"name":"Add Supplier","event":[{"listen":"test","script":{"id":"13fe060d-af4c-483c-a45f-b039f18d287b","exec":[""],"type":"text/javascript"}}],"id":"a2349a3e-b529-4f4c-baa6-d871c36773cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for the Supplier. (Note does not have to be UUID format.)
`auto_fund`	Boolean	Y	Set to `true` if all of Supplier's invoices are to be funded.
`additional_data`	Object	N	Optional set of key/value pairs provided by Partner.

`company` (Required)

Information about the Supplier's company.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`kyc_completed`	Boolean	Y	Set to `true` if you have completed KYC on this Supplier's business.
`name`	String	Y	Legal name of Supplier's company, including entity type (\"Inc.\", \"LLC\", etc.).
`address`	String	Y	Street address of Supplier headquarters; separate multiple lines with commas.
`city`	String	Y
`state`	String	Y	2-letter abbreviation.
`country`	String	Y	Please send US for USA and CA for Canada
`postcode`	String	Y	Zip or postal code of Supplier's headquarters.
`phone`	Integer	N	Contact phone for Supplier headquarters, no dashes.
`business_number`	String	Y	Supplier's EIN or BN
`incorporation_status`	String	N	{\"C-Corp\", \"S-Corp\", \"unincorporated\"}
`organization_date`	String	N	YYYY-MM-DD

`principal_contact` (Required)

Primary contact at the Supplier; should be a signing authority.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`kyc_completed`	Boolean	Y	Set to `true` if you have completed KYC on this individual.
`given_name`	String	Y
`surname`	String	Y
`email`	String	Y
`phone`	Integer	Y	Contact phone for individual, no dashes.
`title`	String	N	Contact's job title, if known.

`Business Bank Account info` (Optional)

Optional Supplier Business Bank information, if known.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type / Format	Required?	Description
`account_number`	String	N	Should be a business bank account number.
`routing_number`	String	N

","urlObject":{"protocol":"https","path":["v1","suppliers"],"host":["5f2de6fd-40b8-4e21-acd5-500dd8c8cd49","mock","pstmn","io"],"query":[],"variable":[]}},"response":[{"id":"daee492b-6d5b-43a0-b812-4f95ef9d687e","name":"Success - Supplier Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Supplier data received\",\n \"ft_supplier_id\": \"fundthrough-supplier-uuid\"\n}"},{"id":"a064aceb-94ff-481b-8e55-ab70c7a5ace5","name":"Empty Body","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": null,\n \"title\": \"Invalid Body Param\",\n \"details\": \"Request body is empty\"\n }\n ]\n}"},{"id":"2b650255-15ce-49eb-a581-84cb8b49618b","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\n source_uuid: 1111111,\n auto_fund: false,\n company: {\n kyc_completed: true,\n name: Maple Energy Inc.,\n address: 123 Street Av, Unit 201,\n city: Toronto,\n state: ON,\n country: CA,\n postcode: X0X0X0,\n phone: 6470001123,\n business_number: 123456789,\n incorporation_status: ,\n organization_date: \n },\n principal_contact: {\n kyc_completed: true,\n given_name: John,\n surname: Doe,\n email: john.doe@email.com,\n phone: 6470001122,\n title: \n },\n bank: {\n account_number: ,\n routing_number: \n },\n additional_data: {}\n}","options":{"raw":{"language":"text"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": null,\n \"title\": \"Invalid Body Param\",\n \"details\": \"Please ensure request body is a valid JSON\"\n }\n ]\n}"},{"id":"3ee3ec98-3db5-4cfa-8c92-5f367b731e03","name":"Validation Error - Account Number US","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Cactus Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Flagstaff\",\n \"state\": \"AZ\",\n \"country\": \"US\",\n \"postcode\": \"12345\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"1\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"account_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Account number should have 4-17 digits\"\n ]\n }\n ]\n}"},{"id":"e7332e20-b0a8-4a77-a1e5-83f67167b6be","name":"Validation Error - Account Number CA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"1\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"account_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Account number should have 7-12 digits\"\n ]\n }\n ]\n}"},{"id":"4f04374a-5d64-4844-a314-4dc91f313a53","name":"Validation Error - Routing Number US","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Cactus Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Flagstaff\",\n \"state\": \"AZ\",\n \"country\": \"US\",\n \"postcode\": \"12345\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"1\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"routing_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Routing number should have 9 digits\"\n ]\n }\n ]\n}"},{"id":"79ab2b4a-e195-4b0e-be8c-ddb81a11725d","name":"Validation Error - Routing Number CA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"1\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"routing_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Routing number should have 5 digits\"\n ]\n }\n ]\n}"},{"id":"a1ca2183-9bdb-4451-8c27-f75918d8ef83","name":"Validation Error - Non Unique Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"email\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Email already exists in our system. Please use a different email\"\n ]\n }\n ]\n}"},{"id":"4c7f43ab-baf3-46a0-a597-c432407da603","name":"Validation Error - Email Invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doeemail.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"email\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Email format is invalid\"\n ]\n }\n ]\n}"},{"id":"589c54b6-f654-473d-b78b-1e84e0f56aa2","name":"Validation Error - Source uuid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"source_uuid\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Source uuid can't be blank\"\n ]\n }\n ]\n}"},{"id":"63774531-4ccd-4c81-afa5-219aafcbf23c","name":"Validation Error - Non Unique Source uuid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"source_uuid\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Source uuid is not unique, please ensure the source_uuid is unique to supplier\"\n ]\n }\n ]\n}"},{"id":"16bb159f-cea3-4f16-a99d-ae1adc50ab17","name":"Validation Error - Postcode","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"123\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"postcode\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Postcode format is invalid\"\n ]\n }\n ]\n}"},{"id":"6dc0ba65-183a-46f1-8c9e-25e9382b0161","name":"Validation Error - Country","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"country\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Country can't be blank\",\n \"Country must be either US or CA\"\n ]\n }\n ]\n}"},{"id":"891b10b1-fa41-4bd6-9087-ef1754a23a0a","name":"Validation Error - User Phone","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"user_phone\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"User phone can't be blank\",\n \"User phone # must only have 10 digits\"\n ]\n }\n ]\n}"},{"id":"3085ab92-0093-4b21-9850-06db665f67f1","name":"Validation Error - Company Phoned Copy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"company_phone\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Company phone can't be blank\",\n \"Company phone # must only have 10 digits\"\n ]\n }\n ]\n}"},{"id":"28105b77-3f0d-4aca-8c2a-0e225ae0901e","name":"Validation Error - Empty Business Number","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"business_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"Business number can't be blank\"\n ]\n }\n ]\n}"},{"id":"38ceb174-b39a-4479-89c9-910759d10ea9","name":"Validation Error - Invalid Business Number","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"ON\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"1234567890\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"business_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"business number must be 9 digits\"\n ]\n }\n ]\n}"},{"id":"acc126e2-1b86-4770-a481-511186da16f5","name":"Validation Error - Invalid Business Number (QC)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"1111111\",\n \"auto_fund\": false,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Maple Energy Inc.\",\n \"address\": \"123 Street Av, Unit 201\",\n \"city\": \"Toronto\",\n \"state\": \"QC\",\n \"country\": \"CA\",\n \"postcode\": \"X0X0X0\",\n \"phone\": \"6470001123\",\n \"business_number\": \"123456789\",\n \"incorporation_status\": \"\",\n \"organization_date\": \"\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"given_name\": \"John\",\n \"surname\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"phone\": \"6470001122\",\n \"title\": \"\"\n },\n \"bank\": {\n \"account_number\": \"\",\n \"routing_number\": \"\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"source\": \"business_number\",\n \"title\": \"Invalid Attribute\",\n \"details\": [\n \"business number must be 10 digits when state is Quebec\"\n ]\n }\n ]\n}"}],"_postman_id":"a2349a3e-b529-4f4c-baa6-d871c36773cb"},{"name":"Add Buyer","event":[{"listen":"test","script":{"id":"13fe060d-af4c-483c-a45f-b039f18d287b","exec":[""],"type":"text/javascript"}}],"id":"9ccb1d38-834e-4973-a756-cbafbfabcf3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"2222222\",\n \"anonymous\": true,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Staples\",\n \"address\": \"123 Avenida SE\",\n \"city\": \"Calgary\",\n \"state\": \"Alberta\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4031112233\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"name\": \"Elise\",\n \"email\": \"elise@staples.ca\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers","description":"

Add Buyers associated with a Supplier, as identified by its FundThrough ID.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for the Buyer. (Note does not have to be UUID format.)
`anonymous`	Boolean	Y	Set to `true` if Buyer is not to be identified to the Supplier.
`additional_data`	Object	N	Optional set of key/value pairs provided by Partner.

`company`

Information about the Buyer's company.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`kyc_completed`	Boolean	Y	Set to `true` if you have completed KYC on this Buyer's company.
`name`	String	Y	Legal name of Buyer's company, including entity type (\"Inc.\", \"LLC\", etc.).
`address`	String	Y	Street address of Buyer headquarters; separate multiple lines with commas.
`city`	String	Y
`state`	String	Y	2-letter abbreviation.
`country`	String	Y	Please send US for USA and CA for Canada
`postcode`	String	Y	Zip or postal code of Buyer's headquarters.
`phone`	String	Y	Contact phone for Buyer headquarters, no dashes.

`principal_contact`

Primary contact at the Buyer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`kyc_completed`	Boolean	Y	Set to `true` if you have completed KYC on this individual.
`name`	String	Y
`email`	String	Y

","urlObject":{"path":["v1","suppliers",":ft_supplier_id","buyers"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[],"variable":[{"type":"any","value":"fundthrough-supplier-uuid","key":"ft_supplier_id"}]}},"response":[{"id":"1aaeec3d-c5a4-42cd-9779-c5ae91dd5cd6","name":"Success - Buyer Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"2222222\",\n \"anonymous\": true,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Staples\",\n \"address\": \"123 Avenida SE\",\n \"city\": \"Calgary\",\n \"state\": \"Alberta\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4031112233\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"name\": \"Elise\",\n \"email\": \"elise@staples.ca\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers"],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Buyer data received\",\n \"ft_buyer_id\": \"fundthrough-buyer-uuid\"\n}"},{"id":"3f51d016-fd82-4532-9555-5fcd1e418175","name":"Error - Invalid Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"2222222\",\n \"anonymous\": true,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Staples\",\n \"address\": \"123 Avenida SE\",\n \"city\": \"Calgary\",\n \"state\": \"Alberta\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4031112233\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"name\": \"Elise\",\n \"email\": \"elise@staples.ca\"\n },\n \"custom_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers"],"variable":[{"id":"1ccaa31b-ce93-48e2-a6f5-dd0f9c51a354","key":"ft_supplier_id","value":"fundthrough-supplier-generated-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Request\",\n \"error\": \"Incorrect information provided\"\n}"},{"id":"8ce37f61-f2e1-46fc-a534-9e5a1857b0f0","name":"Validation Error - Source_UUID is not unique","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"2222222\",\n \"anonymous\": true,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Staples\",\n \"address\": \"123 Avenida SE\",\n \"city\": \"Calgary\",\n \"state\": \"Alberta\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4031112233\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"name\": \"Elise\",\n \"email\": \"elise@staples.ca\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers"],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Please ensure the Source_UUID is unique\"\n}"},{"id":"6eb592d4-4da0-4fe9-beef-58b930b8c945","name":"Validation Error - Empty company","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"2222222\",\n \"anonymous\": true,\n \"company\": {\n \"kyc_completed\": true,\n \"name\": \"Staples\",\n \"address\": \"123 Avenida SE\",\n \"city\": \"Calgary\",\n \"state\": \"Alberta\",\n \"country\": \"CA\",\n \"postcode\": \"Z0Z0Z0\",\n \"phone\": \"4031112233\"\n },\n \"principal_contact\": {\n \"kyc_completed\": true,\n \"name\": \"Elise\",\n \"email\": \"elise@staples.ca\"\n },\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers"],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Company phone can't be blank, Company phone # must only have 10 digits, Country can't be blank, Country must be either US or CA, Address can't be blank, City can't be blank, State can't be blank, Company name can't be blank, Company kyc completed must be a boolean value\"\n}"}],"_postman_id":"9ccb1d38-834e-4973-a756-cbafbfabcf3c"},{"name":"Generate Supplier Documentation S3 Upload URL","id":"b608aadd-ea74-4505-beea-e60bd957b885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/new_supporting_document_upload_url?filename=article-of-incorporation.png&document_type=Article Of Incorporation","description":"

FundThrough requires documentation to support our KYC processes, which will vary partner to partner.

Uploading a file is a two-step process:

Generate a AWS S3 presigned URL. This endpoint will generate one for you, given a correct Supplier or Buyer ID (Buyer is optional for some document types) values in path, as well as parameters to specify the file name and the document type. In response you will get a JSON object with a url key that can be used to upload the file.
Use the url key to upload the file directly to S3. Code samples to do this are provided below.

For a list supported document types, see below.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`filename`	String	Y	Filename of the provided file. Valid filetypes include `.pdf` `.jpg` and `.png`
`document_type`	String	Y	See list below for valid values. In some implementations of HTTP libraries it may be necessary to encode this parameter before sending the request. Not case-sensitive.

Valid values for document_type that can be provided to the Supplier endpoint includes:

Article of Incorporation
Business License
Certificate of Incorporation
Driving license
Passport
Tax authorization
MPSA/PG/Corp Guarantee
Void Check
Bank statements
AP Aging Report
AR Aging Report
Profit and Loss statements
Balance Sheet
Direct deposit

S3 Code Examples

Examples provided by others showing how to add files to S3, given a URL:

Example curl usage: curl -T contract.pdf \"https://s3.amazonaws.com/files.fundthrough.com/inv...\"
Example Ruby code: https://stackoverflow.com/a/50590108

\n","urlObject":{"path":["v1","suppliers",":ft_supplier_id","new_supporting_document_upload_url"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[{"key":"filename","value":"article-of-incorporation.png"},{"key":"document_type","value":"Article Of Incorporation"}],"variable":[{"description":{"content":"

Generated ID from Add Supplier call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"}]}},"response":[{"id":"c2982256-ed02-4ed7-a667-184ff0c4fee5","name":"Success - URL Generated","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/new_supporting_document_upload_url?filename=article-of-incorporation.png&document_type=Article Of Incorporation","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"article-of-incorporation.png"},{"key":"document_type","value":"Article Of Incorporation"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://s3.amazonaws.com/files.stage.fundthrough.com/credit_signals/451f90dc-8a8a-4246-9c44-9bdcba7393d4/company_identity__1891365/51eca788__patrick-testing-invoice.png?x-amzn-trace-id=Root%3D1-6346c6c6-2cc8e7562f8e18276621b3f4%3BParent%3D1c80dd644a710919%3BSampled%3D0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZOS3IN4KU6QHROFH%2F20221012%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221012T135312Z&X-Amz-Expires=900&X-Amz-Security-Token=VERYLONGAWSSECURITYTOKEN\"\n}"},{"id":"338e4ace-ab97-4e3b-883d-38a86cf3c431","name":"Failure - unsupported file extension","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/new_supporting_document_upload_url?filename=article-of-incorporation.pn&document_type=Article Of Incorporation","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"article-of-incorporation.pn"},{"key":"document_type","value":"Article Of Incorporation"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"'filename' should have pdf, jpg or png extension\"\n}"},{"id":"b9bedad6-640b-4ae7-bc5a-488e7565765f","name":"Failure - unsupported document_type","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/new_supporting_document_upload_url?filename=article-of-incorporation.pn&document_type=Article Of Incorporation","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"article-of-incorporation.pn"},{"key":"document_type","value":"Article Of Incorporation"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid document type. Supported values are: [\\\"Article Of Incorporation\\\", \\\"Business License\\\", \\\"Certificate of Incorporation\\\", \\\"Driving license\\\", \\\"Passport\\\", \\\"Tax authorization\\\", \\\"MPSA/PG/Corp Guarantee\\\", \\\"Void Check\\\", \\\"Bank statements\\\", \\\"AP Aging Report\\\", \\\"AR Aging Report\\\", \\\"Profit and Loss statements\\\", \\\"Balance Sheet\\\", \\\"Direct Deposit\\\", \\\"MSA (Master Service Agreement)\\\", \\\"Purchase Orders\\\", \\\"Contracts\\\", \\\"SOW (Statement of Work)\\\", \\\"NOA document\\\"]\"\n}"},{"id":"18156613-897b-4877-935d-91a7aecc932f","name":"Failure - unsupported document_type for buyer","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/new_supporting_document_upload_url?filename=contract.png&document_type=Contracts","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"contract.png"},{"key":"document_type","value":"Contracts"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"This document_type is only supported in context of buyer\"\n}"}],"_postman_id":"b608aadd-ea74-4505-beea-e60bd957b885"},{"name":"Generate Buyer Documentation S3 Upload URL","id":"91613db9-36af-421c-a21b-785de1ef4e87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/new_supporting_document_upload_url?filename=contract.png&document_type=Contracts","description":"

FundThrough requires documentation to support our KYC processes, which will vary partner to partner.

Uploading a file is a two-step process:

Generate a AWS S3 presigned URL. This endpoint will generate one for you, given a correct Supplier or Buyer ID (Buyer is optional for some document types) values in path, as well as parameters to specify the file name and the document type. In response you will get a JSON object with a url key that can be used to upload the file.
Use the url key to upload the file directly to S3. Code samples to do this are provided below.

For a list supported document types, see below.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`filename`	String	Y	Filename of the provided file. Valid filetypes include `.pdf` `.jpg` and `.png`
`document_type`	String	Y	See list below for valid values. In some implementations of HTTP libraries it may be necessary to encode the document_type parameter before sending the request. Not case-sensitive.

Valid values for document_type that can be provided to the Buyer endpoint includes:

MSA (Master Service Agreement)
Purchase Orders
Contracts
SOW(Statement of Work)
NOA document

S3 Code Examples

Examples provided by others showing how to add files to S3, given a URL:

Example curl usage: curl -T contract.pdf \"https://s3.amazonaws.com/files.fundthrough.com/inv...\"
Example Ruby code: https://stackoverflow.com/a/50590108

\n","urlObject":{"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","new_supporting_document_upload_url"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[{"key":"filename","value":"contract.png"},{"key":"document_type","value":"Contracts"}],"variable":[{"description":{"content":"

Generated ID from Add Supplier call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"},{"description":{"content":"

Generated ID from Add Buyer call

\n","type":"text/plain"},"type":"any","value":"fundthrough-buyer-generated-uuid","key":"ft_buyer_id"}]}},"response":[{"id":"648fa964-84ee-4311-bbb5-b82a2a48dccb","name":"Success - URL Generated","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/new_supporting_document_upload_url?filename=contract.png&document_type=Contracts","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"contract.png"},{"key":"document_type","value":"Contracts"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-uuid","description":"Generated ID from Buyer Create Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://s3.amazonaws.com/files.stage.fundthrough.com/credit_signals/451f90dc-8a8a-4246-9c44-9bdcba7393d4/company_identity__1891365/51eca788__contract.png?x-amzn-trace-id=Root%3D1-6346c6c6-2cc8e7562f8e18276621b3f4%3BParent%3D1c80dd644a710919%3BSampled%3D0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZOS3IN4KU6QHROFH%2F20221012%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221012T135312Z&X-Amz-Expires=900&X-Amz-Security-Token=VERYLONGAWSSECURITYTOKEN\"\n}"},{"id":"ceec3fbc-6c2b-412f-ac3a-769824d9fe8d","name":"Failure - unsupported file extension","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/new_supporting_document_upload_url?filename=contract.png&document_type=Contract","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"contract.png"},{"key":"document_type","value":"Contract"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-uuid","description":"Generated ID from Buyer Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"'filename' should have pdf, jpg or png extension\"\n}"},{"id":"c87ef9e4-ecc7-4257-bbb4-d189242cb6f4","name":"Failure - unsupported document_type","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/new_supporting_document_upload_url?filename=contract.png&document_type=Contract","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","new_supporting_document_upload_url"],"query":[{"key":"filename","value":"contract.png"},{"key":"document_type","value":"Contract"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-uuid","description":"Generated ID from Buyer Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid document type. Supported values are: [\\\"Article Of Incorporation\\\", \\\"Business License\\\", \\\"Certificate of Incorporation\\\", \\\"Driving license\\\", \\\"Passport\\\", \\\"Tax authorization\\\", \\\"MPSA/PG/Corp Guarantee\\\", \\\"Void Check\\\", \\\"Bank statements\\\", \\\"AP Aging Report\\\", \\\"AR Aging Report\\\", \\\"Profit and Loss statements\\\", \\\"Balance Sheet\\\", \\\"Direct Deposit\\\", \\\"MSA (Master Service Agreement)\\\", \\\"Purchase Orders\\\", \\\"Contracts\\\", \\\"SOW (Statement of Work)\\\", \\\"NOA document\\\"]\"\n}"}],"_postman_id":"91613db9-36af-421c-a21b-785de1ef4e87"},{"name":"Supplier Status","id":"0d90b113-1b48-455e-af83-e06969aac5a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","description":"

Returns the supplier details, including the financing status of the supplier.

\n","urlObject":{"path":["v1","suppliers",":ft_supplier_id"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[],"variable":[{"id":"22038148-1293-48c1-bdd8-e652b2eff259","description":{"content":"

Generated ID from Add Supplier call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"}]}},"response":[{"id":"1f974c8d-f91e-4124-af5c-90ecd3544c7b","name":"Supplier Status - In Review","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Supplier information in review\",\n \"data\": {\n \"name\": \"The Birch Company\",\n \"uuid\": \"1c209faa-29b3-4d08-979c-4f7dcd6ce473\",\n \"client_state\": \"in_review\"\n }\n}"},{"id":"7de1c316-c48b-4c94-a397-3374e46de033","name":"Supplier Status - Closed Inactive","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Supplier closed or inactive\",\n \"data\": {\n \"name\": \"The Oak Company\",\n \"uuid\": \"fea1fa56-412f-489a-a34b-ba95030cc4cf\",\n \"client_state\": \"closed_inactive\"\n }\n}"},{"id":"b22e9e43-20b0-447e-a16e-fe3e1e3a8b53","name":"Supplier Status - Active","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Active supplier, eligible for funding\",\n \"data\": {\n \"name\": \"The Spruce Company\",\n \"uuid\": \"98d6592a-364e-4f06-8aa0-5d53cb9ef201\",\n \"client_state\": \"active\"\n }\n}"},{"id":"529a50c8-f4d4-4315-bfef-759f1bb49f2c","name":"Supplier Status - Rejected","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Supplier rejected. Contact FundThrough's Client Success team to learn more.\",\n \"data\": {\n \"name\": \"The Maple Company\",\n \"uuid\": \"601008f9-ad25-4064-803d-d90488433172\",\n \"client_state\": \"rejected\"\n }\n}"},{"id":"2b34df2b-2a60-4c22-b83b-3f6460c7e113","name":"Supplier Status - Not Yet Synced to Orbit","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Supplier received, waiting to be processed\",\n \"data\": {}\n}"},{"id":"0a36e757-3ba8-431c-85a1-618ef84f4730","name":"Supplier Status - Supplier Id Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": \"Supplier with ft_supplier_id 6178dc07-199a-4c76-91bf-5b2310802b03 not found\"\n}"},{"id":"d24932b8-7b55-4530-a39c-5e3b1c714d6d","name":"Supplier Status - Invalid Supplier Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id"],"variable":[{"key":"ft_supplier_id","value":"","description":"Generated ID from Add Supplier call"}]}},"_postman_previewlanguage":"json","header":["",{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": \"Please provide a valid ft_supplier_id\"\n}"}],"_postman_id":"0d90b113-1b48-455e-af83-e06969aac5a2"}],"id":"49475301-b7e2-4d5a-827d-5f1faae52942","description":"

In the context of the FundThrough API, a Supplier (a.k.a. Seller, Client) represents the party that's providing a service or product; and a Buyer (a.k.a., Payor, Institution) is the purchaser of the service or product.

Use the Add Suppliers and Add Buyers endpoints to provide information to FundThrough about each of these businesses.

\n","_postman_id":"49475301-b7e2-4d5a-827d-5f1faae52942"},{"name":"3. Add Invoices","item":[{"name":"Add Invoice","id":"1120c55b-33f8-45cc-b9ae-82b65d8a7be9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333335\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 5000,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n },\n {\n \"source_uuid\": \"3333337\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for the Invoice. (Note does not have to be UUID format.)
`number`	String	Y
`date`	String	Y	YYYY-MM-DD
`amount`		Y
`currency`	String	Y	3-letter ISO currency code. We accept only USD and CAD.
`due_date`	String	Y	YYYY-MM-DD
`paid_amount`	Number	N	Filled for historical invoices; set to `null` when first sending an invoice to fund.
`paid_date`	String	N	Filled for historical invoices; set to `null` when first sending an invoice to fund. YYYY-MM-DD
`outstanding_amount`	Number	N	Filled for historical invoices; set to `null` when first sending an invoice to fund.
`verified`	Boolean	N	Filled for historical invoices; set to `null` when first sending an invoice to fund.
`additional_data`	Object	N	Optional set of key/value pairs provided by Partner.

","urlObject":{"protocol":"https","path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"host":["5f2de6fd-40b8-4e21-acd5-500dd8c8cd49","mock","pstmn","io"],"query":[],"variable":[{"description":{"content":"

Generated ID from Add Supplier Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"},{"description":{"content":"

Generated ID from Add Buyer Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-buyer-generated-uuid","key":"ft_buyer_id"}]}},"response":[{"id":"db577d3a-7829-4d3b-a8f7-c5a48e87bc97","name":"Error - Supplier Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333333\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-generated-uuid"},{"key":"ft_buyer_id","value":"fundthrough-buyer-generated-uuid"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:21:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"3462e8e9-a0fb-423d-b231-b19615c409bd"},{"key":"x-amz-apigw-id","value":"RVXG_HP0IAMEbuw="},{"key":"x-amzn-trace-id","value":"Root=1-659ed22c-4732f84b726bff003ff02ae3;Sampled=0;lineage=a7b73740:0"},{"key":"x-cache","value":"Error from cloudfront"},{"key":"via","value":"1.1 8ba3a4becb51f8eb807e5e3697846e1a.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD89-C2"},{"key":"x-amz-cf-id","value":"jhEaLfSTlTjH3bIgIC2lQEjwklVDH5Wv7IP4V5FBGekRuTS8qsIhbg=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"843699359d8d391c-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Supplier with ft_supplier_id fundthrough-supplier-generated-uuid not found\"\n}"},{"id":"c08277f1-14f1-4ee9-b38e-5a91178af498","name":"Error - Buyer Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333333\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"variable":[{"key":"ft_supplier_id","value":"26f02979-ade2-4006-92d6-db65b1b5eb69"},{"key":"ft_buyer_id","value":"fundthrough-buyer-generated-uuid"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:26:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"e964ee19-b7d6-4946-bf31-1f18de26ad10"},{"key":"x-amz-apigw-id","value":"RVXvXHV1IAMEh6Q="},{"key":"x-amzn-trace-id","value":"Root=1-659ed32e-2997ff982ee0c4711d215276;Sampled=0;lineage=a7b73740:0"},{"key":"x-cache","value":"Error from cloudfront"},{"key":"via","value":"1.1 c37f72766931ae9c3f146ffa54018d1c.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD89-C2"},{"key":"x-amz-cf-id","value":"PHXlSQeXuT9KtPk1yK2Gh4AFecDcGJmgnuvbhsxgDeUZv77sGck1rw=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"84369f8458de8260-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Buyer with ft_buyer_id fundthrough-buyer-generated-uuid not found\"\n}"},{"id":"dd39d33d-dee7-4cb8-9f58-39879718785c","name":"Success (single) - Invoices Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333333\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"variable":[{"key":"ft_supplier_id","value":"26f02979-ade2-4006-92d6-db65b1b5eb69"},{"key":"ft_buyer_id","value":"8b2ab7f7-99e0-4db2-bcd5-1cff413a2911"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:27:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"141"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"be151a1f-fa44-4477-b41b-72e17e0dc435"},{"key":"x-amz-apigw-id","value":"RVX3yEaxoAMEsmw="},{"key":"x-amzn-trace-id","value":"Root=1-659ed364-3682600b6622469a1212b146;Sampled=0;lineage=a7b73740:0"},{"key":"x-cache","value":"Miss from cloudfront"},{"key":"via","value":"1.1 c8c9787916110356915bbdbddd0a32d6.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD89-C2"},{"key":"x-amz-cf-id","value":"UKw53jdDXpo2L0WF-oLRxjEXBNIIpHJxxY0ym1UblsZI4kwLLzyw6Q=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436a0d50b24241a-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoices accepted\",\n \"data\": [\n {\n \"source_uuid\": \"3333333\",\n \"ft_invoice_id\": \"bdb195df-7062-407c-8659-5eeb08d0688f\",\n \"status\": \"received\"\n }\n ]\n}"},{"id":"26b2d015-3423-4e5c-90ca-3ec2e6464856","name":"Success (bulk) - Invoices Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333335\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n },\n {\n \"source_uuid\": \"3333336\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"variable":[{"key":"ft_supplier_id","value":"26f02979-ade2-4006-92d6-db65b1b5eb69"},{"key":"ft_buyer_id","value":"8b2ab7f7-99e0-4db2-bcd5-1cff413a2911"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:28:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"242"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"e55f769f-ff52-4e22-9ba0-c3d22fc9295f"},{"key":"x-amz-apigw-id","value":"RVYI4FSVoAMEPeA="},{"key":"x-amzn-trace-id","value":"Root=1-659ed3d2-7941036a3db699277adeffa6;Sampled=0;lineage=a7b73740:0"},{"key":"x-cache","value":"Miss from cloudfront"},{"key":"via","value":"1.1 ffa8ec5cfe61dcaaebc108ff8c867054.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD89-C2"},{"key":"x-amz-cf-id","value":"0K80iTvvNORK1bni8ATZ5pj2hN-tXv9NXZhltDtPjnKZI23szlWpJg=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436a380cebc3920-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoices accepted\",\n \"data\": [\n {\n \"source_uuid\": \"3333335\",\n \"ft_invoice_id\": \"1dad0fb5-eabc-4c25-9f67-184c037ed804\",\n \"status\": \"received\"\n },\n {\n \"source_uuid\": \"3333336\",\n \"ft_invoice_id\": \"d692caa7-50bd-4956-8dd3-13bd3af1e1ae\",\n \"status\": \"received\"\n }\n ]\n}"},{"id":"6e5c1a1a-eb24-4170-835b-722d29e9acbb","name":"Partial Success (bulk)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"source_uuid\": \"3333335\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": null,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n },\n {\n \"source_uuid\": \"3333337\",\n \"number\": \"inv-0012331\",\n \"date\": \"2022-02-01\",\n \"amount\": 34233,\n \"currency\": \"CAD\",\n \"due_date\": \"2022-05-01\",\n \"paid_amount\": 5000,\n \"paid_date\":\"2021-03-21\",\n \"outstanding_amount\": 0,\n \"verified\": true,\n \"additional_data\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/bulk","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices","bulk"],"variable":[{"key":"ft_supplier_id","value":"26f02979-ade2-4006-92d6-db65b1b5eb69"},{"key":"ft_buyer_id","value":"8b2ab7f7-99e0-4db2-bcd5-1cff413a2911"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Jan 2024 17:31:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"222"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-requestid","value":"ddc93ad3-43d0-41f5-b0e9-ac5cd5973b4d"},{"key":"x-amz-apigw-id","value":"RVYdLEERIAMEmwg="},{"key":"x-amzn-trace-id","value":"Root=1-659ed454-7695e2477cbe040c23d61fd4;Sampled=0;lineage=a7b73740:0"},{"key":"x-cache","value":"Miss from cloudfront"},{"key":"via","value":"1.1 b051e9c33308597b659c33b8999b521c.cloudfront.net (CloudFront)"},{"key":"x-amz-cf-pop","value":"IAD89-C2"},{"key":"x-amz-cf-id","value":"zK9uW3xo-R8l6cYFzvS_756awS8whOAjI55VkMR8hb9FVkp-CwWB6g=="},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8436a6accda2094f-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoices accepted\",\n \"data\": [\n {\n \"source_uuid\": \"3333335\",\n \"status\": \"rejected\",\n \"errors\": [\n \"Amount can't be blank\"\n ]\n },\n {\n \"source_uuid\": \"3333337\",\n \"ft_invoice_id\": \"26edf476-22fd-4199-8fc8-942a403cb446\",\n \"status\": \"received\"\n }\n ]\n}"}],"_postman_id":"1120c55b-33f8-45cc-b9ae-82b65d8a7be9"},{"name":"Add Invoice Transaction","id":"3ba6c369-6253-494b-aa58-27b44f7a11a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"12983193719283712\",\n \"source_invoice_uuid\": \"3333333\",\n \"type\": \"issued\",\n \"issued_amount\": 34233,\n \"paid_amount\": 0,\n \"credit_amount\": 0,\n \"payment_method\": \"\",\n \"details\": \"\",\n \"invoice_number\": \"\",\n \"invoice_date\": \"\",\n \"invoice_currency\": \"\",\n \"invoice_due_date\": \"\",\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/transactions","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`source_uuid`	String	Y	Your unique ID for this transaction. (Note does not have to be UUID format.)
`source_invoice_uuid`	String	Y	Your unique ID for the Invoice this transaction pertains to.
`type`	String	Y	Type of this transaction: {\"Issued\", \"Funding_Requested\", \"Confirmed\", \"Paid\", \"Adjusted\"} If Supplier or Partner is set to `auto_fund`, `Funding_Requested` is not mandatory.
`issued_amount`	Number	Y	Face value amount of invoice issued.
`paid_amount`	Number	Y	Amount paid, if any, by Buyer.
`credit_amount`	Number	Y	Amount of credits, if any, issued by Supplier against invoice (e.g., for refunds or disputes).
`payment_method`	String	Y	Method by which payment was sent from buyer to supplier, if applicable: {\"Check\", \"ACH\", \"Wire\", via_source}.
`details`		Y	Backup data to support invoice transaction. Especially important for \"Confirmed\" and \"Adjusted\" transactions. (Details TBC.)
`invoice_number`	String	N
`invoice_date`	String	N	YYYY-MM-DD
`invoice_currency`	String	N	3-letter ISO currency code. We accept USD and CAD only
`invoice_due_date`	String	N	YYYY-MM-DD
`additional_data`	Object	N	Optional set of key/value pairs provided by Partner.

","urlObject":{"protocol":"https","path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","transactions"],"host":["5f2de6fd-40b8-4e21-acd5-500dd8c8cd49","mock","pstmn","io"],"query":[],"variable":[{"description":{"content":"

Generated ID from Add Supplier Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"},{"description":{"content":"

Generated ID from Add Buyer Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-buyer-generated-uuid","key":"ft_buyer_id"},{"description":{"content":"

Generated ID from Add Invoice Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-invoice-generated-uuid","key":"ft_invoice_id"}]}},"response":[{"id":"4e40e414-e959-4313-81ce-44556798cbad","name":"Success - Invoice Transaction Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"12983193719283712\",\n \"source_invoice_uuid\": \"3333333\",\n \"type\": \"issued\",\n \"issued_amount\": 34233,\n \"paid_amount\": 0,\n \"credit_amount\": 0,\n \"payment_method\": \"\",\n \"details\": \"\",\n \"invoice_number\": \"\",\n \"invoice_date\": \"\",\n \"invoice_currency\": \"\",\n \"invoice_due_date\": \"\",\n \"additional_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/transactions","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","transactions"],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-generated-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-generated-uuid","description":"Generated ID from Buyer Create Call"},{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-uuid","description":"Generated ID from InvoiceCreate Call"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice transaction data received\",\n \"ft_invoice_transaction_id\": \"fundthrough-invoice-transaction-uuid\"\n}"},{"id":"36465c2f-5720-41c3-8592-25813b1aaec5","name":"Error - Invalid Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_uuid\": \"12983193719283712\",\n \"source_invoice_uuid\": \"3333333\",\n \"type\": \"issued\",\n \"issued_amount\": 34233,\n \"paid_amount\": 0,\n \"credit_amount\": 0,\n \"payment_method\": \"\",\n \"details\": \"\",\n \"invoice_number\": \"\",\n \"invoice_date\": \"\",\n \"invoice_currency\": \"\",\n \"invoice_due_date\": \"\",\n \"custom_data\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/transactions","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","transactions"],"variable":[{"id":"aa991f9d-3082-42ae-93f3-78b82974b169","key":"ft_supplier_id","value":"fundthrough-supplier-generated-uuid","description":"Generated ID from Supplier Create Call"},{"id":"6561465c-748c-4e83-9b2b-b9af0c7ac5e3","key":"ft_buyer_id","value":"fundthrough-buyer-generated-uuid","description":"Generated ID from Buyer Create Call"},{"id":"850609e5-bfdb-4286-9b6f-99420b6a5cfe","key":"ft_invoice_id","value":"fundthrough-invoice-generated-uuid","description":"Generated ID from InvoiceCreate Call"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid Request\",\n \"error\": \"Incorrect information provided\"\n}"}],"_postman_id":"3ba6c369-6253-494b-aa58-27b44f7a11a0"},{"name":"Generate Invoice Attachment S3 Upload URL","id":"3a171ba4-cf74-4274-910e-a9db6380108c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/new_invoice_attachment_upload_url?filename=invoice.pdf","description":"

The invoice file and any related attachments can be provided via this endpoint. Required invoice documentation can vary partner to partner.

Uploading a file is a two-step process:

Generate a AWS S3 presigned URL. This endpoint will generate one for you, given the correct Supplier ID, Buyer ID, and Invoice ID values in the path, as well as parameters to specify the file name and the document type. In response you will get a JSON object with a url key that can be used to upload the file.
Use the url key to upload the file directly to S3. Code samples to do this are provided below.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Required?	Description
`filename`	String	Y	Filename of the provided file. Valid filetypes include `.pdf` `.jpg` and `.png`

S3 Code Examples

Example curl usage: curl -T invoice.pdf \"https://s3.amazonaws.com/files.fundthrough.com/inv...\"
Example Ruby code: https://stackoverflow.com/a/50590108

\n","urlObject":{"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","new_invoice_attachment_upload_url"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[{"key":"filename","value":"invoice.pdf"}],"variable":[{"description":{"content":"

Generated ID from Add Supplier call

\n","type":"text/plain"},"type":"any","value":"fundthrough-supplier-generated-uuid","key":"ft_supplier_id"},{"description":{"content":"

Generated ID from Add Buyer call

\n","type":"text/plain"},"type":"any","value":"fundthrough-buyer-generated-uuid","key":"ft_buyer_id"},{"description":{"content":"

Generated ID from Add Invoice call

\n","type":"text/plain"},"type":"any","value":"fundthrough-invoice-generated-uuid","key":"ft_invoice_id"}]}},"response":[{"id":"5348faa3-b58e-4dbf-bd3d-0a879ae5ec02","name":"Success - URL Generated","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/new_invoice_attachment_upload_url?filename=invoice.pdf","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","new_invoice_attachment_upload_url"],"query":[{"key":"filename","value":"invoice.pdf"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-uuid","description":"Generated ID from Buyer Create Call"},{"key":"ft_invoice_id","value":"fundthrough-invoice-uuid","description":"Generated ID from Invoice Create Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://s3.amazonaws.com/files.stage.fundthrough.com/credit_signals/451f90dc-8a8a-4246-9c44-9bdcba7393d4/company_identity__1891365/51eca788__contract.png?x-amzn-trace-id=Root%3D1-6346c6c6-2cc8e7562f8e18276621b3f4%3BParent%3D1c80dd644a710919%3BSampled%3D0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZOS3IN4KU6QHROFH%2F20221012%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221012T135312Z&X-Amz-Expires=900&X-Amz-Security-Token=VERYLONGAWSSECURITYTOKEN\"\n}"},{"id":"1ef0f3f8-745b-4fe5-87b9-56ef21f3f4fd","name":"Failure - unsupported file extension error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/suppliers/:ft_supplier_id/buyers/:ft_buyer_id/invoices/:ft_invoice_id/new_invoice_attachment_upload_url?filename=invoice.pd","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","suppliers",":ft_supplier_id","buyers",":ft_buyer_id","invoices",":ft_invoice_id","new_invoice_attachment_upload_url"],"query":[{"key":"filename","value":"invoice.pd"}],"variable":[{"key":"ft_supplier_id","value":"fundthrough-supplier-uuid","description":"Generated ID from Supplier Create Call"},{"key":"ft_buyer_id","value":"fundthrough-buyer-uuid","description":"Generated ID from Buyer Create Call"},{"key":"ft_invoice_id","value":"fundthrough-invoice-uuid","description":"Generated ID from Invoice Create Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": \"'filename' should have pdf, jpg or png extension\"\n}"}],"_postman_id":"3a171ba4-cf74-4274-910e-a9db6380108c"},{"name":"Invoice Status","id":"3bb37e18-7b82-4b47-8189-20e951adb2b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","description":"

Returns whether an invoice already exists and what the status and details of that invoice is.

\n","urlObject":{"path":["v1","invoices",":ft_invoice_id"],"host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"query":[],"variable":[{"description":{"content":"

Generated ft invoice id from Add Invoice Call

\n","type":"text/plain"},"type":"any","value":"fundthrough-invoice-generated-id","key":"ft_invoice_id"}]}},"response":[{"id":"9e30ccf6-f005-4b66-a935-081658ac0f40","name":"Invoice Status - Recieved","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"status\": \"received\",\n \"status_description\": \"Invoices received, waiting to be processed\"\n }\n ]\n}"},{"id":"a32fa387-ac59-49cb-8df7-b7d3abfc2eec","name":"Invoice Status - Ineligible","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"ineligible\",\n \"status_description\": \"Invoice ineligible for funding\"\n }\n ]\n}"},{"id":"3b57a386-46b1-43bb-8227-bb3ca38a014b","name":"Invoice Status - Expired","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"expired\",\n \"status_description\": \"Invoice ineligible for funding\"\n }\n ]\n}"},{"id":"aa32743e-1e55-4c2c-a66a-7e2da90f123e","name":"Invoice Status - Outstanding","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"outstanding\",\n \"status_description\": \"Invoice ineligible for funding\"\n }\n ]\n}"},{"id":"e875eaa0-d22b-434a-a487-5c4eb1e8c633","name":"Invoice Status - Closed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"closed\",\n \"status_description\": \"Advance closed-out/repaid\"\n }\n ]\n}"},{"id":"3ae2bade-adf0-4a61-ae85-6d1a8edb9cf6","name":"Invoice Status - Eligible","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"eligible\",\n \"status_description\": \"Invoice eligible for funding. Request funding to receive an advance.\"\n }\n ]\n}"},{"id":"9ed4feee-d77d-4007-ad91-9952ede728bb","name":"Invoice Status - Credit Pending","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"credit_pending\",\n \"status_description\": \"Funding request received/in process\"\n }\n ]\n}"},{"id":"d61a375c-fe49-44af-968c-48abc651e7d2","name":"Invoice Status - Sent","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"sent\",\n \"status_description\": \"Funding request received/in process\"\n }\n ]\n}"},{"id":"34b18e6a-8715-4100-a34a-cc009a94bc07","name":"Invoice Status - Verified","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"verified\",\n \"status_description\": \"Funding request received/in process\"\n }\n ]\n}"},{"id":"3fa2fa58-337e-4d82-b837-a8a34f32ef2f","name":"Invoice Status - Rejected","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"rejected\",\n \"status_description\": \"Funding request rejected. Contact FundThrough's Client Success team to learn more.\"\n }\n ]\n}"},{"id":"9e619c5e-a57e-422a-b5b2-3552a37fc6a4","name":"Invoice Status - Reviewing Client","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"reviewing_client\",\n \"status_description\": \"Supplier application is being reviewed.\"\n }\n ]\n}"},{"id":"33fd280c-9ced-49ed-a118-f0f35e6a980c","name":"Invoice Status - Reviewing Customer","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"reviewing_customer\",\n \"status_description\": \"Buyer is being reviewed.\"\n }\n ]\n}"},{"id":"f16ff7a5-76fa-4c67-8bdb-b0560e067c86","name":"Invoice Status - Funded","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"funded\",\n \"status_description\": \"Advance has been sent to Supplier bank account.\"\n }\n ]\n}"},{"id":"aeaf9c1e-6269-42f6-8e99-ae056187412b","name":"Invoice Status - Credit Funded","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"credit_funded\",\n \"status_description\": \"Advance has been sent to Supplier bank account.\"\n }\n ]\n}"},{"id":"072d16d8-0c73-438a-b574-6147a22f14fa","name":"Invoice Status - FTX Funded","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"ftx_funded\",\n \"status_description\": \"Advance has been sent to Supplier bank account.\"\n }\n ]\n}"},{"id":"c3f4bcf1-9e18-488b-bc35-53be33fe2730","name":"Invoice Status - Paid","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"data\": [\n {\n \"ft_supplier_uuid\": \"49bbf3c3-0308-4d6e-bf63-e21e8269988c\",\n \"source_buyer_uuid\": \"\",\n \"source_uuid\": \"5f5e6f6d-3b9e-4f12-a622-d804721b5ac2\",\n \"face_value\": 2000,\n \"status\": \"paid\",\n \"status_description\": \"Advance closed-out/repaid\"\n }\n ]\n}"},{"id":"f3cca8f3-e016-42f2-9546-3fe854fdb18a","name":"Invoice Status - Invalid Invoice Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Please provide a valid ft_invoice_id\"\n}"},{"id":"b8e95d54-4baa-47c1-951c-d31c8785fa96","name":"Invoice Status - Invoice Id Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invoice with ft_invoice_id f3a52117-35cf-4433-8b5e-8c956107bd0f not found\"\n}"},{"id":"c833584b-5b6d-4322-a539-8bac79298ec3","name":"Invoice Status - Standard Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io/v1/invoices/:ft_invoice_id","host":["https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io"],"path":["v1","invoices",":ft_invoice_id"],"variable":[{"key":"ft_invoice_id","value":"fundthrough-invoice-generated-id","description":"Generated ft invoice id from Add Invoice Call"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"unable to fetch invoice details, please try again\"\n}"}],"_postman_id":"3bb37e18-7b82-4b47-8189-20e951adb2b0"}],"id":"c16edd1d-6186-4ee8-aac5-5c0a06e1537d","description":"

All invoices for the Supplier must be shared as they are created and updated. This helps ensure eligibility is correct and quick access to funds. Invoices can be sent individually or in bulk.

\n","_postman_id":"c16edd1d-6186-4ee8-aac5-5c0a06e1537d"}],"id":"5e2499cc-7e0a-4fe1-a5c1-15e7756b932c","description":"

Please email product@fundthrough.com, with your comments and suggestions. We would love to hear how to improve our API or the use cases we cover.

\n","_postman_id":"5e2499cc-7e0a-4fe1-a5c1-15e7756b932c"}],"event":[{"listen":"prerequest","script":{"id":"e1ac351b-bee5-4b07-9955-0e14f88fa54a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9c628616-9682-4062-9091-71c1140d0c23","type":"text/javascript","exec":[""]}}],"variable":[{"key":"auth_key","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXJ0bmVyIjoiZnQtcGFydG5lci1kZW1vIn0.NGE8KDvL9v02hkYziyaMx_73_JDF-XyCuDtWgvn-FzM","type":"string"},{"key":"base_url","value":"https://5f2de6fd-40b8-4e21-acd5-500dd8c8cd49.mock.pstmn.io","type":"string"}]}

Overview

How It Works

Request Flow

Definitions

Server Authentication

Supplier Authentication

Parameters

Parameters

Response Format

prequal_decision

Attributes

company (Required)

principal_contact (Required)

Business Bank Account info (Optional)

Attributes

company

principal_contact

Parameters

Parameters

Attributes

Attributes

Parameters

`prequal_decision`

`company` (Required)

`principal_contact` (Required)

`Business Bank Account info` (Optional)

`company`

`principal_contact`