On This Page
Example: Drafting a Deliverable Invoice
Request
{ "customerInformation": { "name": "Tanya Lee", "email": "tanya.lee@my-email.world" }, "invoiceInformation": { "dueDate": "2019-07-11", "sendImmediately": false, "deliveryMode": "email" }, "orderInformation": { "amountDetails": { "totalAmount": "247.86", "currency": "USD" }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "quantity": "20", "unitPrice": "12.05", "totalAmount": "247.86" } ] } }
Response to a Successful Request
{ "_links": { "self": { "href": "/v2/invoices/2669", "method": "GET" }, "update": { "href": "/v2/invoices/2669", "method": "PUT" }, "deliver": { "href": "/v2/invoices/2669/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/2669/cancelation", "method": "POST" } }, "id": "2669", "submitTimeUtc": "2024-07-24T18:24:36.153361386Z", "status": "DRAFT", "customerInformation": { "name": "Tanya Lee", "email": "tanya.lee@my-email.world" }, "processingInformation": { "requestPhone": false, "requestShipping": false }, "invoiceInformation": { "invoiceNumber": "2669", "dueDate": "2019-07-11", "allowPartialPayments": false, "deliveryMode": "Email" }, "orderInformation": { "amountDetails": { "totalAmount": 247.86, "currency": "USD", "balanceAmount": 247.86 }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 12.05, "quantity": 20, "totalAmount": 247.86 } ] } }
Request
{ "customerInformation": { "name": "Tanya Lee", "email": "tanya.lee@my-email.world" }, "invoiceInformation": { "dueDate": "2019-07-11", "sendImmediately": false, "deliveryMode": "email" }, "orderInformation": { "amountDetails": { "totalAmount": 293.5, "currency": "USD" }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 12.05, "quantity": 20, "totalAmount": 241 }, { "productSku": "P653727383", "productName": "Second line item's name", "unitPrice": 5.25, "quantity": 10, "totalAmount": 52.5 } ] } }
Response to a Successful Request
{ "_links": { "self": { "href": "/v2/invoices/98765", "method": "GET" }, "update": { "href": "/v2/invoices/98765", "method": "PUT" }, "deliver": { "href": "/v2/invoices/98765/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/98765/cancelation", "method": "POST" } }, "id": "98765", "submitTimeUtc": "2024-08-02T22:18:24.341304588Z", "status": "DRAFT", "customerInformation": { "name": "Tanya Lee", "email": "tanya.lee@my-email.world" }, "processingInformation": { "requestPhone": false, "requestShipping": false }, "invoiceInformation": { "invoiceNumber": "98765", "dueDate": "2019-07-11", "allowPartialPayments": false, "deliveryMode": "Email" }, "orderInformation": { "amountDetails": { "totalAmount": 293.5, "currency": "USD", "balanceAmount": 293.5 }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 12.05, "quantity": 20, "totalAmount": 241 }, { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 5.25, "quantity": 10, "totalAmount": 52.5 } ] } }