GET
View a tax profile
Company space For: Manager, Accountant · Permission: tax_profiles.retrieve Part of Set up VAT and the other taxes.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tax_profile
string
required

Identifier of the tax profile (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, country_code, fiscal_status, rounding_favor, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the tax profile (27-character KSUID string).

country_code

Country of the profile.

fiscal_status

Fiscal status of the profile.

rounding_favor

Where an extraction rounding remainder goes: tax (added to a tax line, the default) or net (added to the net amount).

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).