invoicepdfs-com Document Attachments API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Document Attachments API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged document-attachments 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: document-attachments
paths:
  /api/v1/documents/{document_id}/attachments:
    get:
      tags:
      - document-attachments
      summary: List Document Attachments
      description: Files attached to this document.
      operationId: list_document_attachments
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceAttachmentsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - document-attachments
      summary: Create Document Attachment
      description: 'Attach an already-uploaded file to a document.


        Takes the `file_id` from `upload_file` rather than the bytes, so one upload

        can be attached to several documents.'
      operationId: create_document_attachment
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceAttachmentCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceAttachmentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/documents/{document_id}/attachments/{attachment_id}:
    delete:
      tags:
      - document-attachments
      summary: Delete Document Attachment
      description: Detach a file from this document. The file itself is kept.
      operationId: delete_document_attachment
      security:
      - HTTPBearer: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: attachment_id
        in: path
        required: true
        schema:
          type: string
          title: Attachment 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:
    InvoiceAttachmentsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/InvoiceAttachmentOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: InvoiceAttachmentsListResponse
    InvoiceAttachmentCreateRequest:
      properties:
        file_id:
          type: string
          title: File Id
          examples:
          - fil_01ABC
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
          examples:
          - Purchase Order
      type: object
      required:
      - file_id
      title: InvoiceAttachmentCreateRequest
    InvoiceAttachmentOut:
      properties:
        id:
          type: string
          title: Id
        invoice_id:
          type: string
          title: Invoice Id
        file_id:
          type: string
          title: File Id
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - invoice_id
      - file_id
      - created_at
      title: InvoiceAttachmentOut
    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
    InvoiceAttachmentResponse:
      properties:
        data:
          $ref: '#/components/schemas/InvoiceAttachmentOut'
      type: object
      required:
      - data
      title: InvoiceAttachmentResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs