AR releasable retainage

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

List AR releasable retainage

get/objects/construction/ar-releasable-retainage

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


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


 
 Example:  2902
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "2902",
    • "key": "2902",
    • "retainageInvoiceLine": {
      • "id": "2902",
      • "key": "2902",
      • "href": "/objects/accounts-receivable/invoice-line/2902"
      },
    • "retainageInvoice": {
      • "id": "450",
      • "key": "450",
      • "href": "/objects/accounts-receivable/invoice/450"
      },
    • "lineNumber": 3,
    • "invoiceLineAmount": "188220.00",
    • "txnInvoiceLineAmount": "188220.00",
    • "amountRetained": "18822.00",
    • "txnAmountRetained": "18822.00",
    • "txnTotalReleased": "0.00",
    • "txnAmountRemaining": "18822.00",
    • "documentLineKey": "1199",
    • "department": {
      • "key": "9",
      • "id": "Maintenance",
      • "href": "/objects/company-config/department/9"
      },
    • "location": {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/location/1"
      },
    • "projectContract": {
      • "id": "ST-001",
      • "key": "16",
      • "href": "/objects/construction/project-contract/16"
      },
    • "projectContractLine": {
      • "id": "Concrete",
      • "key": "29",
      • "href": "/objects/construction/project-contract-line/29"
      },
    • "href": "/objects/construction/ar-releasable-retainage/2902"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}