APapaleo
Invoice

Creates an invoice for one specific folio.

Creates an invoice for one specific folio. The invoice can only be created once. The debitor needs to have name, city, postal code and country code, as these are required for invoices. If the folio is not fully paid, this will check out the reservation on AR and create an invoice with outstanding payments.<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

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

lineItemGrouping'NoGrouping' | 'ByCharge' | 'ByRatePlanDetailed' | 'ByRatePlanSimplified' | 'ByReceipt' nullable

The line item grouping type to be applied to the invoice being created.

folioIdstring required

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

languageCodestring required

The language in which the invoice should be produced.

Example request

{
  "lineItemGrouping": "NoGrouping",
  "folioId": "HBCXQZ-1",
  "languageCode": "en"
}

Response

The 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.