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

idstringRequired

The Rutter generated unique ID of the payment term.

platform_idstringRequired

The platform specific ID of the payment term.

due_daysnumberRequired

The number of days until the bill is due.

term_namestringRequired

The name of the payment term.

discount_daysnumbernullableRequired

The number of days until the payment discount expires.

discount_percentnumbernullableRequired

The percent of the discount a customer will gain if paid within the discount period.

created_atstringnullableRequired

The ISO 8601 timestamp that the paymentterm was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the paymentterm was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the payment term was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/payment_terms

List Payment Terms

GEThttps://production.rutterapi.com/versioned/accounting/payment_terms

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

expandenumquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

last_synced_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

limitintegerquery

The number of entities to return. Defaults to 50. Maximum is 500.

sortstringquery

The 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_maxintegerquery

Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

updated_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

connectionobjectRequired

Show connection attributes

payment_termsarrayRequired

Show payment_terms attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite
QuickBooks Desktop

Example Response Body

JSON

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.

Contact support