5.331 Fields: Liens
See the associated Accounting Liens resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | accounting/liens | Permissions |
| Hooks filename | accounting.liens.groovy | Pre- and Post-Processing Hooks |
| Distinct query-supported | No | Distinct |
API version 3
A lien is a reservation or hold placed against an allocation. Before usage of a resource or service begins, a lien is placed against one or more allocations within the requesting user's applicable funds. Subsequent usage requests will also post liens while the available balance (active allocations minus liens) allows. When the usage ends, the lien is removed and the actual charge is made to the allocation(s). This procedure ensures that usage will only be permitted so long as the requestors have sufficient funds.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique lien identifier |
| allocations | Set<LienAllocation> |
The allocation amounts reserved with this lien. |
| creationTime | Date |
The date this lien was created |
| deleted | Boolean |
A boolean indicating whether this lien is deleted or not |
| description | String |
The lien description |
| duration | Long |
The expected duration of the reserved usage in seconds |
| endTime | Date |
The time the lien becomes inactive |
| instance | String |
The lien is against the specified instance (i.e. job id) |
| modificationTime | Date |
The date this lien was last modified |
| requestId | Long |
The id of the last modifying request |
| startTime | Date |
The time the lien becomes active |
| transactionId | Long |
The id of the last modifying transaction |
| usageRecord | Long |
The id of the usage record associated with the lien and containing the usage properties |
Amounts of the allocations that the lien has holds against
API version 2
A lien is a reservation or hold placed against an allocation. Before usage of a resource or service begins, a lien is placed against one or more allocations within the requesting user's applicable funds. Subsequent usage requests will also post liens while the available balance (active allocations minus liens) allows. When the usage ends, the lien is removed and the actual charge is made to the allocation(s). This procedure ensures that usage will only be permitted so long as the requestors have sufficient funds.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique lien identifier |
| allocations | Set<LienAllocation> |
The allocation amounts reserved with this lien. |
| creationTime | Date |
The date this lien was created |
| deleted | Boolean |
A boolean indicating whether this lien is deleted or not |
| description | String |
The lien description |
| duration | Long |
The expected duration of the reserved usage in seconds |
| endTime | Date |
The time the lien becomes inactive |
| instance | String |
The lien is against the specified instance (i.e. job id) |
| modificationTime | Date |
The date this lien was last modified |
| requestId | Long |
The id of the last modifying request |
| startTime | Date |
The time the lien becomes active |
| transactionId | Long |
The id of the last modifying transaction |
| usageRecord | Long |
The id of the usage record associated with the lien and containing the usage properties |
Amounts of the allocations that the lien has holds against
Related Topics