latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Sales

Preview ConsolidatedInvoice

Permissions needed: NONE

This end point is used to preview the consolidated invoice for selected sales, if no sale is selected all customer sales eligible for consolidation are used - create flow.<br> If ID of a already consoliated sale is provided (in body an in path also!!!)then preview of existing consolidated invoice is returned - update flow.<br> property <i>notConsolidatedSalesDetails</i> from response Contains details for all customer sales eligibe for consolidation process.<br> property <i>selectedSalesDetails</i> from response Contains details of selected sales for consolidation process. null - if the request is made with empty <i>sales_ids</i> parameter<br>

post/api/v1/sale/consolidate/preview/{consolidatingSale}

Path parameters

consolidatingSaleinteger required

The consolidating sale id

Request body

customer_idinteger required
consolidating_sale_idinteger

Required for a existing consolidated invoice preview - on update flow

invoice_datestring required
sales_idsinteger[]

Response

successful operation

consolidatingSaleIdinteger

Consolidating sale id for existing consolidated invoice preview - on update flow

invoicePreviewstring

HTML string of invoice