APapaleo
Invoice

Creates an advance invoice for one specific folio.

Creates an advance invoice for one specific folio.<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/advance

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/advance
  • 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

folioIdstring required

The ID of the folio for which the advance invoice should be created.

languageCodestring required

The language in which the advance invoice should be produced.

chargeIdsstring[] required

The filter for charges

paymentIdsstring[] required

The filter for payments

Example request

{
  "folioId": "HBCXQZ-1",
  "languageCode": "en",
  "chargeIds": [
    "HBCXQZ-1-C-1"
  ],
  "paymentIds": [
    "HBCXQZ-1-C-1"
  ]
}

Response

The advance invoice was created successfully.

idstring required

The invoice id

Example response

{
  "id": "MUC_201705070000012"
}

Changes

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