Payment Methods

The PaymentMethod Object

A Rutter Payment Method represents a payment method that can be applied against an invoice payment

Properties

idstring

The Rutter generated unique ID of the payment method.

platform_idstring

The platform specific ID of the payment method.

namestring

The name of the payment method.

created_atstringfilterablenullable

The ISO 8601 timestamp that the payment method was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the payment method was last updated.

last_synced_atstringfilterable

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

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/payment_methods

GET

/accounting/payment_methods/:id

List Payment Methods

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

filterstringqueryOptional

Not 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.

sortstringqueryOptional

Used 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.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Deprecated - 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_maxintegerqueryOptional

Deprecated - 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_minintegerqueryOptional

Deprecated - 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_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "payment_methods": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "name": "Credit Card",
7      "created_at": "2023-01-02T02:34:56.000Z",
8      "updated_at": "2023-01-02T02:34:56.000Z",
9      "last_synced_at": "2023-01-02T02:34:56.000Z",
10      "platform_data": {
11        "id": 123,
12        "data": "Varies by platform"
13      }
14    }
15  ],
16  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
17  "connection": {
18    "id": "00000000-0000-0000-0000-000000000000",
19    "orgId": "00000000-0000-0000-0000-000000000000",
20    "platform": "NETSUITE"
21  }
22}

Fetch a Payment Method

GEThttps://production.rutterapi.com/versioned/accounting/payment_methods/:id

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "payment_method": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "name": "Credit Card",
6    "created_at": "2023-01-02T02:34:56.000Z",
7    "updated_at": "2023-01-02T02:34:56.000Z",
8    "last_synced_at": "2023-01-02T02:34:56.000Z",
9    "platform_data": {
10      "id": 123,
11      "data": "Varies by platform"
12    }
13  },
14  "connection": {
15    "id": "00000000-0000-0000-0000-000000000000",
16    "orgId": "00000000-0000-0000-0000-000000000000",
17    "platform": "NETSUITE"
18  }
19}

Have questions?

Contact support for personalized guidance.

Contact support