Filter Invoices

API Reference for Filtering

MyCarrier's POST/api/v1/Integrations/Invoices/Filterendpoint allows you to filter invoices by the following parameters:

• Statuses
• Tags
• quoteReferenceIds (NOTE: The quoteReferenceId field for the Invoice API is distinct from the one used in the Order API)
• isArchived
• Pagination
• invoiceDateTime

Not all of these are required, and unused fields can be commented out using "//" at the start of the line. The response will show you all the invoices returned through this endpoint and their information. The Invoice Filter endpoint also returns the recordID for each invoice, which is required in the other endpoints to manipulate invoice data.

Sample Request

{
  "statuses": [
    "Open"
  ],
 // "tags": [
//    ""
 // ],
//  "quoteReferenceIds": [
 //   "string"
//  ],
 // "pagination": {
 //   "skip": 0,
 //   "take": 1
//  },
  "invoiceDateTime": {
    "from": "2024-08-01T14:15:22Z",
    "to": "2025-01-10T14:15:22Z"
  }
}