TRANXACT.AI Help

CRM · Utility Cashiering & Payments

Cashiering

The counter: open a drawer session with its float, find the account, take cash, check, card or money order, take a deposit, ask for a void, close with the count.

Type REST6 operationsBase path /api/crm/util-cashiering

Download specification (OpenAPI 3.1) Screen: Cashiering

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold CRM › Cashiering 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.
RulesThe 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/util-cashiering/stateState

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/util-cashiering/state" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/util-cashiering/lookupLookup

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/util-cashiering/lookup" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-cashiering/openOpen

Request body

The keys this action reads (* = required; "one of" lists the only values):

opening_float, openingFloat, drawer_id, drawerId

Response

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/util-cashiering/open" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"opening_float":"value","openingFloat":"value","drawer_id":"value","drawerId":"value"}'
POST/api/crm/util-cashiering/paymentPayment

Request body

The keys this action reads (* = required; "one of" lists the only values):

service_account_id, accountId, amount, tender, check_no, card_last4, reference

Response

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/util-cashiering/payment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"service_account_id":"value","accountId":"value","amount":"value","tender":"value","check_no":"value","card_last4":"value"}'
POST/api/crm/util-cashiering/depositDeposit

Request body

The keys this action reads (* = required; "one of" lists the only values):

service_account_id, amount, tender

Response

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/util-cashiering/deposit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"service_account_id":"value","amount":"value","tender":"value"}'
POST/api/crm/util-cashiering/closeClose

Request body

The keys this action reads (* = required; "one of" lists the only values):

counted_cash, countedCash, counted_checks, countedChecks, note

Response

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/util-cashiering/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"counted_cash":"value","countedCash":"value","counted_checks":"value","countedChecks":"value","note":"value"}'

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Cashiering for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.