AR retainage release lines

AR retainage release line - detail of the AR retainage release.

List AR retainage release lines

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

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


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


 
 Example:  2902
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "7",
    • "arRetainageRelease": {
      • "id": "60",
      • "key": "60",
      • "href": "/objects/construction/ar-retainage-release/60"
      },
    • "salesOrderDocument": {
      • "key": "490",
      • "id": "Project contract invoice-PCI-00151",
      • "href": "/objects/order-entry/document/490"
      },
    • "retainageInvoice": {
      • "key": "443",
      • "id": "PCI-00151",
      • "href": "/objects/accounts-receivable/invoice/443"
      },
    • "retainageInvoiceLine": {
      • "id": "2870",
      • "key": "2870",
      • "href": "/objects/accounts-receivable/invoice-line/2870"
      },
    • "txnAmountReleased": "17500.00",
    • "releasedInvoice": {
      • "key": "451",
      • "id": "ARRET-00040",
      • "href": "/objects/accounts-receivable/invoice/451"
      },
    • "releasedInvoiceLine": {
      • "id": "2908",
      • "key": "2908",
      • "href": "/objects/accounts-receivable/invoice-line/2908"
      },
    • "audit": {
      • "createdDateTime": "2025-02-28T00:00:00Z",
      • "modifiedDateTime": "2025-02-28T00:00:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "projectContract": {
      • "id": "ST-001",
      • "key": "16",
      • "href": "/objects/construction/project-contract/16"
      },
    • "projectContractLine": {
      • "id": "1",
      • "key": "28",
      • "href": "/objects/construction/project-contract-line/28"
      },
    • "href": "/objects/construction/ar-retainage-release-line/178"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query AR retainage release lines
post/services/core/query
Use the query service to find AR 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
    }
}
Feedback