APapaleo
Invoice

Gets a preview invoice PDF for one specific folio.

Gets a preview invoice PDF for one specific folio.<br>You must have this scope: 'invoices.read'.<br>For fine-grained clients, you must have this permission: 'core.invoices.read'.

get/finance/v0-nsfw/invoices/preview-pdf

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/preview-pdf
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: invoices.read, admin

Query parameters

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

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

languageCodestring required

The language in which the invoice should be produced.

folioIdstring required

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

Response

Success.

string binary required

Changes

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