Terms

Accounts Receivable (AR) terms are the rules a company establishes for extending credit to customers. Terms can be associated with AR transactions and with customers.

List terms

get/objects/accounts-receivable/term

Returns a collection with a key, ID, and link for each AR 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": "5",
      • "id": "N15",
      • "href": "/objects/accounts-receivable/term/5"
      },
    • {
      • "key": "8",
      • "id": "N30",
      • "href": "/objects/accounts-receivable/term/8"
      },
    • {
      • "key": "9",
      • "id": "NET15",
      • "href": "/objects/accounts-receivable/term/9"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a term
post/objects/accounts-receivable/term
Creates a new AR term.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the term.


 
 Example:  "2% 10 Net 30"
description
required
string
Note about the purpose and use of the term.


 
 Example:  "2% discount if paid 10 days from invoice. Due on day 30."
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
The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in day, and set fromInvoiceDate in from.


 
days
integer or null
Number of days until the term is due.


 
 Example:  10
from
string or null
 Default:  null
The reference point from which to begin counting the number of days until the term is due.


 Enum: "afterEndOfMonthOfInvoiceDate" "fromInvoiceDate" "fromInvoiceDateExtendingToEom" null "of2ndMonthFromInvoiceDate" "of3rdMonthFromInvoiceDate" "of4thMonthFromInvoiceDate" "of5thMonthFromInvoiceDate" "of6thMonthFromInvoiceDate" "ofNextMonthFromInvoiceDate" "ofTheMonthOfInvoiceDate"  
 Example:  "fromInvoiceDate"
object
A discount is a combination of the days, what the days reference, the dollar or percent discount, and the number of grace days.


 
days
integer
Number of days until the discount goes into effect.


 
 Example:  2
amount
integer or null
Amount of the discount.


 
 Example:  5
from
string or null
 Default:  null
The reference point from which to begin counting the number of days until the discount goes into effect.


 Enum: "afterEndOfMonthOfInvoiceDate" "fromInvoiceDate" "fromInvoiceDateExtendingToEom" null "of2ndMonthFromInvoiceDate" "of3rdMonthFromInvoiceDate" "of4thMonthFromInvoiceDate" "of5thMonthFromInvoiceDate" "of6thMonthFromInvoiceDate" "ofNextMonthFromInvoiceDate" "ofTheMonthOfInvoiceDate"  
 Example:  "fromInvoiceDate"
unit
string or null
 Default:  null
The type of discount, which can be a dollar amount or a percentage.


 Enum: "amount" null "percentage"  
 Example:  "percentage"
graceDays
integer or null
Number of days before the discount is withdrawn.


 
 Example:  10
calculateOn
string
 Default:  "invoiceTotal"
How the system calculates discounts in transactions that use this term. The calculation can be based on the line item total, excluding added charges (such as shipping and taxes), or on the invoice total, including all charges.


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


 
cycle
string
 Default:  "noPenalty"
Time span in which the penalty accrues.


 Enum: "annually" "bimonthly" "biweekly" "daily" "halfYearly" "monthly" "noPenalty" null "quarterly" "weekly"  
 Example:  "weekly"
amount
integer or null
Amount of the penalty.


 
 Example:  5
unit
string or null
 Default:  null
The type of penalty, which can be a dollar amount or a percentage.


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


 
 Example:  15
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "2-10 Net 30",
  • "description": "N30 with discount",
  • "due": {
    • "days": 30,
    • "from": "fromInvoiceDate"
    },
  • "discount": {
    • "days": 4,
    • "amount": 2,
    • "from": "fromInvoiceDate",
    • "calculateOn": "lineItemsTotal",
    • "unit": "percentage",
    • "graceDays": 10
    },
  • "penalty": {
    • "cycle": "weekly",
    • "amount": 1,
    • "unit": "percentage",
    • "graceDays": 20
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "18",
    • "id": "2-10 Net 30",
    • "href": "/objects/accounts-receivable/term/18"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a term
get/objects/accounts-receivable/term/{key}
Returns detailed information for a specified term.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "2-10 Net 30",
    • "description": "N30 with discount",
    • "status": "active",
    • "key": "18",
    • "due": {
      • "days": 30,
      • "from": "fromInvoiceDate"
      },
    • "discount": {
      • "days": 4,
      • "from": "fromInvoiceDate",
      • "amount": 2,
      • "unit": "percentage",
      • "graceDays": 10,
      • "calculateOn": "lineItemsTotal"
      },
    • "penalty": {
      • "cycle": "weekly",
      • "amount": 1,
      • "unit": "percentage",
      • "graceDays": 20
      },
    • "audit": {
      • "modifiedDateTime": "2024-03-06T09:23:41Z",
      • "createdDateTime": "2024-03-06T09:23:41Z",
      • "modifiedBy": "1",
      • "createdBy": "1"
      },
    • "href": "/objects/accounts-receivable/term/18"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a term
patch/objects/accounts-receivable/term/{key}
Updates an existing AR term by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique 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
Note about the purpose and use of the term.


 
 Example:  "2% discount if paid 10 days from invoice. Due on day 30."
object
The due date is a combination of a number of days and a reference point. For example, to set terms that reference the number of days from the invoice date, set the number of days in day, and set fromInvoiceDate in from.


 
days
integer or null
Number of days until the term is due.


 
 Example:  10
from
string or null
 Default:  null
The reference point from which to begin counting the number of days until the term is due.


 Enum: "afterEndOfMonthOfInvoiceDate" "fromInvoiceDate" "fromInvoiceDateExtendingToEom" null "of2ndMonthFromInvoiceDate" "of3rdMonthFromInvoiceDate" "of4thMonthFromInvoiceDate" "of5thMonthFromInvoiceDate" "of6thMonthFromInvoiceDate" "ofNextMonthFromInvoiceDate" "ofTheMonthOfInvoiceDate"  
 Example:  "fromInvoiceDate"
object
A discount is a combination of the days, what the days reference, the dollar or percent discount, and the number of grace days.


 
days
integer
Number of days until the discount goes into effect.


 
 Example:  2
amount
integer or null
Amount of the discount.


 
 Example:  5
from
string or null
 Default:  null
The reference point from which to begin counting the number of days until the discount goes into effect.


 Enum: "afterEndOfMonthOfInvoiceDate" "fromInvoiceDate" "fromInvoiceDateExtendingToEom" null "of2ndMonthFromInvoiceDate" "of3rdMonthFromInvoiceDate" "of4thMonthFromInvoiceDate" "of5thMonthFromInvoiceDate" "of6thMonthFromInvoiceDate" "ofNextMonthFromInvoiceDate" "ofTheMonthOfInvoiceDate"  
 Example:  "fromInvoiceDate"
unit
string or null
 Default:  null
The type of discount, which can be a dollar amount or a percentage.


 Enum: "amount" null "percentage"  
 Example:  "percentage"
graceDays
integer or null
Number of days before the discount is withdrawn.


 
 Example:  10
calculateOn
string
 Default:  "invoiceTotal"
How the system calculates discounts in transactions that use this term. The calculation can be based on the line item total, excluding added charges (such as shipping and taxes), or on the invoice total, including all charges.


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


 
cycle
string
 Default:  "noPenalty"
Time span in which the penalty accrues.


 Enum: "annually" "bimonthly" "biweekly" "daily" "halfYearly" "monthly" "noPenalty" null "quarterly" "weekly"  
 Example:  "weekly"
amount
integer or null
Amount of the penalty.


 
 Example:  5
unit
string or null
 Default:  null
The type of penalty, which can be a dollar amount or a percentage.


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


 
 Example:  15
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "NA customer term"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "18",
    • "id": "N30",
    • "href": "/objects/accounts-receivable/term/18",
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}
Delete a term
delete/objects/accounts-receivable/term/{key}
Deletes a term. Delete terms that are no longer in use to avoid cluttering the list of active terms.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique 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
    }
}