Payment Items
GET
v1/containers/{containerId}/payment-items
Retrieves payment items in the given project based on associationId and paymentId.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/cost/v1/containers/:containerId/payment-items |
| 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: |
* Required
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
| filter[associationId] array: string: uuid | Return only the payment items that are associated with the provided list of contract or main contract IDs. Separate multiple IDs with commas. For example, filter[associationId]=id1,id2. |
| filter[paymentId] array: string: uuid | Return only the payment items that are associated with the payments identified by the provided list of payment IDs. Separate multiple IDs with commas. For example, filter[id]=id1,id2. |
| filter[associationType] array: string | Return only the payment items that are associated with the type of original entities specified. For example, filter[associationType]=SOV,SCO.
Possible values for cost payment: SOV,SCO,CostItem,MaterialsOnSite, and budget payments: MainContractItem,OCO,CostItem,SubCostItem,MaterialsOnSite. |
| offset int | The number of records to skip before returning results. Used together with limit to paginate through results, where offset specifies the starting point and limit specifies the number of records to return. |
| limit int | The maximum number of records returned per page. Default: 100. A page may contain fewer records than the limit if there are fewer matching items or if it is the last page of results. |
| sort string | Defines the sort order for the results. Each attribute can be sorted in asc (default) or desc order. For example, sort=name desc sorts the results by name in descending 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)
Expand all
| pagination object | Contains pagination information when data is returned page by page. |
| limit int | The maximum number of records returned in the response. |
| offset int | The number of records skipped before returning the page of results. |
| totalResults int | The total number of records that matched the request criteria. |
| nextUrl string | The URL for the next request to retrieve the next page of results. Max length: 2000.
Max length: 2000 |
| results array: object | The detail items in the payment. |
| id string: UUID | Unique identifier of the payment. |
| paymentId string: UUID | The ID of the payment the items belong to. |
| parentId string: UUID | The ID of the parent item for sub items. |
| budgetId string: UUID | The ID of the Budget to which the payment item belongs. |
| associationType enum:string | The object type of the payment item is generated from.
Possible values: SCO, OCO, SOV, CostItem, SubCostItem, MaterialsOnSite |
| associationId string: UUID | The ID of the object that the payment item is generated from. |
| name string | The name of the payment item.
Max length: 1024 |
| description string | A description of the payment item. |
| position int | The position of the payment item in the payment item siblings. |
| exchangeRate number,string,null | Exchange rate. Default value is 1. If multi-currency is not enabled, it will also be 1. |
| originalExchangeRate number,string,null | If this payment item came from Schedule of Value, the value is equal to Schedule of Value exchange rate; If this payment item came from SCO, the value is equal to SCO exchange rate. Default value is 1. If multi-currency is not enabled, it will also be 1. |
| previousExchangeRate number,string,null | Exchange rate from previous payment application. Default value is 1, if multi-currency is not enabled, it will also be 1. |
| originalQuantity number | The original quantity of the payment item. |
| originalUnitPrice number,string,null | The original unit price of the payment item. |
| originalAmount number,string,null | The original amount of the payment item. |
| budgetTransfersQuantity number | Not relevant |
| budgetTransfersUnitPrice number,string,null | Not relevant |
| budgetTransfers number,string,null | Not relevant |
| previousAmount number,string,null | The amount of total work completed prior to this billing period. |
| previousAmountForeignCurrency number,string,null | The amount of total work completed prior to this billing period in foreign currency. |
| previousQuantity number | The quantity of total work completed prior to this billing period. |
| previousUnitPrice number,string,null | The unit price of total work completed prior to this billing period. |
| previousMaterials number,string,null | Not relevant |
| previousMaterialsOnStore number,string,null | The amount of the materials stored from the previous payment application. |
| previousMaterialsBilled number,string,null | The amount of the total materials billed prior to this billing period. |
| previousMaterialsBilledForeignCurrency number,string,null | The amount of the total materials billed prior to this billing period in foreign currency. |
| previousMaterialsBilledUnitPrice number,string,null | The unit price of the total materials billed prior to this billing period. |
| previousMaterialsBilledQuantity number | The quantity of the total materials billed prior to this billing period. |
| previousMaterialsBilledUnit string | The unit of the total materials billed prior to this billing period. |
| quantity number | The quantity of the work completed in this billing period. |
| unitPrice number,string,null | The unit price of the work completed in this billing period. |
| unit string | The unit of the work completed in this billing period. |
| amount number,string,null | The amount of the work completed in this billing period. |
| materials number,string,null | Not relevant |
| materialsOnStore number,string,null | The amount of the materials stored. |
| materialsOnStoreQuantity number | The quantity of the materials stored. |
| materialsOnStoreUnit string | The unit of the materials stored. |
| materialsOnStoreUnitPrice number,string,null | The unit price of the materials stored. |
| materialsBilled number,string,null | The amount of the materials billed in this billing period. |
| materialsBilledQuantity number | The quantity of the materials billed in this billing period. |
| materialsBilledUnit string | The unit of the materials billed in this billing period. |
| materialsBilledUnitPrice number,string,null | The unit price of the materials billed in this billing period. |
| previousCompletedWorkRetained number,string,null | Not relevant |
| previousCompletedWorkRetainedForeignCurrency number,string,null | Not relevant |
| currentCompletedWorkRetentionPercent number | Not relevant |
| currentCompletedWorkRetention number,string,null | Not relevant |
| currentCompletedWorkRetentionForeignCurrency number,string,null | Not relevant |
| completedWorkRetentionPercent number | The percentage of the total completed work to be retained. |
| completedWorkRetention number,string,null | The amount of total completed work to be retained. |
| completedWorkRetainedPercent number | Not relevant |
| completedWorkReleased number,string,null | The retention amount of total completed work to be released in this billing period. |
| previousMaterialsRetained number,string,null | Not relevant |
| previousMaterialsRetainedForeignCurrency number,string,null | Not relevant |
| currentMaterialsRetentionPercent number | Not relevant |
| currentMaterialsRetention number,string,null | Not relevant |
| currentMaterialsRetentionForeignCurrency number,string,null | Not relevant |
| materialsOnStoreRetentionPercent number | The percentage of the materials to be retained. This parameter is deprecated, use materialsRetentionPercent. |
| materialsRetentionPercent number | The percentage of the materials to be retained (pre-release) in this billing period. |
| materialsRetainedPercent number | Not relevant |
| materialsRetention number,string,null | The amount of the materials (stored or billed) to be retained (pre-release). |
| totalRetentionPercent number | The percentage of total completed work and materials to be retained (pre-release). |
| totalRetainedPercent number | Not relevant |
| materialsOnStoreReleased number,string,null | The amount of the materials that is released in this payment. This parameter is deprecated, use materialsReleased. |
| materialsReleased number,string,null | The retention amount of the materials to be released in this billing period . |
| netAmount number,string,null | The net amount that should be paid in this billing period, including work completed, materials stored or billed, retention and release. |
| netAmountForeignCurrency number,string,null | The net amount that should be paid in this billing period in foreign currency. |
| previousNetAmount number,string,null | Not relevant |
| realizedGainOrLoss number,string,null | netAmountForeignCurrency / originalExchangeRate - netAmount |
| claimedQuantity number | The claimed quantity of the work completed in this billing period. |
| claimedUnitPrice number,string,null | The claimed unit price of the work completed in this billing period. |
| claimedAmount number,string,null | The claimed amount of the work completed in this billing period. |
| previousClaimedQuantity number | The claimed quantity of the work completed from the previous payment application. |
| previousClaimedUnitPrice number,string,null | The claimed unit price of the work completed from the previous payment application. |
| previousClaimedAmount number,string,null | The claimed amount of the work completed from the previous payment application. |
| previousClaimedAmountForeignCurrency number,string,null | The claimed amount of the work completed from the previous payment application in foreign currency. |
| advanceAmount number,string,null | The advance amount of the work completed in this billing period. |
| advancePercent number,null | The advance percent of the work completed in this billing period. |
| previousAdvanceAmount number,string,null | The advance amount of the work completed from the previous payment application. |
| previousAdvanceAmountForeignCurrency number,string,null | The advance amount of the work completed from the previous payment application in foreign currency. |
| recoupmentAmount number,string,null | The recoupment amount of the work completed in this billing period. |
| recoupmentPercentOfCompletedWork number,null | The recoupment percentage of the work completed in this billing period. |
| previousRecoupmentAmount number,string,null | The recoupment amount of the work completed from the previous payment application. |
| previousRecoupmentAmountForeignCurrency number,string,null | The recoupment amount of the work completed from the previous payment application in foreign currency. |
| creatorId string,null | The user who created the payment item. This is the ID of a user managed by BIM 360 Admin. |
| changedBy string,null | The user who made the change. |
| status string,null | The review status the payment item.
Possible values: accepted, rejected, semi-rejected, null |
| lastReviewedBy string,null | The last user who made the review. |
| hasComment boolean | Indicate if this payment item has comment. |
| canDelete boolean | Indicate if this payment item can be deleted. |
| isPrivate boolean,null | Indicate if this payment item should be exposed to owner. This is only for budget payment. |
| aggregateBy string,null | The aggregate type to budget Payment application.
Possible values: workCompleted, workCompletedPercentage |
| 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. |
| externalId string | The identifier assigned to an item in its original external ERP system. Use this ID to track and look up data within the integrated system. Note that this value comes from the item’s ID in the external system.
Max length: 255 |
| externalSystem string | The name of the external ERP system integrated with Cost Management. Use this name to identify and search for data within the integrated system.
Max length: 255 |
| externalMessage string | A message generated by the external ERP system that explains the sync status of the integration. For example, common values include success or fail to indicate the result of the integration operation.
Max length: 255 |
| lastSyncTime datetime: ISO 8601 | The date and time when the item was last synchronized with the external ERP system. This value is updated by the external system and is in ISO 8601 format. |
| integrationState string,null | The state of the item during the integration with the external ERP system (such as SignNow). An item can be a budget, contract, main contract, main contract item, cost item, expense, expense item, change order, or schedule of value. For more details, see Integrate with External System tutorial.
Possible values:
For more information regarding integrations within the Cost Management system, see Integrations in Cost Management. |
| integrationStateChangedAt string,null | The date and time that the item’s integration status was last changed. |
| integrationStateChangedBy string,null | The user who last changed the integration status. This is the ID of a user managed by the BIM 360/ACC Admin. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/payment-items?limit=100&sort=name,createdAt desc' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 0,
"totalResults": 1,
"nextUrl": ""
},
"results": [
{
"id": "a2e16076-d5bb-44b3-b451-fb1fb390e4fc",
"paymentId": "18d97ae0-9484-11e8-a7ec-7ddae203e404",
"parentId": "18d97ae0-9484-11e8-a7ec-7ddae203e404",
"budgetId": "48934441-e392-49d7-bf58-8dea43d413ae",
"associationType": "Contract",
"associationId": "18d97ae0-9484-11e8-a7ec-7ddae203e404",
"name": "INSURANCE",
"description": "The description of the payment item.",
"position": 1,
"exchangeRate": "1.0000",
"originalExchangeRate": "1.0000",
"previousExchangeRate": "1.0000",
"originalQuantity": 100,
"originalUnitPrice": "1000.0000",
"originalAmount": "1000.0000",
"budgetTransfersQuantity": 100,
"budgetTransfersUnitPrice": "1000.0000",
"budgetTransfers": "1000.0000",
"previousAmount": "1000.0000",
"previousAmountForeignCurrency": "1000.0000",
"previousQuantity": 2000,
"previousUnitPrice": "1000.0000",
"previousMaterials": "1000.0000",
"previousMaterialsOnStore": "1000.0000",
"previousMaterialsBilled": "1000.0000",
"previousMaterialsBilledForeignCurrency": "1000.0000",
"previousMaterialsBilledUnitPrice": "1000.0000",
"previousMaterialsBilledQuantity": 100,
"previousMaterialsBilledUnit": "LS",
"quantity": 100,
"unitPrice": "1000.0000",
"unit": "LS",
"amount": "1000.0000",
"materials": "1000.0000",
"materialsOnStore": "1000.0000",
"materialsOnStoreQuantity": 100,
"materialsOnStoreUnit": "LS",
"materialsOnStoreUnitPrice": "1000.0000",
"materialsBilled": "1000.0000",
"materialsBilledQuantity": 100,
"materialsBilledUnit": "LS",
"materialsBilledUnitPrice": "1000.0000",
"previousCompletedWorkRetained": "1000.0000",
"previousCompletedWorkRetainedForeignCurrency": "1000.0000",
"currentCompletedWorkRetentionPercent": 0.3,
"currentCompletedWorkRetention": "1000.0000",
"currentCompletedWorkRetentionForeignCurrency": "1000.0000",
"completedWorkRetentionPercent": 0.3,
"completedWorkRetention": "1000.0000",
"completedWorkRetainedPercent": 0.3,
"completedWorkReleased": "1000.0000",
"previousMaterialsRetained": "1000.0000",
"previousMaterialsRetainedForeignCurrency": "1000.0000",
"currentMaterialsRetentionPercent": 0.1,
"currentMaterialsRetention": "1000.0000",
"currentMaterialsRetentionForeignCurrency": "1000.0000",
"materialsOnStoreRetentionPercent": 0.1,
"materialsRetentionPercent": "0.1",
"materialsRetainedPercent": 0.1,
"materialsRetention": "1000.0000",
"totalRetentionPercent": 0.2,
"totalRetainedPercent": 0.3,
"materialsOnStoreReleased": "1000.0000",
"materialsReleased": "1000.0000",
"netAmount": "1000.0000",
"netAmountForeignCurrency": "1000.0000",
"previousNetAmount": "1000.0000",
"realizedGainOrLoss": "1000.0000",
"claimedQuantity": 100,
"claimedUnitPrice": "1000.0000",
"claimedAmount": "1000.0000",
"previousClaimedQuantity": 100,
"previousClaimedUnitPrice": "1000.0000",
"previousClaimedAmount": "1000.0000",
"previousClaimedAmountForeignCurrency": "1000.0000",
"advanceAmount": "1000.0000",
"advancePercent": 0.1,
"previousAdvanceAmount": "1000.0000",
"previousAdvanceAmountForeignCurrency": "1000.0000",
"recoupmentAmount": "1000.0000",
"recoupmentPercentOfCompletedWork": 0.1,
"previousRecoupmentAmount": "1000.0000",
"previousRecoupmentAmountForeignCurrency": "1000.0000",
"creatorId": "CED9LVTLHNXV",
"changedBy": "CED9LVTLHNXV",
"status": "rejected",
"lastReviewedBy": "CED9LVTLHNXV",
"hasComment": true,
"canDelete": true,
"isPrivate": false,
"aggregateBy": "workCompleted",
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z",
"externalId": "10010-99-AB",
"externalSystem": "Sage300",
"externalMessage": "Success.",
"lastSyncTime": "2019-09-05T01:00:12.989Z",
"integrationState": "locked",
"integrationStateChangedAt": "2019-09-05T01:00:12.989Z",
"integrationStateChangedBy": "CED9LVTLHNXV"
}
]
}
Show More
