find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/tinvio-com:tinvio-com-claim-types-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Tinvio Com Claim Types API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Claim Types 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: Manage the organization's claim types, the expense categories with default posting accounts.
  name: Claim Types
paths:
  /api/v1/claim-types:
    get:
      description: List all of the organization's claim types, alphabetical by name.
      operationId: list-claim-types
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '402':
          description: Payment Required
          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 Claim Types
      tags:
      - Claim Types
    post:
      description: Create a claim type.
      operationId: create-claim-type
      responses:
        '201':
          description: Created
          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'
        '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: Create Claim Type
      tags:
      - Claim Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClaimTypeRequest'
        description: The claim type to create.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/claim-types/search:
    post:
      description: Search claim types with filters, sort, and pagination.
      operationId: search-claim-type
      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'
        '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: Search Claim Types
      tags:
      - Claim Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchClaimTypesRequest'
        description: Search filters, sort, and pagination.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/claim-types/{resourceId}:
    delete:
      description: Soft-delete a claim type. The name becomes reusable immediately. Types referenced by live claims may be blocked server-side.
      operationId: delete-claim-type
      parameters:
      - description: Resource ID of the claim type.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '402':
          description: Payment Required
          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: Delete Claim Type
      tags:
      - Claim Types
    get:
      description: Get a single claim type by its resource ID. Returns CLAIM_TYPE_NOT_FOUND when it does not exist.
      operationId: get-claim-type
      parameters:
      - description: Resource ID of the claim type.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '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: Get Claim Type
      tags:
      - Claim Types
    put:
      description: Update an existing claim type.
      operationId: update-claim-type
      parameters:
      - description: Resource ID of the claim type.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      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'
        '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: Update Claim Type
      tags:
      - Claim Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClaimTypeRequest'
        description: The claim type fields to update.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    CreateClaimTypeRequest:
      properties:
        classifierConfig:
          description: Classifier defaults for the Magic OCR pipeline (JSON string, passed through).
          type: string
        expenseAccountResourceId:
          description: 'Default expense CoA for lines of this type (UUIDv4). Schema-optional, but the

            server requires a resolvable posting account by submit time; supplying it here

            makes the type self-sufficient.'
          type: string
        name:
          description: Display name (max 255, case-insensitive unique per organization). Required.
          example: Travel
          maxLength: 255
          type: string
        taxProfileResourceId:
          description: Resource ID of the default tax profile. Optional for organizations without VAT.
          type: string
      required:
      - name
      type: object
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    DateExpression:
      properties:
        between:
          description: Match dates between these two dates (exactly two, in YYYY-MM-DD format).
          items:
            type: string
          type: array
        eq:
          description: Match dates equal to this, in YYYY-MM-DD format.
          type: string
        gt:
          description: Match dates after this, in YYYY-MM-DD format.
          type: string
        gte:
          description: Match dates on or after this, in YYYY-MM-DD format.
          type: string
        isNotNull:
          description: Match records where the date is set. Pass the placeholder date "0001-01-01".
          example: '0001-01-01'
          type: string
        isNull:
          description: Match records where the date is not set. Pass the placeholder date "0001-01-01".
          example: '0001-01-01'
          type: string
        lt:
          description: Match dates before this, in YYYY-MM-DD format.
          type: string
        lte:
          description: Match dates on or before this, in YYYY-MM-DD format.
          type: string
        notBetween:
          description: Match dates outside these two dates (exactly two, in YYYY-MM-DD format).
          items:
            type: string
          type: array
      required:
      - between
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    StringExpression:
      properties:
        contains:
          description: Match values containing this substring.
          type: string
        endWith:
          description: Match values ending with this term (case sensitive).
          type: string
        eq:
          description: Match values equal to this.
          type: string
        in:
          description: Match values equal to any of these.
          items:
            type: string
          maxItems: 100
          type: array
        isBlank:
          description: Match records where the field is null or empty ("true") or neither ("false").
          type: string
        isNotBlank:
          description: Match records where the field is neither null nor empty ("true").
          type: string
        isNull:
          description: Match records where the field is null ("true") or not null ("false").
          type: string
        likeIn:
          description: Match values containing any of these substrings.
          items:
            type: string
          maxItems: 100
          type: array
        neq:
          description: Match values not equal to this.
          type: string
        notContains:
          description: Match values not containing this substring.
          type: string
        notEndWith:
          description: Match values not ending with this term (case sensitive).
          type: string
        notStartWith:
          description: Match values not starting with this term (case sensitive).
          type: string
        reg:
          description: Match values containing any of these terms. This is a substring match, not a regular expression, despite the name.
          items:
            type: string
          maxItems: 100
          type: array
        startWith:
          description: Match values starting with this term (case sensitive).
          type: string
      required:
      - in
      - likeIn
      - reg
      type: object
    ClaimTypeFilter:
      properties:
        and:
          description: Combine with another filter using AND.
          type: object
        createdAt:
          allOf:
          - $ref: '#/components/schemas/DateExpression'
          description: Filter by creation time.
        expenseAccountResourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by expense account resource ID.
        name:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by name.
        or:
          description: Combine with another filter using OR.
          type: object
        resourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by resource ID.
        taxProfileResourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by tax profile resource ID.
      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
    ClaimConfigSortFilter:
      properties:
        order:
          description: Sort direction, ASC or DESC.
          enum:
          - ASC
          - DESC
          type: string
        sortBy:
          description: Fields to sort by, in priority order.
          items:
            enum:
            - resourceId
            - name
            - isDefault
            - createdAt
            - updatedAt
            type: string
          maxItems: 10
          type: array
          uniqueItems: true
      required:
      - order
      - sortBy
      type: object
    UpdateClaimTypeRequest:
      properties:
        classifierConfig:
          description: Classifier assignments for the line.
          type: string
        clearClassifierConfig:
          description: When true, clears classifierConfig on the profile.
          type: boolean
        clearExpenseAccountResourceId:
          description: When true, clears expenseAccountResourceId on the claim type.
          type: boolean
        clearTaxProfileResourceId:
          description: When true, clears taxProfileResourceId on the claim type.
          type: boolean
        expenseAccountResourceId:
          description: Default expense CoA for lines of this type (UUIDv4). Schema-optional, but the server requires a resolvable posting account by submit time; supplying it here makes the type self-sufficient.
          type: string
        name:
          description: Display name (max 255, case-insensitive unique per organization). Null means no change.
          maxLength: 255
          type: string
        resourceId:
          description: Resource ID of the claim type, from the URL path.
          type: string
        taxProfileResourceId:
          description: Resource ID of the default tax profile. Optional for organizations without VAT.
          type: string
      required:
      - resourceId
      type: object
    SearchClaimTypesRequest:
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/ClaimTypeFilter'
          description: Filter conditions. Combine with and and or for complex queries.
        limit:
          default: 100
          description: Maximum number of results per page (max 1000).
          maximum: 1000
          minimum: 1
          type: integer
        offset:
          default: 0
          description: Zero-indexed row offset into the result set. Sort is required when offset is set.
          maximum: 65536
          minimum: 0
          type: integer
        query:
          description: 'Structured search query using Jaz search operators. Parsed automatically into filter fields.

            Explicit filter fields override query results on conflict.

            Example: "status:unpaid AND $500+".'
          maxLength: 1000
          type: string
        sort:
          allOf:
          - $ref: '#/components/schemas/ClaimConfigSortFilter'
          description: Sort order. Required when offset is set.
      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