TRANXACT.AI Help

Platform · External Accountants

Accountant Access

The outside firm that keeps your books: who they are, what they may reach, who from their office is in your console right now, and every call every one of them has ever made here.

Type REST8 operationsBase path /api/platform/accountant-access

Download specification (OpenAPI 3.1) Screen: Accountant Access

Overview

PackagePlatform
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 Platform › Accountant Access 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

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/accountant-accessRead accountant access

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/accountant-access" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/accountant-access/{id}Read accountant access

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/accountant-access/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/accountant-access/sessions/{id}/eventsSessions events

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/accountant-access/sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/accountant-accessPost accountant access

Request body

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

name*, kind, contact_name, contact_email, contact_phone, modules*, write_mode, max_minutes, concurrent_max, expires_on, note, console_enabled; kind one of cpa|ca|bookkeeper|auditor|tax_agent|other; write_mode one of read_only|read_write

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/platform/accountant-access" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"value","kind":"value","contact_name":"value","contact_email":"value","contact_phone":"value","modules":"value"}'
PATCH/api/platform/accountant-access/{id}Patch accountant access

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

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 PATCH "https://demo.tranxact.ai/api/platform/accountant-access/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/accountant-access/{id}/reissueReissue

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

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/platform/accountant-access/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reissue" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/accountant-access/{id}/endEnd

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

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

reason*

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/platform/accountant-access/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/end" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/platform/accountant-access/sessions/{id}/endSessions end

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

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

reason

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/platform/accountant-access/sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/end" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"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 Platform › Accountant Access 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.