APapaleo
PrepaymentNotice

Gets a prepayment notice preview for some specific charges, or deposit items.

<br>You must have this scope: 'prepayment-notices.read'.<br>For fine-grained clients, you must have this permission: 'core.prepayment_notices.preview'.

post/finance/v0-nsfw/prepayment-notices/preview

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/finance/v0-nsfw/prepayment-notices/preview
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: prepayment-notices.read, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

folioIdstring required

The folio id

chargeIdsstring[] required

The ids of the charges to consider

languageCodestring required

The language in which the document should be produced

Response

Success.

string binary required

Changes

No recorded changes to this operation across all 4 revisions of this API.