AP retainage releases

On an AP bill that has retainage, an AP retainage release is used to release that retainage for payment.

List AP retainage releases

get/objects/construction/ap-retainage-release

Returns up to 100 object references from the collection with a key, ID, and link for each AP retainage release 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-retainage-release/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/construction/ap-retainage-release/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/construction/ap-retainage-release/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an AP retainage release
post/objects/construction/ap-retainage-release
Creates a new AP retainage release with lines.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
AP retainage release object to create.


description
required
string or null
Description of AP retainage release.


 
 Example:  "October retainage release"
releaseDate
string <date> 
Release date.


 
 Example:  "2025-01-23"
glPostingDate
string <date> 
GL posting date.


 
 Example:  "2025-01-23"
state
string
 Default:  "draft"
State.


 Enum: "draft" "released" "reversal"  
 Example:  "draft"
object
Vendor to whom the retainage is being released.


 
key
string or null
Vendor key.


 
 Example:  "72"
id
string or null
Vendor ID.


 
 Example:  "Arthur Bates"
object
Project associated with the AP retainage release.


 
key
string or null
Project key.


 
 Example:  "2"
id
string or null
Project ID.


 
 Example:  "NET-XML30-2"
Array of objects
Array of AP retainage release lines.


 
 Array 
txnAmountReleased
string <decimal-precision-2> 
The amount to release in transaction currency.


 
 Example:  "123.45"
object
Reference to the retainage bill.


 
object
Reference to the retainage bill line.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "19",
  • "description": "AP ret rel desc 101",
  • "releaseDate": "2025-03-02",
  • "glPostingDate": "2025-03-02",
  • "state": "draft",
  • "apRetainageReleaseLines": [
    • {
      • "txnAmountReleased": "123.00",
      • "retainageBill": {
        },
      • "retainageBillLine": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/construction/ap-retainage-release/4"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an AP retainage release
get/objects/construction/ap-retainage-release/{key}
Returns detailed information for a specified AP retainage release.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an AP retainage release.


 
 Example:  195
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "2",
    • "key": "2",
    • "description": "Release A-1 Electric retainage",
    • "releaseDate": "2025-03-21",
    • "glPostingDate": "2025-03-21",
    • "state": "released",
    • "audit": {
      • "createdDateTime": "2025-04-04T00:00:00Z",
      • "modifiedDateTime": "2025-04-04T00:00:00Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": "46",
      • "id": "CORP",
      • "name": "Corp",
      • "href": "/objects/company-config/entity/46"
      },
    • "apRetainageReleaseLines": [
      • {
        }
      ],
    • "href": "/objects/construction/ap-retainage-release/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an AP retainage release
patch/objects/construction/ap-retainage-release/{key}
Updates an existing AP retainage release by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an AP retainage release.


 
 Example:  195
Request Body schema: application/json
description
string or null
Description of AP retainage release.


 
 Example:  "October retainage release"
releaseDate
string <date> 
Release date.


 
 Example:  "2025-01-23"
glPostingDate
string <date> 
GL posting date.


 
 Example:  "2025-01-23"
state
string
 Default:  "draft"
State.


 Enum: "draft" "released" "reversal"  
 Example:  "draft"
object
Vendor to whom the retainage is being released.


 
key
string or null
Vendor key.


 
 Example:  "72"
id
string or null
Vendor ID.


 
 Example:  "Arthur Bates"
object
Project associated with the AP retainage release.


 
key
string or null
Project key.


 
 Example:  "2"
id
string or null
Project ID.


 
 Example:  "NET-XML30-2"
Array of objects
Array of AP retainage release lines.


 
 Array 
txnAmountReleased
string <decimal-precision-2> 
The amount to release in transaction currency.


 
 Example:  "123.45"
object
Reference to the retainage bill.


 
object
Reference to the retainage bill line.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "releaseDate": "2025-04-01",
  • "glPostingDate": "2025-04-01"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "4",
    • "href": "/objects/construction/ap-retainage-release/4"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an AP retainage release
delete/objects/construction/ap-retainage-release/{key}
Deletes an AP retainage release.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an AP retainage release.


 
 Example:  195
Responses 
204
No Content


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
    }
}