Rutter · Schema

Rutter Connection

A connection to a third-party business platform via the Rutter Unified API

AccountingB2BCommerceFinancial DataPaymentsUnified-API

Properties

Name Type Description
id string Unique identifier for the connection
platform string The connected platform identifier (e.g., quickbooks, shopify, amazon)
status string Current connection status
created_at string Timestamp when the connection was created
updated_at string Timestamp when the connection was last updated
View JSON Schema on GitHub

JSON Schema

rutter-connection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12",
  "$id": "https://api-evangelist.github.io/rutter/json-schema/rutter-connection-schema.json",
  "title": "Rutter Connection",
  "description": "A connection to a third-party business platform via the Rutter Unified API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the connection"
    },
    "platform": {
      "type": "string",
      "description": "The connected platform identifier (e.g., quickbooks, shopify, amazon)",
      "examples": ["quickbooks", "xero", "shopify", "amazon", "woocommerce", "netsuite"]
    },
    "status": {
      "type": "string",
      "enum": ["active", "inactive", "error"],
      "description": "Current connection status"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the connection was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the connection was last updated"
    }
  },
  "required": ["id", "platform", "status"]
}