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-tax-profiles-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 Tax Profiles API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Tax Profiles 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: Create and manage tax profiles and their rates.
  name: Tax Profiles
paths:
  /api/v1/tax-profiles:
    get:
      description: List the organization's tax profiles, paginated.
      operationId: list-tax-profiles
      parameters:
      - description: Maximum number of results per page (max 1000).
        in: query
        name: limit
        schema:
          type: integer
          default: 100
      - description: Zero-indexed row offset into the result set.
        in: query
        name: offset
        schema:
          type: integer
      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: List Tax Profiles
      tags:
      - Tax Profiles
    post:
      description: Create a tax profile.
      operationId: create-tax-profile
      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'
        '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: Create Tax Profile
      tags:
      - Tax Profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTaxProfileRequest'
        description: The tax profile to create.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/tax-profiles/search:
    post:
      description: Search tax profiles with filters, sort, and pagination.
      operationId: search-tax-profile
      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: Search Tax Profiles
      tags:
      - Tax Profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTaxProfileRequest'
        description: Search filters, sort, and pagination.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/tax-profiles/{resourceId}:
    delete:
      description: Delete the tax profile.
      operationId: delete-tax-profile
      parameters:
      - description: Resource ID of the tax profile.
        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'
        '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: Delete Tax Profile
      tags:
      - Tax Profiles
    get:
      description: Get a single tax profile by its resource ID.
      operationId: get-tax-profile
      parameters:
      - description: Resource ID of the tax profile.
        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'
        '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 Tax Profile
      tags:
      - Tax Profiles
    put:
      description: Update an existing tax profile.
      operationId: update-tax-profile
      parameters:
      - description: Resource ID of the tax profile.
        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'
        '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: Update Tax Profile
      tags:
      - Tax Profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaxProfileRequest'
        description: The tax profile fields to update.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    SearchTaxProfileRequest:
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/TaxProfileFilter'
          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/TaxProfileSortFilter'
          description: Sort order. Required when offset is set.
      type: object
    TaxProfileFilter:
      properties:
        and:
          description: Combine with another filter using AND.
          type: object
        appliesToPurchase:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Filter by purchase applicability.
        appliesToPurchaseCreditNote:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Filter by supplier credit note applicability.
        appliesToSale:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Filter by sale applicability.
        appliesToSaleCreditNote:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: Filter by customer credit note applicability.
        description:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Description of tax profile.
        isDefault:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: When true, this is the organization's default tax profile.
        isShipping:
          allOf:
          - $ref: '#/components/schemas/BooleanExpression'
          description: When true, the profile applies to shipping.
        name:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Display name of the tax profile.
        not:
          description: Exclude records matching these conditions.
          type: object
        or:
          description: Combine with another filter using OR.
          type: object
        organizationResourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by organization resource ID.
        resourceId:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by tax profile resource ID.
        status:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by status (ACTIVE, INACTIVE).
        taxTypeCode:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Tax Profile Type Code (retrieve the list from '/tax-types' API).
        taxTypeName:
          allOf:
          - $ref: '#/components/schemas/StringExpression'
          description: Filter by tax type name.
        vatValue:
          allOf:
          - $ref: '#/components/schemas/BigDecimalExpression'
          description: Filter by tax rate.
        withholdingValue:
          allOf:
          - $ref: '#/components/schemas/BigDecimalExpression'
          description: Tax Profile Withholding Value % (0-100).
      type: object
    BigDecimalExpression:
      properties:
        eq:
          description: Match values equal to this.
          type: number
        gt:
          description: Match values greater than this.
          type: number
        gte:
          description: Match values greater than or equal to this.
          type: number
        in:
          description: Match values equal to any of these.
          items:
            type: number
          maxItems: 100
          type: array
        inRange:
          description: Match values within this inclusive range (exactly two, low then high).
          items:
            type: number
          type: array
        lt:
          description: Match values less than this.
          type: number
        lte:
          description: Match values less than or equal to this.
          type: number
        neq:
          description: Match values not equal to this.
          type: number
        notInRange:
          description: Match values outside this inclusive range (exactly two, low then high).
          items:
            type: number
          type: array
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    BooleanExpression:
      properties:
        eq:
          description: Match values equal to this.
          type: boolean
      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
    CreateTaxProfileRequest:
      properties:
        description:
          description: Description of tax profile.
          type: string
        isDefault:
          description: When true, this is the organization's default tax profile.
          type: boolean
        isShipping:
          description: When true, the profile applies to shipping.
          type: boolean
        name:
          description: Display name of the tax profile.
          type: string
        taxRate:
          default: 0
          description: Tax Profile Rate % (0-100).
          maximum: 100
          minimum: 0
          type: number
        taxTypeCode:
          description: Tax Profile Type Code (retrieve the list from '/tax-types' API).
          type: string
        withholdingValue:
          description: Tax Profile Withholding Value % (0-100).
          maximum: 100
          minimum: 0
          type: number
      required:
      - description
      - name
      - taxRate
      - taxTypeCode
      type: object
    TaxProfileSortFilter:
      properties:
        order:
          description: Sort direction, ASC or DESC.
          enum:
          - ASC
          - asc
          - DESC
          - desc
          type: string
        sortBy:
          description: Fields to sort by, in priority order.
          items:
            type: string
          maxItems: 15
          type: array
          uniqueItems: true
      required:
      - order
      - sortBy
      type: object
    UpdateTaxProfileRequest:
      properties:
        description:
          description: Description of tax profile.
          type: string
        isDefault:
          description: When true, this is the organization's default tax profile.
          type: boolean
        isShipping:
          description: When true, the profile applies to shipping.
          type: boolean
        name:
          description: Display name of the tax profile.
          type: string
        taxType:
          default: OTHER_NOT_GST
          description: Tax Profile Type Code (retrieve the list from '/tax-types' API).
          type: string
        vatValue:
          description: Tax rate as a percentage.
          maximum: 100
          minimum: 0
          type: number
        withholdingValue:
          description: Tax Profile Withholding Value % (0-100).
          maximum: 100
          minimum: 0
          type: number
      required:
      - description
      - name
      - taxType
      - vatValue
      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