TRANXACT.AI Help

Accounting · Services and actions

Tax

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

Type REST7 operationsBase path /api/accounting/tax

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 › Tax 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/tax/determineDetermine

Request body

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

transactionType, shipFromCountry, shipFromRegion, shipToCountry, shipToRegion, itemId, accountId, supplierId, classificationId, amount, date, partnerRegistration, shipTo, shipToPostalCode, shipToCity, shipToCounty, shipFrom, shipFromPostalCode, shipFromCity, quantity, unitPrice, taxClassification

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/tax/determine" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"transactionType":"value","shipFromCountry":"value","shipFromRegion":"value","shipToCountry":"value","shipToRegion":"value","itemId":"value"}'
POST/api/accounting/tax/returns/prepareReturns prepare

Request body

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

templateCode, periodCode

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/tax/returns/prepare" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"templateCode":"value","periodCode":"value"}'
POST/api/accounting/tax/returns/{id}/fileReturns file

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

skipApproval, post, inputAccountNo, outputAccountNo, payableAccountNo, receivableAccountNo, filingReference, acknowledgementNo, declared

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/tax/returns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/file" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"skipApproval":"value","post":"value","inputAccountNo":"value","outputAccountNo":"value","payableAccountNo":"value","receivableAccountNo":"value"}'
POST/api/accounting/tax/returns/{id}/amendReturns amend

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/accounting/tax/returns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/amend" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/accounting/tax/withholding/computeWithholding compute

Request body

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

supplierId, typeCode, grossAmount, taxAmount, treatyCountry, date

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/tax/withholding/compute" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"value","typeCode":"value","grossAmount":"value","taxAmount":"value","treatyCountry":"value","date":"value"}'
POST/api/accounting/tax/deferred/calculateDeferred calculate

Request body

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

periodCode

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/tax/deferred/calculate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"periodCode":"value"}'
GET/api/accounting/tax/summarySummary

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/tax/summary" \
  -H "Authorization: Bearer $TOKEN"

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 › Tax 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.