Rutter REST API

https://docs.rutter.com/rest/2024-08-31/
Admin
Rutter provides a REST API for financial data, featuring AI-powered supplier enablement to optimize...
Tokens:435,364
Snippets:1,037
Trust Score:8.3
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Platform Sync Configuration Example (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/config-sync

This JSON object represents an example response body for retrieving the sync configuration of a specific platform. It details the initial sync batches, including timeframes and entities, and the incremental sync settings like sync period and entities.

```json
{
  "initialSync": {
    "batches": [
      {
        "timeFrameInMonths": 12,
        "entities": [
          "ACCOUNTING_TRANSACTION"
        ]
      }
    ]
  },
  "incrementalSync": {
    "syncPeriodInMinutes": 120,
    "entities": [
      "ACCOUNTING_TRANSACTION"
    ]
  }
}
```

--------------------------------

### Get Tax Agency Example JSON

Source: https://docs.rutter.com/rest/2024-08-31/tax-rates

Example JSON response for a successful request to retrieve a tax agency. Includes details like IDs, names, timestamps, and platform-specific data.

```json
{
  "tax_agency": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "00000000-0000-0000-0000-000000000000",
    "name": "Tax Agency Name",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### Trigger Data Recovery Backfill Request Example

Source: https://docs.rutter.com/rest/2024-08-31/connections

Demonstrates how to make a POST request to the Trigger Data Recovery Backfill API endpoint. This example shows the basic structure of the request, including the URL and a sample JSON body.

```json
POST https://production.rutterapi.com/versioned/connections/backfill

{
  "start_date": "2023-02-07",
  "end_date": "2023-03-14",
  "include_webhooks": true,
  "object_types": [
    "invoice",
    "invoice_payment"
  ],
  "remarks": "Adding historical invoice data"
}
```

--------------------------------

### Example Vendor Creation Request Body (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/vendors

This JSON object represents the structure of a request body used to create a new vendor. It includes contact details, company information, and addresses. This is an example of the input expected by the API.

```json
{
  "vendor": {
    "contact_name": "Eric Yu",
    "currency_code": "USD",
    "vendor_name": "Rutter",
    "email": "eric@rutter.com",
    "phone": "1234567890",
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "website": "https://rutter.com",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": true
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "primary": false
      }
    ],
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "country": "US",
        "postal_code": "94110",
        "region": "CA"
      }
    ]
  }
}
```

--------------------------------

### Create Account Response Body (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/accounts

This is an example of the response body returned after successfully creating an account. It mirrors the structure of the general account response, providing the newly created account's details and its associated connection information.

```JSON
{
  "account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "parent_id": "00000000-0000-0000-0000-000000000000",
    "account_type": "bank",
    "category": "asset",
    "status": "active",
    "balance": 123.45,
    "currency_code": "USD",
    "name": "Checking",
    "nominal_code": "1001",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "active"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "active"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_url": "https://platform.com/resource?id=123",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
```

--------------------------------

### Example Product Response Body (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/products

This JSON object represents a successful response when retrieving product details. It includes comprehensive information about the product, its variants, images, pricing, and associated platform data.

```json
{
  "product": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "description": "A Rutter Shirt. It comes in all shapes and sizes.",
    "name": "Rutter shirt",
    "type": "physical",
    "product_url": "https://rutter.com/products/shirt",
    "images": [
      {
        "src": "https://rutter.com/products/shirtlarge.jpg"
      },
      {
        "src": "https://rutter.com/products/shirt.jpg"
      },
      {
        "src": "https://rutter.com/products/shirtsmall.jpg"
      }
    ],
    "status": "active",
    "tags": [
      "clothing",
      "shirt"
    ],
    "variants": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "product_id": "00000000-0000-0000-0000-000000000000",
        "price": 12.34,
        "requires_shipping": true,
        "barcode": "0012345678901",
        "fulfillment_service": "fedex",
        "inventory_management": "shopify",
        "iso_currency_code": "USD",
        "sku": "RUTTER-1",
        "title": "Rutter shirt (Large)",
        "unit_cost": 12.34,
        "variant_url": "https://rutter.com/products/shirt?size=large",
        "description": "A Rutter Shirt. It comes in all shapes and sizes, but this one is large",
        "images": [
          {
            "src": "https://rutter.com/products/shirtlarge.jpg"
          }
        ],
        "short_description": "Rutter shirt (Large)",
        "option_values": [
          {
            "name": "size",
            "value": "large"
          }
        ],
        "currency_prices": [
          {
            "iso_currency_code": "USD",
            "price": 12.34
          }
        ],
        "weight": {
          "unit": "kg",
          "value": 10
        },
        "linked_products": [
          {
            "variant_id": "00000000-0000-0000-0000-000000000000",
            "link_type": "product",
            "sku": "RUTTER-2"
          }
        ],
        "inventory": {
          "total_count": 10,
          "locations": []
        },
        "created_at": "2023-01-02T02:34:56.000Z",
        "updated_at": "2023-01-02T02:34:56.000Z"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY"
  }
}
```

--------------------------------

### Rutter API Vendors GET Example (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/vendors

An example JSON response body for fetching vendors via the Rutter API. This demonstrates the structure of the 'vendors' array, pagination cursor, and connection details. It includes common vendor fields and nested objects for subsidiaries and addresses.

```JSON
{
  "vendors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "payment_terms_id": "00000000-0000-0000-0000-000000000000",
      "status": "active",
      "bank_account_number": "123456",
      "contact_name": "Eric Yu",
      "currency_codes": [
        "USD"
      ],
      "display_name": "Rutter Inc.",
      "email": "eric@rutter.com",
      "phone": "1234567890",
      "registration_number": "123456789",
      "tax_number": "12-3456789",
      "vendor_name": "Rutter",
      "website": "https://rutter.com",
      "subsidiaries": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": true,
          "status": "active"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": false,
          "status": "active"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "primary": false,
          "status": "inactive"
        }
      ],
      "addresses": [
        {
          "type": "billing",
          "address1": "123 Rutter Road",
          "address2": "Floor 4",
          "address3": null,
          "city": "San Francisco",
          "country": "US",
          "postal_code": "94110",
          "region": "CA"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_url": "https://platform.com/resource?id=123",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### List Cash Flow Statements Example - GET Request

Source: https://docs.rutter.com/rest/2024-08-31/cash-flow-statements

This snippet demonstrates how to make a GET request to the Rutter API to retrieve a list of cash flow statements. It includes common query parameters such as access token, date filters, and expansion options.

```http
GET https://production.rutterapi.com/versioned/accounting/cash_flow_statements?access_token=YOUR_ACCESS_TOKEN&start_date=2021-01-01&end_date=2022-01-01&expand=platform_data
```

--------------------------------

### Create Product

Source: https://docs.rutter.com/rest/2024-08-31/products

Creates a new product in the merchant's catalog.

```APIDOC
## POST /products

### Description
Creates a new product in the merchant's catalog.

### Method
POST

### Endpoint
/products

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token of the connection.

#### Request Body
- **name** (string) - Required - The name of the product.
- **description** (string) - Optional - The description of the product.
- **category_id** (string) - Optional - The Rutter generated unique ID of the product category.
- **product_url** (string) - Optional - The consumer facing URL used to access the product online.
- **images** (array) - Optional - An array of image URLs linked to the product.
- **status** (string) - Optional - The status of the product. Defaults to 'active'.
- **tags** (array) - Optional - An array of tags for the product.

### Request Example
```json
{
  "name": "New Gadget",
  "description": "An innovative new electronic gadget.",
  "category_id": "cat_xyz789",
  "images": [
    "https://merchant.com/images/gadget.jpg"
  ],
  "tags": ["electronics", "new arrival"]
}
```

### Response
#### Success Response (200)
- **id** (string) - The Rutter generated unique ID of the product.
- **platform_id** (string) - Optional - The platform specific ID of the product.
- **category_id** (string) - Optional, nullable - The Rutter generated unique ID of the product category.
- **description** (string) - The description of the product.
- **name** (string) - The name of the product.
- **type** (string) - The unstandardized type or categorization of the product.
- **product_url** (string) - Optional - The consumer facing URL used to access the product online.
- **images** (array) - An array of images linked to the product.
- **status** (string | string) - The status of the product.
- **tags** (array) - An array of tags linked to the product. String array.
- **variants** (array) - An array of Variants linked to the product.
- **created_at** (string) - The ISO 8601 timestamp that the product was created.
- **updated_at** (string) - The ISO 8601 timestamp that the product was last updated.
- **platform_data** (object) - Optional - The raw platform data corresponding to the Rutter object.

#### Response Example
```json
{
  "id": "prod_98765",
  "platform_id": "shopify_prod_12345",
  "description": "An innovative new electronic gadget.",
  "name": "New Gadget",
  "type": "Electronics",
  "product_url": "https://merchant.com/products/new-gadget",
  "images": [
    "https://merchant.com/images/gadget.jpg"
  ],
  "status": "active",
  "tags": ["electronics", "new arrival"],
  "variants": [],
  "created_at": "2023-10-27T11:00:00Z",
  "updated_at": "2023-10-27T11:00:00Z"
}
```
```

--------------------------------

### Example Purchase Order Response Body (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/purchase-orders

This JSON structure represents a successful response when retrieving purchase order details. It includes comprehensive information about the order, vendor, line items, and associated platform data. This format is typically returned after a GET request or as a successful POST/PATCH response.

```json
{
  "purchase_order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "status": "open",
    "currency_code": "USD",
    "document_number": "VENDPO-1",
    "memo": "Example purchase order top-level memo",
    "total_amount": 12.34,
    "total_quantity": 1,
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "Example description",
        "total_amount": 12.34,
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 12.34
        }
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_url": "https://platform.com/resource?id=123",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### Create Item Request Body Example (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/items

An example of the JSON payload required to create a new item. It includes essential item details such as name, code, type, quantity, and associated billing and invoicing information. The `platform_data` field can be used for system-specific identifiers.

```JSON
{
  "response_mode": "prefer_sync",
  "item": {
    "platform_id": "12345678",
    "status": "active",
    "type": "inventory",
    "code": "1234",
    "name": "Rutter Shirt",
    "quantity_on_hand": 10,
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "bill_item": {
      "description": "A Rutter shirt from the Vendor",
      "unit_price": "12.34"
    },
    "invoice_item": {
      "description": "A Rutter shirt for the Customer",
      "unit_price": "4.21"
    },
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
```

--------------------------------

### Retrieve Invoice with Custom Fields (GET)

Source: https://docs.rutter.com/rest/2024-08-31/custom-fields

This example shows how to retrieve an invoice and include its platform-specific custom field data. It utilizes the `expand=platform_data` query parameter to fetch raw platform responses, which contain the custom field key-value pairs. The response structure includes `platform_data` for both the invoice and its line items.

```json
GET /accounting/invoices?expand=platform_data

{
    "invoice": {
        "id": "11423fb5-e84c-44ec-964f-ab0ffd60e647",
        "platform_id": "21156",
        "document_number": "50",
        "customer_id": "77507585-aeb0-46a2-8667-e56ac1e9126e",
        "subsidiary_id": "00b4187f-80d6-4e6e-bca0-4674b5b1bab0",
        "issue_date": "2023-01-02T08:00:00.000Z",
        "due_date": "2023-01-02T08:00:00.000Z",
        "currency_code": "USD",
        "account_id": "2267d1db-958f-404e-805a-2751a1199ec2",
        "line_items": [
            {
                "id": null,
                "platform_id": "11",
                "description": "A Rutter Shirt",
                "unit_amount": "2",
                "quantity": 1,
                "discount_amount": null,
                "sub_total": "2",
                "tax_amount": null,
                "amount": "2",
                "discount_percentage": null,
                "tax_rate_id": null,
                "item_id": "60d96f07-d474-4978-8422-6d5ec479e2c1",
                "account_id": "15f844d2-0b04-4b8b-a253-261cf9bbd1fd"
            },
            {
                "id": null,
                "platform_id": "5",
                "description": "A Second Rutter Shirt",
                "unit_amount": "2",
                "quantity": 2,
                "discount_amount": null,
                "sub_total": "4",
                "tax_amount": null,
                "amount": "4",
                "discount_percentage": null,
                "tax_rate_id": null,
                "item_id": "c012dc49-3d06-4fc3-9ac3-7a883233d01a",
                "account_id": "15f844d2-0b04-4b8b-a253-261cf9bbd1fd"
            }
        ],
        "status": "open",
        "total_discount": null,
        "sub_total": "6",
        "tax_amount": null,
        "total_amount": "6",
        "amount_due": "6",
        "linked_payments": [],
        "memo": null,
        "created_at": "2023-06-01T13:56:00.000Z",
        "updated_at": "2023-06-01T13:56:00.000Z",
        "platform_data": {
            "id": "21156",
            "custbody_customname": "Awesome Test Demo Product",
            "custbody_secondarycurrency": "3",
            "item": [
                {
                    "id": "21156_1",
                    "custcol_reminderformat": "2",
                    "custcol_reviewed": true
                },
                {
                    "id": "21156_4",
                    "custcol_reminderformat": "4",
                    "custcol_reviewed": false
                }
            ]
        }
    }
}
```

--------------------------------

### Fetch a Single Purchase Order by ID (HTTP Request)

Source: https://docs.rutter.com/rest/2024-08-31/purchase-orders

This example illustrates how to make an HTTP GET request to retrieve a specific purchase order using its unique ID. The request requires an `access_token` and optionally accepts an `id_type` to specify whether the provided ID is a Rutter ID or a platform-specific ID. The `force_fetch` parameter can be used to bypass cache and retrieve the latest data.

```http
GET https://production.rutterapi.com/versioned/accounting/purchase_orders/:id?access_token=<ACCESS_TOKEN>
```

--------------------------------

### Example Request Body for Product Creation (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/products

This JSON object represents the structure of a request to create a new product in the Rutter system. It includes details such as category, description, name, status, tags, images, variants, and additional platform-specific fields.

```json
{
  "product": {
    "category_id": 123456789,
    "description": "A Rutter Shirt. It comes in all shapes and sizes.",
    "name": "Rutter shirt",
    "status": "active",
    "tags": [
      "clothing",
      "shirt"
    ],
    "images": [
      {
        "src": "https://rutter.com/products/shirtlarge.jpg"
      },
      {
        "src": "https://rutter.com/products/shirt.jpg"
      },
      {
        "src": "https://rutter.com/products/shirtsmall.jpg"
      }
    ],
    "variants": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "price": 12.34,
        "sku": "RUTTER-1",
        "images": [
          {
            "src": "https://rutter.com/products/shirtlarge.jpg"
          }
        ],
        "option_values": [
          {
            "name": "size",
            "value": "large"
          }
        ],
        "weight": {
          "unit": "kg",
          "value": 10
        },
        "inventory": {
          "total_count": 10
        }
      }
    ],
    "additional_fields": {
      "amazon": {
        "sku": "RUTTER-1",
        "display_album": null,
        "decorative_cutout": null,
        "cellular_phone_case": null,
        "wall_art": null,
        "drinking_cup": null,
        "tote_bag": null,
        "shirt": null,
        "sweatshirt": null
      }
    }
  }
}
```

--------------------------------

### Example Request Body for Custom Fields

Source: https://docs.rutter.com/rest/2024-08-31/custom-fields

This JSON object demonstrates the structure for sending custom field data in a request. It includes top-level fields, custom fields, and line item custom fields. Note that 'select' type custom fields should use values from the 'GET /accounting/:entityType/custom_fields' endpoint options, and 'boolean' fields require boolean values.

```json
{
  "other_entity_fields": "Other entity values",
  "custom_fields": {
    "custom_field_key": "Custom field value"
  },
  "line_items": [
    {
      "other_line_item_fields": "Other line item values",
      "custom_fields": {
        "line_item_custom_field_key": "Line item custom field value"
      }
    }
  ]
}
```

--------------------------------

### Create Product Endpoint (POST)

Source: https://docs.rutter.com/rest/2024-08-31/products

This POST endpoint is used to create a new product. It requires an `access_token` in the query parameters and accepts a `product` object in the request body containing the details of the product to be created.

```http
POST https://production.rutterapi.com/versioned/products?access_token=YOUR_ACCESS_TOKEN

{
  "product": {
    "name": "New Product Name",
    "description": "Product Description",
    "type": "physical",
    "price": 10.00
    // ... other product attributes
  }
}
```

--------------------------------

### List Tax Areas Example JSON

Source: https://docs.rutter.com/rest/2024-08-31/tax-rates

Example JSON response for listing tax areas. Includes an array of tax area objects, a cursor for pagination, and connection details.

```json
{
  "tax_areas": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "CA",
      "country": "CA",
      "description": "Canadian tax area",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### Create Sales Order Request Body Example (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/sales-orders

This JSON object demonstrates the structure required for creating a sales order. It includes essential fields like customer ID, issue date, currency code, and line items with item details. Note that some fields are optional and may vary based on the integration.

```json
{
  "sales_order": {
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "line_items": [
      {
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "Example description",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 10
        }
      }
    ]
  }
}
```

--------------------------------

### Example JSON Response Body for Product Variant (200 OK)

Source: https://docs.rutter.com/rest/2024-08-31/products

This JSON object illustrates a successful response (200 OK) when retrieving or updating a product variant. It contains detailed information about the variant, including platform-specific data, pricing, inventory, and associated media.

```json
{
  "variant": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price": 12.34,
    "requires_shipping": true,
    "barcode": "0012345678901",
    "fulfillment_service": "fedex",
    "inventory_management": "shopify",
    "iso_currency_code": "USD",
    "sku": "RUTTER-1",
    "title": "Rutter shirt (Large)",
    "unit_cost": 12.34,
    "variant_url": "https://rutter.com/products/shirt?size=large",
    "description": "A Rutter Shirt. It comes in all shapes and sizes, but this one is large",
    "images": [
      {
        "src": "https://rutter.com/products/shirtlarge.jpg"
      }
    ],
    "short_description": "Rutter shirt (Large)",
    "option_values": [
      {
        "name": "size",
        "value": "large"
      }
    ],
    "currency_prices": [
      {
        "iso_currency_code": "USD",
        "price": 12.34
      }
    ],
    "weight": {
      "unit": "kg",
      "value": 10
    },
    "linked_products": [
      {
        "variant_id": "00000000-0000-0000-0000-000000000000",
        "link_type": "product",
        "sku": "RUTTER-2"
      }
    ],
    "inventory": {
      "total_count": 10,
      "locations": []
    },
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
```

--------------------------------

### Customer Refunds Response Body Example

Source: https://docs.rutter.com/rest/2024-08-31/accounting-customer-refunds

An example JSON structure for the response when listing customer refunds. It includes an array of refund objects, a `next_cursor` for pagination, and connection details.

```JSON
{
  "customer_refunds": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "tax_rate_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02",
      "total_amount": 123.45,
      "currency_code": "USD",
      "currency_rate": 5.72,
      "discount_amount": 20,
      "document_number": "CUSTRFD-1",
      "tax_amount": 23.45,
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "class_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
          "total_amount": 123.45,
          "description": "This is a description.",
          "type": "shipping",
          "item": {
            "id": "00000000-0000-0000-0000-000000000000",
            "quantity": 1,
            "unit_amount": 123.45
          }
        }
      ],
      "additional_fields": {
        "shipping_amount": 10
      },
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_url": "https://platform.com/resource?id=123",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### Example Request Body for Attachment Upload (JSON)

Source: https://docs.rutter.com/rest/2024-08-31/bank-deposit-attachments

This is an example of a request body used to upload an attachment. It specifies the file content type and a desired file name for the attachment.

```json
{
  "file": "multipart/form-data",
  "file_name": "T-shirt Receipt"
}
```

--------------------------------

### Create Connection Response Body

Source: https://docs.rutter.com/rest/2024-08-31/connections

Example JSON response body after successfully creating a new connection. Includes connection ID, access token, link URL, and name.

```JSON
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "access_token": "00000000-0000-0000-0000-000000000000",
    "link_url": "https://link.rutterapi.com/connection/00000000-0000-0000-0000-000000000000",
    "name": "Example Connection"
  }
}
```

--------------------------------

### Journal Entry Response Body Example

Source: https://docs.rutter.com/rest/2024-08-31/journal-entries

An example of the JSON response body when successfully retrieving journal entries. It includes a list of journal entries, a cursor for pagination, and connection details.

```JSON
{
  "journal_entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "currency_rate": 1,
      "deposited": true,
      "memo": "For goods sold.",
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "123",
          "total_amount": 12.34,
          "description": "Debit amount for goods sold"
        },
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "123",
          "total_amount": -12.34,
          "description": "Credit amount for goods sold"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_url": "https://platform.com/resource?id=123",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}
```

--------------------------------

### Versioned URL Example

Source: https://docs.rutter.com/rest/2024-08-31/basics

Example of a versioned API endpoint URL, including the base URL and a specific resource like 'accounting/accounts'.

```text
https://production.rutterapi.com/versioned/accounting/accounts
```
Tokens:
Raw