Create an avalara account
How to create an avalara account via API
To create a new avalara account, send a POST request to the /api/avalara_accounts endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/avalara_accounts
Arguments
type
string
Required
attributes.name
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.username
string
Required
attributes.password
string
Required
attributes.company_code
string
Required
attributes.commit_invoice
boolean
Optional
attributes.ddp
boolean
Optional
relationships.tax_categories
array
Optional
Example
The following request creates a new avalara account:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/avalara_accounts' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "avalara_accounts",
"attributes": {
"name": "Personal tax calculator",
"username": "[email protected]",
"password": "secret",
"company_code": "MYCOMPANY"
}
}
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "avalara_accounts",
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN"
},
"attributes": {
"name": "Personal tax calculator",
"type": "avalara_accounts",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
},
"username": "[email protected]",
"company_code": "MYCOMPANY",
"commit_invoice": true,
"ddp": true
},
"relationships": {
"markets": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/markets",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/markets"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/attachments"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/events"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/event_stores"
}
},
"tax_categories": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/relationships/tax_categories",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/XAyRWNUzyN/tax_categories"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

