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
Responses for POST /api/rest/invoices
columns and relationships of "invoices"
Show child attributes