CRM · Point of Sale
POS Terminal
The till: open a session with its float, scan and sell, take cash, card or both, take returns, and close with a cash count. Works through a short outage and catches up.
/api/crm/pos-terminalOverview
| 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 Terminal 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/pos-terminal/stateState
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/pos-terminal/state" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/pos-terminal/lookupLookup
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/pos-terminal/lookup" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pos-terminal/computeCompute
Request body
The keys this action reads (* = required; "one of" lists the only values):
storeId, linesResponse
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-terminal/compute" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"storeId":"value","lines":"value"}'POST/api/crm/pos-terminal/open-sessionOpen session
Request body
The keys this action reads (* = required; "one of" lists the only values):
registerId, openingFloatResponse
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-terminal/open-session" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"registerId":"value","openingFloat":"value"}'POST/api/crm/pos-terminal/sessions/{id}/closeSessions close
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):
countedCash, noteResponse
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-terminal/sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"countedCash":"value","note":"value"}'POST/api/crm/pos-terminal/saleSale
Request body
The keys this action reads (* = required; "one of" lists the only values):
sessionId, lines, tenders, offlineRef, accountIdResponse
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-terminal/sale" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sessionId":"value","lines":"value","tenders":"value","offlineRef":"value","accountId":"value"}'GET/api/crm/pos-terminal/ticketTicket
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/pos-terminal/ticket" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pos-terminal/tickets/{id}/returnTickets return
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):
sessionId, lines, refundTo, reason, offlineRefResponse
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-terminal/tickets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/return" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sessionId":"value","lines":"value","refundTo":"value","reason":"value","offlineRef":"value"}'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 Terminal 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.