- Taxpayers
- Provision a taxpayer
Taxpayers
Provision a taxpayer
Find or create a taxpayer, its tax entities and their tax accounts in a single call.
POST
/v1/firms/{firmId}/taxpayers/provision
curl --request POST \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers/provision \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>' \
--header 'Content-Type: application/json' \
--data '{
"taxpayer": {
"externalId": "string",
"name": "string",
"ownerFirmUserId": "<uuid>",
"activate": true,
"user": {
"emailAddress": "string",
"name": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"taxEntities": [
{
"externalId": "string",
"type": "IrsSsn",
"tin": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"address": {
"address1": "string",
"address2": "string",
"apartmentOrSuite": "string",
"poBox": "string",
"city": "string",
"region": "string",
"country": "string",
"postalCode": "string"
},
"email": "string",
"phone": "string",
"filingStatus": "Single",
"regionalTaxRegistrations": [
{}
],
"taxAccounts": [
{
"externalId": "string",
"taxAuthority": "CA_CRA",
"type": "Personal"
}
]
}
]
}'
curl --request POST \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers/provision \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>' \
--header 'Content-Type: application/json' \
--data '{
"taxpayer": {
"externalId": "string",
"name": "string",
"ownerFirmUserId": "<uuid>",
"activate": true,
"user": {
"emailAddress": "string",
"name": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"taxEntities": [
{
"externalId": "string",
"type": "IrsSsn",
"tin": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"address": {
"address1": "string",
"address2": "string",
"apartmentOrSuite": "string",
"poBox": "string",
"city": "string",
"region": "string",
"country": "string",
"postalCode": "string"
},
"email": "string",
"phone": "string",
"filingStatus": "Single",
"regionalTaxRegistrations": [
{}
],
"taxAccounts": [
{
"externalId": "string",
"taxAuthority": "CA_CRA",
"type": "Personal"
}
]
}
]
}'Authorizations
bearerAuth
required
string
Access token from POST /v1/auth/token, sent as `Authorization: Bearer {accessToken}`.
Query Parameters
firmId
required
string
Unique identifier of the firm.
x-api-key
required
string
API key of your Client Application.
Body
application/json
taxpayer
required
object
The taxpayer to create or reuse.
taxEntities
required
array
The tax entities to create or reuse for the taxpayer.
Response
application/json
200
400
401
403
404
409
OK
taxpayer
required
object
taxEntities
required
array
curl --request POST \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers/provision \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>' \
--header 'Content-Type: application/json' \
--data '{
"taxpayer": {
"externalId": "string",
"name": "string",
"ownerFirmUserId": "<uuid>",
"activate": true,
"user": {
"emailAddress": "string",
"name": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"taxEntities": [
{
"externalId": "string",
"type": "IrsSsn",
"tin": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"address": {
"address1": "string",
"address2": "string",
"apartmentOrSuite": "string",
"poBox": "string",
"city": "string",
"region": "string",
"country": "string",
"postalCode": "string"
},
"email": "string",
"phone": "string",
"filingStatus": "Single",
"regionalTaxRegistrations": [
{}
],
"taxAccounts": [
{
"externalId": "string",
"taxAuthority": "CA_CRA",
"type": "Personal"
}
]
}
]
}'
curl --request POST \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers/provision \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>' \
--header 'Content-Type: application/json' \
--data '{
"taxpayer": {
"externalId": "string",
"name": "string",
"ownerFirmUserId": "<uuid>",
"activate": true,
"user": {
"emailAddress": "string",
"name": "string",
"lastName": "string",
"phoneNumber": "string"
}
},
"taxEntities": [
{
"externalId": "string",
"type": "IrsSsn",
"tin": "string",
"firstName": "string",
"lastName": "string",
"businessName": "string",
"address": {
"address1": "string",
"address2": "string",
"apartmentOrSuite": "string",
"poBox": "string",
"city": "string",
"region": "string",
"country": "string",
"postalCode": "string"
},
"email": "string",
"phone": "string",
"filingStatus": "Single",
"regionalTaxRegistrations": [
{}
],
"taxAccounts": [
{
"externalId": "string",
"taxAuthority": "CA_CRA",
"type": "Personal"
}
]
}
]
}'