APapaleo
Folio

Create additional folios for a reservation, or new external folios

Use this call to create a new folio.<br>You must have at least one of these scopes: 'reservations.create, reservations.manage, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.create'.

post/finance/v1/folios

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/folios
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: reservations.create, reservations.manage, folios.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

reservationIdstring nullable

The ID of the reservation for which a guest folio should be created

companyIdstring nullable

The ID of the company for which a folio should be created

type'Guest' | 'External' nullable

The type of the folio to create. Default is the guest folio. This field will become required 01.11.2019.

propertyIdstring nullable

The ID of the property for which an external folio should be created.

codestring nullable

Optional code for external folios. If present, the id of the folio will be propertyId-code (MUC-SOMETHING); If no code is provided, the id of the folio will be propertyId-ext-number (MUC-EXT-282).

Example request

{
  "reservationId": "TS23XF",
  "debitor": {
    "title": "Dr",
    "firstName": "Jon",
    "name": "Doe",
    "address": {
      "addressLine1": "My Street 1",
      "postalCode": "12453",
      "city": "MyCity",
      "countryCode": "GB"
    },
    "company": {
      "name": "Horns & Hooves Inc",
      "taxId": "TAX-12345",
      "additionalTaxId": "TAX2-12345",
      "additionalTaxId2": "TAX3-12345",
      "invoiceNetworkIdentity": {
        "network": "Peppol",
        "id": "0208:123456789"
      }
    },
    "personalTaxId": "123456789",
    "reference": "SRC-1232",
    "phone": "123456789"
  },
  "type": "Guest"
}

Response

Success

idstring required

The folio id

Example response

{
  "id": "XKCD-17"
}

Changes

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