How do I access additional fields that are not part of Rutter's standard schema?

Rutter standardizes data across many platforms using a unified schema, so you can build once and scale across multiple integrations. However, there are times when platform-specific details are important. That’s where platform_data comes in.

Overview

The platform_data field is available on most Rutter objects and contains the raw data returned directly from the source platform before Rutter applies any normalization.

This can be useful when:

• You need access to platform-specific fields not included in the Rutter schema.

• You're debugging a sync issue or trying to trace data differences between the source platform and Rutter.

• You’re building advanced features that rely on granular, non-standard platform fields.

How to Use platform_data

To retrieve platform_data, include the expand=platform_data query parameter in your request.

Example Request

GET /invoices?expand=platform_data

Example Response Snippet without platform_data

In this example, platform_data is not used.

{
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    ...

  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}

Example Response Snippet with platform_data

In this example, platform_data exposes QuickBooks-specific fields that may not be part of the normalized Rutter object.

{
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "platform_data": {
         "id": 123,  
         "data": "Varies by platform"
    }
    ...
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  }
}

Additional Considerations

• platform_data is not included by default in API responses. You must explicitly request it using expand=platform_data.

• The structure and field names within platform_data vary depending on the platform and object. No normalization is applied.