Skip to main content
GET
/
api
/
rest
/
carrier_invoices
Get Many Carrier Invoices
curl --request GET \
  --url https://api.upwell.com/api/rest/carrier_invoices
{
  "carrierInvoices": [
    {
      "balance": 123,
      "billId": "<string>",
      "carrierId": "<string>",
      "carrierInvoiceLineItems": [
        {
          "description": "<string>",
          "id": "<string>",
          "item": "<string>",
          "lineNumber": "<string>",
          "quantity": "<unknown>",
          "totalAmount": 123,
          "unitPrice": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "dueDate": "2023-12-25",
      "exceptions": "<string>",
      "id": "<string>",
      "invoiceNumber": "<string>",
      "issueDate": "2023-12-25",
      "loadNumber": "<string>",
      "metadata": "<unknown>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "referenceNumbers": "<unknown>",
      "shipmentId": "<string>",
      "status": "APPROVED",
      "totalAmount": 123,
      "totalTaxAmount": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

limit
integer
default:10
offset
integer
default:0

Response

200 - application/json

Responses for GET /api/rest/carrier_invoices

carrierInvoices
CarrierInvoices Ā· object[]