CRM · Point of Sale
POS Stores
A shop: where its stock comes from, what it charges, its tax, its card provider, and the ledger accounts its takings post to.
/api/crm/pos-storesPublished as /api/v1/pos-storesOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › POS Stores on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.pos_stores · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/pos-storesList pos stores
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"country": "US",
"region": "text",
"prices_include_tax": true,
"default_tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/pos-stores?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/pos-stores/{id}Read one pos stores
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"country": "US",
"region": "text",
"prices_include_tax": true,
"default_tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/pos-stores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pos-storesCreate a pos stores
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
location_id | uuid | No | Location id |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin stock is issued from |
price_list_id | uuid | No | Price list |
currency | text | No | Currency |
country | text | No | Country — Where the shop is: the tax rules are read for a sale here. |
region | text | No | State or region |
prices_include_tax | boolean | No | Prices include tax |
default_tax_code_id | uuid | No | Default tax code |
payment_provider_id | uuid | No | Card payment provider |
cash_account_no | text | No | Cash account |
card_account_no | text | No | Card clearing account |
revenue_account_no | text | No | Revenue account |
tax_account_no | text | No | Tax payable account |
over_short_account_no | text | No | Over and short account |
cogs_account_no | text | No | Cost of goods account |
inventory_account_no | text | No | Inventory account |
max_discount_pct | numeric | No | Largest discount a cashier may give (%) |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"country": "US",
"region": "text",
"prices_include_tax": true,
"default_tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/pos-stores" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","price_list_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/crm/pos-stores/{id}Change a pos stores
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
location_id | uuid | No | Location id |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin stock is issued from |
price_list_id | uuid | No | Price list |
currency | text | No | Currency |
country | text | No | Country — Where the shop is: the tax rules are read for a sale here. |
region | text | No | State or region |
prices_include_tax | boolean | No | Prices include tax |
default_tax_code_id | uuid | No | Default tax code |
payment_provider_id | uuid | No | Card payment provider |
cash_account_no | text | No | Cash account |
card_account_no | text | No | Card clearing account |
revenue_account_no | text | No | Revenue account |
tax_account_no | text | No | Tax payable account |
over_short_account_no | text | No | Over and short account |
cogs_account_no | text | No | Cost of goods account |
inventory_account_no | text | No | Inventory account |
max_discount_pct | numeric | No | Largest discount a cashier may give (%) |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"country": "US",
"region": "text",
"prices_include_tax": true,
"default_tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/pos-stores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/pos-stores/{id}Delete a pos stores
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/pos-stores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pos-stores/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/pos-stores/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a pos stores, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
location_id | uuid | read, write | Location id |
warehouse_id | uuid | read, write | Warehouse |
bin_id | uuid | read, write | Bin stock is issued from |
price_list_id | uuid | read, write | Price list |
currency | text | read, write | Currency |
country | text | read, write | Country — Where the shop is: the tax rules are read for a sale here. |
region | text | read, write | State or region |
prices_include_tax | boolean | read, write | Prices include tax |
default_tax_code_id | uuid | read, write | Default tax code |
payment_provider_id | uuid | read, write | Card payment provider |
cash_account_no | text | read, write | Cash account |
card_account_no | text | read, write | Card clearing account |
revenue_account_no | text | read, write | Revenue account |
tax_account_no | text | read, write | Tax payable account |
over_short_account_no | text | read, write | Over and short account |
cogs_account_no | text | read, write | Cost of goods account |
inventory_account_no | text | read, write | Inventory account |
max_discount_pct | numeric | read, write | Largest discount a cashier may give (%) |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › POS Stores for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.