Yokoy Supplier API

openapi: 3.2.0
info:
  description: Public API of the Yokoy Application
  title: Yokoy Card account Supplier API
  version: 1.41.0
servers:
- description: API server scoped to organization with ID `organizationId`
  url: https://api.yokoy.ai/v1/organizations/{organizationId}
  variables:
    organizationId:
      default: AbcDeF1234
      description: Yokoy organization ID
- description: API test server scoped to organization with ID `organizationId`
  url: https://api.test.yokoy.ai/v1/organizations/{organizationId}
  variables:
    organizationId:
      default: AbcDeF1234
      description: Yokoy organization ID
tags:
- description: 'Companies that supply your company with goods, services, items. The Supplier entity contains information on the name, address, and bank accounts of the supplier.

    Suppliers can be set up for different legal entities with default settings at each legal entity level.

    Suppliers must first be created for the organization at `/suppliers` with their basic definition such as name, address, tax number and bank accounts.

    Then they can be created legal entity-level at `/legal-entities/{entityId}/suppliers` with the organization supplier ID in `supplierId`. Without creating a legal entity supplier, the supplier does not appear in Yokoy (in **Invoice processor > Suppliers**).

    Legal entity suppliers can be updated/created just for certain applicable fields.

    To add (POST) or update (PATCH or PUT) a complete legal entity supplier record (e.g. the name of the supplier, contact or banking information), you need to add or update the organization supplier first. These changes are automatically progpaged to the legal entity suppliers (i.e. the same supplier may supply several legal entities) linked to that organization supplier. Then in a subsequent call to the legal entity supplier endpoint, you can update the legal entity supplier.


    **NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.

    It must use the following pattern: `externalId` of the organization supplier + ''_'' + Yokoy ID of the legal entity.

    '
  name: Supplier
