COconvoy
accounting

Return all credit memos associated to the batch debit

Returns all credit memos associated to a batch debit specified by the id. The number of credit memos can be large (e.g. 10k credit memos), so you must paginate.

get/batchDebits/{id}/creditMemos

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Path parameters

idstring required

Batch debit Id (UUID).

Query parameters

cursorstring

Cursor of the pagination to return items after a specific point. If omitted, it returns from the beginning.

limitinteger

Maximum number of items to return. Defaults to 100 if not provided.

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Response

The request has been accepted for processing, but processing has not yet completed.

cursorstring

Example response

{
  "invoices": [
    {
      "broker": {
        "externalId": "ABC123456",
        "mcNumber": "MC1917364",
        "dotNumber": "DOT26423672"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.