TRANXACT.AI Help

Accounting · Services and actions

Assets

The assets service of Accounting: 7 operation(s).

Type REST7 operationsBase path /api/accounting/assets

Download specification (OpenAPI 3.1)

Overview

PackageAccounting
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 Accounting › Assets 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

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

POST/api/accounting/assets/{id}/issueIssue

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):

employeeId, orgUnitId

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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","orgUnitId":"value"}'
POST/api/accounting/assets/{id}/returnReturn

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):

force

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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/return" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"force":"value"}'
POST/api/accounting/assets/{id}/verifyVerify

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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/assets/{id}/acquireAcquire

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):

post, costAccountNo, creditAccountNo, amount, txnDate, areas

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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/acquire" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"post":"value","costAccountNo":"value","creditAccountNo":"value","amount":"value","txnDate":"value","areas":"value"}'
POST/api/accounting/assets/{id}/transferTransfer

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):

toCostCenterId, toOrgUnitId, toLocation, txnDate, 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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transfer" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"toCostCenterId":"value","toOrgUnitId":"value","toLocation":"value","txnDate":"value","reason":"value"}'
POST/api/accounting/assets/{id}/revalueRevalue

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):

areaCode, newValue, kind, txnDate, 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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revalue" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"areaCode":"value","newValue":"value","kind":"value","txnDate":"value","reason":"value"}'
POST/api/accounting/assets/{id}/retireRetire

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):

cashAccountNo, post, proceeds, percentage, txnDate, buyer, reason, isDisposal

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/accounting/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/retire" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cashAccountNo":"value","post":"value","proceeds":"value","percentage":"value","txnDate":"value","buyer":"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 Accounting › Assets 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.