Tinvio Record Lists API

openapi: 3.2.0
info:
  title: Tinvio Com Record Lists API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Record Lists across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: Read the options behind a classifier or custom field that draws them from a record list of customers, suppliers, contacts, employees, or users, and resolve stored resource IDs to their current names.
  name: Record Lists
paths:
  /api/v1/record-lists/{format}/options:
    get:
      description: 'List the options a record list offers, paginated. Use this to populate a picker

        for a classifier or custom field whose format draws its options from a record list.

        Deleted and inactive records are never offered, because they must not be selectable.'
      operationId: list-record-list-options
      parameters:
      - description: Record list to read options from.
        in: path
        name: format
        required: true
        schema:
          type: string
          enum:
          - ALL_CUSTOMERS
          - ALL_SUPPLIERS
          - ALL_CONTACTS
          - ALL_EMPLOYEES
          - ALL_USERS
      - description: Filter options by name. Matches anywhere in the name and ignores case.
        in: query
        name: search
        schema:
          type: string
      - description: Maximum number of results per page (max 1000).
        in: query
        name: limit
        schema:
          type: integer
          default: 100
      - description: Number of results to skip. This is a row offset, not a page number.
        in: query
        name: offset
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageableResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List Record List Options
      tags:
      - Record Lists
    servers:
    - url: https://api.getjaz.com
  /api/v1/record-lists/{format}/resolve:
    post:
      description: 'Look up the current names for record resource IDs already stored on transactions.

        Records that have since been deactivated or deleted are still returned, carrying

        their latest name and a deleted flag, so a saved transaction keeps reading correctly.

        A resource ID that no longer exists at all is absent from the result: fall back to

        the name stored on the transaction. Send every resource ID for a transaction at once.'
      operationId: create-record-list-resolve
      parameters:
      - description: Record list the resource IDs belong to.
        in: path
        name: format
        required: true
        schema:
          type: string
          enum:
          - ALL_CUSTOMERS
          - ALL_SUPPLIERS
          - ALL_CONTACTS
          - ALL_EMPLOYEES
          - ALL_USERS
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Resolve Record List Entities
      tags:
      - Record Lists
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolveRecordListEntitiesRequest'
        description: Resource IDs to resolve.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    ResolveRecordListEntitiesRequest:
      properties:
        entityResourceIds:
          description: 'Resource IDs to resolve, batched. Resolve every row of a transaction in one call.

            A resource ID that no longer exists is absent from the result rather than an error.'
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
          uniqueItems: true
        format:
          description: Record list the resource IDs belong to, from the URL path.
          enum:
          - ALL_CUSTOMERS
          - ALL_SUPPLIERS
          - ALL_CONTACTS
          - ALL_EMPLOYEES
          - ALL_USERS
          type: string
      required:
      - entityResourceIds
      - format
      type: object
    PageableResponse:
      properties:
        data:
          description: Result rows for the requested page.
        totalElements:
          description: Total number of records matching the query.
          type: integer
        totalPages:
          description: Total number of pages.
          type: integer
      type: object
    ErrorResponseData:
      properties:
        error_type:
          description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
          example: validation_error
          type: string
        errors:
          description: Error messages describing what went wrong.
          items:
            type: string
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Organization API key. Pass it in the x-jk-api-key header on every request.
      in: header
      name: x-jk-api-key
      type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml