Payment Terms
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
stringRequiredThe Rutter generated unique ID of the payment term.
platform_id
stringRequiredThe platform specific ID of the payment term.
due_days
numberRequiredThe number of days until the bill is due.
term_name
stringRequiredThe name of the payment term.
discount_days
numbernullableRequiredThe number of days until the payment discount expires.
discount_percent
numbernullableRequiredThe percent of the discount a customer will gain if paid within the discount period.
created_at
stringnullableRequiredThe ISO 8601 timestamp that the paymentterm was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the paymentterm was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the payment term was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Payment Terms
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
sort
stringqueryThe field and direction to sort by (ASC
or DESC
), e.g. last_synced_at ASC
. Currently supports the fields: updated_at
, last_synced_at
. If a field is provided but ASC
or DESC
is not, defaults to ASC
. If this field is omitted, defaults, to updated_at DESC
.
updated_at_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributespayment_terms
arrayRequiredpayment_terms
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "payment_terms": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "due_days": 30,
12 "term_name": "Net 30",
13 "discount_days": 10,
14 "discount_percent": 2,
15 "created_at": "2023-01-02T02:34:56.000Z",
16 "updated_at": "2023-01-02T02:34:56.000Z",
17 "last_synced_at": "2023-01-02T02:34:56.000Z",
18 "platform_data": {
19 "id": 123,
20 "data": "Varies by platform"
21 }
22 }
23 ],
24 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
25}
Have questions?
Contact support for personalized guidance.