APapaleo
Invoice

Issues a deposit invoice for a deposit entry.

Changed on

Issues a deposit invoice on the source folio of the given deposit entry. Line items are generic per VAT bracket from the entry allocation and are not tied to specific charges. A replay of the same request returns the existing invoice.<br>You must have at least one of these scopes: 'invoices.create, invoices.manage'.<br>For fine-grained clients, you must have this permission: 'core.invoices.create'.

post/finance/v0-nsfw/invoices/deposit

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/invoices/deposit
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: invoices.create, invoices.manage, 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

depositEntryIdstring required

The ID of the deposit entry to issue a deposit invoice for.

languageCodestring required

The language in which the deposit invoice should be produced.

Example request

{
  "depositEntryId": "DEPE-MUC-ABCDEF-1",
  "languageCode": "en"
}

Response

The deposit invoice already existed and was returned.

idstring required

The invoice id

Example response

{
  "id": "MUC_201705070000012"
}

Changes