Transactions History

The /credit_risk/get returns the history of invoices (up to 24 months) and payments associated with an account.

Sample response

{
  "source_name": "string",
  "source_type": "Electricity",
  "source_country": "string",
  "accounts": [
    {
      "account_number": "string",
      "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_number": "string",
      "currency_code": "string",
      "invoices": [
        {
          "invoice_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "invoice_number": "string",
          "invoice_date": "2024-01-11",
          "current_balance": 0,
          "currency_code": "string"
        }
      ],
      "payments": [
        {
          "payment_date": "2024-01-11",
          "payment_amount": 0,
          "currency_code": "string"
        }
      ]
    }
  ]
}

Refer to the API reference section for more details

Field	Description	Expected Output
source_name	The data source or Utility provider that has generated the data	Name of Utility provider
source_type	The type of data source	Electricity, Water, Fuel, Gas
source_country	The country where the utility has been consumed	Country
accounts
account_number	The Unique account number found on the Invoice	Number
account_id	A unique account identifier generated by Deck. Use it to query endpoints to denote a specific account	Alphanumeric value
user_number	The unique identifier of the consumer, provided by the Utility (on the Invoice)	Number
currency_code	The currency code denotes the billing currency associated with the account	3 digit code
invoice
invoice_id	Unique identifier of an Invoice that has been fetched from the source. Generated by Deck, use it when you need to retrieve the invoice PDF	Alphanumeric value
invoice_number	The invoice number generated by the Data source	Number
invoice_date	The date the invoice was generated, as printed on the invoice	Date
current_balance	The current balance as indicated by the invoice
currency_code	The currency associated with billing for the account	3 digit code
payments
payment_date	The date on which payment was made for the invoice	Date
payment_amount	The payment amount that was processed for the Invoice
currency_code	The currency associated with billing for the account	3 digit code