paths:
  /legal-entities/{legalEntityId}/suppliers:
    parameters:
    - $ref: '#/components/parameters/LegalEntityIdInPath'
    - $ref: '#/components/parameters/YokoyAuthMethod'
    - $ref: '#/components/parameters/YokoyCorrelationId'
    get:
      description: Retrieves all suppliers for a legal entity.
      operationId: listEntitySupplier
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  suppliers:
                    items:
                      $ref: '#/components/schemas/Supplier'
                    type: array
                type: object
          description: OK
        '400':
          $ref: '#/components/responses/InvalidFilter'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: List all suppliers (legal entity)
      tags:
      - Supplier
    post:
      description: Adds an organization supplier to a legal entity, specifying entity-specific information.
      operationId: createEntitySupplier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegalEntitySupplier'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Supplier'
          description: Created
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Add a supplier (legal entity)
      tags:
      - Supplier
  /legal-entities/{legalEntityId}/suppliers/{supplierId}:
    parameters:
    - $ref: '#/components/parameters/LegalEntityIdInPath'
    - description: Yokoy unique ID of the legal entity supplier.
      example: bbebb9a0-87ef-439c-9ac3-e320e47d85d5
      in: path
      name: supplierId
      required: true
      schema:
        pattern: '[\w-]+'
        type: string
    - $ref: '#/components/parameters/YokoyAuthMethod'
    - $ref: '#/components/parameters/YokoyCorrelationId'
    get:
      description: Retrieves a legal entity supplier identified by its Yokoy legal entity supplier ID.
      operationId: getEntitySupplier
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Supplier'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Get a supplier by ID (legal entity)
      tags:
      - Supplier
    patch:
      description: Updates a legal entity supplier that is identified by its Yokoy legal entity supplier ID, replacing some entity specific attributes. The whole entity is returned. To change the name, address, or contact person for a legal entity supplier, you must update the organization level supplier. Changes to the legal entity supplier are made automatically from the organization supplier.
      operationId: modifyEntitySupplier
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LegalEntitySupplier'
              - description: First modify the organization supplier. Then modify the legal entity supplier to update all relevant fields. Explicit null values mark attributes for deletion.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Supplier'
          description: OK
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Modify a supplier (legal entity)
      tags:
      - Supplier
    put:
      description: Updates a legal entity supplier that is identified by its Yokoy unique ID, replacing all entity-specific attributes. The whole entity is returned. To change the name, address, or contact person for a legal entity supplier, you must update the organization level supplier. Changes to the legal entity supplier are made automatically from the organization supplier.
      operationId: updateEntitySupplier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegalEntitySupplier'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Supplier'
          description: OK
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Update a supplier (legal entity)
      tags:
      - Supplier
  /suppliers:
    parameters:
    - $ref: '#/components/parameters/YokoyAuthMethod'
    - $ref: '#/components/parameters/YokoyCorrelationId'
    get:
      description: 'Returns all suppliers set up in the organization. Organization suppliers provide the basic details of the supplier, such as name, address, and contacts. To create, update or modify a legal entity supplier (for example, to include the name of the supplier, contact or banking information), you need to first call the organization suppliers endpoint.

        With a subsequent call to the legal entity supplier endpoint, you can then update the default settings of the supplier at legal entity level.

        **NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.

        It must have the format: `externalId` of the organization supplier + ''_'' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`.

        '
      operationId: listOrgSuppliers
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  organization-suppliers:
                    items:
                      $ref: '#/components/schemas/OrganizationSupplier'
                    type: array
                type: object
          description: OK
        '400':
          $ref: '#/components/responses/InvalidFilter'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: List all suppliers (organization)
      tags:
      - Supplier
    post:
      description: 'Companies that supply your company with goods, services, and/or items. The supplier contains general

        information of the supplier (ie. name, address, bank accounts, payment terms, etc.) and can be set up with

        default settings that are specific per legal entity. Suppliers need to be created first at an organization

        level and then added at a company (legal entity) level. Without creating a legal entity supplier, the

        supplier does not appear in Yokoy (in **Invoice processor > Suppliers**). For more information, see

        (/docs/tutorials/upload-suppliers).

        '
      operationId: createOrgSupplier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationSupplier'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSupplier'
          description: Created
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Create a supplier (organization)
      tags:
      - Supplier
  /suppliers/{supplierId}:
    parameters:
    - description: Yokoy unique ID of the organization-level supplier.
      example: 8ef7a04a-ce91-4b60-a624-e209f748f86a
      in: path
      name: supplierId
      required: true
      schema:
        pattern: '[\w-]+'
        type: string
    - $ref: '#/components/parameters/YokoyAuthMethod'
    - $ref: '#/components/parameters/YokoyCorrelationId'
    get:
      description: Retrieves an organization-level supplier identified by its Yokoy unique ID.
      operationId: getOrgSupplier
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSupplier'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Get an organization supplier by ID
      tags:
      - Supplier
    patch:
      description: 'Updates a organization supplier by replacing some attributes. The supplier is identified by its Yokoy unique ID. The whole entity is returned.

        **NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.

        It must use this format: `externalId` of the organization supplier + ''_'' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`

        '
      operationId: modifyOrgSupplier
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: true
              description: Dictionary of organization supplier attributes to update. Explicit null values mark attributes for deletion.
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSupplier'
          description: OK
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Modify a supplier (organization)
      tags:
      - Supplier
    put:
      description: 'Updates an organization supplier by replacing all attributes. The organization supplier is identified by its Yokoy unique ID. The whole entity is returned.

        **NOTE**: When the `Enable InternalSupplierID` setting is active at organization level, the `internalSupplierId` attribute is mandatory to point the right supplier.

        It must use this pattern: `externalId` of the organization supplier + ''_'' + Yokoy `legalEntityId`. For example, `S33998_aB9jQoE3HE`.

        '
      operationId: updateOrgSupplier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationSupplier'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSupplier'
          description: OK
        '400':
          $ref: '#/components/responses/HttpValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - OAuth2: []
      summary: Update a supplier (organization)
      tags:
      - Supplier
