/api/p/v{version}/invoices/financing

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint records a financing transaction for a load.

Financing represents funds advanced against an invoice, typically by a factoring provider.

Path Parameters

ParameterTypeRequiredDescription
versionstringYesAPI version (e.g., 1.0)

Request Body

Content-Type: application/json-patch+json

FieldTypeRequiredDescription
LoadNumberstringYesLoad number the financing should be applied to
AmountFundednumberYesAmount funded for the load
FeenumberNoFinancing fee associated with the transaction
DateFundedstring (date-time)YesDate when the financing was issued
ReserveEscrowAmountnumberNoAmount retained in reserve or escrow
ReferenceNumberstringYesExternal reference number used for idempotency and tracking

Example Request

{
  "LoadNumber": "string",
  "AmountFunded": 0,
  "Fee": 0,
  "DateFunded": "2026-03-16T14:15:18.848Z",
  "ReserveEscrowAmount": 0,
  "ReferenceNumber": "string"
}

Response Body

FieldTypeDescription
LoadNumberstringLoad number the financing was applied to
StatusstringCurrent load status after applying the financing
TotalFundedobjectTotal amount funded for the load
TotalFeesobjectTotal financing fees recorded for the load

Money Object

FieldTypeDescription
AmountnumberMonetary amount
CurrencyintegerCurrency identifier

Example Response

{
  "LoadNumber": "string",
  "Status": "string",
  "TotalFunded": {
    "Amount": 0,
    "Currency": 0
  },
  "TotalFees": {
    "Amount": 0,
    "Currency": 0
  }
}

Related Load Fields Updated After Successful Financing

Successful requests may update the related load status to Financed and increase cumulative funded / fee totals used for load payment and factoring workflows.

Notes

  • This endpoint records financing transactions for loads.

  • The request body content type exposed by the API is application/json-patch+json.

  • ReferenceNumber is required and used for idempotency. Repeating the same ReferenceNumber for the same load returns the original financing record instead of creating a duplicate.

  • Successful financing requests may update the related load to financing-related status values such as Financed.

  • Financing can only be recorded when the load is in one of the following statuses:

    • Invoiced
    • Completed
    • Financed
  • Loads in non-payable statuses such as Dispatched are rejected with:

400 Bad Request
Load must be in one of: Invoiced, Completed, Financed.
  • If the LoadNumber does not exist, the endpoint returns:
404 Not Found
  • If AmountFunded is negative or zero, the endpoint returns:
400 Bad Request
AmountFunded must be greater than zero.
  • If Fee is negative, the endpoint returns:
400 Bad Request
Fee must be greater than or equal to zero.
Path Params
string
required
Defaults to 1.0
Body Params
string
required
double
required
double
required
date-time | null
double | null
string
required
Headers
string
enum
Defaults to application/json
Allowed:
string
enum
Defaults to application/json-patch+json
Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json