AP retainage release lines

Line item in an AP retainage release. Create and maintain retainage release lines from the owning AP retainage release object.

List AP retainage release lines

get/objects/construction/ap-retainage-release-line

Returns up to 100 object references from the collection with a key, ID, and link for each AP retainage release line object. This operation is mostly for use in testing; use query 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-retainage-release-line/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/construction/ap-retainage-release-line/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/construction/ap-retainage-release-line/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an AP retainage release line
get/objects/construction/ap-retainage-release-line/{key}
Returns detailed information for a specified AP retainage release line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the AP retainage release line.


 
 Example:  7
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "7",
    • "apRetainageRelease": {
      • "id": "2",
      • "key": "2",
      • "href": "/objects/construction/ap-retainage-release/2"
      },
    • "purchasingDocument": {
      • "key": "11",
      • "id": "Subcontract Invoice-SUBINV#0106#doc",
      • "href": "/objects/purchasing/document/11"
      },
    • "retainageBill": {
      • "key": "1",
      • "id": "SUBINV#0106#doc",
      • "href": "/objects/accounts-payable/bill/1"
      },
    • "retainageBillLine": {
      • "id": "1",
      • "key": "1",
      • "href": "/objects/accounts-payable/bill-line/1"
      },
    • "txnAmountReleased": "500.00",
    • "releasedBill": {
      • "key": "11",
      • "id": "APRET-00002",
      • "href": "/objects/accounts-payable/bill/11"
      },
    • "releasedBillLine": {
      • "id": "45",
      • "key": "45",
      • "href": "/objects/accounts-payable/bill-line/45"
      },
    • "audit": {
      • "createdDateTime": "2025-04-04T00:00:00Z",
      • "modifiedDateTime": "2025-04-04T00:00:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/construction/ap-retainage-release-line/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query AP retainage release lines
post/services/core/query
Use the query service to find AP retainage release lines that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}