> ## Documentation Index
> Fetch the complete documentation index at: https://learn.breezing.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Invoice Upload Links API

> Request signed upload links for vendor invoice files, the first step of sending received invoices to Breezing for scanning.



## OpenAPI

````yaml POST /invoices/upload-links
openapi: 3.1.0
info:
  title: Breezing Public API
  version: 1.0.0
  description: >-
    Crypto accounting API for programmatic access and AI agents. Authenticate
    with an API key using the Authorization header: `Bearer brz_...`
servers:
  - url: https://api.breezing.io/v1
security:
  - BearerAuth: []
paths:
  /invoices/upload-links:
    post:
      tags:
        - Invoices
      summary: Mint upload links for invoice files
      description: >-
        Step 1 of the two-step intake (the dashboard uses the same flow). For
        each file you get a signed PUT URL into Breezing's storage. Upload the
        bytes with an HTTP PUT to `url` carrying EXACTLY the returned
        `requiredHeaders` (the Content-Type returned with the link and
        `x-goog-content-length-range: 0,20971520`; files above 20971520 bytes
        are rejected by storage). Then call POST /invoices with each file's
        `storagePath` to register it and start the scan. Links expire after 15
        minutes and an upload that is never registered is deleted after a day.
        Quotas: 600 upload links per hour per API key and 2 GB of upload volume
        per company per day (counted from the size cap of each link); beyond
        them the call answers 429 with the reason.


        Supported types: PDF, PNG, JPEG, WebP, HEIC, HEIF. Images are re-encoded
        by the scan worker and stored as JPEG (quality 85, long edge at most
        3000 pixels, metadata stripped) and PDFs are scanned for malware before
        the OCR reads them; an infected file fails its invoice and is never
        read. Intake gates: course organizations cannot upload; non-admin key
        owners need an active subscription. Invoice scans never count against
        the transaction plan usage.
      parameters:
        - schema:
            type: string
            description: >-
              Organization ID. Use GET /v1/companies to discover available
              org/company pairs.
            example: '1'
          required: true
          description: >-
            Organization ID. Use GET /v1/companies to discover available
            org/company pairs.
          name: orgId
          in: query
        - schema:
            type: string
            description: >-
              Company ID. Use GET /v1/companies to discover available companies
              and their access levels.
            example: '1'
          required: true
          description: >-
            Company ID. Use GET /v1/companies to discover available companies
            and their access levels.
          name: companyId
          in: query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceUploadLinksBody'
      responses:
        '200':
          description: Links minted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      links:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            url:
                              type: string
                              description: Signed PUT URL, valid 15 minutes.
                            storagePath:
                              type: string
                              description: >-
                                Pass this back verbatim as the file's
                                storagePath in POST /invoices once the PUT
                                succeeded.
                            maxBytes:
                              type: integer
                            requiredHeaders:
                              type: object
                              additionalProperties:
                                type: string
                              description: Headers the PUT must carry exactly.
                          required:
                            - name
                            - url
                            - storagePath
                            - maxBytes
                            - requiredHeaders
                    required:
                      - links
                required:
                  - success
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            API key has no access to this company, has read-only access where
            write was required, or the company subscription is inactive
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '429':
          description: >-
            Upload link quota reached (links per hour per key, or upload volume
            per company per day)
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
      security:
        - BearerAuth: []
components:
  schemas:
    InvoiceUploadLinksBody:
      type: object
      properties:
        files:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                minLength: 1
                maxLength: 255
                description: Original file name (display only).
                example: aws-march.pdf
              contentType:
                type: string
                enum:
                  - application/pdf
                  - image/png
                  - image/jpeg
                  - image/webp
                  - image/heic
                description: >-
                  Ignored since 2026-10-23: the content type is derived from the
                  extension and returned in requiredHeaders.
              extension:
                type: string
                enum:
                  - pdf
                  - png
                  - jpg
                  - jpeg
                  - webp
                  - heic
                  - heif
            required:
              - name
              - extension
          minItems: 1
          maxItems: 50
          description: Files to mint links for (1-50).
      required:
        - files

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.