charges

All charges are the smallest granularity of the revenue. Each item or service posted to a folio is represented as a charge as well as the corrections made to previously created charges.

Fields

Field name	Type	Description/Notes
id	INTEGER	Unique identifier of the charge across the entire Clock PMS+ ecosystem*
account_id	INTEGER	Identification of the account owning the record. Reference to accounts table*
folio_id	INTEGER	Containing folio id. Reference to folios table*
text	STRING	The name of the charge*
print_text	STRING	Optional print text substitute the original name in the printouts
visual_group_text	STRING	Name of the visual group defined for the charge template(Clock PMS+ charges only)
store_id	INTEGER	Configured store / kitchen id for the menu item of Clock POS (blank for Clock PMS+ charges)
capacity_pool_id	INTEGER	Unique Identification of the capacity pool. The capacity pool allows the business to control the availability of extra services with limited availability such as baby beds, parking lot spaces, etc. Applicable for Clock PMS+ only
capacity_pool_name	STRING	The name of the capacity pool
service_date	DATE	Date of service delivery / consumptions for services only. For example the menu items in Clock POS do not have service_date
revenue_date	DATE	The affected by the charge revenue date*
revenue_group	STRING	The revenue groups are fixed in Clock and the value may be one of the following: Clock PMS+* rooms, f&b, extra, other, tax, packages, deposit,surcharge, surcharge_transfer;No tax calculation Clock POS - food, beverage, service, other, discount,surcharge, surcharge_transfere
revenue_category	STRING	Name of the revenue category (optional, user configurable). The revenue category is a subdivision of the revenue group
created_at	TIMESTAMP	Time created (Date and time in UTC)*
updated_at	TIMESTAMP	Time lastly updated (Date and time in UTC)*
qty	NUMERIC	Quantity of the charge*
price_cents	INTEGER	Charge price in cents (10EUR = 1000 cents). Depending on the tax mode the price may be interpreted as net (add_on_row and add_on_total) or gross (in_prices_on_row and in_prices_on_total)*
currency	STRING	Currency of the charge ISO 4217 currency codes*
value_cents	INTEGER	Charge value in cents (10EUR = 1000 cents). Depending on the tax mode the price may be interpreted as net (add_on_row and add_on_total) or gross (in_prices_on_row and in_prices_on_total)*
balance_value_cents	INTEGER	Charge value recalculated in the folio currency*
net_value_cents	INTEGER	Charge net value in cents in the folio currency*
tax_value_cents	INTEGER	Charge tax value in cents in the folio currency*
gross_value_cents	INTEGER	Charge gross value in cents in the folio currency*
discount_rate	NUMERIC	The discounts are handled as separate charges in Clock and may be posted with a value (like every other charge) or be percentage based. The rate of the percentage based discount charges as decimal(-10% = -0.10 for discount or 10% = 0.10 for markup)
tax_rate	NUMERIC	Applicable tax rate as decimal (10% = 0.10)*
tax_code	STRING	Optional. Allows additional tax segmentation.
tax_mode	STRING	Tax mode of the charge. 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
tax_currency	STRING	Currency of the tax ISO 4217 currency codes*
voided_at	TIMESTAMP	Time voided (Date and time in UTC)
void_reason	STRING	Reason for the void added by the operator
transfer_source_account_id	INTEGER	If a charge is transferred from Clock POS to Clock PMS+ here you can find the source account ID
inventory_code	STRING	Inventory code for reference to external systems (inventory control systems)
user_created	STRING	Name of the Clock PMS+ user created the charge*
user_updated	STRING	Name of the Clock PMS+ user updated the charge*
source_type	STRING	Each charge has a charge and the difference source types may lead you to a different reference table. Bellow are the expected values and the reference tables: Booking - reference to bookings table; Folios::Folio - reference to folios table; Subscriptions::Account - source_id will be the Clock PMS+ account ID; Subscriptions::Person - reference to guests table; Pms::Catering - N/A; Event - N/A; Pms::MeetingRoomBooking - N/A; Folios::Company - reference to companies table; LightspeedPos::Bill - N/A.
source_id	INTEGER	Id for reference to the respective table as described in source_type
custom_field_xyz**	STRING

* Field will have value for every record

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

charges

Fields

On this page