v1/containers/{containerId}/taxes
Retrieves a list of tax formulas associated with specific cost objects in the given project.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/taxes |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
region string | The region where the project data resides, to which this request is routed.
This header is optional because the request is automatically routed to a target region based on the project ID or container ID. Using the header, though, can save lookup time on each API call. For information about verifying the region the data resides in, see the Working with BIM 360 Services in Different Regions section on the API Basics page. Possible values: |
Request
URI Parameters
containerId string: UUID | The ID of the cost container for the project. Each project is assigned a container that stores all of the cost data for the project.
To find the container ID, see the Retrieve a Cost Container ID tutorial. In ACC projects, the container ID is the same as the project ID. To obtain a project ID, use GET projects. |
Request
Query String Parameters
offset int | The number of objects to skip before returning a page of records. To return the subsequent page, increment this number by the value of limit in the next request. |
limit int | The maximum number of records that this endpoint returns per page. Default: 100 .
Note that a returned page may contain fewer items than the limit under either of these conditions:
|
sort string | The sort order for items. Each attribute can be sorted in either asc (default) or desc order. For example, sort=name, updatedAt desc or sort=name + updatedAt desc sorts the results first by name in ascending order, then by date updated in descending order. |
associationId* array: string | The object ID of the item is associated to. For example, ID of the budget, contract or cost item. Use comma separated string for multiple IDs. |
associationType* enum:string | Specifies the category of the object the tax is associated with.
Possible values:
- Contract
- MainContract
- BudgetPayment
- CostPayment
- OCO (Owner Change Order)
- SCO (Subcontractor Change Order) |
Response
HTTP Status Code Summary
200 OK | Success |
400 Bad Request | The parameters are invalid. |
401 Unauthorized | The provided bearer token is invalid. |
403 Forbidden | Forbidden. The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The resource or endpoint cannot be found. |
409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
429 Too Many Requests | Rate limit exceeded. Retry your request after a few minutes. |
500 Internal Server Error | An unexpected error occurred on the server. |
503 Service Unavailable | Service unavailable. |
Response
Body Structure (200)
pagination object | Pagination information when data must be returned page by page. |
limit int | The maximum number of objects returned in this response. |
offset int | The number of resulting objects that were skipped before this page of records was returned. |
totalResults int | The total number of objects found that satisfied the request criteria. |
nextUrl string | The URL for the next request to return the next page of records.
Max length: 2000 |
results array: object | |
id string: UUID | The unique identifier of the tax. |
containerId string: UUID | Not relevant |
name string | The name of the tax.
Max length: 1024 |
taxFormulaId string: UUID | Not relevant |
associationId string: UUID | The unique identifier (UUID) of the object the tax is associated with. |
associationType string | The type of object the tax is associated with. |
needUpdate boolean | Indicates whether the tax needs to be recalculated because the associated item was updated after the tax was applied. |
options object | Not relevant |
summary array: object | A consolidated report of all taxes applied within a specific project. |
name string | The name of the applied tax (e.g., Sales Tax, VAT, State Tax, City Tax, Local Tax). |
amount number | The total amount of the applied tax. |
type string | The type of tax applied, such as rate . |
rate string | (optional) The rate of the tax applied. |
createdAt datetime: ISO 8601 | The date and time that the item was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time that the item was last updated, in ISO 8601 format. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/taxes?limit=100&sort=name,createdAt desc&associationId=18d97ae0-9484-11e8-a7ec-7ddae203e404&associationType=Contract' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"results": [
{
"id": "769305a0-96d4-11e8-b53f-f98b28ca3295",
"containerId": "1df59db0-9484-11e8-a7ec-7ddae203e404",
"name": "Sales Tax",
"taxFormulaId": "18d97ae0-9484-11e8-a7ec-7ddae203e404",
"associationId": "18d97ae0-9484-11e8-a7ec-7ddae203e404",
"associationType": "Contract",
"needUpdate": true,
"options": {
"isTaxBeforeRetention": true
},
"summary": [
{
"name": "State Tax",
"amount": 300,
"type": "rate",
"rate": "0.10"
}
],
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z"
}
]
}