Payment Methods
The PaymentMethod Object
A Rutter Payment Method represents a payment method that can be applied against an invoice payment
Properties
idstringRequiredThe Rutter generated unique ID of the payment method.
platform_idstringRequiredThe platform specific ID of the payment method.
namestringRequiredThe name of the payment method.
created_atstringnullableRequiredThe ISO 8601 timestamp that the payment method was created.
updated_atstringnullableRequiredThe ISO 8601 timestamp that the payment method was last updated.
last_synced_atstringRequiredThe ISO 8601 timestamp when the payment method was last synced by Rutter.
platform_dataobjectThe raw platform data corresponding to the Rutter object.
List Payment Methods
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
cursorstringqueryThe cursor to use for pagination. Use the value of next_cursor provided in a previous response.
expandenumqueryUsed to request inclusion of optional objects.
force_fetchenumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_minintegerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limitintegerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
sortstringqueryThe 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_maxintegerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_minintegerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connectionobjectRequiredconnection attributespayment_methodsarrayRequiredpayment_methods attributesnext_cursorstringnullable- 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_methods": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "name": "Credit Card",
12 "created_at": "2023-01-02T02:34:56.000Z",
13 "updated_at": "2023-01-02T02:34:56.000Z",
14 "last_synced_at": "2023-01-02T02:34:56.000Z",
15 "platform_data": {
16 "id": 123,
17 "data": "Varies by platform"
18 }
19 }
20 ],
21 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
22}
Have questions?
Contact support for personalized guidance.