APapaleo
FeatureSettings

Get feature settings for a property.

Get feature settings for a property.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.

get/settings/v1/features/{propertyId}

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/settings/v1/features/{propertyId}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Path parameters

propertyIdstring required

The ID of the property.

Response

Returns feature settings.

areCustomRevenueSubAccountsEnabledboolean required

Are custom sub-accounts for revenue enabled.

performAccountingForOpenInvoiceActionsboolean required

Whether marking an AR invoice as written off/paid leads to accounting or not.

showRecipientForEachLineItemOnTheInvoiceboolean required

Whether to display the main guest's name for each charge on the invoice if the invoice contains charges from several reservations.

maxAmountForMinimalInvoicesnumber double nullable

If the amount for the invoice is lower than this value, allow creating invoices with the name only.

invoiceNumberPatternstring required

Pattern to generate the invoice number. Consists of three parts: custom prefix (optional), date template (optional), and number template (required). use '0' for numbers; 'd' or 'dd' for days; 'M' or 'MM' for months; 'yy' or 'yyyy' for years. To set a custom prefix, enclose it in quotation marks ("). Allowed symbols in the prefix: digits, uppercase letters, .,_,-. Example: pattern "MUC-"yyyy0000 will produce invoice numbers like MUC-20190001.

advanceInvoiceNumberPatternstring required

Pattern to generate the advance invoice number. Consists of three parts: custom prefix (optional), date template (optional), and number template (required). use '0' for numbers; 'd' or 'dd' for days; 'M' or 'MM' for months; 'yy' or 'yyyy' for years. To set a custom prefix, enclose it in quotation marks ("). Allowed symbols in the prefix: digits, uppercase letters, .,_,-. Example: pattern "MUC-"yyyy0000 will produce invoice numbers like MUC-20190001.

Example response

{
  "areCustomRevenueSubAccountsEnabled": true,
  "performAccountingForOpenInvoiceActions": true,
  "showRecipientForEachLineItemOnTheInvoice": true,
  "maxAmountForMinimalInvoices": 100.5,
  "invoiceNumberPattern": "yyMM00000",
  "advanceInvoiceNumberPattern": "\"A-\"yyMM00000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.