APapaleo
FolioActions

Adds and directly posts a transitory charge to the folio. If there are any fees configured for the property, an additional charge for each configured fee will be added.

Adds a transitory item for any good or service, and directly posts it. To be used for sales that are not revenue of the property, but should appear on te guest's invoice.

Requires 'allowed action': AddCharge.<br>You must have at least one of these scopes: 'charges.create, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.post_transitory_charge'.

post/finance/v0-nsfw/folio-actions/{folioId}/transitory-charges

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/folio-actions/{folioId}/transitory-charges
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: charges.create, folios.manage, admin

Path parameters

folioIdstring required

The folio ID

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

namestring required

The name, article number, or other description of this item

receiptstring nullable

Receipt for this transaction

groupIdstring nullable

Identifier used for grouping related charges together

serviceType'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CityTax' | 'SecondCityTax' nullable

The service type. This is not used by accounting, but can be entered and stored on the charge.

quantityinteger nullable

The count of services provided. Defaults to 1. NOTE: this field will become required 07.05.2020.

businessDatestring date nullable

The business date of the charge. Defaults to the current date. In some cases you might want to post the charges to the previous business date, this is only possible until 6 AM of the current day.

Example request

{
  "name": "Restaurant",
  "amount": {
    "amount": 23,
    "currency": "EUR"
  },
  "receipt": "R23412"
}

Response

Success.

idstring required

Example response

{
  "id": "XT347518-1-1"
}

Changes

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