AP Retainage Releases
- Get AP Retainage Release Object Definition
- List AP Retainage Releases
- List AP Bill Lines with Retainages
- List AP Retainage Releases (Legacy)
- Get AP Retainage Release
- Create AP Retainage Release
- Update AP Retainage Release
- Delete AP Retainage Release
- Get AP Retainage Release Entry Object Definition
- List AP Retainage Release Entries
- List AP Retainage Release Entries (Legacy)
- Get AP Retainage Release Entry
This object lets you release amounts retained on AP bills until completion of a construction project.
After the details have been satisfactorily addressed by both the project owner and the construction company, you create a retainage release for the amount still owed to the vendor/subcontractor. You can release some or all of the owed retainages if there are still outstanding issues.
You must configure retainage in your company as described in the Sage Intacct product help.
Get AP Retainage Release Object Definition
lookup
List all the fields and relationships for the AP retainage release object:
<lookup>
<object>APRETAINAGERELEASE</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASE |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List AP Retainage Releases
query
List the record number, description, and release date for each retainage release where the release date is between the given dates:
<query>
<object>APRETAINAGERELEASE</object>
<select>
<field>RECORDNO</field>
<field>DESCRIPTION</field>
<field>RELEASEDATE</field>
</select>
<filter>
<between>
<field>RELEASEDATE</field>
<value>01/01/2020</value>
<value>03/01/2020</value>
</between>
</filter>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASE |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List AP Bill Lines with Retainages
query
For each AP bill line for the given vendor, provide its record number, the record number of the owning bill, and the amount released and retained for that line.
<query>
<object>APBILLITEM</object>
<select>
<field>RECORDNO</field>
<field>APBILL.RECORDNO</field>
<field>VENDORID</field>
<field>TRX_AMOUNTRETAINED</field>
<field>TRX_AMOUNTRELEASED</field>
</select>
<filter>
<and>
<isnotnull>
<field>TRX_AMOUNTRETAINED</field>
</isnotnull>
<notequalto>
<field>TRX_AMOUNTRETAINED</field>
<value>0</value>
</notequalto>
</and>
</filter>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APBILLENTRY |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
Response
The above function returns data structured like this:
<data listtype="APBILLITEM" totalcount="45" offset="0" count="45" numremaining="0">
<APBILLITEM>
<RECORDNO>134</RECORDNO>
<APBILL.RECORDNO>40</APBILL.RECORDNO>
<VENDORID>V100</VENDORID>
<TRX_AMOUNTRETAINED>500</TRX_AMOUNTRETAINED>
<TRX_AMOUNTRELEASED>375</TRX_AMOUNTRELEASED>
</APBILLITEM>
<APBILLITEM>
<RECORDNO>1</RECORDNO>
<APBILL.RECORDNO>1</APBILL.RECORDNO>
<VENDORID>V100</VENDORID>
<TRX_AMOUNTRETAINED>2000</TRX_AMOUNTRETAINED>
<TRX_AMOUNTRELEASED>2000</TRX_AMOUNTRELEASED>
</APBILLITEM>
</data>
List AP Retainage Releases (Legacy)
readByQuery
<readByQuery>
<object>APRETAINAGERELEASE</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASEENTRY |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get AP Retainage Release
read
<read>
<object>APRETAINAGERELEASE</object>
<keys>26</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASE |
keys | Required | string | RECORDNO of the AP retainage release to get |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Create AP Retainage Release
create
Create an AP retainage release for two bill line items:
<create>
<APRETAINAGERELEASE>
<DESCRIPTION>Release for Vendor V100</DESCRIPTION>
<RELEASEDATE>03/15/2020</RELEASEDATE>
<APRETAINAGERELEASEENTRIES>
<APRETAINAGERELEASEENTRY>
<RETAINAGEBILLKEY>40</RETAINAGEBILLKEY>
<RETAINAGEBILLITEMKEY>134</RETAINAGEBILLITEMKEY>
<TRX_AMOUNTRELEASED>125.00</TRX_AMOUNTRELEASED>
</APRETAINAGERELEASEENTRY>
</APRETAINAGERELEASEENTRIES>
</APRETAINAGERELEASE>
</create>
Parameters
Name | Required | Type | Description |
---|---|---|---|
APRETAINAGERELEASE |
Required | object | Object to create |
APRETAINAGERELEASE
Name | Required | Type | Description |
---|---|---|---|
DESCRIPTION | Required | string | Description for the AP retainage release |
RELEASEDATE | Optional | string | Release date in format mm/dd/yyyy (Default: Today’s date) |
GLPOSTINGDATE | Optional | string | GL posting date in format mm/dd/yyyy (Default: Release date) |
STATE | Optional | string | State for the retainage release. Use Draft or Released (Default: Draft ) |
APRETAINAGERELEASEENTRIES | Optional | APRETAINAGERELEASEENTRY[0 .. n] |
Array of retainage release entries, each of which corresponds with a bill line with retainages |
APRETAINAGERELEASEENTRY
Name | Required | Type | Description |
---|---|---|---|
RETAINAGEBILLKEY | Required | string | Bill record number with retainages to be released |
RETAINAGEBILLITEMKEY | Required | string | Bill line record number |
TRX_AMOUNTRELEASED | Required | currency | Amount to release |
Update AP Retainage Release
When updating an AP retainage release to modify the entries, be aware that it is a complete replacement of the existing set. So, to add an entry, supply all the original ones and the new one. To delete an entry, supply only the ones you want to keep.
update
<update>
<APRETAINAGERELEASE>
<RECORDNO>26</RECORDNO>
<APRETAINAGERELEASEENTRIES>
<APRETAINAGERELEASEENTRY>
<RETAINAGEINVOICEKEY>44</RETAINAGEINVOICEKEY>
<RETAINAGEINVOICEITEMKEY>146</RETAINAGEINVOICEITEMKEY>
<TRX_AMOUNTRELEASED>200</TRX_AMOUNTRELEASED>
</APRETAINAGERELEASEENTRY>
<APRETAINAGERELEASEENTRY>
<RETAINAGEINVOICEKEY>44</RETAINAGEINVOICEKEY>
<RETAINAGEINVOICEITEMKEY>148</RETAINAGEINVOICEITEMKEY>
<TRX_AMOUNTRELEASED>300</TRX_AMOUNTRELEASED>
</APRETAINAGERELEASEENTRY>
</APRETAINAGERELEASEENTRIES>
</APRETAINAGERELEASE>
</update>
Parameters
Name | Required | Type | Description |
---|---|---|---|
APRETAINAGERELEASE |
Required | object | Object to update |
APRETAINAGERELEASE
Name | Required | Type | Description |
---|---|---|---|
RECORDNO | Required | string | Record number for the AP retainage release to update |
RELEASEDATE | Optional | string | Release date in format mm/dd/yyyy |
GLPOSTINGDATE | Optional | string | GL posting date in format mm/dd/yyyy |
STATE | Optional | string | State for the retainage release. Use Draft or Released |
APRETAINAGERELEASEENTRIES | Optional | APRETAINAGERELEASEENTRY[0 .. n] |
Array of retainage release entries, each of which corresponds with a bill line with retainages. This a complete replacement of the existing set. |
APRETAINAGERELEASEENTRY
Name | Required | Type | Description |
---|---|---|---|
RETAINAGEBILLKEY | Required | string | Bill record number with retainages to be released |
RETAINAGEBILLITEMKEY | Required | string | Bill line record number |
TRX_AMOUNTRELEASED | Required | currency | Amount to release |
Delete AP Retainage Release
You can delete an AP retainage release that is in Draft
state.
delete
<delete>
<object>APRETAINAGERELEASE</object>
<keys>26</keys>
</delete>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASE |
keys | Required | string | RECORDNO of the APRETAINAGERELEASE to delete |
Get AP Retainage Release Entry Object Definition
lookup
List all the fields and relationships for the AP retainage release entry object:
<lookup>
<object>APRETAINAGERELEASEENTRY</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASEENTRY |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List AP Retainage Release Entries
query
List the record number and transaction amount released for each AP retainage release entry for the bill with record number 15:
<query>
<object>APRETAINAGERELEASEENTRY</object>
<select>
<field>RECORDNO</field>
<field>TRX_AMOUNTRELEASED</field>
<field>RETAINAGEBILLKEY</field>
</select>
<filter>
<equalto>
<field>RETAINAGEBILLKEY</field>
<value>15</value>
</equalto>
</filter>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASEENTRY |
select | Required | sequence | One or more field names and an optional aggregate function such as count or sum . Returning all fields is not supported. |
filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List AP Retainage Release Entries (Legacy)
readByQuery
<readByQuery>
<object>APRETAINAGERELEASEENTRY</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASEENTRY |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get AP Retainage Release Entry
read
<read>
<object>APRETAINAGERELEASEENTRY</object>
<keys>5</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use APRETAINAGERELEASEENTRY |
keys | Required | string | RECORDNO of the AP retainage release entry to get |
fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |