get:
    summary: Returns a list of (optionally filtered) debitors.
    description: Returns the list of (optionally filtered) debitors which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-debitors
    operationId: getListOfDebitors
    parameters:
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
        - name: name
          in: query
          required: false
          schema:
              type: string
          description: Prefix of name properties from person or contact to filter the results.
        - name: partnerUuid
          in: query
          required: false
          schema:
              type: string
              format: uuid
          description: UUID of the business partner, exclusive to `memberNumber`.
        - name: partnerNumber
          in: query
          required: false
          schema:
              type: string
              pattern: 'P-[0-9]{5}'
          description: Partner number of the requested debitor.
    responses:
        "200":
            description: OK
            content:
                'application/json':
                    schema:
                        type: array
                        items:
                            $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
        "401":
            $ref: 'error-responses.yaml#/components/responses/Unauthorized'
        "403":
            $ref: 'error-responses.yaml#/components/responses/Forbidden'

post:
    summary: Adds a new debitor.
    tags:
        - hs-office-debitors
    operationId: postNewDebitor
    parameters:
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
    requestBody:
        content:
            'application/json':
                schema:
                    $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorInsert'
        required: true
    responses:
        "201":
            description: Created
            content:
                'application/json':
                    schema:
                        $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
        "401":
            $ref: 'error-responses.yaml#/components/responses/Unauthorized'
        "403":
            $ref: 'error-responses.yaml#/components/responses/Forbidden'
        "409":
            $ref: 'error-responses.yaml#/components/responses/Conflict'
