TRANXACT.AI Help

CRM · Records

Tax registration

Read and maintain tax registration records (acct.tax_registrations).

Type REST6 operationsBase path /api/crm/tax-registrationsPublished as /api/v1/tax-registrations

Download specification (OpenAPI 3.1)

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 › Tax registration 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.
Tableacct.tax_registrations · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
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/tax-registrationsList tax registration

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "tax_family": "text",
      "registration_no": "REG-000001",
      "nexus_kind": "text",
      "nexus_threshold_amount": "1250.00",
      "nexus_threshold_txns": 10,
      "nexus_lookback_months": 10,
      "filing_frequency": "text",
      "return_due_day": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/tax-registrations?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/tax-registrations/{id}Read one tax registration

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "tax_family": "text",
  "registration_no": "REG-000001",
  "nexus_kind": "text",
  "nexus_threshold_amount": "1250.00",
  "nexus_threshold_txns": 10,
  "nexus_lookback_months": 10,
  "filing_frequency": "text",
  "return_due_day": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/tax-registrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/tax-registrationsCreate a tax registration

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
jurisdiction_iduuidYesJurisdiction id
authority_iduuidNoAuthority id
codetextYesCode
nametextYesName
tax_familytextNoTax family
registration_notextNoRegistration no
nexus_kindtextNoNexus kind
nexus_threshold_amountnumericNoNexus threshold amount
nexus_threshold_txnsintegerNoNexus threshold txns
nexus_lookback_monthsintegerNoNexus lookback months
filing_frequencytextNoFiling frequency
return_due_dayintegerNoReturn due day
payment_due_dayintegerNoPayment due day
prepayment_requiredbooleanNoPrepayment required
prepayment_pctnumericNoPrepayment pct
prepayment_due_dayintegerNoPrepayment due day
vendor_discount_pctnumericNoVendor discount pct
vendor_discount_capnumericNoVendor discount cap
filing_portaltextNoFiling portal
filing_methodtextNoFiling method
effective_fromdateNoEffective from
effective_todateNoEffective to
statustextNoStatus
notestextNoNotes
is_activebooleanNoIs active

Sample body

{
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_family": "text",
  "registration_no": "REG-000001",
  "nexus_kind": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "tax_family": "text",
  "registration_no": "REG-000001",
  "nexus_kind": "text",
  "nexus_threshold_amount": "1250.00",
  "nexus_threshold_txns": 10,
  "nexus_lookback_months": 10,
  "filing_frequency": "text",
  "return_due_day": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/tax-registrations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","authority_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tax_family":"text","registration_no":"REG-000001","nexus_kind":"text"}'
PUT/api/crm/tax-registrations/{id}Change a tax registration

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
jurisdiction_iduuidYesJurisdiction id
authority_iduuidNoAuthority id
codetextYesCode
nametextYesName
tax_familytextNoTax family
registration_notextNoRegistration no
nexus_kindtextNoNexus kind
nexus_threshold_amountnumericNoNexus threshold amount
nexus_threshold_txnsintegerNoNexus threshold txns
nexus_lookback_monthsintegerNoNexus lookback months
filing_frequencytextNoFiling frequency
return_due_dayintegerNoReturn due day
payment_due_dayintegerNoPayment due day
prepayment_requiredbooleanNoPrepayment required
prepayment_pctnumericNoPrepayment pct
prepayment_due_dayintegerNoPrepayment due day
vendor_discount_pctnumericNoVendor discount pct
vendor_discount_capnumericNoVendor discount cap
filing_portaltextNoFiling portal
filing_methodtextNoFiling method
effective_fromdateNoEffective from
effective_todateNoEffective to
statustextNoStatus
notestextNoNotes
is_activebooleanNoIs active

Sample body

{
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "jurisdiction_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "authority_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "tax_family": "text",
  "registration_no": "REG-000001",
  "nexus_kind": "text",
  "nexus_threshold_amount": "1250.00",
  "nexus_threshold_txns": 10,
  "nexus_lookback_months": 10,
  "filing_frequency": "text",
  "return_due_day": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/tax-registrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001"}'
DELETE/api/crm/tax-registrations/{id}Delete a tax registration

Path parameters

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

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/crm/tax-registrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/tax-registrations/{id}/copyCopy

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

overrides, preview, withLines

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/tax-registrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a tax registration, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
jurisdiction_iduuidread, writeJurisdiction id
authority_iduuidread, writeAuthority id
codetextread, writeCode
nametextread, writeName
tax_familytextread, writeTax family
registration_notextread, writeRegistration no
nexus_kindtextread, writeNexus kind
nexus_threshold_amountnumericread, writeNexus threshold amount
nexus_threshold_txnsintegerread, writeNexus threshold txns
nexus_lookback_monthsintegerread, writeNexus lookback months
filing_frequencytextread, writeFiling frequency
return_due_dayintegerread, writeReturn due day
payment_due_dayintegerread, writePayment due day
prepayment_requiredbooleanread, writePrepayment required
prepayment_pctnumericread, writePrepayment pct
prepayment_due_dayintegerread, writePrepayment due day
vendor_discount_pctnumericread, writeVendor discount pct
vendor_discount_capnumericread, writeVendor discount cap
filing_portaltextread, writeFiling portal
filing_methodtextread, writeFiling method
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
statustextread, writeStatus
notestextread, writeNotes
is_activebooleanread, writeIs active
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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