curl --request POST \
--url https://api.upwell.com/api/rest/invoices \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"approvedToSend": true,
"balance": 123,
"billOfLadingNumber": "<string>",
"carrierProNumber": "<string>",
"cassBarcodeMapping": {},
"checkOrAchNumber": "<string>",
"companyDivision": "<string>",
"createdFromEmailMessageId": "<string>",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"debitsUpdatedAt": "<unknown>",
"deliveryDate": "2023-12-25",
"documentExceptions": "<unknown>",
"dueDate": "2023-12-25",
"ediDocuments": {},
"exceptions": {},
"externallyManaged": true,
"fileAssociations": {},
"fileAssociationsUpdatedAt": "<unknown>",
"invoiceLineItems": {},
"issueDate": "2023-12-25",
"lastUpdatedByEmailMessageId": "<string>",
"latestCassStatus": {},
"lineItemsLastUpdatedAt": "2023-11-07T05:31:56Z",
"metadata": "<unknown>",
"number": "<string>",
"paidDate": "2023-11-07T05:31:56Z",
"paymentLineItems": {},
"portalException": "<string>",
"portalSlug": "<string>",
"receivedAt": "<unknown>",
"receivedFromPortalSlug": "<string>",
"referenceNumbers": "<unknown>",
"scheduledPaymentDate": "2023-12-25",
"sentAt": "<unknown>",
"sentToPortalSlug": "<string>",
"shipDate": "2023-12-25",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "created",
"totalAmount": 123,
"totalTaxAmount": 123
}
}
'{
"createInvoice": {
"balance": 123,
"companyDivision": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"dueDate": "2023-12-25",
"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"
}
}Create a new invoice
curl --request POST \
--url https://api.upwell.com/api/rest/invoices \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"approvedToSend": true,
"balance": 123,
"billOfLadingNumber": "<string>",
"carrierProNumber": "<string>",
"cassBarcodeMapping": {},
"checkOrAchNumber": "<string>",
"companyDivision": "<string>",
"createdFromEmailMessageId": "<string>",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"debitsUpdatedAt": "<unknown>",
"deliveryDate": "2023-12-25",
"documentExceptions": "<unknown>",
"dueDate": "2023-12-25",
"ediDocuments": {},
"exceptions": {},
"externallyManaged": true,
"fileAssociations": {},
"fileAssociationsUpdatedAt": "<unknown>",
"invoiceLineItems": {},
"issueDate": "2023-12-25",
"lastUpdatedByEmailMessageId": "<string>",
"latestCassStatus": {},
"lineItemsLastUpdatedAt": "2023-11-07T05:31:56Z",
"metadata": "<unknown>",
"number": "<string>",
"paidDate": "2023-11-07T05:31:56Z",
"paymentLineItems": {},
"portalException": "<string>",
"portalSlug": "<string>",
"receivedAt": "<unknown>",
"receivedFromPortalSlug": "<string>",
"referenceNumbers": "<unknown>",
"scheduledPaymentDate": "2023-12-25",
"sentAt": "<unknown>",
"sentToPortalSlug": "<string>",
"shipDate": "2023-12-25",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "created",
"totalAmount": 123,
"totalTaxAmount": 123
}
}
'{
"createInvoice": {
"balance": 123,
"companyDivision": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"customerReferenceNumber": "<string>",
"dueDate": "2023-12-25",
"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"
}
}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 "invoices"
Show child attributes
The balance of the invoice. This should be in cents. For example, $100.00 should be represented as 10000.
CassBarcodeMappingArrRelInsertInput (simplified)
A date string, such as 2024-02-03 (YYYY-MM-DD)
A date string, such as 2024-02-03 (YYYY-MM-DD)
EdiEdiDocumentsArrRelInsertInput (simplified)
ExceptionsArrRelInsertInput (simplified)
FileAssociationsArrRelInsertInput (simplified)
InvoiceLineItemsArrRelInsertInput (simplified)
A date string, such as 2024-02-03 (YYYY-MM-DD)
CassLatestInvoiceStatusObjRelInsertInput (simplified)
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
PaymentLineItemsArrRelInsertInput (simplified)
A date string, such as 2024-02-03 (YYYY-MM-DD)
A date string, such as 2024-02-03 (YYYY-MM-DD)
created, open, sent, viewed, paid, part-paid, disputed, overdue, cancelled, write-off, refunded, send-error 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.
Responses for POST /api/rest/invoices
columns and relationships of "invoices"
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
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
columns and relationships of "shipments"
Show child attributes
columns and relationships of "addresses"
Show child attributes
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
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
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
columns and relationships of "addresses"
Show child attributes
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)
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