PosStoreProfile
The store's business profile: the name and contact block its register prints at the top of every receipt, its tax slots and its POS database version. Every text is as the store keeps it and is absent when blank; nothing is derived. It never carries a license value, a payment processor or terminal id, a carrier account, a machine path, a PIN or staff setting, a pricing or discount rule, the receipt footer or custom text, or the enterprise ids.
Type: object.
| Name | Type | Description |
|---|---|---|
addressLine1 | string | Street address. |
addressLine2 | string | Second address line. |
city | string | City. |
currency | string | ISO 4217 currency of the store's amounts, where CompuDime configured it on the store's POS agent (the POS itself keeps none); absent otherwise. |
databaseVersion | string | The TisWin3 database version of the store's POS (for example 1.324). Several reads depend on it: the POS keeps the category and brand lists from 1.308 (an older store's lists are built from its products), an invoice's externalId and processorCode exist from 1.324. Absent when the store's POS does not say. Pattern: ^[0-9]+\.[0-9]+$ |
email | string | The store's public email address, as printed on its receipts. |
fax | string | The store's fax, as the store wrote it. |
name | string | The store's name as its POS is licensed to it, which TisWin3 shows and the register prints at the top of the receipt. |
nameLine2 | string | The line the receipt prints under the name, often a legal or trading name. |
phone | string | The store's phone, as the store wrote it (formatting kept). |
postalCode | string | ZIP code, as the store keeps it. |
state | string | State, as the store keeps it (two letters in the POS). |
taxRates | array of PosStoreTaxRate | The register's two tax slots, in slot order; a slot is listed when the store's POS keeps any of its settings. At most 2 items. |
timeZone | string | IANA time zone of the store, where CompuDime configured it on the store's POS agent; absent otherwise. |
utcOffset | string | The store clock's offset from UTC when the profile was read (for example -04:00): the zone every store-local date and time of this API is read in. Pattern: ^[+-][0-9]{2}:[0-9]{2}$ |
website | string | The store's website, as printed on its receipts. |
No other fields appear.