REST Order DocumentAccountingSummary

List document accounting summaries.

List document accounting summaries

Lists document accounting summaries. A document accounting summary is saved along with each reversal document (for invoice and credit note). It contains accounting information about the order for this point in time. The summary is saved because an order can be updated after a reversal_document is generated. The information about the order before the update is needed for accounting.

/rest/orders/documents/accounting_summary

Parameters

Field Type Description
orderId Int The ID of the order.
documentType String The document type.
createdAtFrom String Get entries with createdAt date after this date.
createdAtTo String Get entries with createdAt date before this date.
page Int The page to get. The default page that will be returned is page 1.
itemsPerPage Int The number of summaries to be displayed per page. The default number of orders per page is 10.

Success 200

{"orderId":13487,"methodOfPaymentId":8,"parentDocument":{"type":"invoice","number":"RE17002140"},"document":{"type":"reversal_document","number":"ST170000142","date":"2017-07-24 00:00:00"},"contact":{"contactId":29242,"bookAccount":"","billingAddressId":39927,"company":"","firstName":"Max","lastName":"Mustermann","billingCountryISO":"DE","deliveryCountryISO":"DE","VATNumber":"","deliveryAddressId":29710,"hasEntryCertificat":false},"amounts":{"paidAmount":0,"invoiceTotal":299,"totalNet":251.26,"totalVat":47.74,"vat":[{"countryVatId":1,"vatField":0,"vatAmount":47.74,"netAmount":251.26,"grossAmount":299}]},"items":[{"orderItemId":18698,"itemId":42271,"variationId":79079,"quantity":1,"typeId":1,"priceGross":299,"priceNet":251.26,"countryVatId":1,"vatField":0,"vatAmount":47.74}]}

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!