APapaleo
FolioActions

Adds and directly posts a 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 charge for any good or service, and directly posts it. Can be used to charge items that are not part of the reservation, but should appear on the 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_charge'.

post/finance/v1/folio-actions/{folioId}/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/v1/folio-actions/{folioId}/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

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

The service type, used by accounting to determine the correct revenue account

vatType'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed' required

The VAT type, used by accounting to determine the correct vat amount and account

subAccountIdstring nullable

ID of the custom sub-account to post the charge to, used by accounting to determine the correct revenue account

namestring required

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

receiptstring nullable

Receipt for this transaction

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

{
  "serviceType": "FoodAndBeverages",
  "vatType": "Normal",
  "subAccountId": "MUC-BEER",
  "name": "Restaurant",
  "amount": {
    "amount": 23,
    "currency": "EUR"
  },
  "receipt": "R23412"
}

Response

Success.

idstring required

The id of the added charge

feeChargeIdsstring[] nullable

The fee charges ids

Example response

{
  "id": "XT347518-1-1",
  "feeChargeIds": [
    "XT347518-1-SERVICE-1"
  ]
}

Changes

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