---
openapi: 3.0.1
info:
  title: API v6
  description: |-
    # CFE-Civil - Check Financial Eligibility for Civil legal aid

    ## Usage:
      - Calculate eligibility by POSTing a payload to `/v6/assessments`
      - Add assessment components, such as applicant, capitals and properties in the payload
  contact:
    name: Github repository
    url: https://github.com/ministryofjustice/cfe-civil
  version: v6
components:
  schemas:
    currency:
      oneOf:
      - type: number
        format: decimal
        multipleOf: 0.01
      - type: string
        pattern: "^[-+]?\\d+(\\.\\d{1,2})?$"
      example: 70.25
    numeric_currency:
      description: Currency as number
      type: number
      format: decimal
      multipleOf: 0.01
    string_currency:
      description: Currency as string
      type: string
      pattern: "^[-+]?\\d+(\\.\\d{1,2})?$"
    positive_currency:
      oneOf:
      - type: number
        format: decimal
        minimum: 0.0
        multipleOf: 0.01
      - type: string
        pattern: "^[+]?\\d+(\\.\\d{1,2})?$"
      example: 60.99
    OverallResult:
      type: string
      enum:
      - eligible
      - ineligible
      - contribution_required
      - partially_eligible
    PartialResult:
      type: string
      enum:
      - eligible
      - ineligible
      - contribution_required
      - not_yet_known
      - not_calculated
    PropertyResult:
      type: object
      additionalProperties: false
      properties:
        value:
          type: number
          minimum: 0.0
        outstanding_mortgage:
          type: number
          minimum: 0.0
        percentage_owned:
          type: number
          minimum: 0
          maximum: 100
        main_home:
          type: boolean
        shared_with_housing_assoc:
          type: boolean
        transaction_allowance:
          type: number
          minimum: 0.0
        allowable_outstanding_mortgage:
          type: number
          minimum: 0.0
        net_value:
          type: number
        net_equity:
          type: number
        smod_allowance:
          type: number
          description: Amount of subject matter of dispute disregard applied to this
            property
          minimum: 0.0
          maximum: 100000.0
        main_home_equity_disregard:
          type: number
          description: Amount of main home equity disregard applied to this property
        assessed_equity:
          type: number
          minimum: 0.0
        subject_matter_of_dispute:
          type: boolean
          nullable: true
    BankAccounts:
      type: array
      description: Describes the name of the bank account and the lowest balance during
        the computation period<p>Inaccessible capital - For submissions after MTR
        Phase 2 is implemented, capital where the value cannot be accessed to pay
        legal costs, should be excluded.</p><p>Detailed guidance TBD</p>
      example:
      - value: 1.01
        description: test name 1
        subject_matter_of_dispute: false
      - value: 100.01
        description: test name 2
        subject_matter_of_dispute: true
      items:
        type: object
        description: Account detail
        additionalProperties: false
        required:
        - value
        - description
        properties:
          value:
            "$ref": "#/components/schemas/currency"
          description:
            type: string
          subject_matter_of_dispute:
            description: Whether the contents of this bank account are the subject
              of a dispute
            type: boolean
    Capitals:
      type: object
      additionalProperties: false
      properties:
        bank_accounts:
          "$ref": "#/components/schemas/BankAccounts"
        non_liquid_capital:
          type: array
          description: An array of objects describing applicant's non-liquid capital
            items (excluding property), e.g. valuable items, jewellery, trusts, other
            investments
          example:
          - value: 1.01
            description: asset name 1
            subject_matter_of_dispute: false
          - value: 100.01
            description: asset name 2
            subject_matter_of_dispute: true
          items:
            type: object
            description: Asset detail<p>Inaccessible capital - For submissions after
              MTR Phase 2 is implemented, capital where the value cannot be accessed
              to pay legal costs, should be excluded.</p><p>Detailed guidance TBD</p>
            required:
            - value
            - description
            additionalProperties: false
            properties:
              value:
                "$ref": "#/components/schemas/positive_currency"
              description:
                description: Definition of a non-liquid capital item
                type: string
              subject_matter_of_dispute:
                description: Whether the item is the subject of a dispute
                type: boolean
    NonPropertyAsset:
      type: object
      additionalProperties: false
      description: Non-property Asset
      required:
      - value
      - description
      properties:
        value:
          type: number
          format: decimal
          description: Value of asset
        description:
          type: string
          description: Description of asset
    OutgoingsList:
      type: array
      description: One or more outgoings categorized by name
      items:
        oneOf:
        - type: object
          required:
          - name
          - payments
          additionalProperties: false
          description: Outgoing payments detail. 'priority_debt_repayment' and 'council_tax'
            are not calculated before MTR
          properties:
            name:
              type: string
              enum:
              - child_care
              - maintenance_out
              - legal_aid
              - pension_contribution
              - council_tax
              - priority_debt_repayment
              description: Type of outgoing
              example: child_care
            payments:
              type: array
              description: One or more outgoing payments detail
              items:
                type: object
                additionalProperties: false
                required:
                - client_id
                - payment_date
                - amount
                properties:
                  client_id:
                    type: string
                    description: Client identifier for outgoing payment
                    example: '05459c0f-a620-4743-9f0c-b3daa93e57'
                  payment_date:
                    type: string
                    format: date
                    description: Date payment made
                    example: '1992-07-23'
                  amount:
                    type: number
                    format: decimal
                    description: Amount of payment made
                    example: 101.01
        - type: object
          required:
          - name
          - payments
          additionalProperties: false
          description: Outgoing payments detail
          properties:
            name:
              type: string
              enum:
              - rent_or_mortgage
              description: Type of outgoing
            payments:
              type: array
              description: One or more outgoing payments detail
              items:
                type: object
                additionalProperties: false
                required:
                - client_id
                - payment_date
                - amount
                - housing_cost_type
                properties:
                  client_id:
                    type: string
                    description: Client identifier for outgoing payment
                    example: '05459c0f-a620-4743-9f0c-b3daa93e5'
                  payment_date:
                    type: string
                    format: date
                    description: Date payment made
                    example: '1992-07-24'
                  housing_cost_type:
                    type: string
                    enum:
                    - rent
                    - mortgage
                    - board_and_lodging
                    description: Housing cost type - should also be in cash_transactions.outgoings,
                      but currently unused by both clients
                  amount:
                    type: number
                    format: decimal
                    description: Amount of payment made
                    example: 101.01
    Assessment:
      type: object
      additionalProperties: false
      required:
      - submission_date
      properties:
        client_reference_id:
          type: string
          example: LA-FOO-BAR
          description: Client's reference number for this application (free text)
        submission_date:
          type: string
          format: date
          description: Date of the original submission (iso8601 format)
          example: '2022-05-19'
        level_of_help:
          type: string
          enum:
          - certificated
          - controlled
          example: certificated
          description: The level of help required by the client. Defaults to 'certificated'
        controlled_legal_representation:
          type: boolean
          example: false
          description: Whether the work is “controlled legal representation” (CLR)
            (only relevant if client under 18)
        not_aggregated_no_income_low_capital:
          type: boolean
          example: false
          description: Whether the means test is eligible via the “simplified approach
            to means testing”, which is only relevant to applications for children
            (under 18) for controlled work. Set to True if it has been considered
            inequitable to aggregate the means of the child with that of their maintaining
            adult(s), the child does not have any regular income (not including part-time
            earnings, holiday jobs or pocket money), and their capital is worth less
            than £2500.
        section_gross_income:
          type: string
          enum:
          - complete
          - incomplete
        section_disposable_income:
          type: string
          enum:
          - complete
          - incomplete
        section_capital:
          type: string
          enum:
          - complete
          - incomplete
    CashTransactions:
      type: object
      description: A set of cash income[ings] and outgoings payments by category
      example:
        income:
        - category: maintenance_in
          payments:
          - date: '2022-01-01'
            amount: 1046.44
            client_id: '05459c0f-a620-4743-9f0c-b3daa93e5711'
          - date: '2022-02-01'
            amount: 1034.33
            client_id: 10318f7b-289a-4fa5-a986-fc6f499fecd0
          - date: '2022-03-01'
            amount: 1033.44
            client_id: 5cf62a12-c92b-4cc1-b8ca-eeb4efbcce21
        - category: friends_or_family
          payments:
          - date: '2022-02-01'
            amount: 250.0
            client_id: e47b707b-d795-47c2-8b39-ccf022eae33b
          - date: '2022-03-01'
            amount: 266.02
            client_id: b0c46cc7-8478-4658-a7f9-85ec85d420b1
          - date: '2022-01-01'
            amount: 250.0
            client_id: f3ec68a3-8748-4ed5-971a-94d133e0efa0
        outgoings:
        - category: maintenance_out
          payments:
          - date: '2022-02-01'
            amount: 256.0
            client_id: 347b707b-d795-47c2-8b39-ccf022eae33b
          - date: '2022-03-01'
            amount: 256.0
            client_id: 722b707b-d795-47c2-8b39-ccf022eae33b
          - date: '2022-01-01'
            amount: 256.0
            client_id: abcb707b-d795-47c2-8b39-ccf022eae33b
        - category: child_care
          payments:
          - date: '2022-03-01'
            amount: 258.0
            client_id: ff7b707b-d795-47c2-8b39-ccf022eae33b
          - date: '2022-02-01'
            amount: 257.0
            client_id: ee7b707b-d795-47c2-8b39-ccf022eae33b
          - date: '2022-01-01'
            amount: 256.0
            client_id: ec7b707b-d795-47c2-8b39-ccf022eae33b
      properties:
        income:
          type: array
          description: One or more income details
          items:
            type: object
            description: Income detail
            additionalProperties: false
            required:
            - category
            - payments
            properties:
              category:
                type: string
                enum:
                - benefits
                - friends_or_family
                - maintenance_in
                - property_or_lodger
                - pension
                example: benefits
                description: "<p>Do not include “disregarded payments” - those which
                  should be excluded from the gross income and disposable income calculations,
                  as described in the Lord Chancellor's guidance - certificated: ‘5.3
                  Disregarded payments', controlled: '5.4 Disregarded income’.</p><p>Note:
                  for submissions after MTR Phase 2 is implemented, “disregarded payments”
                  will be extended to cover “Modern Slavery Victim Care Contract (MSVCC)
                  financial support payments”, and no longer cover “Back to Work Bonus
                  payments”</p>"
              payments:
                type: array
                description: One or more payment details
                items:
                  type: object
                  additionalProperties: false
                  required:
                  - amount
                  - client_id
                  - date
                  properties:
                    date:
                      type: string
                      format: date
                      example: '1992-07-26'
                    amount:
                      "$ref": "#/components/schemas/positive_currency"
                    client_id:
                      type: string
                      format: uuid
                      example: '05459c0f-a620-4743-9f0c-b3daa93e'
        outgoings:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
            - category
            - payments
            properties:
              category:
                description: The category of the outgoing transaction. 'priority_debt_repayment'
                  and 'council_tax' are not calculated before MTR
                type: string
                enum:
                - child_care
                - rent_or_mortgage
                - maintenance_out
                - legal_aid
                - pension_contribution
                - council_tax
                - priority_debt_repayment
              payments:
                description: The payments of the outgoing transaction
                type: array
                items:
                  type: object
                  required:
                  - amount
                  - client_id
                  - date
                  properties:
                    amount:
                      "$ref": "#/components/schemas/positive_currency"
                    client_id:
                      type: string
                    date:
                      type: string
                      format: date
                  additionalProperties: false
      additionalProperties: false
    DateOfBirth:
      type: string
      format: date
      example: '1992-07-27'
    InFullTimeEducation:
      type: boolean
      example: false
      description: Dependant is in full time education or not
    RelationShip:
      type: string
      enum:
      - child_relative
      - adult_relative
      description: Dependant's relationship to the applicant
    DependantIncome:
      type: object
      required:
      - frequency
      - amount
      additionalProperties: false
      properties:
        frequency:
          type: string
          enum:
          - weekly
          - two_weekly
          - four_weekly
          - monthly
          - three_monthly
          - annually
        amount:
          oneOf:
          - "$ref": "#/components/schemas/numeric_currency"
          example: 0
    IrregularIncomePayments:
      type: array
      minItems: 0
      maxItems: 2
      description: One or more irregular payment details
      items:
        type: object
        required:
        - income_type
        - frequency
        - amount
        description: Irregular payment detail
        properties:
          income_type:
            type: string
            enum:
            - student_loan
            - unspecified_source
            description: Identifying name for this irregular income payment
            example: student_loan
          frequency:
            type: string
            enum:
            - monthly
            - annual
            - quarterly
            description: Frequency of the payment received
            example: monthly
          amount:
            "$ref": "#/components/schemas/currency"
        additionalProperties: false
    OtherIncomes:
      type: array
      description: One or more other regular income payments categorized by source
      items:
        type: object
        description: Other regular income detail
        required:
        - source
        - payments
        properties:
          source:
            type: string
            enum:
            - benefits
            - friends_or_family
            - maintenance_in
            - property_or_lodger
            - pension
            - Benefits
            - Friends or family
            - Maintenance in
            - Property or lodger
            - Pension
            description: Source of other regular income
            example: benefits
          payments:
            type: array
            description: One or more other regular payment details
            items:
              type: object
              required:
              - date
              - amount
              - client_id
              properties:
                date:
                  type: string
                  format: date
                  example: '1992-07-28'
                amount:
                  oneOf:
                  - "$ref": "#/components/schemas/positive_currency"
                  description: Amount of payment received
                client_id:
                  type: string
                  format: uuid
                  description: Client identifier for payment received
                  example: '05459c0f-a620-4743-9f0c-b3daa93e'
              additionalProperties: false
        additionalProperties: false
    Property:
      type: object
      description: Details of property<p>Inaccessible capital - For submissions after
        MTR Phase 2 is implemented, capital where the value cannot be accessed to
        pay legal costs, should be excluded.</p><p>Detailed guidance TBD</p>
      required:
      - value
      - outstanding_mortgage
      - percentage_owned
      - shared_with_housing_assoc
      properties:
        value:
          oneOf:
          - "$ref": "#/components/schemas/currency"
          description: Financial value of the property
        outstanding_mortgage:
          oneOf:
          - "$ref": "#/components/schemas/currency"
          description: Amount outstanding on all mortgages against this property
        percentage_owned:
          type: number
          format: decimal
          description: Percentage share of the property which is owned by the applicant
          example: 99.99
          minimum: 0
          maximum: 100
        shared_with_housing_assoc:
          type: boolean
          description: Property is shared with a housing association
        subject_matter_of_dispute:
          type: boolean
          description: Property is the subject of a dispute. Defaults to false
      additionalProperties: false
    MainHome:
      oneOf:
      - "$ref": "#/components/schemas/Property"
      description: Property where applicant is living, or original main property in
        a domestic abuse case<p>Inaccessible capital - For submissions after MTR Phase
        2 is implemented, capital where the value cannot be accessed to pay legal
        costs, should be excluded.</p><p>Detailed guidance TBD</p>
    RegularTransaction:
      type: object
      description: Regular transaction detail. 'priority_debt_repayment' and 'council_tax'
        are not calculated before MTR
      required:
      - category
      - operation
      - frequency
      - amount
      additionalProperties: false
      properties:
        category:
          type: string
          enum:
          - benefits
          - friends_or_family
          - maintenance_in
          - property_or_lodger
          - pension
          - housing_benefit
          - child_care
          - rent_or_mortgage
          - maintenance_out
          - legal_aid
          - pension_contribution
          - council_tax
          - priority_debt_repayment
          description: 'Identifying category for this regular transaction<p>Do not
            include “disregarded payments” - those which should be excluded from the
            gross income and disposable income calculations, as described in the Lord
            Chancellor''s guidance - certificated: ‘5.3 Disregarded payments'', controlled:
            ''5.4 Disregarded income’.</p><p>Note: for submissions after MTR Phase
            2 is implemented, “disregarded payments” will be extended to cover “Modern
            Slavery Victim Care Contract (MSVCC) financial support payments”, and
            no longer cover “Back to Work Bonus payments”</p>'
          example: benefits
        operation:
          type: string
          enum:
          - credit
          - debit
          description: Identifying operation for this regular transaction
          example: credit
        frequency:
          type: string
          enum:
          - three_monthly
          - monthly
          - four_weekly
          - two_weekly
          - weekly
          - unknown
          description: Frequency with which regular transaction is made or received
          example: three_monthly
        amount:
          "$ref": "#/components/schemas/currency"
    SelfEmployment:
      type: object
      required:
      - income
      additionalProperties: false
      description: Self employment, with pay info supplied in the 'how much, how often'
        pattern
      properties:
        client_reference:
          type: string
          description: Optional reference, echoed in response
        income:
          type: object
          required:
          - frequency
          - gross
          - tax
          - national_insurance
          additionalProperties: false
          properties:
            frequency:
              type: string
              enum:
              - weekly
              - two_weekly
              - four_weekly
              - monthly
              - three_monthly
              - annually
            gross:
              type: number
              format: decimal
              minimum: 0
              description: Gross income from this undertaking
            tax:
              type: number
              format: decimal
              maximum: 0
              description: Tax paid (negative) on this income
            national_insurance:
              type: number
              maximum: 0
              format: decimal
              description: NI paid (negative) on this income
            prisoner_levy:
              type: number
              maximum: 0
              format: decimal
              description: prisoner levy paid (negative) on this income
            student_debt_repayment:
              type: number
              maximum: 0
              format: decimal
              description: student debt repayment paid (negative) on this income
    EmploymentDetails:
      type: object
      required:
      - income
      additionalProperties: false
      description: Employment, with pay info supplied in the 'how much, how often'
        pattern
      properties:
        client_reference:
          type: string
          description: Optional reference, echoed in response
        income:
          type: object
          required:
          - frequency
          - gross
          - tax
          - benefits_in_kind
          - national_insurance
          - receiving_only_statutory_sick_or_maternity_pay
          additionalProperties: false
          properties:
            receiving_only_statutory_sick_or_maternity_pay:
              type: boolean
            frequency:
              type: string
              enum:
              - weekly
              - two_weekly
              - four_weekly
              - monthly
              - three_monthly
              - annually
            gross:
              type: number
              format: decimal
              minimum: 0
              description: Gross income from this employment
              example: '2000.00'
            benefits_in_kind:
              type: number
              format: decimal
              minimum: 0
              description: Regular benefits in kind from this employment
            tax:
              type: number
              format: decimal
              maximum: 0
              description: tax paid (negative) on this employment
            national_insurance:
              type: number
              format: decimal
              maximum: 0
              description: NI paid (negative) on this employment
            prisoner_levy:
              type: number
              format: decimal
              maximum: 0
              description: prisoner levy paid (negative) on this employment
            student_debt_repayment:
              type: number
              maximum: 0
              format: decimal
              description: student debt repayment paid (negative) on this income
    StateBenefit:
      type: object
      required:
      - name
      - payments
      additionalProperties: false
      description: State benefit payment detail
      properties:
        name:
          type: string
          description: 'Name of the state benefit<p>Do not include “disregarded payments”
            - those which should be excluded from the gross income and disposable
            income calculations, as described in the Lord Chancellor''s guidance -
            certificated: ‘5.3 Disregarded payments'', controlled: ''5.4 Disregarded
            income’.</p><p>Note: for submissions after MTR Phase 2 is implemented,
            “disregarded payments” will be extended to cover “Modern Slavery Victim
            Care Contract (MSVCC) financial support payments”, and no longer cover
            “Back to Work Bonus payments”</p>'
          example: my_state_benefit
        payments:
          type: array
          description: One or more state benefit payments details
          items:
            required:
            - client_id
            - date
            - amount
            additionalProperties: false
            type: object
            properties:
              client_id:
                type: string
                format: uuid
                description: Client identifier for payment received
                example: '05459c0f-a620-4743-9f0c-b3daa9'
              date:
                type: string
                format: date
                example: '1992-07-29'
              amount:
                oneOf:
                - "$ref": "#/components/schemas/currency"
                description: Amount of payment received
              flags:
                type: object
                description: Line items that should be flagged to caseworkers for
                  review
                example:
                  multi_benefit: true
                properties:
                  multi_benefit:
                    type: boolean
                additionalProperties: false
    Vehicle:
      type: object
      description: Detail of vehicle<p>Inaccessible capital - For submissions after
        MTR Phase 2 is implemented, capital where the value cannot be accessed to
        pay legal costs, should be excluded.</p><p>Detailed guidance TBD</p>
      required:
      - value
      - date_of_purchase
      properties:
        value:
          oneOf:
          - "$ref": "#/components/schemas/positive_currency"
          description: Financial value of the vehicle
        loan_amount_outstanding:
          oneOf:
          - "$ref": "#/components/schemas/currency"
          description: Amount remaining, if any, of a loan used to purchase the vehicle
        date_of_purchase:
          type: string
          format: date
          description: Date vehicle purchased by the applicant
        in_regular_use:
          type: boolean
          description: Vehicle in regular use or not
        subject_matter_of_dispute:
          type: boolean
          description: Whether this vehicle is the subject of a dispute
      additionalProperties: false
    ExplicitRemarks:
      type: array
      description: One or more remarks by category
      items:
        type: object
        required:
        - category
        - details
        description: Explicit remark
        properties:
          category:
            type: string
            enum:
            - policy_disregards
            description: Category of remark. Currently, only 'policy_disregard' is
              supported
            example: policy_disregards
          details:
            type: array
            description: One or more remarks for that category
            items:
              type: string
        additionalProperties: false
    TotalLiquidCapital:
      type: number
      description: Total value of all liquid assets in submission
      format: decimal
    TotalNonLiquidCapital:
      description: Total value of all non-liquid assets in submission
      type: number
      format: decimal
      minimum: 0.0
    TotalVehicleCapital:
      description: Total value of all client vehicle assets in submission
      type: number
      format: decimal
    TotalPropertyCapital:
      description: Total value of all client property assets in submission
      type: number
      format: decimal
    TotalCapital:
      description: Total value of all capital assets in submission
      type: number
      format: decimal
    TotalCapitalWithSmod:
      type: number
      format: decimal
      minimum: 0
      description: Total of all capital but with subject matter of dispute deduction
        applied where applicable
    TotalMortgageAllowance:
      description: Maximum mortgage allowance used in submission. Cases post-April
        2020 will all be set to 999_999_999
      type: number
      format: decimal
    SmodDisregard:
      type: number
      format: decimal
      minimum: 0
      description: Total amount of subject matter of dispute disregard applied on
        this submission
    AssessedCapital:
      type: number
      format: decimal
      minimum: 0
      description: Amount of assessed client capital. Zero if deductions exceed total
        capital.
    DisputedNonPropertyDisregard:
      type: number
      format: decimal
      minimum: 0
      description: Amount of subject matter of dispute deduction applied for assets
        other than property
    PensionerDisregardApplied:
      type: number
      format: decimal
      minimum: 0
      description: Amount of pensioner capital disregard applied to this assessment
    CapitalResult:
      type: object
      additionalProperties: false
      properties:
        total_liquid:
          "$ref": "#/components/schemas/TotalLiquidCapital"
        total_non_liquid:
          "$ref": "#/components/schemas/TotalNonLiquidCapital"
        total_vehicle:
          "$ref": "#/components/schemas/TotalVehicleCapital"
        total_property:
          "$ref": "#/components/schemas/TotalPropertyCapital"
        total_capital:
          "$ref": "#/components/schemas/TotalCapital"
        total_capital_with_smod:
          "$ref": "#/components/schemas/TotalCapitalWithSmod"
        total_mortgage_allowance:
          "$ref": "#/components/schemas/TotalMortgageAllowance"
        subject_matter_of_dispute_disregard:
          "$ref": "#/components/schemas/SmodDisregard"
        assessed_capital:
          "$ref": "#/components/schemas/AssessedCapital"
        disputed_non_property_disregard:
          "$ref": "#/components/schemas/DisputedNonPropertyDisregard"
        pensioner_disregard_applied:
          "$ref": "#/components/schemas/PensionerDisregardApplied"
    PensionerCapitalDisregard:
      type: number
      format: decimal
      description: Cap on pensioner capital disregard for this assessment (based on
        disposable_income)
      minimum: 0.0
    CapitalContribution:
      type: number
      format: decimal
      minimum: 0
      description: Amount of capital contribution required (only valid if result is
        contribution_required)
    CombinedDisputedCapital:
      description: Combined applicant and partner disputed capital
      type: number
      format: decimal
    CombinedNonDisputedCapital:
      description: Combined applicant and partner non-disputed capital
      type: number
      format: decimal
    CombinedAssessedCapital:
      type: number
      format: decimal
      minimum: 0
      description: Amount of assessed capital for both client and partner
    EmploymentIncomeResult:
      type: object
      description: Calculated monthly employment income
      additionalProperties: false
      properties:
        gross_income:
          type: number
        benefits_in_kind:
          type: number
        tax:
          type: number
          format: decimal
          maximum: 0
          description: "(negative) monthly tax paid"
        national_insurance:
          type: number
          format: decimal
          maximum: 0
          description: "(negative) monthly NI paid"
        prisoner_levy:
          type: number
          format: decimal
          maximum: 0
          description: "(negative) monthly prisoner levy paid"
        student_debt_repayment:
          type: number
          format: decimal
          maximum: 0
          description: "(negative) monthly student debt repayment"
        fixed_employment_deduction:
          type: number
          format: decimal
          maximum: 0
          description: "(negative) fixed employment deduction (if applicable) otherwise
            zero"
        net_employment_income:
          type: number
          description: Calculated monthly net income (gross + benefits_in_kind - tax
            - ni - deductions)
    HousingCosts:
      type: number
      format: decimal
      minimum: 0
      description: Calculated monthly rent/mortgage costs
    HousingBenefit:
      type: number
      format: decimal
      minimum: 0
      description: Calculated monthly housing benefit received
    AllowedHousingCosts:
      type: number
      format: decimal
      minimum: 0
      description: Calculated monthly allowed housing costs
    MaintenanceAllowance:
      type: number
      format: decimal
      minimum: 0
      description: Total of maintenance outgoings costs
    DependantAllowanceUnder16:
      type: number
      format: decimal
      minimum: 0
      description: Allowance for dependants under 16
    DependantAllowanceOver16:
      type: number
      format: decimal
      minimum: 0
      description: Allowance for dependants 16 and over
    DependantAllowance:
      type: number
      format: decimal
      minimum: 0
      description: Sum of dependant_allowance_under_16 and dependant_allowance_over_16
    TotalOutgoingsAndAllowances:
      type: number
      format: decimal
      description: Sum of outgoings and allowances
    TotalDisposableIncome:
      type: number
      format: decimal
      description: Calculated monthly disposable income (gross - outgoings - allowances)
    IncomeContribution:
      type: number
      format: decimal
      minimum: 0
      description: Amount of income contribution required (only valid if result is
        contribution_required)
    PartnerAllowance:
      type: number
      format: decimal
      minimum: 0
      description: Fixed allowance given if applicant has a partner for means assessment
        purposes
    LoneParentAllowance:
      type: number
      format: decimal
      minimum: 0
      description: Fixed allowance given if applicant is a lone parent
    CombinedOutgoingsAndAllowances:
      type: number
      format: decimal
      description: total_outgoings_and_allowances + partner total_outgoings_and_allowances
    CombinedDisposableIncome:
      type: number
      format: decimal
      description: total_disposable_income + partner total_disposable_income
    ApplicantResult:
      type: object
      additionalProperties: false
      properties:
        date_of_birth:
          type: string
          format: date
        involvement_type:
          type: string
          deprecated: true
        employed:
          type: boolean
        has_partner_opponent:
          type: boolean
        receives_qualifying_benefit:
          type: boolean
    ClientIdArray:
      type: array
      description: Array of client_ids affected by remark
      items:
        type: string
    AmountVariationRemark:
      type: object
      additionalProperties: false
      properties:
        amount_variation:
          "$ref": "#/components/schemas/ClientIdArray"
        unknown_frequency:
          "$ref": "#/components/schemas/ClientIdArray"
        multi_benefit:
          "$ref": "#/components/schemas/ClientIdArray"
    Remarks:
      type: object
      additionalProperties: false
      properties:
        client_employment:
          type: object
          additionalProperties: false
          properties:
            multiple_employments:
              "$ref": "#/components/schemas/ClientIdArray"
        client_employment_tax:
          type: object
          additionalProperties: false
          properties:
            refunds:
              "$ref": "#/components/schemas/ClientIdArray"
        client_employment_nic:
          type: object
          additionalProperties: false
          properties:
            refunds:
              "$ref": "#/components/schemas/ClientIdArray"
        client_employment_payment:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_state_benefit_payment:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_other_income_payment:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_outgoings_housing_cost:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_outgoings_legal_aid:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_outgoings_maintenance:
          "$ref": "#/components/schemas/AmountVariationRemark"
        client_outgoings_childcare:
          "$ref": "#/components/schemas/AmountVariationRemark"
    OutgoingResult:
      type: object
      additionalProperties: false
      properties:
        friends_or_family:
          type: number
        maintenance_in:
          type: number
        property_or_lodger:
          type: number
        pension:
          type: number
    StateBenefitsResult:
      type: object
      additionalProperties: false
      properties:
        monthly_equivalents:
          type: object
          additionalProperties: false
          required:
          - all_sources
          - cash_transactions
          - bank_transactions
          properties:
            all_sources:
              type: number
              format: decimal
            cash_transactions:
              type: number
              format: decimal
            bank_transactions:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  name:
                    type: string
                  monthly_value:
                    type: number
                  excluded_from_income_assessment:
                    type: boolean
    OtherIncomeResult:
      type: object
      additionalProperties: false
      properties:
        monthly_equivalents:
          type: object
          additionalProperties: false
          properties:
            all_sources:
              "$ref": "#/components/schemas/OutgoingResult"
            bank_transactions:
              "$ref": "#/components/schemas/OutgoingResult"
            cash_transactions:
              "$ref": "#/components/schemas/OutgoingResult"
    GrossIncomeResult:
      type: object
      additionalProperties: false
      required:
      - employment_income
      - irregular_income
      - state_benefits
      - other_income
      properties:
        employment_income:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
            - name
            - payments
            properties:
              name:
                type: string
              payments:
                type: array
        employment_details:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
            - monthly_income
            properties:
              monthly_income:
                type: object
                additionalProperties: false
                properties:
                  gross:
                    type: number
                  tax:
                    type: number
                  national_insurance:
                    type: number
                  prisoner_levy:
                    type: number
                  student_debt_repayment:
                    type: number
                  benefits_in_kind:
                    type: number
                  client_id:
                    type: string
        irregular_income:
          type: object
          additionalProperties: false
          required:
          - monthly_equivalents
          properties:
            monthly_equivalents:
              type: object
              additionalProperties: false
              required:
              - student_loan
              - unspecified_source
              properties:
                student_loan:
                  type: number
                unspecified_source:
                  type: number
        state_benefits:
          "$ref": "#/components/schemas/StateBenefitsResult"
        other_income:
          "$ref": "#/components/schemas/OtherIncomeResult"
        self_employments:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
            - monthly_income
            properties:
              client_reference:
                type: string
                description: client reference from request
              monthly_income:
                type: object
                description: Monthly versions of input data
                additionalProperties: false
                required:
                - gross
                - tax
                - national_insurance
                - benefits_in_kind
                properties:
                  gross:
                    type: number
                    format: decimal
                    minimum: 0
                    description: A positive number representing a gross income
                    example: '2050.20'
                  tax:
                    type: number
                    format: decimal
                    maximum: 0
                    description: A negative number representing a tax deduction
                    example: "-250.20"
                  national_insurance:
                    type: number
                    format: decimal
                    maximum: 0
                    description: A negative number representing a National Insurance
                      deduction
                    example: "-150.20"
                  prisoner_levy:
                    type: number
                    format: decimal
                    maximum: 0
                    description: A negative number representing a Prisoner Levy deduction
                    example: "-20.00"
                  student_debt_repayment:
                    type: number
                    format: decimal
                    maximum: 0
                    description: A negative number representing a Student Debt Repayment
                      deduction
                    example: "-50.00"
                  benefits_in_kind:
                    type: number
                    minimum: 0
                    format: decimal
                    description: A positive number representing a benefit in kind
                      payment
                    example: '100.00'
    DisposableIncomeResult:
      type: object
      additionalProperties: false
      properties:
        monthly_equivalents:
          type: object
          additionalProperties: false
          properties:
            all_sources:
              type: object
              additionalProperties: false
              properties:
                child_care:
                  type: number
                rent_or_mortgage:
                  type: number
                maintenance_out:
                  type: number
                legal_aid:
                  type: number
                pension_contribution:
                  type: number
                council_tax:
                  type: number
                priority_debt_repayment:
                  type: number
            bank_transactions:
              type: object
              additionalProperties: false
              properties:
                child_care:
                  type: number
                rent_or_mortgage:
                  type: number
                maintenance_out:
                  type: number
                legal_aid:
                  type: number
                pension_contribution:
                  type: number
                council_tax:
                  type: number
                priority_debt_repayment:
                  type: number
            cash_transactions:
              type: object
              additionalProperties: false
              properties:
                child_care:
                  type: number
                rent_or_mortgage:
                  type: number
                maintenance_out:
                  type: number
                legal_aid:
                  type: number
                pension_contribution:
                  type: number
                council_tax:
                  type: number
                priority_debt_repayment:
                  type: number
        childcare_allowance:
          type: number
        deductions:
          type: object
          additionalProperties: false
          properties:
            dependants_allowance:
              type: number
            disregarded_state_benefits:
              type: number
    AssessmentCapitalResult:
      type: object
      additionalProperties: false
      properties:
        capital_items:
          type: object
          additionalProperties: false
          required:
          - liquid
          - non_liquid
          - vehicles
          - properties
          properties:
            liquid:
              type: array
              items:
                "$ref": "#/components/schemas/NonPropertyAsset"
            non_liquid:
              type: array
              items:
                "$ref": "#/components/schemas/NonPropertyAsset"
            vehicles:
              type: array
              items:
                "$ref": "#/components/schemas/NonPropertyAsset"
            properties:
              type: object
              additionalProperties: false
              properties:
                main_home:
                  "$ref": "#/components/schemas/PropertyResult"
                additional_properties:
                  type: array
                  items:
                    "$ref": "#/components/schemas/PropertyResult"
    ProceedingTypes:
      type: array
      minItems: 1
      description: Unless the assessment qualifies as 'non-means', it is required
        to provide one or more proceeding_types
      items:
        type: object
        required:
        - ccms_code
        - client_involvement_type
        properties:
          ccms_code:
            type: string
            enum:
            - DA001
            - DA002
            - DA003
            - DA004
            - DA005
            - DA006
            - DA007
            - DA020
            - SE003
            - SE004
            - SE013
            - SE014
            - SE007
            - SE008
            - SE015
            - SE016
            - SE095
            - SE097
            - SE003A
            - SE004A
            - SE007A
            - SE008A
            - SE013A
            - SE014A
            - SE015A
            - SE016A
            - SE095A
            - SE097A
            - SE101A
            - PBM01
            - PBM02
            - PBM04
            - PBM05
            - PBM06
            - PBM07
            - PBM08
            - PBM09
            - PBM10
            - PBM11
            - PBM13
            - PBM16
            - PBM17
            - PBM18
            - PBM19
            - PBM20
            - PBM21
            - PBM22
            - PBM23
            - PBM24
            - PBM26
            - PBM27
            - PBM28
            - PBM29
            - PBM30
            - PBM32
            - PBM33
            - PBM35
            - PBM36
            - PBM37
            - PBM38
            - PBM39
            - PBM01A
            - PBM02A
            - PBM04A
            - PBM05A
            - PBM06A
            - PBM07A
            - PBM08A
            - PBM09A
            - PBM10A
            - PBM11A
            - PBM13A
            - PBM16A
            - PBM17A
            - PBM18A
            - PBM19A
            - PBM20A
            - PBM21A
            - PBM22A
            - PBM23A
            - PBM24A
            - PBM26A
            - PBM27A
            - PBM28A
            - PBM29A
            - PBM30A
            - PBM32A
            - PBM33A
            - PBM35A
            - PBM36A
            - PBM37A
            - PBM38A
            - PBM39A
            - PBM02E
            - PBM04E
            - PBM05E
            - PBM06E
            - PBM07E
            - PBM08E
            - PBM09E
            - PBM11E
            - PBM16E
            - PBM17E
            - PBM18E
            - PBM19E
            - PBM20E
            - PBM21E
            - PBM23E
            - PBM24E
            - PBM26E
            - PBM27E
            - PBM29E
            - PBM30E
            - PBM32E
            - PBM33E
            - PBM35E
            - PBM36E
            - PBM37E
            - PBM38E
            - PBM39E
            - IM030
            - IA031
            - SE003E
            - SE004E
            - SE007E
            - SE008E
            - SE013E
            - SE014E
            - SE015E
            - SE016E
            - SE096E
            - SE099E
            - SE100E
            - SE101E
            description: A proxy for the type of law. Values beginning with DA are
              considered domestic abuse cases. IM030 indicates an immigration case.
              IA031 indicates an asylum case.
          client_involvement_type:
            type: string
            enum:
            - A
            - D
            - W
            - Z
            - I
            description: CCMS Client Involvement type A=applicant/claimant/petitioner,
              D=Defendant, W=subject of proceedings, I=intevenor, Z=joined party.
              Domestic abuse waivers only apply for type 'A'
        additionalProperties: false
    ProceedingTypeResults:
      type: array
      minItems: 1
      items:
        type: object
        required:
        - ccms_code
        - client_involvement_type
        - upper_threshold
        - lower_threshold
        - result
        properties:
          ccms_code:
            type: string
            enum:
            - DA001
            - DA002
            - DA003
            - DA004
            - DA005
            - DA006
            - DA007
            - DA020
            - SE003
            - SE004
            - SE013
            - SE014
            - SE007
            - SE008
            - SE015
            - SE016
            - SE095
            - SE097
            - SE003A
            - SE004A
            - SE007A
            - SE008A
            - SE013A
            - SE014A
            - SE015A
            - SE016A
            - SE095A
            - SE097A
            - SE101A
            - PBM01
            - PBM02
            - PBM04
            - PBM05
            - PBM06
            - PBM07
            - PBM08
            - PBM09
            - PBM10
            - PBM11
            - PBM13
            - PBM16
            - PBM17
            - PBM18
            - PBM19
            - PBM20
            - PBM21
            - PBM22
            - PBM23
            - PBM24
            - PBM26
            - PBM27
            - PBM28
            - PBM29
            - PBM30
            - PBM32
            - PBM33
            - PBM35
            - PBM36
            - PBM37
            - PBM38
            - PBM39
            - PBM01A
            - PBM02A
            - PBM04A
            - PBM05A
            - PBM06A
            - PBM07A
            - PBM08A
            - PBM09A
            - PBM10A
            - PBM11A
            - PBM13A
            - PBM16A
            - PBM17A
            - PBM18A
            - PBM19A
            - PBM20A
            - PBM21A
            - PBM22A
            - PBM23A
            - PBM24A
            - PBM26A
            - PBM27A
            - PBM28A
            - PBM29A
            - PBM30A
            - PBM32A
            - PBM33A
            - PBM35A
            - PBM36A
            - PBM37A
            - PBM38A
            - PBM39A
            - PBM02E
            - PBM04E
            - PBM05E
            - PBM06E
            - PBM07E
            - PBM08E
            - PBM09E
            - PBM11E
            - PBM16E
            - PBM17E
            - PBM18E
            - PBM19E
            - PBM20E
            - PBM21E
            - PBM23E
            - PBM24E
            - PBM26E
            - PBM27E
            - PBM29E
            - PBM30E
            - PBM32E
            - PBM33E
            - PBM35E
            - PBM36E
            - PBM37E
            - PBM38E
            - PBM39E
            - IM030
            - IA031
            - SE003E
            - SE004E
            - SE007E
            - SE008E
            - SE013E
            - SE014E
            - SE015E
            - SE016E
            - SE096E
            - SE099E
            - SE100E
            - SE101E
            description: The code expected by CCMS
          client_involvement_type:
            type: string
            enum:
            - A
            - D
            - W
            - Z
            - I
            example: A
            description: The client_involvement_type expected by CCMS
          upper_threshold:
            type: number
          lower_threshold:
            type: number
          result:
            "$ref": "#/components/schemas/PartialResult"
        additionalProperties: false
    v6:
      Applicant:
        type: object
        description: Object describing pertinent applicant details
        required:
        - date_of_birth
        additionalProperties: false
        properties:
          date_of_birth:
            type: string
            format: date
            example: '1992-07-25'
            description: Applicant date of birth
          employed:
            oneOf:
            - type: boolean
            - type: 'null'
            example: true
            description: Deprecated - employment is determined by presence of gross
              employment income
            deprecated: true
          has_partner_opponent:
            type: boolean
            example: false
            description: Applicant has partner opponent (unused in calculation)
          receives_qualifying_benefit:
            type: boolean
            example: false
            description: Applicant receives qualifying benefit
          receives_asylum_support:
            type: boolean
            example: false
            description: Applicant receives section 4 or section 95 Asylum Support
          involvement_type:
            type: string
            deprecated: true
            enum:
            - applicant
      DisposableIncome:
        type: object
        additionalProperties: false
        properties:
          employment_income:
            "$ref": "#/components/schemas/EmploymentIncomeResult"
          housing_costs:
            "$ref": "#/components/schemas/HousingCosts"
          housing_benefit:
            "$ref": "#/components/schemas/HousingBenefit"
          gross_housing_costs:
            allOf:
            - "$ref": "#/components/schemas/HousingCosts"
            - deprecated: true
          net_housing_costs:
            allOf:
            - "$ref": "#/components/schemas/AllowedHousingCosts"
            - deprecated: true
          allowed_housing_costs:
            "$ref": "#/components/schemas/AllowedHousingCosts"
          maintenance_allowance:
            "$ref": "#/components/schemas/MaintenanceAllowance"
          dependant_allowance_under_16:
            "$ref": "#/components/schemas/DependantAllowanceUnder16"
          dependant_allowance_over_16:
            "$ref": "#/components/schemas/DependantAllowanceOver16"
          dependant_allowance:
            "$ref": "#/components/schemas/DependantAllowance"
          total_outgoings_and_allowances:
            "$ref": "#/components/schemas/TotalOutgoingsAndAllowances"
          total_disposable_income:
            "$ref": "#/components/schemas/TotalDisposableIncome"
        required:
        - employment_income
        - gross_housing_costs
        - housing_benefit
        - net_housing_costs
        - allowed_housing_costs
        - housing_costs
        - maintenance_allowance
        - dependant_allowance_under_16
        - dependant_allowance_over_16
        - dependant_allowance
        - total_outgoings_and_allowances
        - total_disposable_income
      Employments:
        type: array
        description: One or more employment income details
        items:
          type: object
          additionalProperties: false
          required:
          - name
          - client_id
          - payments
          description: Employment income detail
          properties:
            name:
              type: string
              description: Identifying name for this employment - e.g. employer's
                name
            client_id:
              type: string
              description: Client supplied id to identify the employment
            receiving_only_statutory_sick_or_maternity_pay:
              type: boolean
              description: Client is in receipt only of Statutory Sick Pay (SSP) or
                Statutory Maternity Pay (SMP)
            payments:
              "$ref": "#/components/schemas/v6/EmploymentPaymentList"
      EmploymentPaymentList:
        type: array
        description: 0 or more employment payment details
        items:
          type: object
          additionalProperties: false
          required:
          - client_id
          - date
          - gross
          - benefits_in_kind
          - tax
          - national_insurance
          properties:
            client_id:
              type: string
              description: Client supplied id to identify the payment
              example: '05459c0f-a620-4743-9f0c-b3daa93e571'
            date:
              type: string
              format: date
              example: '1992-07-22'
            gross:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Gross payment income received
              example: 101.01
            benefits_in_kind:
              oneOf:
              - "$ref": "#/components/schemas/positive_currency"
              description: Benefit in kind amount received
              example: 10.5
            tax:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of tax paid - normally negative, but can be positive
                for a refund
              example: -10.01
            national_insurance:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of national insurance paid - normally negative,
                but can be positive for a refund
              example: -5.24
            prisoner_levy:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of prisoner levy paid - always negative
              example: -5.24
            student_debt_repayment:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of student debt repayment paid - always negative
              example: -50.0
            net_employment_income:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Deprecated field not used in calculation
              deprecated: true
      ApplicantCapitalResult:
        type: object
        additionalProperties: false
        properties:
          total_liquid:
            "$ref": "#/components/schemas/TotalLiquidCapital"
          total_non_liquid:
            "$ref": "#/components/schemas/TotalNonLiquidCapital"
          total_vehicle:
            "$ref": "#/components/schemas/TotalVehicleCapital"
          total_property:
            "$ref": "#/components/schemas/TotalPropertyCapital"
          total_capital:
            "$ref": "#/components/schemas/TotalCapital"
          total_capital_with_smod:
            "$ref": "#/components/schemas/TotalCapitalWithSmod"
          total_mortgage_allowance:
            "$ref": "#/components/schemas/TotalMortgageAllowance"
          subject_matter_of_dispute_disregard:
            "$ref": "#/components/schemas/SmodDisregard"
          assessed_capital:
            "$ref": "#/components/schemas/AssessedCapital"
          disputed_non_property_disregard:
            "$ref": "#/components/schemas/DisputedNonPropertyDisregard"
          pensioner_disregard_applied:
            "$ref": "#/components/schemas/PensionerDisregardApplied"
          proceeding_types:
            "$ref": "#/components/schemas/ProceedingTypeResults"
          pensioner_capital_disregard:
            "$ref": "#/components/schemas/PensionerCapitalDisregard"
          capital_contribution:
            "$ref": "#/components/schemas/CapitalContribution"
          combined_disputed_capital:
            "$ref": "#/components/schemas/CombinedDisputedCapital"
          combined_non_disputed_capital:
            "$ref": "#/components/schemas/CombinedNonDisputedCapital"
          combined_assessed_capital:
            "$ref": "#/components/schemas/CombinedAssessedCapital"
      ApplicantDisposableIncome:
        type: object
        additionalProperties: false
        properties:
          employment_income:
            "$ref": "#/components/schemas/EmploymentIncomeResult"
          housing_costs:
            "$ref": "#/components/schemas/HousingCosts"
          gross_housing_costs:
            allOf:
            - "$ref": "#/components/schemas/HousingCosts"
            - deprecated: true
          net_housing_costs:
            allOf:
            - "$ref": "#/components/schemas/AllowedHousingCosts"
            - deprecated: true
          housing_benefit:
            "$ref": "#/components/schemas/HousingBenefit"
          allowed_housing_costs:
            "$ref": "#/components/schemas/AllowedHousingCosts"
          maintenance_allowance:
            "$ref": "#/components/schemas/MaintenanceAllowance"
          dependant_allowance_under_16:
            "$ref": "#/components/schemas/DependantAllowanceUnder16"
          dependant_allowance_over_16:
            "$ref": "#/components/schemas/DependantAllowanceOver16"
          dependant_allowance:
            "$ref": "#/components/schemas/DependantAllowance"
          total_outgoings_and_allowances:
            "$ref": "#/components/schemas/TotalOutgoingsAndAllowances"
          total_disposable_income:
            "$ref": "#/components/schemas/TotalDisposableIncome"
          income_contribution:
            "$ref": "#/components/schemas/IncomeContribution"
          partner_allowance:
            "$ref": "#/components/schemas/PartnerAllowance"
          lone_parent_allowance:
            "$ref": "#/components/schemas/LoneParentAllowance"
          combined_total_outgoings_and_allowances:
            "$ref": "#/components/schemas/CombinedOutgoingsAndAllowances"
          combined_total_disposable_income:
            "$ref": "#/components/schemas/CombinedDisposableIncome"
          proceeding_types:
            "$ref": "#/components/schemas/ProceedingTypeResults"
        required:
        - employment_income
        - gross_housing_costs
        - housing_benefit
        - net_housing_costs
        - allowed_housing_costs
        - housing_costs
        - maintenance_allowance
        - dependant_allowance_under_16
        - dependant_allowance_over_16
        - dependant_allowance
        - total_outgoings_and_allowances
        - total_disposable_income
        - income_contribution
        - partner_allowance
        - lone_parent_allowance
        - combined_total_outgoings_and_allowances
        - combined_total_disposable_income
        - proceeding_types
      Dependants:
        type: array
        description: One or more dependants details
        items:
          type: object
          required:
          - date_of_birth
          - in_full_time_education
          - relationship
          properties:
            date_of_birth:
              "$ref": "#/components/schemas/DateOfBirth"
            in_full_time_education:
              "$ref": "#/components/schemas/InFullTimeEducation"
            relationship:
              "$ref": "#/components/schemas/RelationShip"
            monthly_income:
              description: Dependant's monthly income
              deprecated: true
              oneOf:
              - "$ref": "#/components/schemas/numeric_currency"
              - "$ref": "#/components/schemas/string_currency"
            income:
              "$ref": "#/components/schemas/DependantIncome"
            assets_value:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Dependant's total assets value
          additionalProperties: false
    v7:
      Applicant:
        type: object
        description: Object describing pertinent applicant details
        required:
        - date_of_birth
        additionalProperties: false
        properties:
          date_of_birth:
            type: string
            format: date
            example: '1992-07-25'
            description: Applicant date of birth
          receives_qualifying_benefit:
            type: boolean
            example: false
            description: Applicant receives qualifying benefit
          receives_asylum_support:
            type: boolean
            example: false
            description: Applicant receives section 4 or section 95 Asylum Support
      DisposableIncome:
        type: object
        additionalProperties: false
        properties:
          employment_income:
            "$ref": "#/components/schemas/EmploymentIncomeResult"
          housing_costs:
            "$ref": "#/components/schemas/HousingCosts"
          housing_benefit:
            "$ref": "#/components/schemas/HousingBenefit"
          allowed_housing_costs:
            "$ref": "#/components/schemas/AllowedHousingCosts"
          maintenance_allowance:
            "$ref": "#/components/schemas/MaintenanceAllowance"
          dependant_allowance_under_16:
            "$ref": "#/components/schemas/DependantAllowanceUnder16"
          dependant_allowance_over_16:
            "$ref": "#/components/schemas/DependantAllowanceOver16"
          dependant_allowance:
            "$ref": "#/components/schemas/DependantAllowance"
          total_outgoings_and_allowances:
            "$ref": "#/components/schemas/TotalOutgoingsAndAllowances"
          total_disposable_income:
            "$ref": "#/components/schemas/TotalDisposableIncome"
        required:
        - employment_income
        - housing_benefit
        - allowed_housing_costs
        - housing_costs
        - maintenance_allowance
        - dependant_allowance_under_16
        - dependant_allowance_over_16
        - dependant_allowance
        - total_outgoings_and_allowances
        - total_disposable_income
      Employments:
        type: array
        description: One or more employment income details
        items:
          type: object
          additionalProperties: false
          required:
          - name
          - client_id
          - payments
          description: Employment income detail
          properties:
            name:
              type: string
              description: Identifying name for this employment - e.g. employer's
                name
            client_id:
              type: string
              description: Client supplied id to identify the employment
            receiving_only_statutory_sick_or_maternity_pay:
              type: boolean
              description: Client is in receipt only of Statutory Sick Pay (SSP) or
                Statutory Maternity Pay (SMP)
            payments:
              "$ref": "#/components/schemas/v7/EmploymentPaymentList"
      EmploymentPaymentList:
        type: array
        description: 0 or more employment payment details
        items:
          type: object
          additionalProperties: false
          required:
          - client_id
          - date
          - gross
          - benefits_in_kind
          - tax
          - national_insurance
          properties:
            client_id:
              type: string
              description: Client supplied id to identify the payment
              example: '05459c0f-a620-4743-9f0c-b3daa93e571'
            date:
              type: string
              format: date
              example: '1992-07-22'
            gross:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Gross payment income received
              example: 101.01
            benefits_in_kind:
              oneOf:
              - "$ref": "#/components/schemas/positive_currency"
              description: Benefit in kind amount received
              example: 10.5
            tax:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of tax paid - normally negative, but can be positive
                for a refund
              example: -10.01
            national_insurance:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of national insurance paid - normally negative,
                but can be positive for a refund
              example: -5.24
            prisoner_levy:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of prisoner levy paid - always negative
              example: -5.24
            student_debt_repayment:
              oneOf:
              - "$ref": "#/components/schemas/currency"
              description: Amount of student debt repayment paid - always negative
              example: -50.0
      ApplicantCapitalResult:
        type: object
        additionalProperties: false
        properties:
          total_liquid:
            "$ref": "#/components/schemas/TotalLiquidCapital"
          total_non_liquid:
            "$ref": "#/components/schemas/TotalNonLiquidCapital"
          total_vehicle:
            "$ref": "#/components/schemas/TotalVehicleCapital"
          total_property:
            "$ref": "#/components/schemas/TotalPropertyCapital"
          total_capital:
            "$ref": "#/components/schemas/TotalCapital"
          total_capital_with_smod:
            "$ref": "#/components/schemas/TotalCapitalWithSmod"
          total_mortgage_allowance:
            "$ref": "#/components/schemas/TotalMortgageAllowance"
          subject_matter_of_dispute_disregard:
            "$ref": "#/components/schemas/SmodDisregard"
          assessed_capital:
            "$ref": "#/components/schemas/AssessedCapital"
          disputed_non_property_disregard:
            "$ref": "#/components/schemas/DisputedNonPropertyDisregard"
          pensioner_disregard_applied:
            "$ref": "#/components/schemas/PensionerDisregardApplied"
          proceeding_types:
            "$ref": "#/components/schemas/ProceedingTypeResults"
          pensioner_capital_disregard:
            "$ref": "#/components/schemas/PensionerCapitalDisregard"
          capital_contribution:
            "$ref": "#/components/schemas/CapitalContribution"
          combined_disputed_capital:
            "$ref": "#/components/schemas/CombinedDisputedCapital"
          combined_non_disputed_capital:
            "$ref": "#/components/schemas/CombinedNonDisputedCapital"
          combined_assessed_capital:
            "$ref": "#/components/schemas/CombinedAssessedCapital"
      ApplicantDisposableIncome:
        type: object
        additionalProperties: false
        properties:
          employment_income:
            "$ref": "#/components/schemas/EmploymentIncomeResult"
          housing_costs:
            "$ref": "#/components/schemas/HousingCosts"
          housing_benefit:
            "$ref": "#/components/schemas/HousingBenefit"
          allowed_housing_costs:
            "$ref": "#/components/schemas/AllowedHousingCosts"
          maintenance_allowance:
            "$ref": "#/components/schemas/MaintenanceAllowance"
          dependant_allowance_under_16:
            "$ref": "#/components/schemas/DependantAllowanceUnder16"
          dependant_allowance_over_16:
            "$ref": "#/components/schemas/DependantAllowanceOver16"
          dependant_allowance:
            "$ref": "#/components/schemas/DependantAllowance"
          total_outgoings_and_allowances:
            "$ref": "#/components/schemas/TotalOutgoingsAndAllowances"
          total_disposable_income:
            "$ref": "#/components/schemas/TotalDisposableIncome"
          income_contribution:
            "$ref": "#/components/schemas/IncomeContribution"
          partner_allowance:
            "$ref": "#/components/schemas/PartnerAllowance"
          lone_parent_allowance:
            "$ref": "#/components/schemas/LoneParentAllowance"
          combined_total_outgoings_and_allowances:
            "$ref": "#/components/schemas/CombinedOutgoingsAndAllowances"
          combined_total_disposable_income:
            "$ref": "#/components/schemas/CombinedDisposableIncome"
          proceeding_types:
            "$ref": "#/components/schemas/ProceedingTypeResults"
        required:
        - employment_income
        - housing_costs
        - housing_benefit
        - allowed_housing_costs
        - maintenance_allowance
        - dependant_allowance_under_16
        - dependant_allowance_over_16
        - dependant_allowance
        - total_outgoings_and_allowances
        - total_disposable_income
        - income_contribution
        - partner_allowance
        - lone_parent_allowance
        - combined_total_outgoings_and_allowances
        - combined_total_disposable_income
        - proceeding_types
      Dependants:
        type: array
        description: One or more dependants details
        items:
          type: object
          required:
          - date_of_birth
          - in_full_time_education
          - relationship
          properties:
            date_of_birth:
              "$ref": "#/components/schemas/DateOfBirth"
            in_full_time_education:
              "$ref": "#/components/schemas/InFullTimeEducation"
            relationship:
              "$ref": "#/components/schemas/RelationShip"
            income:
              "$ref": "#/components/schemas/DependantIncome"
            assets_value:
              oneOf:
              - oneOf:
                - "$ref": "#/components/schemas/numeric_currency"
                description: Dependant's total assets value
              example: 0
          additionalProperties: false
