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/invoicepdfs-com:invoicepdfs-com-numbering-sequences-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: Invoicepdfs Com Numbering Sequences API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged numbering-sequences 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: numbering-sequences
paths:
  /api/v1/numbering-sequences:
    get:
      tags:
      - numbering-sequences
      summary: List Sequences
      description: 'The numbering schemes that produce document numbers, newest first.


        Each names the document type it numbers, so invoices and credit notes can

        run on separate counters.'
      operationId: list_sequences
      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/NumberingSequencesListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - numbering-sequences
      summary: Create Sequence
      description: 'Define how a document type''s numbers are built.


        A prefix, an optional date pattern, and a zero-padded counter — `INV-2026-0001`.

        `reset` decides whether the counter returns to one each year.'
      operationId: create_sequence
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberingSequenceCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberingSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/numbering-sequences/{sequence_id}:
    get:
      tags:
      - numbering-sequences
      summary: Get Sequence
      description: One numbering sequence, including the number it will issue next.
      operationId: get_sequence
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          title: Sequence Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberingSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - numbering-sequences
      summary: Update Sequence
      description: 'Change a numbering scheme.


        Numbers already issued are not rewritten, so a change takes effect from the

        next document. Moving the counter backwards can collide with a number already

        used.'
      operationId: update_sequence
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          title: Sequence Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberingSequencePatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberingSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - numbering-sequences
      summary: Delete Sequence
      description: 'Remove a numbering scheme.


        Documents of that type then need their number supplied explicitly.'
      operationId: delete_sequence
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          title: Sequence 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
  /api/v1/numbering-sequences/{sequence_id}/preview:
    post:
      tags:
      - numbering-sequences
      summary: Preview Sequence
      description: 'Show the next number **without consuming it**.


        Nothing is claimed, so calling this twice returns the same number and the

        number stays available. Use `consume_sequence_number` to take it.'
      operationId: preview_sequence
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          title: Sequence Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberingSequencePreviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/numbering-sequences/{sequence_id}/next:
    post:
      tags:
      - numbering-sequences
      summary: Consume Sequence Number
      description: Consume and return the next number, incrementing the counter.
      operationId: consume_sequence_number
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          title: Sequence Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberingNextResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    NumberingSequenceCreateRequest:
      properties:
        name:
          type: string
          title: Name
          examples:
          - Default invoice sequence
        document_type:
          type: string
          enum:
          - invoice
          - credit_note
          title: Document Type
          default: invoice
        prefix:
          type: string
          title: Prefix
          default: INV-
          examples:
          - INV-
        date_pattern:
          type: string
          title: Date Pattern
          default: '{YYYY}-'
          examples:
          - '{YYYY}-'
        padding:
          type: integer
          maximum: 10.0
          minimum: 1.0
          title: Padding
          default: 5
          examples:
          - 5
        next_number:
          type: integer
          minimum: 1.0
          title: Next Number
          default: 1
          examples:
          - 1001
        reset:
          type: string
          enum:
          - never
          - yearly
          - monthly
          title: Reset
          default: yearly
      type: object
      required:
      - name
      title: NumberingSequenceCreateRequest
    NumberingSequenceResponse:
      properties:
        data:
          $ref: '#/components/schemas/NumberingSequenceOut'
      type: object
      required:
      - data
      title: NumberingSequenceResponse
    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
    NumberingSequenceOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        document_type:
          type: string
          title: Document Type
        prefix:
          type: string
          title: Prefix
        date_pattern:
          type: string
          title: Date Pattern
        padding:
          type: integer
          title: Padding
        next_number:
          type: integer
          title: Next Number
        reset:
          type: string
          title: Reset
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - name
      - document_type
      - prefix
      - date_pattern
      - padding
      - next_number
      - reset
      - created_at
      - updated_at
      title: NumberingSequenceOut
    NumberingSequencePreviewResponse:
      properties:
        data:
          additionalProperties: true
          type: object
          title: Data
      type: object
      required:
      - data
      title: NumberingSequencePreviewResponse
    NumberingNextOut:
      properties:
        number:
          type: string
          title: Number
          examples:
          - AMI-INV-2026-0013
        sequence_id:
          type: string
          title: Sequence Id
        next_number:
          type: integer
          title: Next Number
          description: The counter after this allocation
      type: object
      required:
      - number
      - sequence_id
      - next_number
      title: NumberingNextOut
      description: 'What POST /numbering-sequences/{id}/next allocated.


        The number is the point of the call. It used to answer with the sequence

        row instead, so a caller burned a number and had to reconstruct the string

        itself from prefix, date pattern and padding — the one thing the endpoint

        exists to do for them.'
    NumberingNextResponse:
      properties:
        data:
          $ref: '#/components/schemas/NumberingNextOut'
      type: object
      required:
      - data
      title: NumberingNextResponse
    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
    NumberingSequencesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/NumberingSequenceOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: NumberingSequencesListResponse
    NumberingSequencePatchRequest:
      properties:
        name:
          type: string
          title: Name
        prefix:
          type: string
          title: Prefix
        date_pattern:
          type: string
          title: Date Pattern
        padding:
          type: integer
          maximum: 10.0
          minimum: 1.0
          title: Padding
        next_number:
          type: integer
          minimum: 1.0
          title: Next Number
        reset:
          type: string
          enum:
          - never
          - yearly
          - monthly
          title: Reset
      type: object
      title: NumberingSequencePatchRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs