/get-invoice/
Purpose
Allows a user to requests the details of a certain invoice.
Header Information
The following Authorization keys need to be added to any API call header.
Auth-FactorID: an ID provided by FactorCloud to the Factor who owns the instance of FactorCloud.
Auth-SystemKey: A Key to Identify the specific system.
Auth-APIKey: An API password.
InvoiceIntegrationID: this key is unique to each invoice in system.
HTTP Methods
Accepts GET requests.
URI
/api_factor/get-invoice/
Return Information
A JSON object with the following paramaters:
| Variable Name |
Type |
Purpose |
| ClientKey |
String |
Unique Identifier for a client in system. |
| DebtorKey |
String |
Unique Identifier for a Debtor in system. |
| InvoiceNumber |
String |
Unique Identifier for an invoice in system. |
| InvoiceAmount |
Float |
The value of the invoice. |
| InvoiceDate |
Date |
The day the invoice was created. |
| InvoiceDueDate |
Date |
The day the invoice is due, depends on contract terms, but is typically 30 days. |
| InvoiceStatus |
String |
The status of an invoice. May be F, for Funded; P, for Pending; V, for Verified; H, for on hold; or X, for cancelled. |
| RefNumber |
String |
Unique Identifier for an invoice, differs from invoice number as it's unique to the debtor. |
| InvoicePurchaseDate |
Date |
Date the invoice was purchased by the system. |
| InvoiceFundDate |
Date |
Date the invoice was funded by the system. |
| EscrowReserveAmount |
Float |
The amount of an invoice withheld as escrow. These funds are released to a client's cash reserve when the invoice is paid for, and the amount held is determined by the client's terms. |
| PaymentMade |
String |
Identifies if a payment has been made for the invoice. |
| LastPaymentMadeOn |
Date |
The date the invoice last received a payment. May be NULL if the invoice is open. |
| PaidInFull |
Bool |
Identifies if the invoice has been closed. |
| PaidInFullOn |
Date |
The date the invoice was closed. May be NULL if the invoice is open. |
Example cURL call
curl -H 'Auth-FactorId: FACTORID’ -H 'Auth-SystemKey: SYSTEMKEY’ -H 'Auth-ApiKey: APIKEY’ https://EXAMPLE.factorcloud.com/api_factor/get-invoice/?InvoiceIntegrationId=EXAMPLE_INTEGRATION_ID
Example Path
Request:
https://EXAMPLE.factorcloud.com/api_factor/get-invoice/?InvoiceIntegrationId=EXAMPLE_INTEGRATION_ID
Response:
{
"ClientKey": "",
"DebtorKey": "",
"InvoiceNumbe": "",
"InvoiceAmount": "",
"InvoiceDate": "",
"InvoiceDueDate": "",
"InvoiceStatus": "",
"RefNumber": "",
"InvoicePurchaseDate": "",
"InvoiceFundDate": "",
"EscrowReserveAmount": "",
"PaymentMade": "",
"LastPaymentMadeOn": "",
"PaidInFull": "",
"PaidInFullOn": ""
}