Company Config

Type	Base Path	Trigger Name
Single entity resource	~{realm}/config	company-configs

This is a single-entity resource that holds account-wide configuration properties.

Endpoints

Name	Method	Relative Path	Payload	Response	Description
getCompanyConfig	GET	~{realm}/config	N/A	Stored_CompanyConfig	Retrieves the configuration.
putCompanyConfig	PUT	~{realm}/config	CompanyConfig	Stored_CompanyConfig	Replaces the configuration.
updateCompanyConfig	PATCH	~{realm}/config	Partial_CompanyConfig	Stored_CompanyConfig	Updates specified configuration fields.

Permissions

Permission	Description
edit-company-config	Client is allowed to modify the configuration.
show-company-config	Client is allowed to show the configuration.

Entities

Interface CompanyConfig

interface CompanyConfig {
    'account-config'?: AccountConfig;
    'gratuity-handling'?: boolean;
    'id'?: number;
    'created'?: DateTime;
    'updated'?: DateTime;
    'deleted'?: DateTime;
    'updated-by'?: number;
    'updated-from'?: number;
    'tags'?: string[];
    'labels'?: number[];
}

Property	Data Type	Description
account-config	AccountConfig?	Account configuration defaults. Product group and payment method overrides are not allowed. See the documentation of the Till entity for a description.
gratuity-handling	Boolean	Enables support for gratuity handling.
id	Int64?	The resource ID of this entity.
created	DateTime?	Date and time when this entity was first created.
updated	DateTime?	Date and time when this entity was last modified.
deleted	DateTime?	Date and time when this entity was deleted.
updated-by	Int64?	ID of User who last modified this entity.
updated-from	Int64?	ID of Till (trusted device) which last modified this entity.
labels	Int64[]?	A list of Label IDs associated with this entity.