paths:
  "/v6/assessments":
    post:
      summary: create
      tags:
      - Perform assessment with single call
      description: Performs a complete assessment
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                required:
                - timestamp
                - result_summary
                - assessment
                - version
                - success
                additionalProperties: false
                properties:
                  result_summary:
                    type: object
                    required:
                    - overall_result
                    - gross_income
                    - disposable_income
                    - capital
                    additionalProperties: false
                    properties:
                      overall_result:
                        type: object
                        required:
                        - result
                        - capital_contribution
                        - income_contribution
                        - proceeding_types
                        additionalProperties: false
                        properties:
                          result:
                            "$ref": "#/components/schemas/OverallResult"
                          income_contribution:
                            "$ref": "#/components/schemas/IncomeContribution"
                          capital_contribution:
                            "$ref": "#/components/schemas/CapitalContribution"
                          proceeding_types:
                            "$ref": "#/components/schemas/ProceedingTypeResults"
                      gross_income:
                        type: object
                        description: gross_income calculation for partner, with some
                          combined totals where appropriate
                        required:
                        - total_gross_income
                        - combined_total_gross_income
                        - proceeding_types
                        additionalProperties: false
                        properties:
                          total_gross_income:
                            type: number
                            format: decimal
                            description: Calculated monthly total gross income for
                              applicant
                          combined_total_gross_income:
                            type: number
                            format: decimal
                            description: Calculated monthly total gross income for
                              applicant and partner
                          proceeding_types:
                            "$ref": "#/components/schemas/ProceedingTypeResults"
                      partner_gross_income:
                        type: object
                        required:
                        - total_gross_income
                        additionalProperties: false
                        properties:
                          total_gross_income:
                            type: number
                            format: decimal
                            description: Calculated monthly total gross income for
                              partner
                      disposable_income:
                        "$ref": "#/components/schemas/v6/ApplicantDisposableIncome"
                      partner_disposable_income:
                        "$ref": "#/components/schemas/v6/DisposableIncome"
                      capital:
                        "$ref": "#/components/schemas/v6/ApplicantCapitalResult"
                      partner_capital:
                        "$ref": "#/components/schemas/CapitalResult"
                  assessment:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      client_reference_id:
                        type: string
                        nullable: true
                        example: ref-11-22
                      submission_date:
                        type: string
                        format: date
                        example: '2022-07-22'
                      level_of_help:
                        type: string
                        enum:
                        - certificated
                        - controlled
                        example: certificated
                        description: The level of representation required by the client
                      applicant:
                        "$ref": "#/components/schemas/ApplicantResult"
                      gross_income:
                        "$ref": "#/components/schemas/GrossIncomeResult"
                      disposable_income:
                        "$ref": "#/components/schemas/DisposableIncomeResult"
                      capital:
                        "$ref": "#/components/schemas/AssessmentCapitalResult"
                      partner_gross_income:
                        "$ref": "#/components/schemas/GrossIncomeResult"
                      partner_disposable_income:
                        "$ref": "#/components/schemas/DisposableIncomeResult"
                      partner_capital:
                        "$ref": "#/components/schemas/AssessmentCapitalResult"
                      remarks:
                        "$ref": "#/components/schemas/Remarks"
                  version:
                    type: string
                    enum:
                    - '6'
                    description: Version of the API used in the request
                  success:
                    type: boolean
                    description: Always true when HTTP 200 returned, false otherwise
                  timestamp:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - assessment
              - applicant
              additionalProperties: false
              properties:
                assessment:
                  "$ref": "#/components/schemas/Assessment"
                applicant:
                  "$ref": "#/components/schemas/v6/Applicant"
                proceeding_types:
                  "$ref": "#/components/schemas/ProceedingTypes"
                capitals:
                  "$ref": "#/components/schemas/Capitals"
                cash_transactions:
                  "$ref": "#/components/schemas/CashTransactions"
                dependants:
                  "$ref": "#/components/schemas/v6/Dependants"
                employment_income:
                  "$ref": "#/components/schemas/v6/Employments"
                irregular_incomes:
                  type: object
                  description: A set of irregular income payments
                  required:
                  - payments
                  additionalProperties: false
                  example:
                    payments:
                    - income_type: student_loan
                      frequency: annual
                      amount: 123456.78
                  properties:
                    payments:
                      "$ref": "#/components/schemas/IrregularIncomePayments"
                other_incomes:
                  "$ref": "#/components/schemas/OtherIncomes"
                outgoings:
                  "$ref": "#/components/schemas/OutgoingsList"
                properties:
                  type: object
                  required: []
                  description: A main home and additional properties
                  additionalProperties: false
                  properties:
                    main_home:
                      "$ref": "#/components/schemas/MainHome"
                    additional_properties:
                      type: array
                      description: Additional properties owned by the applicant -
                        i.e. not including the main home
                      items:
                        "$ref": "#/components/schemas/Property"
                regular_transactions:
                  type: array
                  description: Zero or more regular transactions
                  items:
                    "$ref": "#/components/schemas/RegularTransaction"
                state_benefits:
                  type: array
                  description: Benefits paid by the state to the applicant. One item
                    per type of benefit
                  items:
                    "$ref": "#/components/schemas/StateBenefit"
                vehicles:
                  type: array
                  description: One or more vehicles' details
                  items:
                    "$ref": "#/components/schemas/Vehicle"
                employment_details:
                  type: array
                  description: 'Employments, with pay info supplied in the ''how much,
                    how often'' pattern. (Compare with: ''employment_income'')'
                  items:
                    "$ref": "#/components/schemas/EmploymentDetails"
                self_employment_details:
                  type: array
                  description: Self employments, with pay info supplied in the 'how
                    much, how often' pattern
                  items:
                    "$ref": "#/components/schemas/SelfEmployment"
                partner:
                  type: object
                  required:
                  - partner
                  additionalProperties: false
                  description: 'Partner of the applicant''s financial and personal
                    info. Definition of ''partner'' that should included in the means
                    test is described in the Lord Chancellor''s guidance - certificated:
                    ''3.1 Individual and partner'', controlled: ''4.2 Aggregation
                    of Means''.'
                  example:
                    partner:
                      date_of_birth: '1992-07-22'
                      employed: true
                    cash_transactions:
                      income:
                      - category: property_or_lodger
                        payments:
                        - date: '2022-01-01'
                          amount: 7
                          client_id: '05459c0f'
                        - date: '2022-02-01'
                          amount: 5
                          client_id: 10318f7b
                        - date: '2022-03-01'
                          amount: 5
                          client_id: 5cf62a12
                      outgoings:
                      - category: legal_aid
                        payments:
                        - date: '2022-02-01'
                          amount: 8
                          client_id: 0fb3daa93e5711-a620-4743-9f0c-05459c
                        - date: '2022-03-01'
                          amount: 9
                          client_id: 10318f7b-289a-4fa5-a986-fc6f499fecd0
                        - date: '2022-04-01'
                          amount: 8
                          client_id: 5cf62a12-c92b-4cc1-b8ca-eeb4efbcce21
                    outgoings:
                    - name: child_care
                      payments:
                      - client_id: '05459c0f-a620-4743-9f0c-b3daa93e5711'
                        payment_date: '2022-04-22'
                        amount: 20
                    - name: rent_or_mortgage
                      payments:
                      - client_id: '05459c0f-a620-4743-9f0c-b3daa93e5711'
                        payment_date: '2022-03-22'
                        housing_cost_type: rent
                        amount: 10
                    irregular_incomes:
                    - income_type: student_loan
                      frequency: annual
                      amount: 101.01
                    employments:
                    - name: Dish washing
                      client_id: Gino's
                      payments:
                      - client_id: March 23 payroll
                        date: '2022-03-22'
                        gross: 80
                        benefits_in_kind: 5
                        tax: 15
                        national_insurance: 0
                    employment_details:
                    - income:
                        receiving_only_statutory_sick_or_maternity_pay: true
                        frequency: monthly
                        gross: 500
                        benefits_in_kind: 13
                        tax: -9
                        national_insurance: -4
                    self_employment_details:
                    - income:
                        frequency: monthly
                        gross: 22
                        tax: -3
                        national_insurance: -1
                    regular_transactions:
                    - category: benefits
                      operation: credit
                      frequency: three_monthly
                      amount: 75
                    state_benefits:
                    - name: Disability Benefit
                      payments:
                      - client_id: 12A
                        date: '2022-03-22'
                        amount: 100
                        flags:
                          multi_benefit: false
                    additional_properties:
                    - value: 50000
                      outstanding_mortgage: 0
                      percentage_owned: 5
                      shared_with_housing_assoc: false
                      subject_matter_of_dispute: false
                    other_incomes:
                    - source: benefits
                      payments:
                      - date: '2023-05-07'
                        amount: 16
                        client_id: b3daa93e5711-a620-4743-9f0c-05459c0f
                    capitals:
                      bank_accounts:
                      - value: 100
                        description: Barclays
                        subject_matter_of_dispute: false
                      non_liquid_capital:
                      - value: 200
                        description: Bond
                        subject_matter_of_dispute: false
                    vehicles:
                    - value: 18000
                      loan_amount_outstanding: 1000
                      date_of_purchase: '2021-01-23'
                      in_regular_use: true
                      subject_matter_of_dispute: false
                    dependants:
                    - date_of_birth: '1983-08-08'
                      in_full_time_education: false
                      relationship: adult_relative
                      monthly_income: 48.63
                      assets_value: 0
                    - date_of_birth: '1982-02-03'
                      in_full_time_education: false
                      relationship: adult_relative
                      monthly_income: 800
                      assets_value: 0
                  properties:
                    partner:
                      type: object
                      description: Partner's personal info
                      required:
                      - date_of_birth
                      additionalProperties: false
                      properties:
                        date_of_birth:
                          type: string
                          format: date
                          example: '1992-07-22'
                          description: Partner's date of birth
                        employed:
                          type: boolean
                          description: Deprecated - employment is now determined by
                            presence of gross employment income
                          deprecated: true
                    cash_transactions:
                      "$ref": "#/components/schemas/CashTransactions"
                    outgoings:
                      "$ref": "#/components/schemas/OutgoingsList"
                    irregular_incomes:
                      "$ref": "#/components/schemas/IrregularIncomePayments"
                    employments:
                      "$ref": "#/components/schemas/v6/Employments"
                    employment_details:
                      type: array
                      description: 'Employments, with pay info supplied in the ''how
                        much, how often'' pattern, for partner. (Compare with: ''employments'')'
                      items:
                        "$ref": "#/components/schemas/EmploymentDetails"
                    self_employment_details:
                      type: array
                      description: Self employments, with pay info supplied in the
                        'how much, how often' pattern, for partner
                      items:
                        "$ref": "#/components/schemas/SelfEmployment"
                    regular_transactions:
                      type: array
                      description: Zero or more regular transactions
                      items:
                        "$ref": "#/components/schemas/RegularTransaction"
                    state_benefits:
                      type: array
                      description: One or more state benefits received by the applicant's
                        partner and categorized by name
                      items:
                        "$ref": "#/components/schemas/StateBenefit"
                    additional_properties:
                      type: array
                      description: Additional properties owned by the partner - i.e.
                        excluding those already listed for the applicant
                      items:
                        "$ref": "#/components/schemas/Property"
                    capitals:
                      "$ref": "#/components/schemas/Capitals"
                    vehicles:
                      type: array
                      description: One or more vehicles' details
                      items:
                        "$ref": "#/components/schemas/Vehicle"
                    dependants:
                      "$ref": "#/components/schemas/v6/Dependants"
                    other_incomes:
                      "$ref": "#/components/schemas/OtherIncomes"
                explicit_remarks:
                  "$ref": "#/components/schemas/ExplicitRemarks"
        required: true
  "/state_benefit_type":
    get:
      summary: list state_benefit_types
      tags:
      - Lookups
      responses:
        '200':
          description: successful