The PaymentTerm object
A Rutter Payment Term represents the terms of payment on a bill or an invoice. For example, a payment term might be "Net 30" or "Due on Receipt".
Properties
id
stringThe Rutter generated unique ID of the payment term.
platform_id
stringThe platform specific ID of the payment term.
due_days
numberThe number of days until the bill is due.
term_name
stringThe name of the payment term.
discount_days
numbernullableThe number of days until the payment discount expires.
discount_percent
numbernullableThe percent of the discount a customer will gain if paid within the discount period.
created_at
stringnullableThe ISO 8601 timestamp that the paymentterm was created.
updated_at
stringnullableThe ISO 8601 timestamp that the paymentterm was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"due_days": 30,
"term_name": "Net 30",
"discount_days": 10,
"discount_percent": 2,
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Payment Terms
GET /accounting/payment_termsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributespayment_terms
arraypayment_terms
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"payment_terms": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"due_days": 30,
"term_name": "Net 30",
"discount_days": 10,
"discount_percent": 2,
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}