openapi: 3.0.3
info:
  title: Quaderno Authentication Credits API
  description: 'The Quaderno API is a REST API for tax compliance, invoicing, and sales tax / VAT automation. It exposes resources with predictable, account-scoped URLs and uses standard HTTP features - HTTP Basic Authentication, standard methods, and response codes. All requests and responses are JSON, and every endpoint path ends in `.json` to indicate JSON serialization.

    The base URL is account-scoped: `https://ACCOUNT_NAME.quadernoapp.com/api`, where `ACCOUNT_NAME` is your Quaderno account subdomain. Authenticate with your private API key as the HTTP Basic Auth username (any value for the password). Sandbox testing is available on a separate sandbox host.

    Core resources include Contacts, Items, Invoices, Credits, Estimates, Expenses, Recurring documents, Payments, Transactions, Checkout Sessions, Webhooks, and the tax engine (tax rate calculation, tax jurisdictions, tax codes, and tax ID validation). Endpoint paths and the account-scoped base URL are confirmed against Quaderno''s public developer documentation and the official quaderno-ruby SDK; request and response bodies are modeled and should be verified against the live API reference.'
  version: '1.0'
  contact:
    name: Quaderno
    url: https://developers.quaderno.io
  license:
    name: Proprietary
    url: https://quaderno.io/terms/
servers:
- url: https://{account}.quadernoapp.com/api
  description: Production (account-scoped)
  variables:
    account:
      default: ACCOUNT_NAME
      description: Your Quaderno account subdomain.
security:
- basicAuth: []
tags:
- name: Credits
  description: Credit notes issued against invoices.
paths:
  /credits.json:
    get:
      operationId: listCredits
      tags:
      - Credits
      summary: List credit notes
      parameters:
      - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: A list of credit notes.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Credit'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCredit
      tags:
      - Credits
      summary: Create a credit note
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditInput'
      responses:
        '201':
          description: The created credit note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credit'
        '422':
          $ref: '#/components/responses/ValidationError'
  /credits/{id}.json:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      operationId: getCredit
      tags:
      - Credits
      summary: Retrieve a credit note
      responses:
        '200':
          description: The requested credit note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credit'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateCredit
      tags:
      - Credits
      summary: Update a credit note
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditInput'
      responses:
        '200':
          description: The updated credit note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credit'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteCredit
      tags:
      - Credits
      summary: Delete a credit note
      responses:
        '204':
          description: The credit note was deleted.
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: The request payload failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    CreditInput:
      type: object
      required:
      - contact_id
      properties:
        contact_id:
          type: string
        invoice_id:
          type: string
          description: The invoice this credit note is issued against.
        currency:
          type: string
        items_attributes:
          type: array
          items:
            $ref: '#/components/schemas/DocumentItem'
        notes:
          type: string
    Credit:
      allOf:
      - $ref: '#/components/schemas/CreditInput'
      - type: object
        properties:
          id:
            type: string
          number:
            type: string
          issue_date:
            type: string
          total:
            type: number
    DocumentItem:
      type: object
      description: A line item on a document.
      properties:
        description:
          type: string
        quantity:
          type: number
        unit_price:
          type: number
        discount_rate:
          type: number
        tax_1_name:
          type: string
        tax_1_rate:
          type: number
        tax_code:
          type: string
        reference:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
          additionalProperties: true
  parameters:
    Id:
      name: id
      in: path
      required: true
      description: The unique ID of the resource.
      schema:
        type: string
    Page:
      name: page
      in: query
      required: false
      description: Page number for paginated results (25 records per page).
      schema:
        type: integer
        default: 1
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication. Use your private API key as the username; the password can be any value. API keys are managed in the Quaderno account settings.