curl --request GET \
--url https://api.upwell.com/api/rest/carrier_invoices/{id}{
"carrierInvoice": {
"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"
}
}Get a carrier invoice by ID
curl --request GET \
--url https://api.upwell.com/api/rest/carrier_invoices/{id}{
"carrierInvoice": {
"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"
}
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
"id" is required (enter it either in parameters or request body)
Responses for GET /api/rest/carrier_invoices/{id}
Invoices (payables) received from carriers (e.g. via email)
Show child attributes
Show child attributes
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
AED, AUD, BRL, CAD, CHF, CNY, EGP, EUR, GBP, HKD, IDR, INR, JPY, KRW, MXN, MYR, NZD, QAR, SAR, SGD, THB, TRY, TWD, USD, VND, ZAR A date string, such as 2024-02-03 (YYYY-MM-DD)
A date string, such as 2024-02-03 (YYYY-MM-DD)
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
APPROVED, AWAITING_BILL, AWAITING_CARRIER_RESPONSE, AWAITING_INVOICE, CANCELLED, CARRIER_EXCEPTION, CARRIER_RESPONDED, DISPUTED, EXCEPTION, PAID, PART_PAID, PROCESSING, RECEIVED, REFUNDED, REJECTED, UNDER_REVIEW A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00