GetPurchasesForInvoice

Under development; not stable and subject to change without notice.

Overview

Retrieves all Purchases on an invoice.

Returns

Returns a InvoicePurchases object, which contains a paginated list of Purchases and the invoice RevisionToken.

The RevisionToken is unique per calculated invoice. The RevisionToken is null if the invoice has not been calculated, or when invoice calculation has not yet finished. The RevisionToken will be null during invoice calculation. The RevisionToken may change between requests for different pages, in which case the set of purchases may have changed as well.

The set of purchases retrieved from this endpoint is only guaranteed to be complete for a specific revision, if all page responses bear the same non-null RevisionToken of said revision. If the RevisionToken changes between pages, it may be necessary to restart retrieval from page 1.

---

Request

Name	Type	Description
invoiceId	String	The identifier of the invoice.
page	Int32?	Page to return (starting at 1).

Response

Name	Type	Description
ResultMessage	String	Additional information when operation failed.
ResultCode	ResultCodeEnum	Whether the operation completed successfully.
Result	InvoicePurchases	Operation result.