Changing Statuses

API Reference for Changing Statuses

What is an Invoice Status

The status of an invoice signifies which stage of the freight auditing process the invoice is in, and allows your organization to keep track of any actions that need to be taken.

The following are the possible Invoice statuses available through the API

Status NameDescription
OpenInvoices in your account where no action has been taken
ApprovedInvoices that have been approved for payment
PaidInvoices that have been paid
ArchivedInvoices that have been moved to the “Archived” section are removed from the main invoice table.

Sample Request

The status you wish to apply to the invoice will be entered as a path parameter. For example, if you wanted to change an invoice to "Paid", you'd use the PATCH/api/v2/integrations/invoices/Status/{status} endpoint and enter "Paid" inside the brackets. It would appear as such along with the associated request body:

PATCH/api/v2/integrations/invoices/Status/{Paid}

{
  "recordId": "d3cc524a-a500-474d-af5a-7538835d77ba",
  "updatedBy": "string"
}

What’s Next