Rutter

opencollection: 1.0.0
info:
  name: Rutter Unified API
  version: '2024-08-31'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Connections
    type: folder
  items:
  - info:
      name: List Connections
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/connections
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve all connections for the authenticated client.
  - info:
      name: Get Connection
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/connections/:connectionId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: connectionId
        value: ''
        type: path
    docs: Retrieve details for a specific platform connection.
  - info:
      name: Exchange Token
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/connections/token_exchange
      body:
        type: json
        data: '{}'
    docs: Exchange a Rutter Link public token for a permanent access token for the connected platform.
- info:
    name: Accounting
    type: folder
  items:
  - info:
      name: List Accounts
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/accounts
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of chart of accounts entries from the connected accounting platform.
  - info:
      name: List Transactions
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/transactions
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
      - name: updated_at_min
        value: ''
        type: query
        description: Filter transactions updated after this timestamp
    docs: Retrieve a list of financial transactions from the connected platform.
  - info:
      name: List Invoices
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/invoices
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of invoices from the connected accounting platform.
  - info:
      name: Create Invoice
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/invoices
      headers:
      - name: X-Rutter-Version
        value: ''
      - name: Idempotency-Key
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      body:
        type: json
        data: '{}'
    docs: Create a new invoice in the connected accounting platform.
  - info:
      name: Get Invoice
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/invoices/:invoiceId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: invoiceId
        value: ''
        type: path
    docs: Retrieve a specific invoice by ID.
  - info:
      name: List Bills
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/bills
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of bills (vendor invoices) from the connected accounting platform.
  - info:
      name: Create Bill
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/bills
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      body:
        type: json
        data: '{}'
    docs: Create a new bill in the connected accounting platform.
  - info:
      name: List Expenses
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/expenses
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of expense records from the connected accounting platform.
- info:
    name: Commerce
    type: folder
  items:
  - info:
      name: List Orders
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/orders
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
      - name: expand
        value: ''
        type: query
        description: Expand response with additional platform-specific data
      - name: updated_at_min
        value: ''
        type: query
    docs: Retrieve a list of orders from the connected commerce platform. Supports expansions to include additional data.
  - info:
      name: Create Order
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/orders
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      body:
        type: json
        data: '{}'
    docs: Create a new order in the connected commerce platform.
  - info:
      name: Get Order
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/orders/:orderId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: orderId
        value: ''
        type: path
    docs: Retrieve a specific order by ID.
  - info:
      name: Fulfill Order
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/orders/:orderId/fulfillments
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: orderId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Mark an order as fulfilled and provide fulfillment details.
  - info:
      name: List Products
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/products
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of products from the connected commerce platform.
  - info:
      name: Create Product
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/products
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      body:
        type: json
        data: '{}'
    docs: Create a new product in the connected commerce platform.
  - info:
      name: Get Product
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/products/:productId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: productId
        value: ''
        type: path
    docs: Retrieve a specific product by ID.
  - info:
      name: Update Product
      type: http
    http:
      method: PUT
      url: https://production.rutterapi.com/versioned/products/:productId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: productId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an existing product in the connected commerce platform.
  - info:
      name: List Customers
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/customers
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of customers from the connected commerce or accounting platform.
  - info:
      name: Get Customer
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/customers/:customerId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: customerId
        value: ''
        type: path
    docs: Retrieve details for a specific customer.
- info:
    name: Banking
    type: folder
  items:
  - info:
      name: List Bank Accounts
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/bank-accounts
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of bank accounts from the connected banking platform.
- info:
    name: Ads
    type: folder
  items:
  - info:
      name: List Ad Accounts
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/ad-accounts
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: access_token
        value: ''
        type: query
        description: Unique access token identifying the specific connection
      - name: cursor
        value: ''
        type: query
        description: Pagination cursor from previous response next_cursor field
    docs: Retrieve a list of advertising accounts from the connected ads platform.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List Webhooks
      type: http
    http:
      method: GET
      url: https://production.rutterapi.com/versioned/config-webhooks
      headers:
      - name: X-Rutter-Version
        value: ''
    docs: Retrieve all configured webhooks for the authenticated client.
  - info:
      name: Create Webhook
      type: http
    http:
      method: POST
      url: https://production.rutterapi.com/versioned/config-webhooks
      headers:
      - name: X-Rutter-Version
        value: ''
      body:
        type: json
        data: '{}'
    docs: Configure a new webhook endpoint to receive event notifications.
  - info:
      name: Delete Webhook
      type: http
    http:
      method: DELETE
      url: https://production.rutterapi.com/versioned/config-webhooks/:webhookId
      headers:
      - name: X-Rutter-Version
        value: ''
      params:
      - name: webhookId
        value: ''
        type: path
    docs: Remove a webhook configuration.
bundled: true