/get-sched/

Purpose
Allows a user to requests the details of a certain schedule.
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.
IntegrationBatchID: this key is unique to each schedule in the system.
HTTP Methods
Accepts GET requests.
URI
/api_factor/get-sched/
Return Information (Schedule Body):
Variable Name Type Purpose
ClientKey String The unique identifier for a client in system.
Amount Float The sum of Invoices for the schedule, must be >0
InvoiceArray JSON[] An array of at least one invoice object. The Invoice Object is described in the table below.
Label String Optional space to include a label.
Notes String Optional space to include extra information
PaymentMethod String The method the schedule’s advance should be paid by, either by ACH “A”, Wire “W”, or Check “C”
IntegrationBatchId String The unique Identifier for the schedule.
Return Information (Invoice Objects)
An array of JSON objects with the following parameters:
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-sched/?IntegrationBatchId=EXAMPLE_INTEGRATION_ID
Example Response
{
    "ClientKey": "EXAMPLE_CLIENT",
	"Amount": "0",
	"InvoiceArray":
      [{
         "ClientKey": "",
         "DebtorKey": "",
         "VendorKey": "",
         "InvoiceNumbe": "",
         "InvoiceAmount": "",
         "InvoiceDate": "",
         "InvoiceDueDate": "",
         "InvoiceStatus": "",
         "RefNumber": "",
         "InvoicePurchaseDate": "",
         "InvoiceFundDate": "",
         "EscrowReserveAmount": "",
         "PaymentMade": "",
         "LastPaymentMadeOn": "",
         "PaidInFull": "",
         "PaidInFullOn": "",
         "BrokerInvoice": ""
      },
	  {
         "ClientKey": "",
         "DebtorKey": "",
         "VendorKey": "",
         "InvoiceNumbe": "",
         "InvoiceAmount": "",
         "InvoiceDate": "",
         "InvoiceDueDate": "",
         "InvoiceStatus": "",
         "RefNumber": "",
         "InvoicePurchaseDate": "",
         "InvoiceFundDate": "",
         "EscrowReserveAmount": "",
         "PaymentMade": "",
         "LastPaymentMadeOn": "",
         "PaidInFull": "",
         "PaidInFullOn": "",
         "BrokerInvoice": ""
      }],
	  "Label": "",
	  "Notes": "",
	  "PaymentMethod": "",
	  "IntegrationBatchId": "EXAMPLE_BATCH_ID"
}
Return to Index