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 query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR terms
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Add AR terms







SecurityOAuth2 
Request 
Request Body schema: application/json
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View AR terms







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


 
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Edit AR terms







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


 
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Delete AR terms







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


 
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
    }
}
Query terms
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-receivable/term"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-receivable/term",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "description",
    • "status",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "60 Days",
      • "description": "Net 60 Days",
      • "status": "active",
      • "href": "/objects/accounts-receivable/term/1"
      },
    • {
      • "id": "N30",
      • "description": "Net 30 days",
      • "status": "active",
      • "href": "/objects/accounts-receivable/term/15"
      },
    • {
      • "id": "Net 10",
      • "description": "Due in 10 Days",
      • "status": "active",
      • "href": "/objects/accounts-receivable/term/6"
      },
    • {
      • "id": "Net20",
      • "description": "Due in 20 Days",
      • "status": "active",
      • "href": "/objects/accounts-receivable/term/8"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}