components:
  schemas:
    SupplierContact:
      properties:
        email:
          description: Email address of the supplier's contact.
          example: quinn.leavy@example.com
          type: string
        firstName:
          description: Given name of the supplier's contact.
          example: Quinn
          type: string
        lastName:
          description: Family name of the supplier's contact.
          example: Leavy
          type: string
        phone:
          description: Phone number of the supplier's contact.
          example: +49 12 3456789
          type: string
        role:
          description: Contact's role in the supplier company.
          example: Sales representative
          type: string
      required:
      - email
      - firstName
      - lastName
      - phone
      - role
      type: object
    LegalEntitySupplier:
      properties:
        autoSubmissionSettings:
          $ref: '#/components/schemas/SupplierAutoSubmissionSettings'
        codingType:
          description: 'Determines how invoices from this supplier should be processed by Yokoy.

            - `smart`: If selected, Yokoy tries to smart-code all invoices for the supplier.

            - `supplierDefault`: If selected, Yokoy picks the default cost object and category that you have set up in the supplier settings.

            - `entity`: If this option is selected, Yokoy follows whatever coding logic is determined for the company. If smart coding is enabled for the legal entity, Yokoy performs smart coding of the invoice. If smart coding is not enabled for the legal entity, then no smart coding is performed.

            '
          enum:
          - smart
          - supplierDefault
          - entity
          example: smart
          type:
          - string
          - 'null'
        customInformation:
          additionalProperties: true
          type:
          - object
          - 'null'
        defaultApproverFirstName:
          description: The first name of the default invoice approver.
          example: Alex
          type:
          - string
          - 'null'
        defaultApproverId:
          description: Yokoy unique ID of the default approver.
          example: 9L7rovNzNhTCsJSTkbfq
          pattern: '[\w-]+'
          type:
          - string
          - 'null'
        defaultApproverLastName:
          description: The last name of the default invoice approver.
          example: Doe
          type:
          - string
          - 'null'
        defaultCategoryId:
          description: Yokoy unique ID of the default invoice category.
          example: uhmkC9Mzzn
          pattern: '[\w-]+'
          type:
          - string
          - 'null'
        defaultCategoryName:
          description: Name of the default invoice category for this supplier.
          example: Category A
          type:
          - string
          - 'null'
        defaultCostCenterId:
          description: Yokoy unique ID of the default cost object.
          example: Mt34DVcI8R2sdLutWViu
          pattern: '[\w-]+'
          type:
          - string
          - 'null'
        defaultCostCenterName:
          description: Name of the default cost object.
          example: Default cost center
          type:
          - string
          - 'null'
        defaultPaymentTermId:
          description: Yokoy unique ID of the default payment term.
          example: uhmkC9Mzzn
          pattern: '[\w-]+'
          type:
          - string
          - 'null'
        id:
          description: Yokoy unique ID of supplier linked to a specific legal entity.
          example: 8ef7a04a-ce91-4b60-a624-e209f748f86a
          pattern: '[\w-]+'
          readOnly: true
          type: string
        isInternalSupplier:
          description: Identifies the supplier as intercompany supplier.
          example: false
          type:
          - boolean
          - 'null'
        isPurchaseOrderSupplier:
          description: Indicates if the supplier requires a purchase order for each invoice.
          example: false
          type:
          - boolean
          - 'null'
        paymentTermIds:
          description: Array of Yokoy IDs of payment terms.
          example:
          - 06x2u4nagAMEq3gGoMch
          - 34e5u4nqgBMWq4gRalmX
          items:
            type: string
          type:
          - array
          - 'null'
        statusActive:
          type: boolean
        supplierId:
          description: Yokoy ID of the organization supplier. It must reference an existing organization-level supplier.
          example: 8ef7a04a-ce91-4b60-a624-e209f748f86a
          type: string
        triggerAutoMatchWithoutPO:
          description: Trigger auto-match without purchase order number data. For PO suppliers (i.e. suppliers with invoices that must always have an associated PO), if set as `true`, Yokoy tries to match the invoice to a purchase order if no purchase order data is provided.
          example: false
          type:
          - boolean
          - 'null'
      required:
      - id
      - legalEntityId
      - supplierId
      - statusActive
      type: object
    InvoiceBankAccount:
      description: Information related to the payment of the invoice.
      properties:
        bankAccount:
          description: Bank account number. Often used if no IBAN exists.
          example: '987654321'
          type:
          - string
          - 'null'
        bankCountry:
          description: Country of the bank.
          example: UK
          type:
          - string
          - 'null'
        bankKey:
          description: Bank key (also called branch code).
          example: XXX
          type:
          - string
          - 'null'
        bankNumber:
          description: Bank number (also called bank code).
          example: UBSW
          type:
          - string
          - 'null'
        externalId:
          description: External ID of the bank in ERP systems.
          example: UBS12
          type:
          - string
          - 'null'
        iban:
          description: IBAN (International Bank Account Number).
          example: CH5604835012345678009
          type:
          - string
          - 'null'
        swiftCode:
          description: Swift code (also called the BIC).
          example: UBSWCHZHXXX
          type:
          - string
          - 'null'
      type: object
    SupplierAutoSubmissionSettings:
      properties:
        nonPoCreditNotes:
          allOf:
          - $ref: '#/components/schemas/SupplierAutoSubmissionDocumentSettings'
          - description: Auto-submission settings for credit note without a PO documents
        nonPoInvoices:
          allOf:
          - $ref: '#/components/schemas/SupplierAutoSubmissionDocumentSettings'
          - description: Auto-submission settings for invoice documents without a PO
        poCreditNotes:
          allOf:
          - $ref: '#/components/schemas/SupplierAutoSubmissionDocumentSettings'
          - description: Auto-submission settings for credit note with a PO documents
        poInvoices:
          allOf:
          - $ref: '#/components/schemas/SupplierAutoSubmissionDocumentSettings'
          - description: Auto-submission settings for invoice documents with a PO
        status:
          description: 'Status of the auto-submission settings.

            - `disabled`: Invoices and/or credit notes for the supplier are not auto-submitted. This overrides any auto-submission settings defined at company level.

            - `enabled`: Invoices and/or credit notes for the supplier are auto-submitted using the auto-submission settings specified.

            - `entity`: Invoices and/or credit notes may be auto-submitted according to the setting defined at company level.

            '
          enum:
          - disabled
          - enabled
          - entity
          example: entity
          type: string
      required:
      - status
      type: object
    SupplierAutoSubmissionDocumentSettings:
      properties:
        amount:
          description: 'Threshold amount (**Max. allowed amount**) below which the supplier document is submitted automatically by Yokoy when all other conditions are met.

            The amount is converted to the currency of the legal entity.

            A 0 or `null` amount means that all documents are auto-submitted.

            '
          example: 1000
          minimum: 0
          type:
          - number
          - 'null'
        enabled:
          example: false
          type: boolean
      required:
      - enabled
      type: object
    Error:
      properties:
        code:
          type: integer
        message:
          type: string
      required:
      - code
      - message
      type: object
    HttpError:
      properties:
        field:
          type: string
        message:
          type: string
      required:
      - field
      - message
      type: object
    Supplier:
      allOf:
      - $ref: '#/components/schemas/OrganizationSupplier'
      - $ref: '#/components/schemas/LegalEntitySupplier'
    OrganizationSupplier:
      properties:
        bankAccounts:
          items:
            $ref: '#/components/schemas/InvoiceBankAccount'
          type:
          - array
          - 'null'
        city:
          description: City where the supplier is located.
          example: München
          type:
          - string
          - 'null'
        contacts:
          default: []
          items:
            $ref: '#/components/schemas/SupplierContact'
          type:
          - array
          - 'null'
        countryCode:
          description: Country where the supplier is located. Expressed as an ISO 3166 Alpha-2 code.
          example: DE
          type:
          - string
          - 'null'
        customInformation:
          additionalProperties: true
          type:
          - object
          - 'null'
        externalId:
          description: External ID of the organization supplier. This must be unique within the organization and cannot be changed after creation.
          example: S33998
          type: string
        id:
          description: Yokoy ID of the organization supplier.
          example: 8ef7a04a-ce91-4b60-a624-e209f748f86a
          pattern: '[\w-]+'
          readOnly: true
          type: string
        internalSupplierId:
          description: ID of the internal supplier. Only mandatory when the `Enable InternalSupplierID` setting is active at organization level, | It must have the format of the organization supplier's external identifier + '_' + Yokoy legal entity ID.
          example: S33998_aB9jQoE3HE
          type: string
        isTemplateOneTimeSupplier:
          default: false
          description: Determines whether the supplier is to be imported as a one-time vendor or not. One-time vendors are only supported in SAP systems. If the supplier is a template to be used for non-recurring one-time suppliers, you must set this attribute as `true`.
          type: boolean
        name:
          description: Full company name of the supplier.
          example: Acme INC
          type: string
        secondaryName:
          description: Additional information about the supplier name.
          example: Department A
          type:
          - string
          - 'null'
        shortName:
          description: Short name of the supplier for display.
          example: Acme
          type:
          - string
          - 'null'
        statusActive:
          default: false
          type: boolean
        street:
          description: Street where the supplier is located.
          example: Isartorpl 8
          type:
          - string
          - 'null'
        taxNumber:
          deprecated: true
          description: Legal tax number of the supplier. Use `taxNumbers` instead.
          example: '123456789'
          type:
          - string
          - 'null'
        taxNumbers:
          default: []
          description: An array of the supplier's legal tax numbers. Use this attribute instead of `taxNumber` after setting `taxNumber` to null.
          example:
          - CH123456789
          - CH115222333
          items:
            type: string
          type:
          - array
          - 'null'
        url:
          description: Website of the supplier.
          example: https://www.example.com
          type:
          - string
          - 'null'
        zipCode:
          description: Postal code where the supplier is located.
          example: D18 V6K0
          type:
          - string
          - 'null'
      required:
      - id
      - externalId
      - name
      type: object
  responses:
    Unauthorized:
      content:
        application/json:
          example:
            code: 401
            message: Token expired
          schema:
            $ref: '#/components/schemas/Error'
      description: The server was unable to establish the identity of the client.
    InternalError:
      content:
        application/json:
          example:
            code: 500
            message: Server error
          schema:
            $ref: '#/components/schemas/Error'
      description: An internal error occurred.
    HttpValidationError:
      content:
        application/json:
          example:
            code: 400
            errors:
            - field: Yokoy Field
              message: Yokoy Field is mandatory
            message: Validation Error
          schema:
            $ref: '#/components/schemas/HttpError'
            additionalProperties: true
      description: The request was not valid.
    TooManyRequests:
      content:
        application/json:
          example:
            code: 429
            message: Too many requests
          schema:
            $ref: '#/components/schemas/Error'
      description: The request cannot be processed by the server due to too many concurrent requests.
    ServiceUnavailable:
      content:
        application/json:
          example:
            code: 503
            message: Service unavailable
          schema:
            $ref: '#/components/schemas/Error'
      description: The server is unavailable. Please try again later
    Forbidden:
      content:
        application/json:
          example:
            code: 403
            message: User not authorized to access organization
          schema:
            $ref: '#/components/schemas/Error'
      description: The client is not authorized to perform the requested operation.
    GatewayError:
      content:
        application/json:
          example:
            code: 502
            message: Gateway error
          schema:
            $ref: '#/components/schemas/Error'
      description: An issue occurred in a downstream service. Please try again later.
    InvalidFilter:
      content:
        application/json:
          example:
            code: 400
            message: 'Invalid filter string: foo e bar'
          schema:
            $ref: '#/components/schemas/Error'
      description: The request was not valid.
    

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yokoy/refs/heads/main/openapi/yokoy-supplier-api-openapi.yml