Sign in
Tax Rate

Find tax rates based on search parameters.

post/api/tax-rates/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

codestring nullable

Filter tax rates based on their code.

idsstring[] nullable

Filter tax rates based on matching ids.

Response

List of tax rates matching the filters

idstring required

Unique id associated to this entity.

codestring required

Identifying code. Must be unique.

provider'avalaraOrder' | 'avalaraInvoice'
ratenumber double required

Tax Rate (%)

applyToLandedCostsboolean

Indicate if this tax rate applies to landed costs.

deletedboolean

Indicate if this record is deleted.

Changes