metadata
title: AP Terms | Sage Intacct Developer
url: https://developer.intacct.com/api/accounts-payable/ap-terms/
AP Terms | Sage Intacct Developer
- Get AP Term Object Definition
- Query and List AP Terms
- Query and List AP Terms (Legacy)
- Get AP Term
- Get AP Term by ID
- Create AP Term (Legacy)
- Update AP Term (Legacy)
- Delete AP Term (Legacy)
An AP term is a rule (such as net 30) that a vendor establishes for extending credit to your company. AP terms can be associated with AP transactions or with specific vendors.
Get AP Term Object Definition
lookup
List all the fields and relationships for the AP term object:
<lookup>
<object>APTERM</object>
</lookup>
Parameters
| Name |
Required |
Type |
Description |
| object |
Required |
string |
Use APTERM |
Query and List AP Terms
query
List information about each AP term:
<query>
<object>APTERM</object>
<select>
<field>RECORDNO</field>
<field>DESCRIPTION</field>
<field>DUEDATE</field>
<field>DUEFROM</field>
</select>
</query>
Parameters
| Name |
Required |
Type |
Description |
| object |
Required |
string |
Use APTERM |
| filter |
Optional |
object |
Filter expression to limit the response to only objects that match the 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). |
| select |
Required |
sequence |
The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported. |
| 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 |
Query options: * 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> * Specify the returnformat for the response: xml (default), json, or csv <returnformat>json</returnformat> |
| pagesize |
Optional |
integer |
Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100) |
| offset |
Optional |
integer |
Point at which to start indexing into records (Default: 0) |
Query and List AP Terms (Legacy)
readByQuery
<readByQuery>
<object>APTERM</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery>
Parameters
| Name |
Required |
Type |
Description |
| object |
Required |
string |
Use APTERM |
| 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 Term
read
<read>
<object>APTERM</object>
<keys>1</keys>
<fields>*</fields>
</read>
Parameters
| Name |
Required |
Type |
Description |
| object |
Required |
string |
Use APTERM |
| keys |
Required |
string |
Comma-separated list of object RECORDNO to get |
| fields |
Optional |
string |
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields. |
| returnFormat |
Optional |
string |
Data format for the response body: * xml (default) * json * csv |
Get AP Term by ID
readByName
<readByName>
<object>APTERM</object>
<keys>N15</keys>
<fields>*</fields>
</readByName>
Parameters
| Name |
Required |
Type |
Description |
| object |
Required |
string |
Use APTERM |
| keys |
Required |
string |
Comma-separated list of object NAME to get |
| fields |
Optional |
string |
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields. |
| returnFormat |
Optional |
string |
Data format for the response body: * xml (default) * json * csv |
Create AP Term (Legacy)
create_apterm
<create_apterm>
<name>2-10 N30</name>
<description>2%/10 net 30</description>
<due>
<dueday>30</dueday>
<duefrom>from invoice/bill date</duefrom>
</due>
<discount>
<discday>10</discday>
<discfrom>from invoice/bill date</discfrom>
<discamount>2</discamount>
<discpercamn>%</discpercamn>
<discgracedays></discgracedays>
</discount>
<disccalcon>Line items total</disccalcon>
<penalty>
<pen_type>Weekly</pen_type>
<penamount>1</penamount>
<penpercamn>%</penpercamn>
<pengracedays></pengracedays>
</penalty>
</create_apterm>
Parameters
| Name |
Required |
Type |
Description |
| name |
Required |
string |
Term name |
| description |
Optional |
string |
Description |
| status |
Optional |
string |
Term status. Use active for Active otherwise use inactive for Inactive. (Default: active) |
| due |
Optional |
object |
Due |
| discount |
Optional |
object |
Discount |
| disccalcon |
Optional |
string |
Calculate discount on. Use either Line items total or Bill total. (Default: Bill total). |
| penalty |
Optional |
object |
Penalty |
due
| Name |
Required |
Type |
Description |
| dueday |
Optional |
integer |
Due day |
| duefrom |
Optional |
string |
Due from. Use from invoice/bill date, of the month of invoice/bill date, of next month from invoice/bill date, of 2nd month from invoice/bill date, of 3rd month from invoice/bill date, of 4th month from invoice/bill date, of 5th month from invoice/bill date, or of 6th month from invoice/bill date. (Default: from invoice/bill date). |
discount
| Name |
Required |
Type |
Description |
| discday |
Optional |
integer |
Discount day |
| discfrom |
Optional |
string |
Due from. Use from invoice/bill date, of the month of invoice/bill date, of next month from invoice/bill date, of 2nd month from invoice/bill date, of 3rd month from invoice/bill date, of 4th month from invoice/bill date, of 5th month from invoice/bill date, or of 6th month from invoice/bill date. (Default: from invoice/bill date). |
| discamount |
Optional |
currency |
Discount amount |
| discpercamn |
Optional |
number |
Discount amount type. Use either $ or %. (Default: $) |
| discgracedays |
Optional |
integer |
Discount grace days |
penalty
| Name |
Required |
Type |
Description |
| pen_type |
Optional |
string |
Cycle. Use No Penalty, Daily, Weekly, Biweekly, Monthly, Bimonthly, Quarterly, Half yearly, or Annually. (Default: No Penalty) |
| penamount |
Optional |
currency |
Penalty amount |
| penpercamn |
Optional |
number |
Penalty percent. Use either $ or %. (Default: $) |
| pengracedays |
Optional |
integer |
Penalty grace days |
Update AP Term (Legacy)
update_apterm
<update_apterm name="2-10 N30">
<description>2% discount if paid in 10 days, otherwise due in 30 days</description>
</update_apterm>
Parameters
| Name |
Required |
Type |
Description |
| name |
Required |
string |
Term name to update |
| description |
Optional |
string |
Description |
| status |
Optional |
string |
Term status. Use active for Active otherwise use inactive for Inactive. |
| due |
Optional |
object |
Due |
| discount |
Optional |
object |
Discount |
| disccalcon |
Optional |
string |
Calculate discount on. Use either Line items total or Bill total. |
| penalty |
Optional |
object |
Penalty |
due
| Name |
Required |
Type |
Description |
| dueday |
Optional |
integer |
Due day |
| duefrom |
Optional |
string |
Due from. Use from invoice/bill date, of the month of invoice/bill date, of next month from invoice/bill date, of 2nd month from invoice/bill date, of 3rd month from invoice/bill date, of 4th month from invoice/bill date, of 5th month from invoice/bill date, or of 6th month from invoice/bill date. |
discount
| Name |
Required |
Type |
Description |
| discday |
Optional |
integer |
Discount day |
| discfrom |
Optional |
string |
Due from. Use from invoice/bill date, of the month of invoice/bill date, of next month from invoice/bill date, of 2nd month from invoice/bill date, of 3rd month from invoice/bill date, of 4th month from invoice/bill date, of 5th month from invoice/bill date, or of 6th month from invoice/bill date. |
| discamount |
Optional |
currency |
Discount amount |
| discpercamn |
Optional |
number |
Discount amount type. Use either $ or %. |
| discgracedays |
Optional |
integer |
Discount grace days |
penalty
| Name |
Required |
Type |
Description |
| pen_type |
Optional |
string |
Cycle. Use No Penalty, Daily, Weekly, Biweekly, Monthly, Bimonthly, Quarterly, Half yearly, or Annually. |
| penamount |
Optional |
currency |
Penalty amount |
| penpercamn |
Optional |
number |
Penalty percent. Use either $ or %. |
| pengracedays |
Optional |
integer |
Penalty grace days |
Delete AP Term (Legacy)
delete_apterm
<delete_apterm name="2-10 N30"></delete_apterm>
Parameters
| Name |
Required |
Type |
Description |
| name |
Required |
string |
Term name to delete |
Provide feedback
