CreditCapacity

How much monthly trade credit the company can support, based on its financial data.

  • effectiveDate
    Type: string Format: date-time

    Timestamp (ISO-8601) at which the current credit-capacity assessment last changed.

  • history
    Type: array object[] · CreditCapacityHistory[]

    Prior credit-capacity assessments, letting you track how the recommended limit has moved over time.

    A point in the credit-capacity history

    • effectiveDate
      Type: string Format: date-time

      Timestamp (ISO-8601) at which this historical assessment was recorded.

    • reasons
      Type: array object[] · StructuredReason[]

      Human-readable drivers recorded for this historical assessment.

      A structured factor contributing to a section's assessment

    • recommended
      Type: object

      Recommended credit limit recorded at this point, given as both a monthly figure and its yearly equivalent. Zero when status is NOT_RECOMMENDED.

      • monthly
        Type: object · MoneyAmount

        Recommended monthly trade-credit limit, as a MoneyAmount (always GBP). Zero when credit is not recommended.

      • yearly
        Type: object · MoneyAmount

        Yearly equivalent of the monthly limit (monthly × 12), as a MoneyAmount (always GBP). Zero when credit is not recommended.

    • status
      Type: object
      Empty object
  • reasons
    Type: array object[] · StructuredReason[]

    Human-readable drivers behind the current credit-capacity outcome. null when the assessment is suspended.

    A structured factor contributing to a section's assessment

    • code
      Type: string | null

      Stable, machine-readable reason code for programmatic branching. RESERVED and currently always null — the canonical code vocabulary is being defined separately. The example shows the intended format; until it ships, rely on message.

    • message
      Type: string

      Human-readable, self-contained explanation of the factor (a full sentence).

  • recommended
    Type: object

    Recommended credit limit, given as both a monthly figure and its yearly equivalent. Zero when status is NOT_RECOMMENDED, and null when the assessment is suspended.

    • monthly
      Type: object · MoneyAmount

      Recommended monthly trade-credit limit, as a MoneyAmount (always GBP). Zero when credit is not recommended.

    • yearly
      Type: object · MoneyAmount

      Yearly equivalent of the monthly limit (monthly × 12), as a MoneyAmount (always GBP). Zero when credit is not recommended.

  • status
    Type: object
    Empty object

Grand Public API