--- title: "Returns one folio." method: GET path: "/finance/v1/folios/{id}" tags: ["Folio"] --- # Returns one folio. `GET /finance/v1/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/v1/folios/{id}` - Auth: OAuth 2 - Implicit: `https://identity.apaleo.com/connect/authorize` - Scopes: `folios.read`, `folios.manage`, `admin` Get a folio by ID.
You must have at least one of these scopes: 'folios.read, folios.manage'.
For fine-grained clients, you must have this permission: 'core.folios.read'. ## Path parameters - `id` string, required ## Query parameters - `expand` string[] ## Response `200` Success - FolioModel - `id` string, required: The id of the folio - `created` string, date-time, required: Date of creation
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `updated` string, date-time, required: Date of update
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `type` 'House' | 'Guest' | 'External' | 'Booking': The folio type - `debitor` FolioDebitorModel - `type` 'Booker' | 'PrimaryGuest' | 'Company' | 'AdditionalGuest' | 'Property', nullable: Whether the debitor is the booker, the primary guest, an additional guest, or the company. When the folio has a company, the only possible value is 'Company'. 'Property' is a reserved type for the house folio. - `title` 'Mr' | 'Ms' | 'Dr' | 'Prof' | 'Mrs' | 'Other', nullable: Title - `firstName` string, nullable: First name - `name` string, nullable: Last name - `address` NonStrictAddressModel - `addressLine1` string, nullable - `addressLine2` string, nullable - `postalCode` string, nullable - `city` string, nullable - `regionCode` string, nullable - `countryCode` string, nullable - `company` CompanyInfoModel - `name` string, required: Name of the company - `taxId` string, nullable: Tax or Vat ID of the company - `additionalTaxId` string, nullable: The additional tax ID of the company (e.g. SIRET in France, Codice Destinatario in Italy, SST in Malaysia) - `additionalTaxId2` string, nullable: The additional tax ID of the company (e.g. Codice Fiscale in Italy, BRN in Malaysia) - `invoiceNetworkIdentity` InvoiceNetworkIdentityModel - `network` 'Peppol', required: The Network through which to send the Invoice e. g. Peppol - `id` string, required: The Id of the company at the network. e.g. "0208:123456789" - `personalTaxId` string, nullable: Debitor's Tax Id if debitor is a person - `reference` string, nullable: Any additional information about the debitor that should be present on the invoice - `email` string, nullable: Debitor's email - `phone` string, nullable: Debitor's phone - `closingDate` string, date, nullable: The date when the folio has been closed - `reservation` EmbeddedReservationModel - `id` string, required: Reservation id - `bookingId` string, required: Booking id - `bookingId` string, nullable: The id of the booking linked to this folio - `company` EmbeddedCompanyModel - `id` string, required: The company ID - `code` string, nullable: The code of the company - `name` string, nullable: The name of the company - `canCheckOutOnAr` boolean, nullable: Whether or not the company can check out on AR - `property` EmbeddedPropertyModel, required - `id` string, required: The property id - `code` string, nullable: The code for the property that can be shown in reports and table views - `name` string, nullable: The name for the property - `description` string, nullable: The description for the property - `charges` ChargeModel[], nullable: The list of charges - `id` string, required: ID for charges. This is unique within one folio. - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', required: The type of the service or good - `name` string, required: The name, article number, or other description of this charge - `translatedNames` object, nullable: The name, article number, or other description of this charge translated in different languages - `isPosted` boolean, required: Status: is this already posted? - `serviceDate` string, date, required: The day when the line item is (or was) due to be charged. - `created` string, date-time, required: Date of creation
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `movedFrom` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedTo` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedReason` string, nullable: A reason why move operation was performed - `routedFrom` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `routedTo` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `amount` AmountModel, required - `grossAmount` number, double, required - `netAmount` number, double, required - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required - `vatPercent` number, double, required - `currency` string, required - `receipt` string, nullable: Receipt for this transaction - `groupId` string, nullable: Identifier used for grouping related charges together - `subAccountId` string, nullable: ID of the custom sub-account the charge has been posted to - `quantity` integer, required: The count of services provided - `type` 'Direct' | 'TimeSlice' | 'IncludedService' | 'ExtraService' | 'CityTax' | 'NoShowFee' | 'CancellationFee' | 'ServiceFee' | 'Tax' | 'SecondCityTax' | 'GuestLevy', required: The type of the charge - `transitoryCharges` TransitoryChargeModel[], nullable: The list of charges - `id` string, required: ID for transitory charge. This is unique within one folio. - `name` string, required: The name, article number, or other description of this item - `amount` MonetaryValueModel, required - `amount` number, double, required - `currency` string, required - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', nullable: The service type of this transitory charge. As revenue and VAT of transitory charges are not recorded for the hotel, this is just FYI. - `serviceDate` string, date, required: The date when this charge was added. - `created` string, date-time, required: Date of creation
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `receipt` string, nullable: Receipt for this transaction - `movedFrom` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedTo` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedReason` string, nullable: A reason why move operation was performed - `quantity` integer, required: The count of services provided - `payments` PaymentModel[], nullable: The list of payments - DEPRECATED: This field will be removed on July 3rd 2020. Use GET /finance/v1/folios/{folioId}/payments or GET /finance/v1/folios/{folioId}/refunds instead. - `id` string, required: Id of the payment. This is unique within one folio. - `method` 'Cash' | 'BankTransfer' | 'CreditCard' | 'Invoice' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'PspCash' | 'PspDebit' | 'PspBanking' | 'PspOpenInvoice' | 'PspWallet' | 'Representation' | 'IDeal', required: The Payment Method. - `amount` MonetaryValueModel, required - `amount` number, double, required - `currency` string, required - `externalReference` ExternalReference - `merchantReference` string, required: The merchant reference ('order number') - `pspReference` string, required: The globally unique identifier of this payment in the reports of the payment service - `receipt` string, nullable: Receipt for the payment. For payments done by the payment service provider integration, this is the same as the pspReference. - `paymentDate` string, date-time: The date when the payment was done
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `movedFrom` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedTo` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedReason` string, nullable: A reason why move operation was performed - `sourcePaymentId` string, nullable: A link to the original payment in case of splitting payments - `depositEntryId` string, nullable: Id of the deposit entry this payment was classified as, if any - `businessDate` string, date, required: The business date of the payment - `pendingPayments` PendingPaymentModel[], nullable: The list of pending payments - DEPRECATED: This field will be removed on July 3rd 2020. Use GET /finance/v1/folios/{folioId}/payments instead. - `id` string, required: Id of the payment task. - `amount` MonetaryValueModel, required - `amount` number, double, required - `currency` string, required - `terminalId` string, nullable: The terminal used for the payment. - `allowances` AllowanceModel[], nullable: The list of allowances - `id` string, required: ID for allowances. This is unique within one folio. - `amount` AmountModel, required - `grossAmount` number, double, required - `netAmount` number, double, required - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required - `vatPercent` number, double, required - `currency` string, required - `reason` string, required: Reason why this allowance was posted - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages' | 'CancellationFees' | 'NoShow' | 'CityTax' | 'SecondCityTax' | 'LocalTax' | 'ConsumptionTax', required - `serviceDate` string, date, required - `created` string, date-time, required: Date of creation
A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004 - `movedFrom` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedTo` EmbeddedFolioModel - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `movedReason` string, nullable: A reason why move operation was performed - `sourceChargeId` string, nullable: ID of a charge allowance posted for. `Null` if posted for folio - `subAccountId` string, nullable: ID of the custom sub-account the allowance has been posted to - `balance` MonetaryValueModel, required - `amount` number, double, required - `currency` string, required - `checkedOutOnAccountsReceivable` boolean: 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 - `isMainFolio` boolean: Set to `true` if this is a main folio for the reservation - `isEmpty` boolean: Set to `true` if the folio has no unmoved [transitory] charges, unmoved payments, and allowances. - `relatedFolios` EmbeddedFolioModel[], nullable: All folios that are related to this folio. Either because they belong to the same reservation/booking or charges were moved/routed between them. It is only set on folios of type 'guest', 'booking', and 'external'. - `id` string, required: Folio ID - `debitor` string, nullable: Name of the debitor - the one who will pay the bill - `relatedInvoices` EmbeddedInvoiceModel[], nullable: All invoices that have been created for this folio. This is only set on folios of type 'guest' - `id` string, required: Invoice id - `folioWarnings` string[], nullable: Depending on the state of the folio, certain warnings are shown. This list includes all folio warnings. - `allowedActions` string[], 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. - `allowedPayment` number, double: The maximum payment that can be posted on this folio - `maximumAllowance` number, double: The maximum allowance (gross) that can be posted on this folio - `status` 'Open' | 'Closed' | 'ClosedWithInvoice', required: Status of the folio ## Other responses - `400`: Bad request. - `401`: You are unauthorized. - `403`: Forbidden. - `404`: The Request-URI could not be found. - `422`: Validation errors in the request body or query params. - `499`: Client closed request. - `500`: An unexpected error occurred. - `503`: The server is currently unavailable. Please try later. --- [API](https://skmtc.dev/apaleo/apis/apaleo-finance-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api/revisions/6f1d524c1ea7?raw)