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
idstringThe Rutter generated unique ID of the payment term.
platform_idstringThe platform specific ID of the payment term.
due_daysnumberThe number of days until the bill is due.
term_namestringThe name of the payment term.
discount_daysnumbernullableThe number of days until the payment discount expires.
discount_percentnumbernullableThe percent of the discount a customer will gain if paid within the discount period.
created_atstringfilterablenullableThe ISO 8601 timestamp that the paymentterm was created.
updated_atstringfilterablenullableThe ISO 8601 timestamp that the paymentterm was last updated.
last_synced_atstringfilterableThe ISO 8601 timestamp when the payment term was last synced by Rutter.
platform_dataobjectOptionalThe raw platform data corresponding to the Rutter object.
List Payment Terms
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
cursorstringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.
limitintegerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filterstringqueryOptionalNot currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.
Filterable fields: created_at, updated_at, last_synced_at.
sortstringqueryOptionalUsed to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.
Sortable fields: created_at, updated_at, last_synced_at.
expandenumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_minintegerqueryOptionalDeprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_maxintegerqueryOptionalDeprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_minintegerqueryOptionalDeprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- QuickBooks Desktop
- NetSuite
1{
2 "payment_terms": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "due_days": 30,
7 "term_name": "Net 30",
8 "discount_days": 10,
9 "discount_percent": 2,
10 "created_at": "2023-01-02T02:34:56.000Z",
11 "updated_at": "2023-01-02T02:34:56.000Z",
12 "last_synced_at": "2023-01-02T02:34:56.000Z",
13 "platform_data": {
14 "id": 123,
15 "data": "Varies by platform"
16 }
17 }
18 ],
19 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
20 "connection": {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "orgId": "00000000-0000-0000-0000-000000000000",
23 "platform": "NETSUITE"
24 }
25}
Fetch a Payment Term
Request Parameters
idstringpathRequiredThe unique ID of the object.
access_tokenstringqueryRequiredThe access token of the connection.
id_typeenumqueryOptionalUsed to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- QuickBooks Desktop
- NetSuite
1{
2 "payment_term": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "due_days": 30,
6 "term_name": "Net 30",
7 "discount_days": 10,
8 "discount_percent": 2,
9 "created_at": "2023-01-02T02:34:56.000Z",
10 "updated_at": "2023-01-02T02:34:56.000Z",
11 "last_synced_at": "2023-01-02T02:34:56.000Z",
12 "platform_data": {
13 "id": 123,
14 "data": "Varies by platform"
15 }
16 },
17 "connection": {
18 "id": "00000000-0000-0000-0000-000000000000",
19 "orgId": "00000000-0000-0000-0000-000000000000",
20 "platform": "NETSUITE"
21 }
22}
Have questions?
Contact support for personalized guidance.