Terms

An Accounts Payable term is a rule that a vendor establishes for extending credit to your company. Terms can be associated with transactions or with specific vendors.

List terms

get/objects/accounts-payable/term

Returns up to 100 object references from the collection with a key, ID, and link for each term. 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": "15",
      • "id": "Net40",
      • "href": "/objects/accounts-payable/term/15"
      },
    • {
      • "key": "17",
      • "id": "N40_G",
      • "href": "/objects/accounts-payable/term/17"
      },
    • {
      • "key": "9",
      • "id": "N30",
      • "href": "/objects/accounts-payable/term/9"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a term
post/objects/accounts-payable/term
Creates a new term.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique identifier for the AP term.


 
 Example:  "Net 60"
description
required
string
A note about the purpose and use of the AP term.


 
 Example:  "60 Days term"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Define the calculation for the due date by specifying the number of days and either the date or month to reference.


 
days
integer
The number of days used to calculate the due date.


 
 Example:  60
from
string or null
 Default:  null
The date or month to reference to calculate the due date.


 Enum: "afterEndOfMonthOfBillDate" "fromBillDate" "fromBillDateExtendingToEom" null "of2ndMonthFromBillDate" "of3rdMonthFromBillDate" "of4thMonthFromBillDate" "of5thMonthFromBillDate" "of6thMonthFromBillDate" "ofNextMonthFromBillDate" "ofTheMonthOfBillDate"  
 Example:  "fromBillDate"
object
Terms of the discount extended by the vendor.


 
days
integer
Number of days from the specified date that the discount is valid.


 
 Example:  30
amount
string <decimal-precision-2> 
Amount of the discount.


 
 Example:  "4"
from
string or null
 Default:  null
Date used to determine if the discount is valid.


 Enum: "afterEndOfMonthOfBillDate" "fromBillDate" "fromBillDateExtendingToEom" null "of2ndMonthFromBillDate" "of3rdMonthFromBillDate" "of4thMonthFromBillDate" "of5thMonthFromBillDate" "of6thMonthFromBillDate" "ofNextMonthFromBillDate" "ofTheMonthOfBillDate"  
 Example:  "fromBillDate"
unit
string or null
 Default:  null
Type of discount.


 Enum: "amount" null "percentage"  
 Example:  "amount"
graceDays
integer
Number of days before the vendor withdraws the discount.


 
 Example:  6
calculateOn
string or null
 Default:  null
The total to use when calculating the discount.


 Enum: "billTotal" "lineItemsTotal" null  
 Example:  "billTotal"
object
Penalty for paying after the due date.


 
cycle
string or null
 Default:  null
The time span in which the penalty accrues.


 Enum: "annually" "bimonthly" "biweekly" "daily" "halfYearly" "monthly" "noPenalty" null "quarterly" "weekly"  
 Example:  "daily"
amount
string <decimal-precision-2> 
The penalty amount.


 
 Example:  "10"
unit
string or null
 Default:  null
Type of penalty.


 Enum: "amount" null "percentage"  
 Example:  "amount"
graceDays
integer
The number of days after the due date that the vendor applies the penalty.


 
 Example:  1
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "N500",
  • "description": "60 Days term",
  • "status": "active",
  • "due": {
    • "days": 2,
    • "from": "of5thMonthFromBillDate"
    },
  • "discount": {
    • "days": 1,
    • "from": "of3rdMonthFromBillDate",
    • "amount": 10,
    • "unit": "amount",
    • "graceDays": 15,
    • "calculateOn": "billTotal"
    },
  • "penalty": {
    • "cycle": "quarterly",
    • "amount": 101,
    • "unit": "amount",
    • "graceDays": 16
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "27",
    • "id": "N500",
    • "href": "/objects/accounts-payable/term/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a term
get/objects/accounts-payable/term/{key}
Returns detailed information for a specified term.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the term.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "N500",
    • "description": "60 Days term",
    • "status": "active",
    • "key": "27",
    • "audit": {
      • "modifiedDateTime": "2023-04-19T17:05:02Z",
      • "createdDateTime": "2023-04-19T16:53:48Z",
      • "modifiedBy": "39",
      • "createdBy": "39"
      },
    • "due": {
      • "days": 2,
      • "from": "of5thMonthFromBillDate"
      },
    • "discount": {
      • "days": 1,
      • "from": "of3rdMonthFromBillDate",
      • "amount": 10,
      • "unit": "percentage",
      • "graceDays": 15,
      • "calculateOn": "billTotal"
      },
    • "penalty": {
      • "cycle": "quarterly",
      • "amount": 10.5,
      • "unit": "percentage",
      • "graceDays": 16
      },
    • "href": "/objects/accounts-payable/term/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a term
patch/objects/accounts-payable/term/{key}
Updates an existing term by setting field values. Any fields not provided remain unchanged.
Updating a term already applied to bills may affect payment scheduling for those bills. Existing bills are not updated with edited term information. To update term information for an existing bill, reverse and resubmit the bill.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the term.


 
 Example:  99
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
description
string
A note about the purpose and use of the AP term.


 
 Example:  "60 Days term"
object
Define the calculation for the due date by specifying the number of days and either the date or month to reference.


 
days
integer
The number of days used to calculate the due date.


 
 Example:  60
from
string or null
 Default:  null
The date or month to reference to calculate the due date.


 Enum: "afterEndOfMonthOfBillDate" "fromBillDate" "fromBillDateExtendingToEom" null "of2ndMonthFromBillDate" "of3rdMonthFromBillDate" "of4thMonthFromBillDate" "of5thMonthFromBillDate" "of6thMonthFromBillDate" "ofNextMonthFromBillDate" "ofTheMonthOfBillDate"  
 Example:  "fromBillDate"
object
Terms of the discount extended by the vendor.


 
days
integer
Number of days from the specified date that the discount is valid.


 
 Example:  30
amount
string <decimal-precision-2> 
Amount of the discount.


 
 Example:  "4"
from
string or null
 Default:  null
Date used to determine if the discount is valid.


 Enum: "afterEndOfMonthOfBillDate" "fromBillDate" "fromBillDateExtendingToEom" null "of2ndMonthFromBillDate" "of3rdMonthFromBillDate" "of4thMonthFromBillDate" "of5thMonthFromBillDate" "of6thMonthFromBillDate" "ofNextMonthFromBillDate" "ofTheMonthOfBillDate"  
 Example:  "fromBillDate"
unit
string or null
 Default:  null
Type of discount.


 Enum: "amount" null "percentage"  
 Example:  "amount"
graceDays
integer
Number of days before the vendor withdraws the discount.


 
 Example:  6
calculateOn
string or null
 Default:  null
The total to use when calculating the discount.


 Enum: "billTotal" "lineItemsTotal" null  
 Example:  "billTotal"
object
Penalty for paying after the due date.


 
cycle
string or null
 Default:  null
The time span in which the penalty accrues.


 Enum: "annually" "bimonthly" "biweekly" "daily" "halfYearly" "monthly" "noPenalty" null "quarterly" "weekly"  
 Example:  "daily"
amount
string <decimal-precision-2> 
The penalty amount.


 
 Example:  "10"
unit
string or null
 Default:  null
Type of penalty.


 Enum: "amount" null "percentage"  
 Example:  "amount"
graceDays
integer
The number of days after the due date that the vendor applies the penalty.


 
 Example:  1
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "penalty": {
    • "amount": 10.5
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "27",
    • "id": "N500",
    • "href": "/objects/accounts-payable/term/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a term
delete/objects/accounts-payable/term/{key}
Deletes a term.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the term.


 
 Example:  99
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
    }
}