Folio

Returns one folio.

Get a folio by ID.<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.read'.

get/finance/v0-nsfw/folios/{id}

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/folios/{id}
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: folios.read, folios.manage, admin

Path parameters

idstring required

The ID of the folio.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: folios. All other values will be silently ignored.

Response

Success

idstring required

The id of the folio

createdstring date-time required

Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

updatedstring date-time required

Date of update<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

type'House' | 'Guest' | 'External' | 'Booking'

The folio type

closingDatestring date nullable

The date when the folio has been closed

bookingIdstring nullable

The id of the booking linked to this folio

checkedOutOnAccountsReceivableboolean

Set to true, if the folio has been checked out on accounts receivable. If you create an invoice from this folio, it will display the outstanding payments

isMainFolioboolean

Set to true if this is a main folio for the reservation

isEmptyboolean

Set to true if the folio has no unmoved [transitory] charges, unmoved payments, and allowances.

folioWarningsstring[] nullable

Depending on the state of the folio, certain warnings are shown. This list includes all folio warnings.

allowedActionsstring[] nullable

Depending on the state of the folio, certain actions are allowed or not. This list includes all actions you can perform on this folio.

allowedPaymentnumber double

The maximum payment that can be posted on this folio

maximumAllowancenumber double

The maximum allowance (gross) that can be posted on this folio

status'Open' | 'Closed' | 'ClosedWithInvoice' required

Status of the folio

Example response

{
  "id": "XKCD17-1",
  "created": "0001-01-01T00:00:00Z",
  "updated": "0001-01-01T00:00:00Z",
  "type": "Guest",
  "debitor": {
    "title": "Dr",
    "firstName": "Jon",
    "name": "Doe",
    "address": {
      "addressLine1": "My Street 1",
      "postalCode": "12453",
      "city": "MyCity",
      "countryCode": "GB"
    },
    "company": {
      "type": "GovernmentBuyer",
      "identifiers": [
        {
          "scheme": "PEPPOL:0204",
          "value": "991-12345-37"
        }
      ],
      "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"
  },
  "reservation": {
    "id": "XKCD17",
    "bookingId": "XKCD"
  },
  "property": {
    "id": "MUC"
  },
  "charges": [
    {
      "id": "RND123",
      "serviceType": "Accommodation",
      "name": "Charge",
      "isPosted": true,
      "serviceDate": "2018-05-08",
      "created": "0001-01-01T00:00:00Z",
      "movedFrom": {
        "id": "XKCD23-2"
      },
      "movedTo": {
        "id": "XKCD23-3"
      },
      "amount": {
        "grossAmount": 107,
        "netAmount": 100,
        "vatType": "Reduced",
        "vatPercent": 7,
        "currency": "EUR"
      },
      "quantity": 0,
      "type": "TimeSlice"
    },
    {
      "id": "RND125",
      "serviceType": "Other",
      "name": "The Daily Planet, Newspaper",
      "isPosted": true,
      "serviceDate": "2018-05-07",
      "created": "0001-01-01T00:00:00Z",
      "amount": {
        "grossAmount": 2.14,
        "netAmount": 2,
        "vatType": "Reduced",
        "vatPercent": 7,
        "currency": "EUR"
      },
      "quantity": 0,
      "type": "Direct"
    },
    {
      "id": "REST2018243",
      "serviceType": "Other",
      "name": "Restaurant",
      "isPosted": true,
      "serviceDate": "2018-05-07",
      "created": "0001-01-01T00:00:00Z",
      "amount": {
        "grossAmount": 14.04,
        "netAmount": 12,
        "vatType": "Mixed",
        "vatPercent": -1,
        "currency": "EUR"
      },
      "subAccountId": "MUC-REST",
      "serviceId": "MUC-REST",
      "quantity": 0,
      "type": "Direct",
      "revenueAllocation": [
        {
          "amount": {
            "grossAmount": 11.9,
            "netAmount": 10,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "subAccountId": "MUC-REST",
          "percent": 50
        },
        {
          "amount": {
            "grossAmount": 2.14,
            "netAmount": 2,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "percent": 50
        }
      ]
    }
  ],
  "transitoryCharges": [
    {
      "id": "RND3221-1",
      "name": "Transitory charge",
      "amount": {
        "amount": 20,
        "currency": "EUR"
      },
      "serviceDate": "0001-01-01",
      "created": "0001-01-01T00:00:00Z",
      "quantity": 0
    }
  ],
  "payments": [
    {
      "id": "PAY-1",
      "method": "BankTransfer",
      "amount": {
        "amount": 50,
        "currency": "EUR"
      },
      "receipt": "CA-147-339",
      "paymentDate": "0001-01-01T00:00:00Z",
      "businessDate": "0001-01-01"
    },
    {
      "id": "PAY-2",
      "method": "Cash",
      "amount": {
        "amount": 2.14,
        "currency": "EUR"
      },
      "paymentDate": "0001-01-01T00:00:00Z",
      "businessDate": "0001-01-01"
    }
  ],
  "pendingPayments": [
    {
      "id": "IDDQD-1",
      "amount": {
        "amount": 50,
        "currency": "EUR"
      }
    },
    {
      "id": "IDKFA-2",
      "amount": {
        "amount": 2.14,
        "currency": "EUR"
      }
    }
  ],
  "allowances": [
    {
      "id": "RND3221-1",
      "amount": {
        "grossAmount": 14.04,
        "netAmount": 12,
        "vatType": "Mixed",
        "vatPercent": -1,
        "currency": "EUR"
      },
      "reason": "example",
      "serviceType": "Other",
      "serviceDate": "2018-05-10",
      "created": "0001-01-01T00:00:00Z",
      "movedFrom": {
        "id": "XKCD23-2"
      },
      "movedTo": {
        "id": "XKCD23-3"
      },
      "sourceChargeId": "REST2018243",
      "revenueAllocation": [
        {
          "amount": {
            "grossAmount": 11.9,
            "netAmount": 10,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "subAccountId": "MUC-REST",
          "percent": 50
        },
        {
          "amount": {
            "grossAmount": 2.14,
            "netAmount": 2,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "percent": 50
        }
      ]
    }
  ],
  "balance": {
    "amount": 57,
    "currency": "EUR"
  },
  "checkedOutOnAccountsReceivable": false,
  "isMainFolio": true,
  "isEmpty": false,
  "allowedActions": [
    "AddCharge",
    "AddPayment",
    "Close"
  ],
  "allowedPayment": 45.1,
  "maximumAllowance": 20,
  "status": "Open"
}

Changes

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