curl --request POST \
--url https://api.upwell.com/api/rest/carrier_invoices \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"additionalReferenceNumbers": "<unknown>",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedBy": {},
"assignedById": "<string>",
"assignedTo": {},
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddress": {},
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"currency": "AED",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"emailMessageAssociations": {},
"factor": {},
"factorAddress": {},
"factorAddressId": "<string>",
"factorId": "<string>",
"fileAssociations": {},
"id": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"mergedFrom": {},
"mergedIntoCarrierInvoiceId": "<string>",
"mergedTo": {},
"metadata": "<unknown>",
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "APPROVED",
"tenantId": "<string>",
"tmsDocumentsUploadStatus": "FAILURE",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
'{
"createCarrierInvoice": {
"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"
}
}Create a new carrier invoice
curl --request POST \
--url https://api.upwell.com/api/rest/carrier_invoices \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"additionalReferenceNumbers": "<unknown>",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedBy": {},
"assignedById": "<string>",
"assignedTo": {},
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddress": {},
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"currency": "AED",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"emailMessageAssociations": {},
"factor": {},
"factorAddress": {},
"factorAddressId": "<string>",
"factorId": "<string>",
"fileAssociations": {},
"id": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"mergedFrom": {},
"mergedIntoCarrierInvoiceId": "<string>",
"mergedTo": {},
"metadata": "<unknown>",
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "APPROVED",
"tenantId": "<string>",
"tmsDocumentsUploadStatus": "FAILURE",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
'{
"createCarrierInvoice": {
"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
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "carrier_invoices"
Show child attributes
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
UsersObjRelInsertInput (simplified)
UsersObjRelInsertInput (simplified)
The balance of the invoice. This should be in cents. For example, $100.00 should be represented as 10000.
AddressesObjRelInsertInput (simplified)
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)
EmailMessageAssociationsArrRelInsertInput (simplified)
FactorsObjRelInsertInput (simplified)
AddressesObjRelInsertInput (simplified)
FileAssociationsArrRelInsertInput (simplified)
A date string, such as 2024-02-03 (YYYY-MM-DD)
CarrierInvoicesArrRelInsertInput (simplified)
CarrierInvoicesObjRelInsertInput (simplified)
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 FAILURE, INITIATED, PARTIAL_SUCCESS, SUCCESS The total amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000.
The total tax amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000.
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Responses for POST /api/rest/carrier_invoices
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