Payment Methods
The PaymentMethod Object
A Rutter Payment Method represents a payment method that can be applied against an invoice payment
Properties
id
stringThe Rutter generated unique ID of the payment method.
platform_id
stringThe platform specific ID of the payment method.
name
stringThe name of the payment method.
created_at
stringfilterablenullableThe ISO 8601 timestamp that the payment method was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the payment method was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the payment method was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Payment Methods
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
payment_methods
arraypayment_methods
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- NetSuite
- QuickBooks Desktop
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
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
payment_method
objectpayment_method
attributesconnection
objectconnection
attributes- NetSuite
- QuickBooks Desktop
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.