API Reference

Update registration configuration

put
https://example.com/tax-config-api/config/v2/registrations/

Update a registration configuration. All elements are replaced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

registration id

Body Params

Full replace of registration

registeredJurisdiction
object
required

Represents a government entity. The jurisdiction is best identified by the globally unique id property. Otherwise, jurisdictions provided on request will be matched based on the other properties that are available to the requester, such as name, country, and level. These must be sufficient to uniquely identify the jurisdiction.

string
required

Stringified UUIDv4. See RFC 4112

string

External System identifier for the owning party. This is returned in the response but cannot be used in the request.

string

Full Name for the owning party. This is returned in the response but cannot be used in the request.

string
enum

The party types.

Allowed:
date
required

The date when the registration becomes effective.

date

The date after which the registration is no longer effective.

string
enum

Registration Type indicates the category to which this registration belongs.

string
length between 0 and 40

A tax jurisdiction assigned number. Registration number is required for registration types UNION_SCHEME, NON_UNION_SCHEME, and IMPORT_ONE_STOP_SHOP.

boolean
Defaults to false

True if the business entity has a physical location in the jurisdiction.

string
length between 3 and 3

The ISO 4217 Alpha-3 code for the currency used for tax filing in the country of registration. This value is required for registration types UNION_SCHEME, NON_UNION_SCHEME, and IMPORT_ONE_STOP_SHOP.

Responses
204

successful operation

Updated over 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated over 1 year ago