folios

The folio stores the charges of the items and services and payments. It has its own balance and currency.

Fields

Field name	Type	Description/Notes
id	INTEGER	Unique identifier of folio across the entire Clock PMS+ ecosystem*
account_id	INTEGER	Identification of the account owning the record. Reference to accounts table*
name	STRING	Optional name
number	STRING	Folio number(customer defined)*
created_at	TIMESTAMP	Time when the folio is created in (Date and time in UTC)*
updated_at	TIMESTAMP	Time when the folio is updated (Date and time in UTC)*
closed_at	TIMESTAMP	Time when the folio is closed and document issued (Date and time in UTC)
close_date	DATE	Close date. The date when the document was issued (YYYY-MM-DD)
voided_at	TIMESTAMP	Time when the folio is voided (Date and time in UTC)
void_reason	STRING	Reason for the void added by the operator
invoice_number	STRING	Invoice number will be present for close folios (closed_at not blank) with a document type (document_type_id not blank)
document_type_id	INTEGER	Identification of the document type used for the document
document_type_name	STRING	Name of the document type
fiscalized_at	TIMESTAMP	Time when the folio is fiscalized (Date and time in UTC)
fiscalization_voided_at	TIMESTAMP	Time when the folio's fiscalization was voided (Date and time in UTC)
user_created	STRING	Name of the Clock PMS+ user created the folio*
user_updated	STRING	Name of the Clock PMS+ user updated the folio*
closed_by	STRING	Name of the Clock PMS+ user closed the folio
tax_mode	STRING	Tax mode of the folio. The tax mode is inherited by the account configuration and may be one of the following no_tax* - No tax calculation; in_prices_on_row - Tax included in prices, rounding - per line; in_prices_on_total - Tax included in prices, rounding - total; add_on_row - Tax not included in prices, rounding - per line; add_on_total - Tax not included in prices, rounding – total. More information about the tax modes here*
value_cents	INTEGER	Total value of the folio in cents(10 EUR = 1000 cents)*
net_value_cents	INTEGER	Net value of the folio in cents (10 EUR = 1000 cents)*
total_vat_cents	INTEGER	Value of the total VAT in cents (10 EUR = 1000 cents)*
balance_cents	INTEGER	Balance (charges - payments) for the folio in cents (10 EUR = 1000 cents)*
currency	STRING	Currency of the folio ISO 4217 currency codes*
payed	BOOLEAN	true / false*
payment_terms_date	DATE	Payment due date (YYYY-MM-DD
deposit	BOOLEAN	true for deposit folios, false for others. More information about deposit folios here.
guest_count	INTEGER	Number of covers for Clock POS folios
customer_cost_center	STRING	Customer's cost center. Customer's specific value (account code) which appears on the document printout.
notes	STRING	Folio notes
surcharge_rate	NUMERIC	Rate of surcharge applicable to the folio
client_folio_id	INTEGER	Relation to the main folio in case of a correction folio(debit/credit note)
transfer_to_id	INTEGER	Charge transfer destination folio id. If the charges form Clock POS are transferred to Clock PMS+
billing_to_guest_profile_id	INTEGER	Relation to the guests table if the folio is billed to guest. Otherwise blank.
billing_to_company_profile_id	INTEGER	Relation to the companies table if the folio is billed to company. Otherwise blank.
payer_company_id	INTEGER	Relation to companies table in case when the folio payer is company. Otherwise blank.
payer_event_id	INTEGER	Relation to the event in case when the folio payer is a event. Otherwise blank.
payer_booking_id	INTEGER	Relation to bookings table in case when the folio payer is booking. Otherwise blank.
payer_guest_id	INTEGER	Relation to guests table in case when the folio payer is a guest(non-resident folio is used). Otherwise blank.
contragent_name	STRING	Name of the customer
contragent_vat	STRING	VAT number of the customer
contragent_second_identification	STRING	Second identification number of the customer
contragent_person_name	STRING	Customer's representative name
contragent_country	STRING	Customer's country ALPHA-2 (ISO 3166)
contragent_address	STRING	Customer's address
contragent_city	STRING	Customer's city
contragent_state	STRING	Customer's state
contragent_zip_code	STRING	Customer's ZIP code
contragent_additional_billing_info	STRING	Customer's additional billing information
contragent_custom_field_accompany	STRING	Travelling with field of the guest. if billed to guest!
contragent_custom_field_address	STRING	Guest's address. if billed to guest!
contragent_custom_field_age	STRING	Guest's age. if billed to guest!
contragent_custom_field_city	STRING	Guest's city. if billed to guest!
contragent_custom_field_country	STRING	Guest's country. if billed to guest!
contragent_custom_field_e_mail	STRING	Guest's e-mail. if billed to guest!
contragent_custom_field_fax_number	STRING	Guest's fax number. if billed to guest!
contragent_custom_field_first_name	STRING	Guest's first name. if billed to guest!
contragent_custom_field_language	STRING	Guest's language (as defined by the customer)
contragent_custom_field_last_name	STRING	Guest's last name. if billed to guest!
contragent_custom_field_level	STRING	Guest's level. if billed to guest!
contragent_custom_field_middle_name	STRING	Guest's middle name. if billed to guest!
contragent_custom_field_notes	STRING	Guest's note. if billed to guest!
contragent_custom_field_phone_number	STRING	Guest's phone number. if billed to guest!
contragent_custom_field_state	STRING	Guest's state. if billed to guest!
contragent_custom_field_zip_code	STRING	Guest's ZIP code. if billed to guest!
contragent_custom_field_xyz**	STRING

* Field will have value for every record

** All fields after contragent_custom_field_zip_code field depend on the Clock PMS+ account configuration and would differ for he different customers!

folios

Fields

On this page