Invoices

Get invoice payments

get/api/v1/invoices/payments

Request

  • Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /sandbox/api/v1/invoices/payments
  • Auth: OAuth 2 (authorization code, authorization URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token; client credentials, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token, scopes: policy.read)

Query parameters

invoiceIdstring

e.g. invoice_c0645dc026a74ae99ec436df63d77d2c

The ID of the invoice for which payments are being retrieved

pageIndexinteger

The index of the page to retrieve

pageSizeinteger

The number of items per page

Response

OK

successboolean
reasonstring nullable
resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.