Due

Type: object

Details on amounts due for an account.

root arrears
Type: object Default: null

Part of 'current' that constitutes the arrears portion.

root arrears multiplier
Type: enum (of string) Default: "none"

nan

Must be one of:

  • "f"
  • "c"
  • "G"
  • "d"
  • "z"
  • "p"
  • "y"
  • "h"
  • "Y"
  • "a"
  • "none"
  • "k"
  • "m"
  • "n"
  • "E"
  • "da"
  • "T"
  • "M"
  • "P"
  • "Z"
  • "micro"

root arrears unit
Type: enum (of string) Default: null

nan

Must be one of:

  • "GBP"
  • "TTD"
  • "KGS"
  • "UYU"
  • "SGD"
  • "FJD"
  • "STD"
  • "INR"
  • "CDF"
  • "PKR"
  • "MDL"
  • "XPF"
  • "DOP"
  • "AOA"
  • "RON"
  • "IDR"
  • "XAF"
  • "BHD"
  • "PAB"
  • "SDG"
  • "WST"
  • "MVR"
  • "SLL"
  • "CLF"
  • "XCD"
  • "TRY"
  • "MZN"
  • "KWD"
  • "BBD"
  • "PHP"
  • "CRC"
  • "ANG"
  • "DKK"
  • "TOP"
  • "LKR"
  • "CLP"
  • "GNF"
  • "VEF"
  • "IQD"
  • "GEL"
  • "MUR"
  • "MRO"
  • "PGK"
  • "AMD"
  • "ETB"
  • "UAH"
  • "KES"
  • "KMF"
  • "QAR"
  • "SHP"
  • "JPY"
  • "CNY"
  • "NPR"
  • "HTG"
  • "TWD"
  • "BSD"
  • "MKD"
  • "CHF"
  • "CAD"
  • "SCR"
  • "EEK"
  • "LTL"
  • "SZL"
  • "BZD"
  • "LBP"
  • "ILS"
  • "BAM"
  • "BTN"
  • "CUP"
  • "ZAR"
  • "BDT"
  • "TZS"
  • "RSD"
  • "SEK"
  • "LRD"
  • "LAK"
  • "AED"
  • "UZS"
  • "LVL"
  • "KPW"
  • "GYD"
  • "IRR"
  • "DZD"
  • "DJF"
  • "BOB"
  • "BND"
  • "MMK"
  • "NZD"
  • "LSL"
  • "CUC"
  • "BOV"
  • "BWP"
  • "ARS"
  • "RUB"
  • "MNT"
  • "HUF"
  • "MGA"
  • "JMD"
  • "TJS"
  • "MYR"
  • "OMR"
  • "AUD"
  • "YER"
  • "COU"
  • "MOP"
  • "MWK"
  • "HKD"
  • "ZMK"
  • "SAR"
  • "EUR"
  • "GTQ"
  • "THB"
  • "SOS"
  • "ISK"
  • "GHS"
  • "RWF"
  • "TMT"
  • "BMD"
  • "KRW"
  • "SBD"
  • "GMD"
  • "SRD"
  • "MXN"
  • "GIP"
  • "HNL"
  • "NGN"
  • "CZK"
  • "KHR"
  • "ALL"
  • "CVE"
  • "BYR"
  • "PEN"
  • "TND"
  • "KYD"
  • "ERN"
  • "EGP"
  • "ZWL"
  • "MAD"
  • "NAD"
  • "PLN"
  • "KZT"
  • "VND"
  • "LYD"
  • "NOK"
  • "JOD"
  • "BRL"
  • "BIF"
  • "HRK"
  • "NIO"
  • "COP"
  • "UGX"
  • "XOF"
  • "SYP"
  • "AWG"
  • "BGN"
  • "AZN"
  • "USD"
  • "AFN"
  • "VUV"
  • "PYG"
  • "FKP"

root arrears value
Type: number Default: null

nan

root charges
Type: object Default: null

Part of 'current' that constitutes the charge portion: 'charges' = 'Charge.fixedPortion' + 'Charge.variablePortion'.

Same definition as arrears

root interest
Type: object Default: null

Part of 'current' that constitutes the interest portion.

Same definition as arrears

root current
Type: object Default: null

Current total amount now due: current = principle + arrears + interest + charges. Typically the rule for settlement priority is: interest dues, then arrears dues, then current dues, then charge dues.

Same definition as arrears

root principle
Type: object Default: null

Part of 'current' that constitutes the portion of the principle amount currently due.

Same definition as arrears