openapi: 3.1.0
info:
  title: AbaNinja Documents API - Supplier Credit Notes
  version: 3.0.0
  x-domain-id: documents
servers:
  - url: https://api.abaninja.ch
    description: The AbaNinja API server
tags:
  - name: document-supplier-credit-notes
    description: Manage supplier credit notes
    x-displayName: Supplier Credit Notes
security:
  - ApiToken: []
paths:
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get supplier credit notes
      description: Get supplier credit notes
      operationId: documents_list_supplier_credit_notes
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: updatedSince
          in: query
          description: filter for updated items
          required: false
          schema: {}
        - name: limit
          in: query
          description: pagination limit
          required: false
          schema:
            type:
              - number
              - 'null'
            maximum: 400
            minimum: 1
        - name: page
          in: query
          description: pagination page
          required: false
          schema:
            type:
              - number
              - 'null'
            default: 1
            minimum: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      documents:
                        type: array
                        items:
                          title: Supplier Credit Note Collection Item Resource
                          description: Resource used in collections
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            currencyCode:
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            currencyCodeRecognized:
                              description: >-
                                when importing invoices and detecting the currency, this field contains the detected
                                value
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            reference:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - open
                                - sending
                                - send-failed
                                - sent
                                - viewed
                                - approved
                                - declined
                                - partial
                                - paid
                                - in-payment
                                - collected
                                - planned
                                - pending
                                - archived
                                - cancelled
                                - converted
                                - due
                                - reminder
                                - first-dunning
                                - second-dunning
                                - final-dunning
                                - inactive
                                - active
                                - inbox
                                - expired
                                - done
                                - assign
                                - awaiting-payment
                                - error
                            receiver:
                              properties:
                                addressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                customerNumber:
                                  type:
                                    - string
                                    - 'null'
                                name:
                                  type:
                                    - string
                                    - 'null'
                                email:
                                  type:
                                    - string
                                    - 'null'
                                  format: email
                                personUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                            supplierCreditNoteNumber:
                              type: string
                            supplierCreditNoteDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            dueDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            documentTotal:
                              type: number
                              format: float
                          type: object
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 7af80e2db1037132be0f8b1612e3dade
      x-required-scopes:
        - suppliers
    post:
      tags:
        - document-supplier-credit-notes
      summary: Create supplier credit notes
      description: Create supplier credit notes
      operationId: documents_create_supplier_credit_notes
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Create supplier credit notes
        required: true
        content:
          multipart/form-data:
            schema:
              properties:
                data:
                  $schema: https://json-schema.org/draft/2020-12/schema
                  $id: https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note-multipart.schema.json
                  description: A Schema for importing supplier credit note pdfs in AbaNinja over API
                  type: object
                  properties:
                    documents:
                      type: array
                      items:
                        type: object
                        properties:
                          documentFile:
                            type: string
                            description: The file name when uploading the document as multipart request
                          documentData:
                            type: object
                            description: Additional Data for the invoice document
                            properties:
                              currencyCode:
                                type: string
                                pattern: ^[A-Z]{3}$
                              receiver:
                                $schema: https://json-schema.org/draft/2020-12/schema
                                $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                                description: Invoice Receiver for AbaNinja Invoice Json
                                type: object
                                $defs:
                                  personAddress:
                                    type: object
                                    properties:
                                      addressUuid:
                                        type: string
                                        format: uuid
                                      personUuid:
                                        type: string
                                        format: uuid
                                      deliveryAddressUuid:
                                        type:
                                          - 'null'
                                          - string
                                        format: uuid
                                    required:
                                      - addressUuid
                                      - personUuid
                                  companyAddress:
                                    type: object
                                    properties:
                                      addressUuid:
                                        type: string
                                        format: uuid
                                      companyUuid:
                                        type: string
                                        format: uuid
                                      contactPersonUuid:
                                        type:
                                          - 'null'
                                          - string
                                        format: uuid
                                        description: UUID of contact person inside company
                                      deliveryAddressUuid:
                                        type:
                                          - 'null'
                                          - string
                                        format: uuid
                                      additionalReceivers:
                                        type: array
                                        maxItems: 5
                                        items:
                                          type: object
                                          properties:
                                            personUuid:
                                              type: string
                                              format: uuid
                                              description: UUID of contact person inside given company
                                          required:
                                            - personUuid
                                          additionalProperties: false
                                    required:
                                      - addressUuid
                                      - companyUuid
                                  additionalCompanyReceiver:
                                    type: object
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                        description: UUID of contact person inside given company
                                    required:
                                      - personUuid
                                    additionalProperties: false
                                  customerNumberReceiver:
                                    type: object
                                    properties:
                                      customerNumber:
                                        type: string
                                    required:
                                      - customerNumber
                                properties:
                                  addressUuid:
                                    type: string
                                    format: uuid
                                  personUuid:
                                    type: string
                                    format: uuid
                                  deliveryAddressUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                  companyUuid:
                                    type: string
                                    format: uuid
                                  contactPersonUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                    description: UUID of contact person inside company
                                  additionalReceivers:
                                    type: array
                                    maxItems: 5
                                    items:
                                      type: object
                                      properties:
                                        personUuid:
                                          type: string
                                          format: uuid
                                          description: UUID of contact person inside given company
                                      required:
                                        - personUuid
                                      additionalProperties: false
                                  customerNumber:
                                    type: string
                                required:
                                  - addressUuid
                                  - personUuid
                                  - companyUuid
                                  - customerNumber
                              supplierCreditNoteDate:
                                type: string
                                format: date
                              dueDate:
                                type: string
                                format: date
                              reference:
                                type: string
                              documentTotal:
                                type: number
                                exclusiveMinimum: 0
                                description: Total Amount incl. VAT
                              taxPositions:
                                type: array
                                items:
                                  $schema: https://json-schema.org/draft/2020-12/schema
                                  $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                                  description: A Schema for tax positions for imported invoices
                                  type: object
                                  properties:
                                    id:
                                      type:
                                        - integer
                                        - 'null'
                                      exclusiveMinimum: 0
                                      deprecated: true
                                      description: identifier of the object. "uuid" should be used instead
                                    uuid:
                                      type:
                                        - string
                                        - 'null'
                                      format: uuid
                                    accountNumber:
                                      type: integer
                                      minimum: 1000
                                      maximum: 999999999999
                                      deprecated: true
                                      description: The booking account number. Use bookingAccountUuid instead.
                                    bookingAccountUuid:
                                      type:
                                        - string
                                        - 'null'
                                      format: uuid
                                    isTaxIncluded:
                                      type: boolean
                                      default: false
                                      description: controls if amount already includes tax or not
                                    amount:
                                      type: number
                                    taxRate:
                                      type: number
                                      minimum: 0
                                      maximum: 100
                                      deprecated: true
                                      description: Tax Rate to apply. Use "taxRateUuid" instead
                                    taxRateUuid:
                                      type:
                                        - 'null'
                                        - string
                                      format: uuid
                                  required:
                                    - amount
                                minItems: 1
                              wasTaxIncluded:
                                type: boolean
                                default: false
                                description: Controls whether tax was included during supplier credit note invoicing
                            required:
                              - currencyCode
                              - receiver
                              - supplierCreditNoteDate
                              - dueDate
                              - documentTotal
                              - taxPositions
                        required:
                          - documentFile
                      minItems: 1
                  required:
                    - documents
                  $defs:
                    singleDocument:
                      type: object
                      properties:
                        documentFile:
                          type: string
                          description: The file name when uploading the document as multipart request
                        documentData:
                          type: object
                          description: Additional Data for the invoice document
                          properties:
                            currencyCode:
                              type: string
                              pattern: ^[A-Z]{3}$
                            receiver:
                              $schema: https://json-schema.org/draft/2020-12/schema
                              $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                              description: Invoice Receiver for AbaNinja Invoice Json
                              type: object
                              $defs:
                                personAddress:
                                  type: object
                                  properties:
                                    addressUuid:
                                      type: string
                                      format: uuid
                                    personUuid:
                                      type: string
                                      format: uuid
                                    deliveryAddressUuid:
                                      type:
                                        - 'null'
                                        - string
                                      format: uuid
                                  required:
                                    - addressUuid
                                    - personUuid
                                companyAddress:
                                  type: object
                                  properties:
                                    addressUuid:
                                      type: string
                                      format: uuid
                                    companyUuid:
                                      type: string
                                      format: uuid
                                    contactPersonUuid:
                                      type:
                                        - 'null'
                                        - string
                                      format: uuid
                                      description: UUID of contact person inside company
                                    deliveryAddressUuid:
                                      type:
                                        - 'null'
                                        - string
                                      format: uuid
                                    additionalReceivers:
                                      type: array
                                      maxItems: 5
                                      items:
                                        type: object
                                        properties:
                                          personUuid:
                                            type: string
                                            format: uuid
                                            description: UUID of contact person inside given company
                                        required:
                                          - personUuid
                                        additionalProperties: false
                                  required:
                                    - addressUuid
                                    - companyUuid
                                additionalCompanyReceiver:
                                  type: object
                                  properties:
                                    personUuid:
                                      type: string
                                      format: uuid
                                      description: UUID of contact person inside given company
                                  required:
                                    - personUuid
                                  additionalProperties: false
                                customerNumberReceiver:
                                  type: object
                                  properties:
                                    customerNumber:
                                      type: string
                                  required:
                                    - customerNumber
                              properties:
                                addressUuid:
                                  type: string
                                  format: uuid
                                personUuid:
                                  type: string
                                  format: uuid
                                deliveryAddressUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                  description: UUID of contact person inside company
                                additionalReceivers:
                                  type: array
                                  maxItems: 5
                                  items:
                                    type: object
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                        description: UUID of contact person inside given company
                                    required:
                                      - personUuid
                                    additionalProperties: false
                                customerNumber:
                                  type: string
                              required:
                                - addressUuid
                                - personUuid
                                - companyUuid
                                - customerNumber
                            supplierCreditNoteDate:
                              type: string
                              format: date
                            dueDate:
                              type: string
                              format: date
                            reference:
                              type: string
                            documentTotal:
                              type: number
                              exclusiveMinimum: 0
                              description: Total Amount incl. VAT
                            taxPositions:
                              type: array
                              items:
                                $schema: https://json-schema.org/draft/2020-12/schema
                                $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                                description: A Schema for tax positions for imported invoices
                                type: object
                                properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    exclusiveMinimum: 0
                                    deprecated: true
                                    description: identifier of the object. "uuid" should be used instead
                                  uuid:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                  accountNumber:
                                    type: integer
                                    minimum: 1000
                                    maximum: 999999999999
                                    deprecated: true
                                    description: The booking account number. Use bookingAccountUuid instead.
                                  bookingAccountUuid:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                  isTaxIncluded:
                                    type: boolean
                                    default: false
                                    description: controls if amount already includes tax or not
                                  amount:
                                    type: number
                                  taxRate:
                                    type: number
                                    minimum: 0
                                    maximum: 100
                                    deprecated: true
                                    description: Tax Rate to apply. Use "taxRateUuid" instead
                                  taxRateUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                required:
                                  - amount
                              minItems: 1
                            wasTaxIncluded:
                              type: boolean
                              default: false
                              description: Controls whether tax was included during supplier credit note invoicing
                          required:
                            - currencyCode
                            - receiver
                            - supplierCreditNoteDate
                            - dueDate
                            - documentTotal
                            - taxPositions
                      required:
                        - documentFile
                files:
                  type: array
                  items:
                    type: string
                    format: binary
                  maximum: 5
                  minimum: 1
              type: object
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              $id: https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note.schema.json
              description: A Schema for importing supplier credit note pdfs in AbaNinja over API
              type: object
              properties:
                documents:
                  type: array
                  items:
                    type: object
                    properties:
                      documentUrl:
                        type: string
                        format: uri
                        description: The url where to download the document file to import
                      documentData:
                        type: object
                        description: Additional Data for the invoice document
                        properties:
                          currencyCode:
                            type: string
                            pattern: ^[A-Z]{3}$
                          receiver:
                            $schema: https://json-schema.org/draft/2020-12/schema
                            $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                            description: Invoice Receiver for AbaNinja Invoice Json
                            type: object
                            $defs:
                              personAddress:
                                type: object
                                properties:
                                  addressUuid:
                                    type: string
                                    format: uuid
                                  personUuid:
                                    type: string
                                    format: uuid
                                  deliveryAddressUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                required:
                                  - addressUuid
                                  - personUuid
                              companyAddress:
                                type: object
                                properties:
                                  addressUuid:
                                    type: string
                                    format: uuid
                                  companyUuid:
                                    type: string
                                    format: uuid
                                  contactPersonUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                    description: UUID of contact person inside company
                                  deliveryAddressUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                  additionalReceivers:
                                    type: array
                                    maxItems: 5
                                    items:
                                      type: object
                                      properties:
                                        personUuid:
                                          type: string
                                          format: uuid
                                          description: UUID of contact person inside given company
                                      required:
                                        - personUuid
                                      additionalProperties: false
                                required:
                                  - addressUuid
                                  - companyUuid
                              additionalCompanyReceiver:
                                type: object
                                properties:
                                  personUuid:
                                    type: string
                                    format: uuid
                                    description: UUID of contact person inside given company
                                required:
                                  - personUuid
                                additionalProperties: false
                              customerNumberReceiver:
                                type: object
                                properties:
                                  customerNumber:
                                    type: string
                                required:
                                  - customerNumber
                            properties:
                              addressUuid:
                                type: string
                                format: uuid
                              personUuid:
                                type: string
                                format: uuid
                              deliveryAddressUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                              companyUuid:
                                type: string
                                format: uuid
                              contactPersonUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                                description: UUID of contact person inside company
                              additionalReceivers:
                                type: array
                                maxItems: 5
                                items:
                                  type: object
                                  properties:
                                    personUuid:
                                      type: string
                                      format: uuid
                                      description: UUID of contact person inside given company
                                  required:
                                    - personUuid
                                  additionalProperties: false
                              customerNumber:
                                type: string
                            required:
                              - addressUuid
                              - personUuid
                              - companyUuid
                              - customerNumber
                          supplierCreditNoteDate:
                            type: string
                            format: date
                          dueDate:
                            type: string
                            format: date
                          reference:
                            type: string
                          documentTotal:
                            type: number
                            exclusiveMinimum: 0
                            description: Total Amount incl. VAT
                          taxPositions:
                            type: array
                            items:
                              $schema: https://json-schema.org/draft/2020-12/schema
                              $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                              description: A Schema for tax positions for imported invoices
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  exclusiveMinimum: 0
                                  deprecated: true
                                  description: identifier of the object. "uuid" should be used instead
                                uuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                accountNumber:
                                  type: integer
                                  minimum: 1000
                                  maximum: 999999999999
                                  deprecated: true
                                  description: The booking account number. Use bookingAccountUuid instead.
                                bookingAccountUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                isTaxIncluded:
                                  type: boolean
                                  default: false
                                  description: controls if amount already includes tax or not
                                amount:
                                  type: number
                                taxRate:
                                  type: number
                                  minimum: 0
                                  maximum: 100
                                  deprecated: true
                                  description: Tax Rate to apply. Use "taxRateUuid" instead
                                taxRateUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                              required:
                                - amount
                            minItems: 1
                          wasTaxIncluded:
                            type: boolean
                            default: false
                            description: Controls whether tax was included during supplier credit note invoicing
                        required:
                          - currencyCode
                          - receiver
                          - supplierCreditNoteDate
                          - dueDate
                          - documentTotal
                          - taxPositions
                    required:
                      - documentUrl
                  minItems: 1
              required:
                - documents
              $defs:
                singleDocument:
                  type: object
                  properties:
                    documentUrl:
                      type: string
                      format: uri
                      description: The url where to download the document file to import
                    documentData:
                      type: object
                      description: Additional Data for the invoice document
                      properties:
                        currencyCode:
                          type: string
                          pattern: ^[A-Z]{3}$
                        receiver:
                          $schema: https://json-schema.org/draft/2020-12/schema
                          $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                          description: Invoice Receiver for AbaNinja Invoice Json
                          type: object
                          $defs:
                            personAddress:
                              type: object
                              properties:
                                addressUuid:
                                  type: string
                                  format: uuid
                                personUuid:
                                  type: string
                                  format: uuid
                                deliveryAddressUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                              required:
                                - addressUuid
                                - personUuid
                            companyAddress:
                              type: object
                              properties:
                                addressUuid:
                                  type: string
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                  description: UUID of contact person inside company
                                deliveryAddressUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                additionalReceivers:
                                  type: array
                                  maxItems: 5
                                  items:
                                    type: object
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                        description: UUID of contact person inside given company
                                    required:
                                      - personUuid
                                    additionalProperties: false
                              required:
                                - addressUuid
                                - companyUuid
                            additionalCompanyReceiver:
                              type: object
                              properties:
                                personUuid:
                                  type: string
                                  format: uuid
                                  description: UUID of contact person inside given company
                              required:
                                - personUuid
                              additionalProperties: false
                            customerNumberReceiver:
                              type: object
                              properties:
                                customerNumber:
                                  type: string
                              required:
                                - customerNumber
                          properties:
                            addressUuid:
                              type: string
                              format: uuid
                            personUuid:
                              type: string
                              format: uuid
                            deliveryAddressUuid:
                              type:
                                - 'null'
                                - string
                              format: uuid
                            companyUuid:
                              type: string
                              format: uuid
                            contactPersonUuid:
                              type:
                                - 'null'
                                - string
                              format: uuid
                              description: UUID of contact person inside company
                            additionalReceivers:
                              type: array
                              maxItems: 5
                              items:
                                type: object
                                properties:
                                  personUuid:
                                    type: string
                                    format: uuid
                                    description: UUID of contact person inside given company
                                required:
                                  - personUuid
                                additionalProperties: false
                            customerNumber:
                              type: string
                          required:
                            - addressUuid
                            - personUuid
                            - companyUuid
                            - customerNumber
                        supplierCreditNoteDate:
                          type: string
                          format: date
                        dueDate:
                          type: string
                          format: date
                        reference:
                          type: string
                        documentTotal:
                          type: number
                          exclusiveMinimum: 0
                          description: Total Amount incl. VAT
                        taxPositions:
                          type: array
                          items:
                            $schema: https://json-schema.org/draft/2020-12/schema
                            $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                            description: A Schema for tax positions for imported invoices
                            type: object
                            properties:
                              id:
                                type:
                                  - integer
                                  - 'null'
                                exclusiveMinimum: 0
                                deprecated: true
                                description: identifier of the object. "uuid" should be used instead
                              uuid:
                                type:
                                  - string
                                  - 'null'
                                format: uuid
                              accountNumber:
                                type: integer
                                minimum: 1000
                                maximum: 999999999999
                                deprecated: true
                                description: The booking account number. Use bookingAccountUuid instead.
                              bookingAccountUuid:
                                type:
                                  - string
                                  - 'null'
                                format: uuid
                              isTaxIncluded:
                                type: boolean
                                default: false
                                description: controls if amount already includes tax or not
                              amount:
                                type: number
                              taxRate:
                                type: number
                                minimum: 0
                                maximum: 100
                                deprecated: true
                                description: Tax Rate to apply. Use "taxRateUuid" instead
                              taxRateUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                            required:
                              - amount
                          minItems: 1
                        wasTaxIncluded:
                          type: boolean
                          default: false
                          description: Controls whether tax was included during supplier credit note invoicing
                      required:
                        - currencyCode
                        - receiver
                        - supplierCreditNoteDate
                        - dueDate
                        - documentTotal
                        - taxPositions
                  required:
                    - documentUrl
      responses:
        '201':
          description: Supplier credit note created
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      documents:
                        type: array
                        items:
                          title: Supplier Credit Note Resource
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            currencyCode:
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            currencyCodeRecognized:
                              description: >-
                                when importing invoices and detecting the currency, this field contains the detected
                                value
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            receiver:
                              properties:
                                addressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                networkUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                networkKey:
                                  type:
                                    - string
                                    - 'null'
                                networkName:
                                  type:
                                    - string
                                    - 'null'
                                deliveryAddressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                additionalReceivers:
                                  type: array
                                  items:
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                    type: object
                                receiverInformation:
                                  title: Receiver Information Resource
                                  description: Receiver information resource
                                  properties:
                                    customerNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    companyName:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    nameWithSalutation:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    careOfAddress:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    address:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    extension:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    houseNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    zipCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    city:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    countryCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    email:
                                      type:
                                        - string
                                        - 'null'
                                      format: email
                                      readOnly: true
                                    language:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                      enum:
                                        - de
                                        - en
                                        - fr
                                        - it
                                    deliveryAddress:
                                      properties:
                                        companyName:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        name:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        nameWithSalutation:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        careOfAddress:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        address:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        extension:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        houseNumber:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        zipCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        city:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        countryCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                      type: object
                                      readOnly: true
                                    additionalReceivers:
                                      type: array
                                      items:
                                        properties:
                                          fullName:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                          email:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                        type: object
                                      readOnly: true
                                  type: object
                                personUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                            supplierCreditNoteNumber:
                              type: string
                            supplierCreditNoteDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            dueDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            documentTotal:
                              type: number
                              format: float
                            taxPositions:
                              type: array
                              items:
                                title: Receipt Tax Position Resource
                                properties:
                                  id:
                                    type: integer
                                    format: int64
                                  accountNumber:
                                    type: integer
                                    format: int64
                                  isTaxIncluded:
                                    type: boolean
                                  amount:
                                    type: number
                                    format: float
                                  taxRate:
                                    type: number
                                    format: float
                                  taxRateUuid:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                type: object
                            isTemplate:
                              type: boolean
                            openAmount:
                              type: number
                              format: float
                            reference:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - open
                                - sending
                                - send-failed
                                - sent
                                - viewed
                                - approved
                                - declined
                                - partial
                                - paid
                                - in-payment
                                - collected
                                - planned
                                - pending
                                - archived
                                - cancelled
                                - converted
                                - due
                                - reminder
                                - first-dunning
                                - second-dunning
                                - final-dunning
                                - inactive
                                - active
                                - inbox
                                - expired
                                - done
                                - assign
                                - awaiting-payment
                                - error
                            type:
                              type: string
                              enum:
                                - supplier_credit_note
                            wasTaxIncluded:
                              type: boolean
                            wasRecognitionLimitReached:
                              type: boolean
                          type: object
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 201
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '202':
          description: Asynchronous processing
          content:
            application/json:
              schema:
                properties:
                  data:
                    title: Asynchronous Import Resource
                    description: Resource for asynchronous document imports
                    properties:
                      status:
                        type: string
                        format: uri
                      queueUuid:
                        type: string
                        format: uuid
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 202
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 1be3ab7dd3d00097957a7711dc3471e8
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{supplierCreditNoteUuid}:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get supplier credit note
      description: Get a single supplier credit note
      operationId: documents_get_supplier_credit_notes
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: supplierCreditNoteUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      documents:
                        type: array
                        items:
                          title: Supplier Credit Note Resource
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            currencyCode:
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            currencyCodeRecognized:
                              description: >-
                                when importing invoices and detecting the currency, this field contains the detected
                                value
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            receiver:
                              properties:
                                addressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                networkUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                networkKey:
                                  type:
                                    - string
                                    - 'null'
                                networkName:
                                  type:
                                    - string
                                    - 'null'
                                deliveryAddressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                additionalReceivers:
                                  type: array
                                  items:
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                    type: object
                                receiverInformation:
                                  title: Receiver Information Resource
                                  description: Receiver information resource
                                  properties:
                                    customerNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    companyName:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    nameWithSalutation:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    careOfAddress:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    address:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    extension:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    houseNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    zipCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    city:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    countryCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    email:
                                      type:
                                        - string
                                        - 'null'
                                      format: email
                                      readOnly: true
                                    language:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                      enum:
                                        - de
                                        - en
                                        - fr
                                        - it
                                    deliveryAddress:
                                      properties:
                                        companyName:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        name:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        nameWithSalutation:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        careOfAddress:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        address:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        extension:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        houseNumber:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        zipCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        city:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        countryCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                      type: object
                                      readOnly: true
                                    additionalReceivers:
                                      type: array
                                      items:
                                        properties:
                                          fullName:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                          email:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                        type: object
                                      readOnly: true
                                  type: object
                                personUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                            supplierCreditNoteNumber:
                              type: string
                            supplierCreditNoteDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            dueDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            documentTotal:
                              type: number
                              format: float
                            taxPositions:
                              type: array
                              items:
                                title: Receipt Tax Position Resource
                                properties:
                                  id:
                                    type: integer
                                    format: int64
                                  accountNumber:
                                    type: integer
                                    format: int64
                                  isTaxIncluded:
                                    type: boolean
                                  amount:
                                    type: number
                                    format: float
                                  taxRate:
                                    type: number
                                    format: float
                                  taxRateUuid:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                type: object
                            isTemplate:
                              type: boolean
                            openAmount:
                              type: number
                              format: float
                            reference:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - open
                                - sending
                                - send-failed
                                - sent
                                - viewed
                                - approved
                                - declined
                                - partial
                                - paid
                                - in-payment
                                - collected
                                - planned
                                - pending
                                - archived
                                - cancelled
                                - converted
                                - due
                                - reminder
                                - first-dunning
                                - second-dunning
                                - final-dunning
                                - inactive
                                - active
                                - inbox
                                - expired
                                - done
                                - assign
                                - awaiting-payment
                                - error
                            type:
                              type: string
                              enum:
                                - supplier_credit_note
                            wasTaxIncluded:
                              type: boolean
                            wasRecognitionLimitReached:
                              type: boolean
                          type: object
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 9116ca8fca3b969df4aaae57c3e4d535
      x-required-scopes:
        - suppliers
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Update supplier credit note
      description: Update supplier credit note
      operationId: documents_update_supplier_credit_notes
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: supplierCreditNoteUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Update supplier credit note
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              $id: https://api.abaninja.ch/schemas/2.0.0/import-supplier-credit-note.update.schema.json
              description: A Schema for updating an imported supplier credit note in AbaNinja over API
              type: object
              properties:
                documents:
                  type: array
                  items:
                    type: object
                    properties:
                      documentData:
                        type: object
                        description: Additional Data for the invoice document
                        properties:
                          currencyCode:
                            type: string
                            pattern: ^[A-Z]{3}$
                          receiver:
                            $schema: https://json-schema.org/draft/2020-12/schema
                            $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                            description: Invoice Receiver for AbaNinja Invoice Json
                            type: object
                            $defs:
                              personAddress:
                                type: object
                                properties:
                                  addressUuid:
                                    type: string
                                    format: uuid
                                  personUuid:
                                    type: string
                                    format: uuid
                                  deliveryAddressUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                required:
                                  - addressUuid
                                  - personUuid
                              companyAddress:
                                type: object
                                properties:
                                  addressUuid:
                                    type: string
                                    format: uuid
                                  companyUuid:
                                    type: string
                                    format: uuid
                                  contactPersonUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                    description: UUID of contact person inside company
                                  deliveryAddressUuid:
                                    type:
                                      - 'null'
                                      - string
                                    format: uuid
                                  additionalReceivers:
                                    type: array
                                    maxItems: 5
                                    items:
                                      type: object
                                      properties:
                                        personUuid:
                                          type: string
                                          format: uuid
                                          description: UUID of contact person inside given company
                                      required:
                                        - personUuid
                                      additionalProperties: false
                                required:
                                  - addressUuid
                                  - companyUuid
                              additionalCompanyReceiver:
                                type: object
                                properties:
                                  personUuid:
                                    type: string
                                    format: uuid
                                    description: UUID of contact person inside given company
                                required:
                                  - personUuid
                                additionalProperties: false
                              customerNumberReceiver:
                                type: object
                                properties:
                                  customerNumber:
                                    type: string
                                required:
                                  - customerNumber
                            properties:
                              addressUuid:
                                type: string
                                format: uuid
                              personUuid:
                                type: string
                                format: uuid
                              deliveryAddressUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                              companyUuid:
                                type: string
                                format: uuid
                              contactPersonUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                                description: UUID of contact person inside company
                              additionalReceivers:
                                type: array
                                maxItems: 5
                                items:
                                  type: object
                                  properties:
                                    personUuid:
                                      type: string
                                      format: uuid
                                      description: UUID of contact person inside given company
                                  required:
                                    - personUuid
                                  additionalProperties: false
                              customerNumber:
                                type: string
                            required:
                              - addressUuid
                              - personUuid
                              - companyUuid
                              - customerNumber
                          supplierCreditNoteDate:
                            type: string
                            format: date
                          dueDate:
                            type: string
                            format: date
                          reference:
                            type: string
                          documentTotal:
                            type: number
                            exclusiveMinimum: 0
                            description: Total Amount incl. VAT
                          taxPositions:
                            type: array
                            items:
                              $schema: https://json-schema.org/draft/2020-12/schema
                              $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                              description: A Schema for tax positions for imported invoices
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  exclusiveMinimum: 0
                                  deprecated: true
                                  description: identifier of the object. "uuid" should be used instead
                                uuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                accountNumber:
                                  type: integer
                                  minimum: 1000
                                  maximum: 999999999999
                                  deprecated: true
                                  description: The booking account number. Use bookingAccountUuid instead.
                                bookingAccountUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                isTaxIncluded:
                                  type: boolean
                                  default: false
                                  description: controls if amount already includes tax or not
                                amount:
                                  type: number
                                taxRate:
                                  type: number
                                  minimum: 0
                                  maximum: 100
                                  deprecated: true
                                  description: Tax Rate to apply. Use "taxRateUuid" instead
                                taxRateUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                              required:
                                - amount
                            minItems: 1
                          wasTaxIncluded:
                            type: boolean
                            default: false
                            description: Controls whether tax was included during supplier credit note invoicing
                        required:
                          - currencyCode
                          - receiver
                          - supplierCreditNoteDate
                          - dueDate
                          - documentTotal
                          - taxPositions
                    required:
                      - documentData
                  maxItems: 1
                  minItems: 1
              required:
                - documents
              $defs:
                singleDocument:
                  type: object
                  properties:
                    documentData:
                      type: object
                      description: Additional Data for the invoice document
                      properties:
                        currencyCode:
                          type: string
                          pattern: ^[A-Z]{3}$
                        receiver:
                          $schema: https://json-schema.org/draft/2020-12/schema
                          $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/invoice-receiver.schema.json
                          description: Invoice Receiver for AbaNinja Invoice Json
                          type: object
                          $defs:
                            personAddress:
                              type: object
                              properties:
                                addressUuid:
                                  type: string
                                  format: uuid
                                personUuid:
                                  type: string
                                  format: uuid
                                deliveryAddressUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                              required:
                                - addressUuid
                                - personUuid
                            companyAddress:
                              type: object
                              properties:
                                addressUuid:
                                  type: string
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                  description: UUID of contact person inside company
                                deliveryAddressUuid:
                                  type:
                                    - 'null'
                                    - string
                                  format: uuid
                                additionalReceivers:
                                  type: array
                                  maxItems: 5
                                  items:
                                    type: object
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                        description: UUID of contact person inside given company
                                    required:
                                      - personUuid
                                    additionalProperties: false
                              required:
                                - addressUuid
                                - companyUuid
                            additionalCompanyReceiver:
                              type: object
                              properties:
                                personUuid:
                                  type: string
                                  format: uuid
                                  description: UUID of contact person inside given company
                              required:
                                - personUuid
                              additionalProperties: false
                            customerNumberReceiver:
                              type: object
                              properties:
                                customerNumber:
                                  type: string
                              required:
                                - customerNumber
                          properties:
                            addressUuid:
                              type: string
                              format: uuid
                            personUuid:
                              type: string
                              format: uuid
                            deliveryAddressUuid:
                              type:
                                - 'null'
                                - string
                              format: uuid
                            companyUuid:
                              type: string
                              format: uuid
                            contactPersonUuid:
                              type:
                                - 'null'
                                - string
                              format: uuid
                              description: UUID of contact person inside company
                            additionalReceivers:
                              type: array
                              maxItems: 5
                              items:
                                type: object
                                properties:
                                  personUuid:
                                    type: string
                                    format: uuid
                                    description: UUID of contact person inside given company
                                required:
                                  - personUuid
                                additionalProperties: false
                            customerNumber:
                              type: string
                          required:
                            - addressUuid
                            - personUuid
                            - companyUuid
                            - customerNumber
                        supplierCreditNoteDate:
                          type: string
                          format: date
                        dueDate:
                          type: string
                          format: date
                        reference:
                          type: string
                        documentTotal:
                          type: number
                          exclusiveMinimum: 0
                          description: Total Amount incl. VAT
                        taxPositions:
                          type: array
                          items:
                            $schema: https://json-schema.org/draft/2020-12/schema
                            $id: https://api.abaninja.ch/schemas/2.0.0/subschemas/tax-position.schema.json
                            description: A Schema for tax positions for imported invoices
                            type: object
                            properties:
                              id:
                                type:
                                  - integer
                                  - 'null'
                                exclusiveMinimum: 0
                                deprecated: true
                                description: identifier of the object. "uuid" should be used instead
                              uuid:
                                type:
                                  - string
                                  - 'null'
                                format: uuid
                              accountNumber:
                                type: integer
                                minimum: 1000
                                maximum: 999999999999
                                deprecated: true
                                description: The booking account number. Use bookingAccountUuid instead.
                              bookingAccountUuid:
                                type:
                                  - string
                                  - 'null'
                                format: uuid
                              isTaxIncluded:
                                type: boolean
                                default: false
                                description: controls if amount already includes tax or not
                              amount:
                                type: number
                              taxRate:
                                type: number
                                minimum: 0
                                maximum: 100
                                deprecated: true
                                description: Tax Rate to apply. Use "taxRateUuid" instead
                              taxRateUuid:
                                type:
                                  - 'null'
                                  - string
                                format: uuid
                            required:
                              - amount
                          minItems: 1
                        wasTaxIncluded:
                          type: boolean
                          default: false
                          description: Controls whether tax was included during supplier credit note invoicing
                      required:
                        - currencyCode
                        - receiver
                        - supplierCreditNoteDate
                        - dueDate
                        - documentTotal
                        - taxPositions
                  required:
                    - documentData
      responses:
        '200':
          description: Supplier credit note updated
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      documents:
                        type: array
                        items:
                          title: Supplier Credit Note Resource
                          properties:
                            uuid:
                              type: string
                              format: uuid
                            currencyCode:
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            currencyCodeRecognized:
                              description: >-
                                when importing invoices and detecting the currency, this field contains the detected
                                value
                              type:
                                - string
                                - 'null'
                              format: iso-4217
                              maxLength: 3
                              minLength: 3
                            receiver:
                              properties:
                                addressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                companyUuid:
                                  type: string
                                  format: uuid
                                networkUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                networkKey:
                                  type:
                                    - string
                                    - 'null'
                                networkName:
                                  type:
                                    - string
                                    - 'null'
                                deliveryAddressUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                contactPersonUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                additionalReceivers:
                                  type: array
                                  items:
                                    properties:
                                      personUuid:
                                        type: string
                                        format: uuid
                                    type: object
                                receiverInformation:
                                  title: Receiver Information Resource
                                  description: Receiver information resource
                                  properties:
                                    customerNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    companyName:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    nameWithSalutation:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    careOfAddress:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    address:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    extension:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    houseNumber:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    zipCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    city:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    countryCode:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                    email:
                                      type:
                                        - string
                                        - 'null'
                                      format: email
                                      readOnly: true
                                    language:
                                      type:
                                        - string
                                        - 'null'
                                      readOnly: true
                                      enum:
                                        - de
                                        - en
                                        - fr
                                        - it
                                    deliveryAddress:
                                      properties:
                                        companyName:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        name:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        nameWithSalutation:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        careOfAddress:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        address:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        extension:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        houseNumber:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        zipCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        city:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                        countryCode:
                                          type:
                                            - string
                                            - 'null'
                                          readOnly: true
                                      type: object
                                      readOnly: true
                                    additionalReceivers:
                                      type: array
                                      items:
                                        properties:
                                          fullName:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                          email:
                                            type:
                                              - string
                                              - 'null'
                                            readOnly: true
                                        type: object
                                      readOnly: true
                                  type: object
                                personUuid:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                            supplierCreditNoteNumber:
                              type: string
                            supplierCreditNoteDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            dueDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            documentTotal:
                              type: number
                              format: float
                            taxPositions:
                              type: array
                              items:
                                title: Receipt Tax Position Resource
                                properties:
                                  id:
                                    type: integer
                                    format: int64
                                  accountNumber:
                                    type: integer
                                    format: int64
                                  isTaxIncluded:
                                    type: boolean
                                  amount:
                                    type: number
                                    format: float
                                  taxRate:
                                    type: number
                                    format: float
                                  taxRateUuid:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                type: object
                            isTemplate:
                              type: boolean
                            openAmount:
                              type: number
                              format: float
                            reference:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - open
                                - sending
                                - send-failed
                                - sent
                                - viewed
                                - approved
                                - declined
                                - partial
                                - paid
                                - in-payment
                                - collected
                                - planned
                                - pending
                                - archived
                                - cancelled
                                - converted
                                - due
                                - reminder
                                - first-dunning
                                - second-dunning
                                - final-dunning
                                - inactive
                                - active
                                - inbox
                                - expired
                                - done
                                - assign
                                - awaiting-payment
                                - error
                            type:
                              type: string
                              enum:
                                - supplier_credit_note
                            wasTaxIncluded:
                              type: boolean
                            wasRecognitionLimitReached:
                              type: boolean
                          type: object
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: a6329e81489eec62d7e674368e7492a9
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/bulk-actions:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get bulk actions
      description: Get supplier credit note bulk actions
      operationId: documents_list_bulk_actions_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: forList
          in: query
          description: filter list actions
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    example:
                      archive: Archive
                      cancel: Cancel
                      delete: Delete
                    additionalProperties:
                      description: description of the action
                      type: string
                    propertyNames:
                      enum:
                        - paymentAdd
                        - archive
                        - cancel
                        - cancelPermanently
                        - clone
                        - collectInvoice
                        - convertCNDN
                        - convertCNI
                        - convertDNI
                        - convertIC
                        - convertDN
                        - convertT
                        - convertCN
                        - convert
                        - convertTemplateToContractNote
                        - convertTemplateToCreditNote
                        - convertTemplateToDeliveryNote
                        - convertTI
                        - convertTemplateToQuote
                        - convertToTemplate
                        - createFinal
                        - createInstalments
                        - createPartial
                        - createOnAccount
                        - customerPortalUrl
                        - delete
                        - dissolve
                        - downloadPdf
                        - downloadPaymentConfirmation
                        - dunningPrint
                        - dunningSent
                        - dunningDate
                        - setDunningAmounts
                        - edit
                        - activity
                        - info
                        - email
                        - markApproved
                        - markDeclined
                        - markSent
                        - massDownloadZip
                        - massDunningPrint
                        - massDunningSent
                        - massPrint
                        - massSent
                        - offsetCreditNotes
                        - offsetInvoices
                        - offsetReceipts
                        - offsetSupplierCreditNotes
                        - plannedMail
                        - print
                        - regeneratePdf
                        - resync
                        - restore
                        - save
                        - sendPaymentConfirmation
                        - sendAbaNet
                        - sendDeepSign
                        - sign
                        - signSupplierCreditNote
                        - sync
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 21e2d9ace3155762312873f76962c4b2
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/comments:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get comment collection
      description: fetches comments of a document via pagination
      operationId: documents_list_comments_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          schema:
            type:
              - integer
              - 'null'
            default: 1
            minimum: 1
        - name: perPage
          in: query
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      title: Document Comment Resource
                      properties:
                        uuid:
                          type: string
                          format: uuid
                        authorUserUuid:
                          type:
                            - string
                            - 'null'
                          format: uuid
                        createdAt:
                          type: string
                          format: date-time
                        userName:
                          type: string
                        comment:
                          type: string
                        type:
                          description: Defines if it is only for internal use or if customers can see the comments
                          type: string
                          enum:
                            - intern
                            - extern
                        isDeletable:
                          description: if the current user can delete the comment
                          type: boolean
                      type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    properties:
                      pagination:
                        properties:
                          currentPage:
                            type: integer
                            minimum: 1
                          firstPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          from:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          lastPage:
                            type: integer
                          lastPageUrl:
                            type: string
                            format: uri
                          nextPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          perPage:
                            type: integer
                            example: 50
                          previousPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          to:
                            type:
                              - integer
                              - 'null'
                            example: 50
                          totalItems:
                            type: integer
                        type: object
                    type: object
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: a3329fc80844a21df6bdf9c1b7edb0ad
      x-required-scopes:
        - suppliers
    post:
      tags:
        - document-supplier-credit-notes
      summary: Create comment
      description: creates a new comment on a document either for internal or external use
      operationId: documents_create_comments_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Comment to create
        required: true
        content:
          application/json:
            schema:
              title: Create Document Comment Request
              required:
                - comment
                - type
              properties:
                comment:
                  type: string
                  minLength: 3
                type:
                  description: Defines if it is only for internal use or if customers can see the comments
                  type: string
                  enum:
                    - intern
                    - extern
              type: object
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    title: Document Comment Resource
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      authorUserUuid:
                        type:
                          - string
                          - 'null'
                        format: uuid
                      createdAt:
                        type: string
                        format: date-time
                      userName:
                        type: string
                      comment:
                        type: string
                      type:
                        description: Defines if it is only for internal use or if customers can see the comments
                        type: string
                        enum:
                          - intern
                          - extern
                      isDeletable:
                        description: if the current user can delete the comment
                        type: boolean
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 201
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: ad1731875ea3f42f165d14bdd9ee5f45
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/files:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get Files
      description: Returns a list of files
      operationId: documents_list_files_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          schema:
            type:
              - integer
              - 'null'
            default: 1
            minimum: 1
        - name: perPage
          in: query
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
        - name: kind
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoice
                - invoice_attachment
                - invoice_payments
                - imported_invoice
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      title: Document File Resource
                      properties:
                        uuid:
                          type: string
                          format: uuid
                        name:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        archivedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        archivedReason:
                          type:
                            - string
                            - 'null'
                          enum:
                            - SENT_NEW_DOCUMENT
                            - CANCELATION
                            - DUNNING
                            - PAYMENT_OFFSET
                            - PAYMENT_CONFIRMED
                            - PAYMENT_CANCELED
                            - MANUAL_RECREATION
                        fileSize:
                          type: integer
                          format: int64
                        mimeType:
                          type: string
                        kind:
                          type: string
                          enum:
                            - invoice
                            - invoice_attachment
                            - invoice_payments
                            - imported_invoice
                      type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    properties:
                      pagination:
                        properties:
                          currentPage:
                            type: integer
                            minimum: 1
                          firstPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          from:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          lastPage:
                            type: integer
                          lastPageUrl:
                            type: string
                            format: uri
                          nextPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          perPage:
                            type: integer
                            example: 50
                          previousPageUrl:
                            type:
                              - string
                              - 'null'
                            format: uri
                          to:
                            type:
                              - integer
                              - 'null'
                            example: 50
                          totalItems:
                            type: integer
                        type: object
                    type: object
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 17f6c2db6b91aee06242f738668afbb3
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{supplierCreditNoteUuid}/actions:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get actions
      description: Get supplier credit note actions
      operationId: documents_list_actions_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: supplierCreditNoteUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: forList
          in: query
          description: filter list actions
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    example:
                      archive: Archive
                      cancel: Cancel
                      delete: Delete
                    additionalProperties:
                      description: description of the action
                      type: string
                    propertyNames:
                      enum:
                        - paymentAdd
                        - archive
                        - cancel
                        - cancelPermanently
                        - clone
                        - collectInvoice
                        - convertCNDN
                        - convertCNI
                        - convertDNI
                        - convertIC
                        - convertDN
                        - convertT
                        - convertCN
                        - convert
                        - convertTemplateToContractNote
                        - convertTemplateToCreditNote
                        - convertTemplateToDeliveryNote
                        - convertTI
                        - convertTemplateToQuote
                        - convertToTemplate
                        - createFinal
                        - createInstalments
                        - createPartial
                        - createOnAccount
                        - customerPortalUrl
                        - delete
                        - dissolve
                        - downloadPdf
                        - downloadPaymentConfirmation
                        - dunningPrint
                        - dunningSent
                        - dunningDate
                        - setDunningAmounts
                        - edit
                        - activity
                        - info
                        - email
                        - markApproved
                        - markDeclined
                        - markSent
                        - massDownloadZip
                        - massDunningPrint
                        - massDunningSent
                        - massPrint
                        - massSent
                        - offsetCreditNotes
                        - offsetInvoices
                        - offsetReceipts
                        - offsetSupplierCreditNotes
                        - plannedMail
                        - print
                        - regeneratePdf
                        - resync
                        - restore
                        - save
                        - sendPaymentConfirmation
                        - sendAbaNet
                        - sendDeepSign
                        - sign
                        - signSupplierCreditNote
                        - sync
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: df66c280b0cf204eb815db25a74609f4
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/bulk-actions/archive:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute archive bulk action
      description: Marks the document as archived
      operationId: documents_bulk_archive_supplier_credit_notes
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                documentUuids:
                  type: array
                  items:
                    type: string
                    format: uuid
              type: object
      responses:
        '200':
          description: Successfully bulk executed action
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    additionalProperties:
                      type: array
                      items: {}
                      maxItems: 0
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: a7d77acb376d713d2fe4fdc5a608e95b
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/archive:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute archive action
      description: Archives the document
      operationId: documents_update_archive_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: d2f3fdc080ba0c56f7d64ba6e4c5ceb3
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/cancel:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute cancel action
      description: Cancels and moves the document back to draft
      operationId: documents_update_cancel_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: feeff3afc04fa21efca52ff4c72f4115
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/cancelPermanently:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute cancelPermanently action
      description: Cancels the document permanently. It cannot be edited afterwards
      operationId: documents_update_cancelPermanently_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 5587ade0f7025e5a09e607cb19db7891
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/delete:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute delete action
      description: Deletes a document
      operationId: documents_update_delete_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 00742682c635331975f11d6834ec45cd
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/offsetReceipts:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute offsetReceipts action
      description: Offsets the supplier credit note to receipts
      operationId: documents_update_offsetReceipts
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              title: Offset Receipts Action Request
              required:
                - receiptUuids
              properties:
                receiptUuids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                valutaDate:
                  type:
                    - string
                    - 'null'
                  format: date
              type: object
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      counter:
                        type: integer
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 0e78cc7af4a2419bcff378c31ea979ca
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/restore:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute restore action
      description: Restores an archived document
      operationId: documents_update_restore_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      type:
                        type: string
                        enum:
                          - invoice
                          - receipt
                          - credit_note
                          - recurring_invoice
                          - quote
                          - contract_note
                          - delivery_note
                          - supplier_credit_note
                      id:
                        type: integer
                        deprecated: true
                      uuid:
                        type: string
                        format: uuid
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: cac5b7b7cc41abe603bdd862f8ec033a
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/actions/signSupplierCreditNote:
    patch:
      tags:
        - document-supplier-credit-notes
      summary: Execute signSupplierCreditNote action
      description: Signs the supplier credit note
      operationId: documents_update_signSupplierCreditNote
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successfully executed action
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '400':
          description: Bad request or validation error
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 6ae3a62019b66946e55b9347e945482b
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/comments/{commentUuid}:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get comment
      description: fetches a single comment of a document
      operationId: documents_get_comments_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: commentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    title: Document Comment Resource
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      authorUserUuid:
                        type:
                          - string
                          - 'null'
                        format: uuid
                      createdAt:
                        type: string
                        format: date-time
                      userName:
                        type: string
                      comment:
                        type: string
                      type:
                        description: Defines if it is only for internal use or if customers can see the comments
                        type: string
                        enum:
                          - intern
                          - extern
                      isDeletable:
                        description: if the current user can delete the comment
                        type: boolean
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: a0bc2e74696ac3195c714e15198868d8
      x-required-scopes:
        - suppliers
    delete:
      tags:
        - document-supplier-credit-notes
      summary: Delete comment
      description: deletes a comment of a document, which cannot be restored anymore afterwards.
      operationId: documents_delete_comments_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: commentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Successful response
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: f95cd544b46a9f4fb33dc21969a99ee0
      x-required-scopes:
        - suppliers
  /accounts/{accountUuid}/documents/v2/supplier-credit-notes/{documentUuid}/files/{fileUuid}:
    get:
      tags:
        - document-supplier-credit-notes
      summary: Get File
      description: Returns a file
      operationId: documents_get_files_8
      parameters:
        - name: accountUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: documentUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: fileUuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                properties:
                  data:
                    title: Document File Detail Resource
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      name:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      archivedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      archivedReason:
                        type:
                          - string
                          - 'null'
                        enum:
                          - SENT_NEW_DOCUMENT
                          - CANCELATION
                          - DUNNING
                          - PAYMENT_OFFSET
                          - PAYMENT_CONFIRMED
                          - PAYMENT_CANCELED
                          - MANUAL_RECREATION
                      fileSize:
                        type: integer
                        format: int64
                      mimeType:
                        type: string
                      kind:
                        type: string
                        enum:
                          - invoice
                          - invoice_attachment
                          - invoice_payments
                          - imported_invoice
                      fileUrl:
                        type:
                          - string
                          - 'null'
                        format: uri
                    type: object
                  message:
                    title: message
                    type: string
                  status:
                    example: 200
                  meta:
                    title: meta
                    type:
                      - object
                      - 'null'
                required:
                  - data
                  - message
                  - status
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                properties:
                  detail:
                    title: details
                  type:
                    title: type
                    type: string
                  requestUuid:
                    title: requestUuid
                    type: string
                    format: uuid
                  path:
                    title: path
                    type: string
                  message:
                    title: message
                    type:
                      - string
                      - 'null'
                  status:
                    title: status
                    description: HTTP status code
                    type: integer
                required:
                  - detail
                  - type
                  - message
                  - status
      security:
        - ApiToken:
            - https://api.abaninja.ch/auth/suppliers
      x-legacy-operation-id: 074f9f42a959c5fc5b68d0e4cfa7afdf
      x-required-scopes:
        - suppliers
components:
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token authentication. Create tokens in Settings > API Token.
