Claims API

{
  "properties": {
    "claim": {
      "items": {
        "description": "Claim",
        "properties": {
          "amount": {
            "description": "Amount of claim. Can't be changed after a partial payment has been made.",
            "type": "string"
          },
          "billNumber": {
            "description": "Billnumber, optional. Information provided by claimant.",
            "type": "string"
          },
          "billPresentmentSystem": {
            "description": "Indicates the bill presentment system to which the claim pertains.",
            "properties": {
              "parameters": {
                "description": "Parameters and values needed to display a unique document from a bill presentment system. (URL style)",
                "type": "string"
              },
              "type": {
                "description": "Which bill presentment system.",
                "type": "string"
              }
            },
            "type": "object"
          },
          "cancellationDate": {
            "description": "Date of cancellation, how long should the claim be valid in the system.",
            "type": "string"
          },
          "claimID": {
            "description": "The ID of the claim. Consists of claimantKennitala + dueDate + account. e.g. 660612998020160414032366000001",
            "type": "string"
          },
          "claimKey": {
            "properties": {
              "account": {
                "description": "The branch number of the claim, ledger number (66) and number of claim. ",
                "type": "string"
              },
              "claimantKennitala": {
                "description": "Claimant's kennitala.",
                "type": "string"
              },
              "dueDate": {
                "description": "Due date of the claim.",
                "type": "string"
              }
            },
            "required": [
              "claimantKennitala",
              "account",
              "dueDate"
            ],
            "type": "object"
          },
          "currencyInformation": {
            "description": "For claims which are linked to a foreign currency.",
            "properties": {
              "currency": {
                "type": "string"
              },
              "currencyInformationPaymentRate": {
                "enum": [
                  "dueDateRate",
                  "paymentDateRate"
                ]
              },
              "currencyInformationReferenceRate": {
                "enum": [
                  "exchangeRate",
                  "noteRate",
                  "centralBankMidRate",
                  "centralBankStatutoryRate"
                ]
              }
            },
            "type": "object"
          },
          "customerNumber": {
            "description": "Customer number, optional key used by claimant to identify payor. Necessary if payor is to be able to enable automotic debiting of claims.",
            "type": "string"
          },
          "defaultCharge": {
            "description": "Default charge that claims incur when they default, either a percentage or fixed amount",
            "properties": {
              "firstDefaultCharge": {
                "description": "First default charge.",
                "properties": {
                  "days": {
                    "description": "Indicates the number of days relative to reference date when rule takes effect.",
                    "type": "number"
                  },
                  "value": {
                    "description": "Amount or percentage of default charge.",
                    "type": "number"
                  }
                },
                "required": [
                  "days",
                  "value"
                ],
                "type": "object"
              },
              "referenceDate": {
                "description": "Indicates which date is used as basis for calculation.",
                "enum": [
                  "dueDate",
                  "finalDueDate"
                ]
              },
              "secondDefaultCharge": {
                "description": "Second default charge.",
                "properties": {
                  "days": {
                    "description": "Indicates the count of days relative to reference date when rule takes effect.",
                    "type": "number"
                  },
                  "value": {
                    "description": "Amount or percentage of default charge.",
                    "type": "number"
                  }
                },
                "required": [
                  "days",
                  "value"
                ],
                "type": "object"
              }
            },
            "required": [
              "firstDefaultCharge",
              "secondDefaultCharge",
              "referenceDate"
            ],
            "type": "object"
          },
          "defaultInterest": {
            "description": "Rule for calculating default interest.",
            "properties": {
              "defaultInterestRule": {
                "description": "Determines if the claim should incur default interests after the reference date and if so, how it should be calculated. noDefaultInterest = No default interest. defaultInterestAmount = Default interests are calculations are based on claim amount. defaultInterestAmountAndDefaultCharge = Default interests are calculations are based on claim amount and default charge.",
                "enum": [
                  "noDefaultInterest",
                  "defaultInterestAmount",
                  "defaultInterestAmountAndDefaultCharge"
                ]
              },
              "percentage": {
                "description": "If used, default interest on a claim is calculated based on this percentage and not on the default interest period, as in the case of Central Bank default interest. Not specifying the percentage ensures that the Central Bank default interest is used, and interest is compounded every twelve months, i.e. the default interest is added to the principal.",
                "type": "number"
              },
              "specialCode": {
                "description": "Sending in a special code is the only way to set certain interest rules that map to RB Penalty interest rules. Further documentation can be found in RB documentation.",
                "type": "string"
              }
            },
            "required": [
              "defaultInterestRule",
              "percentage"
            ],
            "type": "object"
          },
          "discount": {
            "description": "Two amount or percentage fields can be attached to a claim base, the first and second discount, which are used to reduce the payment if made before a fixed date.",
            "properties": {
              "firstDiscount": {
                "description": "First discount",
                "properties": {
                  "amount": {
                    "description": "Base for discount or default charge.",
                    "type": "number"
                  },
                  "days": {
                    "description": "Indicates the count of days relative to reference date when rule takes effect.",
                    "type": "number"
                  }
                },
                "required": [
                  "days",
                  "amount"
                ],
                "type": "object"
              },
              "isPostRefDate": {
                "description": "Indicates whether number of days is before or after reference date.",
                "type": "boolean"
              },
              "referenceDate": {
                "description": "Indicates which date is used as basis for calculation.",
                "enum": [
                  "dueDate",
                  "finalDueDate"
                ],
                "type": "integer"
              },
              "secondDiscount": {
                "description": "Second discount.",
                "properties": {
                  "amount": {
                    "description": "Base for discount or default charge.",
                    "type": "number"
                  },
                  "days": {
                    "description": "Indicates the count of days relative to reference date when rule takes effect.",
                    "type": "number"
                  }
                },
                "required": [
                  "days",
                  "amount"
                ],
                "type": "object"
              }
            },
            "required": [
              "firstDiscount",
              "secondDiscount",
              "referenceDate"
            ],
            "type": "object"
          },
          "finalDueDate": {
            "description": "Final due date of claim.",
            "type": "string"
          },
          "identifier": {
            "description": "Three letter unique identifier of the claimant that the claim relates to. Indicates which of claimant's accounts the system should use. e.g. 001",
            "type": "string"
          },
          "isPartialPaymentAllowed": {
            "description": "Indicates whether partial payment is permitted.",
            "type": "boolean"
          },
          "noticeAndPaymentFee": {
            "description": "Charge for calculation and printout of payment slip and sending to payer.",
            "properties": {
              "paperless": {
                "description": "Charge used if claim is not printed.",
                "type": "number"
              },
              "printing": {
                "description": "Charge used if claim is printed.",
                "type": "number"
              }
            },
            "required": [
              "printing",
              "paperless"
            ],
            "type": "object"
          },
          "otherCosts": {
            "description": "Other cost, for special charges to be paid by the payer of the claim.",
            "type": "number"
          },
          "otherDefaultCosts": {
            "description": "For special charges, e.g. secondary collection charge, to be paid by the payer of the claim.",
            "type": "number"
          },
          "payorKennitala": {
            "description": "Payor's kennitala.",
            "type": "string"
          },
          "permitOutOfSequencePayment": {
            "description": "Payment of claim allowed if earlier due date is unpaid.",
            "type": "boolean"
          },
          "printing": {
            "description": "Contains information used for displaying and printing the claim. Changing this info on a claim that has already been created will not result in it being printed again.",
            "properties": {
              "claimantAddress": {
                "description": "Alternate address for claimant if address from the National Register should not be used.",
                "properties": {
                  "addressLine1": {
                    "description": "First part of address.",
                    "type": "string"
                  },
                  "addressLine2": {
                    "description": "First part of address.",
                    "type": "string"
                  },
                  "city": {
                    "description": "Place of residence, be it city, town, etc.",
                    "type": "string"
                  },
                  "country": {
                    "description": "Country.",
                    "type": "string"
                  },
                  "name": {
                    "description": "Name of resident/recipient.",
                    "type": "string"
                  },
                  "postalCode": {
                    "description": "Postal code.",
                    "type": "string"
                  },
                  "region": {
                    "description": "The country region where the person lives.",
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "addressLine1",
                  "addressLine2",
                  "postalCode",
                  "city",
                  "region",
                  "country"
                ],
                "type": "object"
              },
              "comments": {
                "description": "Comments that are displayed on the lower half of the payment slip.",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "itemRows": {
                "description": "Breakdown of items that a claim consists of.",
                "properties": {
                  "itemRow": {
                    "description": "Breakdown items that a claim consists of.",
                    "items": {
                      "description": "A sub-item of a claim, used for printing.",
                      "properties": {
                        "amount": {
                          "description": "The amount of the item.",
                          "type": "number"
                        },
                        "text": {
                          "description": "Item text.",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "payorAddress": {
                "description": "Alternate address for payor if address from the National Register should not be used.",
                "properties": {
                  "addressLine1": {
                    "description": "First part of address.",
                    "type": "string"
                  },
                  "addressLine2": {
                    "description": "First part of address.",
                    "type": "string"
                  },
                  "city": {
                    "description": "Place of residence, be it city, town, etc.",
                    "type": "string"
                  },
                  "country": {
                    "description": "Country.",
                    "type": "string"
                  },
                  "name": {
                    "description": "Name of resident/recipient.",
                    "type": "string"
                  },
                  "postalCode": {
                    "description": "Postal code.",
                    "type": "string"
                  },
                  "region": {
                    "description": "The country region where the person lives.",
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "addressLine1",
                  "addressLine2",
                  "postalCode",
                  "city",
                  "region",
                  "country"
                ],
                "type": "object"
              }
            },
            "required": [
              "claimantAddress",
              "payorAddress"
            ],
            "type": "object"
          },
          "reference": {
            "description": "Refence determined by claimant. Alphanumeric, maximum 16 letters.",
            "type": "string"
          },
          "state": {
            "description": "State of the claim. Indicates the collections state the claim is in.",
            "enum": [
              "primary",
              "secondary",
              "legal"
            ]
          },
          "status": {
            "description": "Status of the claim.",
            "enum": [
              "unpaid",
              "paid",
              "cancelled",
              "invalid"
            ]
          }
        },
        "required": [
          "claimID",
          "payorKennitala",
          "cancellationDate",
          "identifier",
          "amount",
          "reference",
          "finalDueDate",
          "billNumber",
          "customerNumber"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "paging": {
      "description": "Contains information on paging on the claim overview.",
      "properties": {
        "totalPages": {
          "description": "Total pages",
          "type": "integer"
        },
        "totalRecords": {
          "description": "Total number of claims during period",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "paging"
  ],
  "type": "object"
}