Rutter Supplier Enablement Enrichments API

openapi: 3.2.0
info:
  title: Rutter Supplier Enablement Enrichments API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Supplier Enablement Enrichments
paths:
  /supplier_enablement_enrichments:
    get:
      summary: List commerce supplier enablement enrichments
      operationId: listCommerceSupplierEnablementEnrichments
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/AccessToken/properties/access_token'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSupplierEnablementEnrichmentsResponse'
              examples:
                GetSupplierEnablementEnrichmentsResponse_Example:
                  $ref: '#/components/examples/GetSupplierEnablementEnrichmentsResponse_Example'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms:
      - NETSUITE
      - QUICKBOOKS
      tags:
      - Supplier Enablement Enrichments
      x-summary-source: derived
components:
  schemas:
    GetSupplierEnablementEnrichmentsResponse:
      type: object
      properties:
        id:
          type: string
          description: The Rutter generated unique ID of the supplier enablement enrichment report.
        analysis_end_date:
          type:
          - string
          - 'null'
          description: End date of the analysis date range.
        analysis_start_date:
          type:
          - string
          - 'null'
          description: Start date of the analysis date range.
        source:
          type: string
          enum:
          - rutter
          - upload
          description: Source of the enrichment request.
        status:
          type: string
          enum:
          - completed
          - failed
          - in_progress
          description: Status of the enrichment request.
        progress:
          type: object
          properties:
            completion_percentage:
              type: number
              minimum: 0
              maximum: 100
              description: Completion percentage (0-100).
            estimated_time_remaining:
              type: number
              minimum: 0
              description: Estimated time remaining in seconds.
            processed_vendors:
              type: integer
              minimum: 0
              description: Number of vendors already processed.
            total_vendors:
              type: integer
              minimum: 0
              description: Total number of vendors to process.
          required:
          - completion_percentage
          - estimated_time_remaining
          - processed_vendors
          - total_vendors
          additionalProperties: false
          description: Progress tracking information for the enrichment request.
        files:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Rutter generated unique ID of the supplier enablement enrichment file.
              uploaded_at:
                type: string
                description: Timestamp when the file was uploaded.
              name:
                type: string
                description: Name of the enrichment file.
            required:
            - id
            - uploaded_at
            - name
            additionalProperties: false
            description: Supplier enablement source file.
          description: Array of source files.
        vendors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Rutter generated unique ID of the vendor.
              latest_bill_issue_date:
                type:
                - string
                - 'null'
                description: Timestamp of most recent bill issued.
              latest_expense_transaction_date:
                type:
                - string
                - 'null'
                description: Timestamp of most recent expense transaction.
              eligible_card_spend:
                type: number
                minimum: 0
                description: Amount of spend that is eligible for card payments.
              total_spend:
                type: number
                minimum: 0
                description: Total spend with this vendor over the last two years.
              vendor_address:
                type: string
                description: Address of the vendor.
              vendor_name:
                type: string
                description: Name of the vendor.
              accepts_card:
                type:
                - boolean
                - 'null'
                description: Whether the vendor accepts credit card payments.
              billing_portal_link:
                type:
                - string
                - 'null'
                description: Billing portal link for this vendor, extracted from OCR or other sources.
              card_activation_flow:
                type:
                - string
                - 'null'
                enum:
                - merchant_auth_link
                - generic_job
                - payment_link
                - 'null'
                description: The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link.
              card_fee:
                type:
                - number
                - 'null'
                description: Amount of card payment fees.
              current_payment_account:
                type:
                - string
                - 'null'
                description: Current payment account used for this vendor.
              current_payment_method:
                type:
                - string
                - 'null'
                description: Current payment method used for this vendor.
              current_payment_source:
                type:
                - string
                - 'null'
                description: Current payment source used for this vendor.
              has_card_fees:
                type:
                - boolean
                - 'null'
                description: Whether the vendor has card payment fees.
              manual_activation_instructions:
                type:
                - string
                - 'null'
                description: User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link.
              merchant_code:
                type:
                - string
                - 'null'
                description: The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS).
              payment_link:
                type:
                - string
                - 'null'
                description: Payment link for this vendor, extracted from OCR or other sources.
              total_bills_count:
                type: integer
                minimum: 0
                description: Total number of bills associated with this vendor.
              total_expenses_count:
                type: integer
                minimum: 0
                description: Total number of expenses associated with this vendor.
              accepts_card_sources:
                type:
                - array
                - 'null'
                items:
                  type: string
                description: Sources of information for this card acceptance method.
              card_accept_options_sources:
                type:
                - array
                - 'null'
                items:
                  type: string
                description: Sources of information for this card acceptance options.
              card_fee_sources:
                type:
                - array
                - 'null'
                items:
                  type: string
                description: Sources of information for this card payment fees.
              historical_payment_methods:
                type:
                - array
                - 'null'
                items:
                  type: string
                description: Historical payment methods used with this vendor.
              card_accept_options:
                type:
                - array
                - 'null'
                items:
                  type: object
                  properties:
                    description:
                      type: string
                      description: Description of how to use this card acceptance method.
                    type:
                      type: string
                      enum:
                      - billing_portal
                      - invoice_link
                      - online_checkout
                      - agent
                      - phone
                      - email
                      - unknown
                      description: The type of card acceptance method available.
                    sources:
                      type: array
                      items:
                        type: string
                      description: Sources of information for this card acceptance method.
                  required:
                  - description
                  - type
                  - sources
                  additionalProperties: false
                description: Available options for setting up card payments with this vendor.
            required:
            - id
            - latest_bill_issue_date
            - latest_expense_transaction_date
            - eligible_card_spend
            - total_spend
            - vendor_address
            - vendor_name
            - accepts_card
            - billing_portal_link
            - card_activation_flow
            - card_fee
            - current_payment_account
            - current_payment_method
            - current_payment_source
            - has_card_fees
            - manual_activation_instructions
            - merchant_code
            - payment_link
            - accepts_card_sources
            - card_accept_options_sources
            - card_fee_sources
            - historical_payment_methods
            - card_accept_options
            additionalProperties: false
          description: Array of vendor enrichment data.
      required:
      - id
      - analysis_end_date
      - analysis_start_date
      - source
      - status
      - progress
      - vendors
      examples:
      - GetSupplierEnablementEnrichmentsResponse_Example:
          $ref: '#/components/examples/GetSupplierEnablementEnrichmentsResponse_Example'
    AccessToken:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
      required:
      - access_token
  examples:
    GetSupplierEnablementEnrichmentsResponse_Example:
      value:
        id: ''
        analysis_end_date: '2025-01-01'
        analysis_start_date: '2024-01-01'
        source: rutter
        status: completed
        progress:
          completion_percentage: 100
          estimated_time_remaining: 0
          processed_vendors: 2
          total_vendors: 2
        vendors:
        - id: 7f8d9e2a-4b6c-11ee-be56-0242ac120002
          latest_bill_issue_date: '2024-06-09T02:34:56.000Z'
          latest_expense_transaction_date: null
          eligible_card_spend: 12450.75
          total_spend: 12450.75
          vendor_address: 123 Main St, Anytown, USA
          vendor_name: Dashfi
          accepts_card: true
          billing_portal_link: null
          card_activation_flow: merchant_auth_link
          card_fee: 2.9
          current_payment_account: CC Checking
          current_payment_method: visa_ending_4829
          current_payment_source: ERP
          has_card_fees: false
          manual_activation_instructions: You can pay Dashfi by logging into their billing portal and adding your card as a payment method.
          merchant_code: DATADOG
          payment_link: https://app.datadoghq.com/billing/plan
          accepts_card_sources:
          - ERP
          - Visa Supplier Search API
          - docs.datadoghq.com/account_management/billing
          card_accept_options_sources:
          - ERP
          - Visa Supplier Search API
          - docs.datadoghq.com/account_management/billing
          card_fee_sources:
          - ERP
          - docs.datadoghq.com/account_management/billing
          historical_payment_methods:
          - Credit Card - amex_ending_9876
          - Check/ACH, Chase Bank Innovation 3857
          - Check/ACH, Bill.com Money Out 'Clearing'
          card_accept_options:
          - description: Merchant accepts card on billing portal. Use the Merchant Auth Sessions API or agent.
            type: billing_portal
            sources:
            - ERP
            - Visa Supplier Search API
            - docs.datadoghq.com/account_management/billing
          - description: Use Rutter agent to switch the card on file
            type: agent
            sources:
            - app.datadoghq.com/billing
            - docs.datadoghq.com/account_management/billing