POST /apiv2/carrierInvoices/attemptAutoReconciliation

Attempt to auto reconcile consignments based on the thresholds defined in the carrier account associated with the consignment. Note that a successful response from this function will not indicate whether the consignments did or did not auto-reconcile - you will need to establish that from the consignments and their notes instead.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
consignmentIds[] Array No
reason String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.