invoicepdfs-com Imports API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Imports API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged imports 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: Imports
paths:
  /api/v1/imports:
    post:
      tags:
      - Imports
      summary: Create Import
      description: 'Upload rows to be turned into documents, for review first.


        Nothing is created yet: the rows are parsed and held so you can check them.

        `confirm_import` commits them, `cancel_import` discards them.'
      operationId: create_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportCreateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/imports/{import_id}:
    get:
      tags:
      - Imports
      summary: Get Import
      description: An import's status and how many rows it holds.
      operationId: get_import
      security:
      - HTTPBearer: []
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/imports/{import_id}/confirm:
    post:
      tags:
      - Imports
      summary: Confirm Import
      description: 'Commit a reviewed import, creating its documents.


        Only from `pending` — an import already confirmed or cancelled returns `409`.'
      operationId: confirm_import
      security:
      - HTTPBearer: []
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/imports/{import_id}/cancel:
    post:
      tags:
      - Imports
      summary: Cancel Import
      description: Discard an import without creating anything. Only while it is `pending` or `processing`.
      operationId: cancel_import
      security:
      - HTTPBearer: []
      parameters:
      - name: import_id
        in: path
        required: true
        schema:
          type: string
          title: Import Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    ImportCreateRequest:
      properties:
        source_format:
          type: string
          enum:
          - json
          - csv
          title: Source Format
          examples:
          - csv
        data:
          items:
            additionalProperties: true
            type: object
          type: array
          minItems: 1
          title: Data
      type: object
      required:
      - source_format
      - data
      title: ImportCreateRequest
    ImportResponse:
      properties:
        data:
          $ref: '#/components/schemas/ImportOut'
      type: object
      required:
      - data
      title: ImportResponse
    ImportStatus:
      type: string
      enum:
      - pending
      - completed
      - cancelled
      title: ImportStatus
      description: 'How far an import has got.


        `confirm_import` completes the work before it responds, so an import is

        `pending` until it is confirmed and `completed` immediately afterwards.'
    ImportOut:
      properties:
        id:
          type: string
          title: Id
        source_format:
          type: string
          title: Source Format
        status:
          $ref: '#/components/schemas/ImportStatus'
        total_rows:
          type: integer
          title: Total Rows
        imported_rows:
          type: integer
          title: Imported Rows
        failed_rows:
          type: integer
          title: Failed Rows
        errors:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Errors
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
      type: object
      required:
      - id
      - source_format
      - status
      - total_rows
      - imported_rows
      - failed_rows
      - created_at
      - updated_at
      title: ImportOut
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs