Update a taxpayer

put

https://example.com/tax-config-api/config/v2/taxpayers/{id}

Update a taxpayer

Path Params

string

required

taxpayer id

Body Params

Full replace of taxpayer

code

string

required

length between 1 and 40

External System identifier for the taxpayer.

name

string

required

length between 1 and 60

Full Name for the taxpayer.

partyTypeId

integer

Type of taxpayer (1=Normal, 4=Regulated, 5=Unregulated)

note

string

length between 0 and 1000

A free-form text for additional taxpayer information.

parentTaxpayerId

string

Stringified UUIDv4. See RFC 4112

startDate

date

required

The date when the taxpayer becomes effective.

endDate

date

The date after which the taxpayer is no longer effective.

adoptParentSetup

boolean

Defaults to false

Adopt Parent Setup indicates that the current taxpayer entity inherits the tax exceptions of its parent taxpayer.

filingEntity

boolean

Defaults to true

Indicates that the taxpayer is responsible for collecting and remitting taxes by filing tax returns.

shippingTerms

string

enum

Shipping Terms determine the point in a transaction at which title transfer of goods takes place, which impacts identification of the taxing jurisdiction.

discountMappings

array of objects

Collection of discount mappings

discountMappings

Responses

204

successful operation

400Bad Request. The request was invalid (did not have a required parameter) or 1 or more parameters on the request was invalid.

401Authentication failure. There was no credential attached to the request, or the credential was invalid.

403Authorization failure. The user or identity requesting the operation did not have the requisite role to perform the operation.

404The entity you were querying or updating does not exist.

503Service Unavailable