invoicepdfs-com Reference API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Reference API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged reference 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: Reference
paths:
  /api/v1/reference/currencies:
    get:
      tags:
      - Reference
      summary: List Currencies
      description: 'The currency codes a document may be issued in.


        ISO 4217, with the minor-unit count each one uses — the amounts in this API

        are integers in the currency''s smallest unit, so that figure is what says

        where the decimal point goes.'
      operationId: list_currencies
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrenciesListResponse'
      x-visibility: public
  /api/v1/reference/countries:
    get:
      tags:
      - Reference
      summary: List Countries
      description: 'The country codes accepted anywhere an address is given.


        ISO 3166-1 alpha-2.'
      operationId: list_countries
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountriesListResponse'
      x-visibility: public
  /api/v1/reference/locales:
    get:
      tags:
      - Reference
      summary: List Locales
      description: 'The locale codes accepted on a document or business profile.


        The value is stored and returned as given; it is not currently applied to

        anything a render produces.'
      operationId: list_locales
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalesListResponse'
      x-visibility: public
  /api/v1/reference/timezones:
    get:
      tags:
      - Reference
      summary: List Timezones
      description: 'The time zone names accepted on a business profile.


        IANA names. Stored and returned as given: recurring schedules are evaluated

        in UTC and do not consult it.'
      operationId: list_timezones
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezonesListResponse'
      x-visibility: public
  /api/v1/reference/page-sizes:
    get:
      tags:
      - Reference
      summary: List Page Sizes
      description: The page sizes a render can use.
      operationId: list_page_sizes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageSizesListResponse'
      x-visibility: public
  /api/v1/reference/tax-categories:
    get:
      tags:
      - Reference
      summary: List Tax Categories
      description: 'UNCL5305, in full — the VAT treatment of a line, which its rate does not say.


        Two lines at 0% may be zero-rated, exempt, reverse-charge or outside scope,

        and EN 16931 puts them in separate VAT breakdown groups with different

        mandatory fields. Exhaustive: a category outside this list is wrong.'
      operationId: list_tax_categories
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeListResponse'
      x-visibility: public
  /api/v1/reference/tax-schemes:
    get:
      tags:
      - Reference
      summary: List Tax Schemes
      description: 'UNCL5153 — which tax regime a document is issued under, one per document.


        `VAT` is the only member an e-invoice can carry; the others exist so a

        caller can state that their tax is *not* VAT and be told so, rather than

        have VAT assumed on their behalf. There is no default: a PDF does not need

        a scheme, and guessing one puts a claim in a document a tax authority reads

        that the caller never made.'
      operationId: list_tax_schemes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeListResponse'
      x-visibility: public
  /api/v1/reference/unit-codes:
    get:
      tags:
      - Reference
      summary: List Unit Codes
      description: 'UN/ECE Recommendation 20 — the unit a line item is measured in.


        A **shortlist**: twenty-one of hundreds, ordered by how often an invoice

        needs them. `exhaustive` is false, and it means it — `unit_code` accepts any

        value, nothing validates against this list, and an uncommon code is still

        correct. Offered because the field takes a code rather than the printed

        label: mapping "hrs" to HUR is an inference that is right until it silently

        is not, and the audience for the result is a tax authority.'
      operationId: list_unit_codes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeListResponse'
      x-visibility: public
  /api/v1/reference/document-types:
    get:
      tags:
      - Reference
      summary: List Document Types
      description: 'List every supported document type with the metadata a client needs to

        build a type-aware create form: the number prefix, whether it is payable /

        takes a source document / supports a reason, which line-item shape it uses

        (``standard`` = priced, ``shipped`` = quantities only), and the lifecycle

        actions available to it.'
      operationId: list_document_types
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTypesListResponse'
      x-visibility: public
components:
  schemas:
    CurrencyOut:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
        symbol:
          type: string
          title: Symbol
        decimals:
          type: integer
          title: Decimals
      type: object
      required:
      - code
      - name
      - symbol
      - decimals
      title: CurrencyOut
    CountryOut:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
      type: object
      required:
      - code
      - name
      title: CountryOut
    CurrenciesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CurrencyOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: CurrenciesListResponse
    CountriesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CountryOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: CountriesListResponse
    LocaleOut:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
      type: object
      required:
      - code
      - name
      title: LocaleOut
    CodeListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CodeOut'
          type: array
          title: Data
        standard:
          type: string
          title: Standard
          description: The code list these values come from.
          examples:
          - UN/ECE Recommendation 20
        exhaustive:
          type: boolean
          title: Exhaustive
          description: Whether `data` is the complete list. When false it is a shortlist and other codes remain valid.
      type: object
      required:
      - data
      - standard
      - exhaustive
      title: CodeListResponse
      description: 'A coded list from a standard, and whether it is the whole of one.


        `exhaustive` is the field that changes what a client does. `true` means a

        value outside `data` is wrong, so the list can back a picker with no escape

        hatch. `false` means `data` is a shortlist of the codes an invoice usually

        needs — the API accepts any code, nothing validates against this, and

        treating it as closed rejects values that are perfectly valid.'
    CodeOut:
      properties:
        code:
          type: string
          title: Code
          examples:
          - HUR
        label:
          type: string
          title: Label
          examples:
          - Hour
      type: object
      required:
      - code
      - label
      title: CodeOut
    DocumentTypeOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        number_prefix:
          type: string
          title: Number Prefix
        payable:
          type: boolean
          title: Payable
        requires_source_document:
          type: boolean
          title: Requires Source Document
        supports_reason:
          type: boolean
          title: Supports Reason
        line_item_type:
          type: string
          enum:
          - standard
          - shipped
          title: Line Item Type
        actions:
          items:
            type: string
          type: array
          title: Actions
      type: object
      required:
      - id
      - name
      - number_prefix
      - payable
      - requires_source_document
      - supports_reason
      - line_item_type
      - actions
      title: DocumentTypeOut
    PageSizeOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        width_mm:
          type: number
          title: Width Mm
        height_mm:
          type: number
          title: Height Mm
      type: object
      required:
      - id
      - name
      - width_mm
      - height_mm
      title: PageSizeOut
    PageSizesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PageSizeOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: PageSizesListResponse
    TimezoneOut:
      properties:
        name:
          type: string
          title: Name
        offset:
          type: string
          title: Offset
      type: object
      required:
      - name
      - offset
      title: TimezoneOut
    DocumentTypesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/DocumentTypeOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: DocumentTypesListResponse
    LocalesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/LocaleOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: LocalesListResponse
    TimezonesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TimezoneOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: TimezonesListResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs