AP releasable retainage

An AP releasable retainage has information about which records can be released.

List AP releasable retainage

get/objects/construction/ap-releasable-retainage

Returns up to 100 object references from the collection with a key, ID, and link for each AP releasable retainage object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/construction/ap-releasable-retainage/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/construction/ap-releasable-retainage/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/construction/ap-releasable-retainage/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an AP releasable retainage
get/objects/construction/ap-releasable-retainage/{key}
Returns detailed information for a specified AP releasable retainage.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the AP releasable retainage.


 
 Example:  195
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1",
    • "key": "1",
    • "retainageBillLine": {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/accounts-payable/bill-line/1"
      },
    • "retainageBill": {
      • "id": "15",
      • "key": "15",
      • "href": "/objects/accounts-payable/bill/15"
      },
    • "lineNumber": 1,
    • "billLineAmount": "10000.00",
    • "txnBillLineAmount": "10000.00",
    • "amountRetained": "1000.00",
    • "txnAmountRetained": "1000.00",
    • "txnTotalReleased": "500.00",
    • "txnAmountRemaining": "500.00",
    • "documentLineKey": "14",
    • "department": {
      • "key": "9",
      • "id": "Forecasting",
      • "href": "/objects/company-config/department/9"
      },
    • "primaryDocument": {
      • "key": "2",
      • "id": "Subcontract-SUB-00002",
      • "href": "/objects/order-entry/document/2"
      },
    • "primaryDocumentLine": {
      • "key": "2",
      • "id": "1--Subcontract",
      • "href": "/objects/order-entry/document-line/2"
      },
    • "href": "/objects/construction/ap-releasable-retainage/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}