Preview Billing Information

1 min

POST

https://api.nue.io/orders/invoices:preview

Generate the preview invoices in memory for a list of order products of a given customer. The generated invoices will be included in the response payload. There are 2 preview modes: First Invoice Only, Invoices with a Target Date. When choose first invoice only option, only the first invoice will be previewed. The system will use Today's date or the next billing date, which comes later as the invoice target date to generate a preview of the first invoice. To choose this option, set the firstInvoiceOnly parameter to true. When choose invoice with a target date option, the system will default the invoice target date as the Start Date of the quote or the order. To choose this option. set the firstInvoiceOnly parameter to false and set the targetDate parameter to the desired target date.

acceptstringGenerated from available response content types

bodyobjectInvoice preview request

200Successfully generated preview invoices

400Bad Request

404Not Found

curl --request POST \
     --url https://api.nue.io/orders/invoices:preview \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customerId": "",
     "orders": [
     {
     "id": ""
     }
     ],
     "orderProducts": [
     {
     "id": "",
     "priceModel": "",
     "startDate": "",
     "totalPrice": "",
     "tax": "",
     "quantity": "",
     "productId": "",
     "productName": "",
     "lineType": "",
     "netSalesPrice": "",
     "productSku": ""
     }
     ]
     }'