invoicepdfs-com Tax Rates API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Tax Rates API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged tax-rates across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: tax-rates
paths:
  /api/v1/tax-rates:
    get:
      tags:
      - tax-rates
      summary: List Tax Rates
      description: 'Named tax rates you can apply by reference, newest first.


        A convenience, not a requirement: a line item can state its rate inline

        instead. Storing one means a rate change is made in a single place.'
      operationId: list_tax_rates
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRatesListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - tax-rates
      summary: Create Tax Rate
      description: 'Store a reusable tax rate.


        `inclusive` decides whether the rate is already inside the unit price or

        added to it — the difference is the total, so it is worth being sure. The

        tax `category` travels with the rate into e-invoicing XML.'
      operationId: create_tax_rate
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxRateCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/tax-rates/{tax_rate_id}:
    get:
      tags:
      - tax-rates
      summary: Get Tax Rate
      description: One stored tax rate.
      operationId: get_tax_rate
      security:
      - HTTPBearer: []
      parameters:
      - name: tax_rate_id
        in: path
        required: true
        schema:
          type: string
          title: Tax Rate Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - tax-rates
      summary: Update Tax Rate
      description: 'Change a stored tax rate.


        Documents already issued keep the rate they were calculated with. This

        affects future documents only.'
      operationId: update_tax_rate
      security:
      - HTTPBearer: []
      parameters:
      - name: tax_rate_id
        in: path
        required: true
        schema:
          type: string
          title: Tax Rate Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxRatePatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - tax-rates
      summary: Delete Tax Rate
      description: Remove a stored tax rate. Documents already issued are unaffected.
      operationId: delete_tax_rate
      security:
      - HTTPBearer: []
      parameters:
      - name: tax_rate_id
        in: path
        required: true
        schema:
          type: string
          title: Tax Rate Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleBoolResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    TaxCategory:
      properties:
        code:
          type: string
          minLength: 1
          title: Code
          description: UNCL5305 tax category code — S standard, Z zero-rated, E exempt, AE reverse charge, K intra-community, G export, O outside scope
          examples:
          - S
        exemption_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Exemption Reason
          description: Required by EN 16931 whenever the category is not standard.
          examples:
          - Reverse charge
        exemption_reason_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Exemption Reason Code
          examples:
          - VATEX-EU-AE
      type: object
      required:
      - code
      title: TaxCategory
      description: 'How a tax is treated, as opposed to what it is called.


        `name` and `rate` do not say this: two taxes at 0% may be zero-rated,

        exempt, reverse-charge or outside scope, and EN 16931 keeps them in

        separate VAT breakdown groups with different mandatory fields. Optional,

        so an invoice that never mentions a category calculates exactly as before.'
    TaxRateOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        rate:
          type: string
          title: Rate
        inclusive:
          type: boolean
          title: Inclusive
        jurisdiction:
          anyOf:
          - type: string
          - type: 'null'
          title: Jurisdiction
        category:
          anyOf:
          - $ref: '#/components/schemas/TaxCategory'
          - type: 'null'
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - name
      - rate
      - inclusive
      - is_active
      - created_at
      - updated_at
      title: TaxRateOut
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    TaxRateResponse:
      properties:
        data:
          $ref: '#/components/schemas/TaxRateOut'
      type: object
      required:
      - data
      title: TaxRateResponse
    TaxRateCreateRequest:
      properties:
        name:
          type: string
          title: Name
          examples:
          - California sales tax
        rate:
          type: string
          title: Rate
          examples:
          - '8.375'
        inclusive:
          type: boolean
          title: Inclusive
          default: false
        jurisdiction:
          anyOf:
          - type: string
          - type: 'null'
          title: Jurisdiction
          examples:
          - US-CA
        category:
          anyOf:
          - $ref: '#/components/schemas/TaxCategory'
          - type: 'null'
          description: Default treatment for this rate. A line item may override it.
      type: object
      required:
      - name
      - rate
      title: TaxRateCreateRequest
    SimpleBoolResponse:
      properties:
        data:
          additionalProperties:
            type: boolean
          type: object
          title: Data
      type: object
      required:
      - data
      title: SimpleBoolResponse
      description: 'Generic boolean response envelope.


        Example:

        {"data": {"deleted": true}}'
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    TaxRatesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TaxRateOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: TaxRatesListResponse
    TaxRatePatchRequest:
      properties:
        name:
          type: string
          title: Name
        rate:
          type: string
          title: Rate
        inclusive:
          type: boolean
          title: Inclusive
        jurisdiction:
          anyOf:
          - type: string
          - type: 'null'
          title: Jurisdiction
        is_active:
          type: boolean
          title: Is Active
        category:
          anyOf:
          - $ref: '#/components/schemas/TaxCategory'
          - type: 'null'
      type: object
      title: TaxRatePatchRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs