Carrier Payment Line Items
Vendors
Invoice Line Items
Carrier Invoices
Carrier Invoice Documents
Addresses
Carriers
Bill Line Items
Customer Payments
Bills
Customer Payment Line Items
Invoice Shipments
Invoices
Customers
Carrier Invoice Approval Requests
Shipments
Shipment Documents
Bill Payments
Webhooks
- HOOKHandle carrier invoice events
- HOOKHandle carrier invoice status approved events
- HOOKHandle carrier invoice status portal exception events
- HOOKHandle carrier invoice shipment creation events
- HOOKHandle carrier invoice shipment update events
- HOOKHandle payments events
- HOOKHandles invoice events
- HOOKHandle invoice status portal exception events
- HOOKHandle invoice status sent events
- HOOKHandles remittance events
- HOOKHandle shipment documents events
Get Many Invoices
Copy
Ask AI
curl --request GET \
--url https://api.upwell.com/api/rest/invoicesCopy
Ask AI
{
"invoices": [
{
"balance": 123,
"companyDivision": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"dueDate": "2023-12-25",
"exceptions": [
{
"details": "<unknown>",
"id": "<string>",
"status": "CLOSED",
"type": "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH"
}
],
"id": "<string>",
"invoiceLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"item": "<string>",
"remoteId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"invoiceShipments": [
{
"shipment": {
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"customerId": "<string>",
"deliveredAt": "<unknown>",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"shipmentId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
],
"issueDate": "2023-12-25",
"metadata": "<unknown>",
"missingDocuments": "<string>",
"number": "<string>",
"portalSlug": "<string>",
"referenceNumbers": "<unknown>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "APPROVED",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"invoicesAggregate": {
"aggregate": {
"avg": {
"balance": 123,
"totalAmount": 123,
"totalTaxAmount": 123
},
"count": 123,
"sum": {
"balance": 123,
"totalAmount": 123,
"totalTaxAmount": 123
}
}
}
}Invoices
Get Many Invoices
Query a list of invoices
GET
/
api
/
rest
/
invoices
Get Many Invoices
Copy
Ask AI
curl --request GET \
--url https://api.upwell.com/api/rest/invoicesCopy
Ask AI
{
"invoices": [
{
"balance": 123,
"companyDivision": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"dueDate": "2023-12-25",
"exceptions": [
{
"details": "<unknown>",
"id": "<string>",
"status": "CLOSED",
"type": "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH"
}
],
"id": "<string>",
"invoiceLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"item": "<string>",
"remoteId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"invoiceShipments": [
{
"shipment": {
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"customerId": "<string>",
"deliveredAt": "<unknown>",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"shipmentId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
],
"issueDate": "2023-12-25",
"metadata": "<unknown>",
"missingDocuments": "<string>",
"number": "<string>",
"portalSlug": "<string>",
"referenceNumbers": "<unknown>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "APPROVED",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"invoicesAggregate": {
"aggregate": {
"avg": {
"balance": 123,
"totalAmount": 123,
"totalTaxAmount": 123
},
"count": 123,
"sum": {
"balance": 123,
"totalAmount": 123,
"totalTaxAmount": 123
}
}
}
}Headers
Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Response
200 - application/json
Responses for GET /api/rest/invoices
Show child attributes
Show child attributes
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A date string, such as 2024-02-03 (YYYY-MM-DD)
Show child attributes
Show child attributes
Available options:
CLOSED, IN_PROGRESS, OPEN, RESOLVED Available options:
CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH, CARRIER_INVOICE_HAS_LUMPER_LINE_ITEM_AND_NO_LUMPER_RECEIPT, CARRIER_INVOICE_MISSING, CARRIER_INVOICE_MISSING_ISSUE_DATE, CARRIER_INVOICE_MISSING_POD, CARRIER_INVOICE_MISSING_POD_FOR_EACH_DELIVERY_STOP, CARRIER_INVOICE_TOTAL_AMOUNT_BILL_TOTAL_AMOUNT_MISMATCH, CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH, CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH_BILL_OR_SHIPMENT, CARRIER_INVOICE_TOTAL_AMOUNT_SHIPMENT_CARRIER_TOTAL_RATE_MISMATCH, CARRIER_NAME_MISMATCH, CARRIER_NAME_MISMATCH_BILL_OR_SHIPMENT, CARRIER_NAME_MISMATCH_WITH_ASSIGNED_CARRIER, CARRIER_NAME_MISMATCH_WITH_BILL, CARRIER_NAME_MISMATCH_WITH_SHIPMENT, DAMAGE_OR_SHORTAGE, DOCUMENT_CONTENT_VALIDATION_EXCEPTION, DOCUMENT_LOAD_NUMBER_MISMATCH, INVOICE_AMOUNT_MISMATCH, LOCATION_RULE_VIOLATION_EXCEPTION, MATCHING_INVOICE_NOT_FOUND, MULTIPLE_MATCHING_INVOICES_FOUND, MULTI_DOCUMENT_SET_INCOMPLETE_EXCEPTION, NO_ASSIGNED_CARRIER, NO_CARRIER_NAME, NO_MATCHING_SHIPMENT, OVERPAYMENT, REFERENCE_NUMBER_MISMATCH_EXCEPTION, REFERENCE_NUMBER_MISSING_EXCEPTION, REMITTANCE_LINE_ITEMS_EXCEPTION, REMIT_TO_MISMATCH, SHIPPER_INVOICE_DOCUMENT_RULES_EXCEPTION, SHIPPER_RULE_AI_REVIEW_REQUIRED, SIGNATURE_VALIDATION_EXCEPTION, STAMP_VALIDATION_EXCEPTION, UNDERPAYMENT Show child attributes
Show child attributes
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Show child attributes
Show child attributes
columns and relationships of "shipments"
Show child attributes
Show child attributes
columns and relationships of "addresses"
Show child attributes
Show child attributes
Available options:
AD, AE, AF, AG, AL, AM, AO, AR, AT, AU, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FM, FR, GA, GB, GD, GE, GH, GM, GN, GQ, GR, GT, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MR, MT, MU, MV, MW, MX, MY, MZ, NA, NE, NG, NI, NL, NO, NP, NR, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PS, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TD, TG, TH, TJ, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VN, VU, WS, YE, ZA, ZM, ZW A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Available options:
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 columns and relationships of "addresses"
Show child attributes
Show child attributes
Available options:
AD, AE, AF, AG, AL, AM, AO, AR, AT, AU, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FM, FR, GA, GB, GD, GE, GH, GM, GN, GQ, GR, GT, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MR, MT, MU, MV, MW, MX, MY, MZ, NA, NE, NG, NI, NL, NO, NP, NR, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PS, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TD, TG, TH, TJ, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VN, VU, WS, YE, ZA, ZM, ZW Show child attributes
Show child attributes
columns and relationships of "addresses"
Show child attributes
Show child attributes
Available options:
AD, AE, AF, AG, AL, AM, AO, AR, AT, AU, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FM, FR, GA, GB, GD, GE, GH, GM, GN, GQ, GR, GT, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MR, MT, MU, MV, MW, MX, MY, MZ, NA, NE, NG, NI, NL, NO, NP, NR, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PS, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TD, TG, TH, TJ, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VN, VU, WS, YE, ZA, ZM, ZW A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A date string, such as 2024-02-03 (YYYY-MM-DD)
Available options:
APPROVED, CANCELLED, CREATED, DELIVERED, DISPUTED, OPEN, OVERDUE, PAID, PART_PAID, PORTAL_EXCEPTION, PORTAL_RESOLVED, PROCESSING, REFUNDED, SEND_ERROR, SENT, VIEWED, WRITE_OFF A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
aggregated selection of "invoices"
Show child attributes
Show child attributes
aggregate fields of "invoices"
Show child attributes
Show child attributes
āI