List tax code values

get

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/taxcodes/{taxCodeId}/values

Returns a paginated list of values for the given tax code. Returns an empty list if the tax code exists but has no values configured yet. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the tax code does not exist or has already been deleted.

Path Params

organizationId

string

required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

taxCodeId

string

required

String. The ID of the tax code whose values to list (32-character hex string), as returned in the id field of the list or GET response.

Query Params

searchText

string

String. Filters values by a partial, case-insensitive match on the display text (value).

sort

string

Defaults to sortOrder:asc

String. One or more sorting criteria in field:direction format, combined either as a comma-separated list (sortOrder:asc,startDate:desc) or as repeated query parameters (sort=sortOrder:asc&sort=startDate:desc). Supported fields: sortOrder, startDate, endDate. Supported directions: asc, desc. Defaults to sortOrder:asc. Unsupported or unknown fields (e.g. value) are not an error — the request silently falls back to the default.

max

integer

1 to 1000

Defaults to 10

Integer. Maximum number of results to return per page.

offset

integer

≥ 0

Defaults to 0

Integer. Zero-based offset of the first result to return. Used for pagination.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK — returns an empty list if the tax code has no values configured yet

400Bad request — invalid query parameter value

403Forbidden — organization not found or access denied

404Not found — tax code does not exist or has already been deleted