hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml

components:

    schemas:

        HsOfficeDebitor:
            type: object
            properties:
                uuid:
                    type: string
                    format: uuid
                debitorRel:
                    $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
                debitorNumber:
                    type: integer
                    format: int32
                    minimum: 1000000
                    maximum: 9999999
                debitorNumberSuffix:
                    type: integer
                    format: int8
                    minimum: 00
                    maximum: 99
                partner:
                    $ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
                billable:
                    type: boolean
                vatId:
                   type: string
                vatCountryCode:
                   type: string
                   pattern: '^[A-Z][A-Z]$'
                vatBusiness:
                   type: boolean
                vatReverseCharge:
                   type: boolean
                refundBankAccount:
                    $ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
                defaultPrefix:
                    type: string
                    pattern: '^[a-z0-9]{3}$'

        HsOfficeDebitorPatch:
            type: object
            properties:
                debitorRelUuid:
                    type: string
                    format: uuid
                    nullable: true
                billable:
                    type: boolean
                    nullable: false
                vatId:
                    type: string
                    nullable: true
                vatCountryCode:
                    type: string
                    pattern: '^[A-Z][A-Z]$'
                    nullable: true
                vatBusiness:
                    type: boolean
                    nullable: false
                vatReverseCharge:
                    type: boolean
                    nullable: false
                refundBankAccountUuid:
                    type: string
                    format: uuid
                    nullable: true
                defaultPrefix:
                    type: string
                    pattern: '^[a-z0-9]{3}$'
                    nullable: true

        HsOfficeDebitorInsert:
            type: object
            properties:
                debitorRel:
                    $ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert'
                debitorRelUuid:
                    type: string
                    format: uuid
                debitorNumberSuffix:
                    type: integer
                    format: int8
                    minimum: 00
                    maximum: 99
                billable:
                    type: boolean
                vatId:
                    type: string
                vatCountryCode:
                    type: string
                    pattern: '^[A-Z][A-Z]$'
                vatBusiness:
                    type: boolean
                vatReverseCharge:
                    type: boolean
                refundBankAccountUuid:
                    type: string
                    format: uuid
                defaultPrefix:
                    type: string
                    pattern: '^[a-z]{3}$'
            required:
              - debitorNumberSuffix
              - defaultPrefix
              - billable