Bill

Produce powerful billing automations

Deck’s Billing Automation product empowers businesses to streamline their bill payment processes by automating the retrieval and processing of utility and telecom invoices. With this product, you can ensure accurate and up-to-date invoice data, automate payments, and simplify the end-to-end billing cycle for both your business and your customers.

Streamlined Utility Account Connections

Easily connect utility and telecom accounts, enabling secure data access for efficient bill processing.

Automated Invoice Retrieval

Once an account is linked, Deck automatically pulls the latest invoices directly from the service provider, ensuring accuracy, each billing cycle.


Sample Response for the Bill endpoint:

{
  "source_name": "National Grid",
  "source_country": "US",
  "username": "[email protected]",
  "accounts": [
    {
      "account_number": "987654321",
      "statements": [
        {
          "customer_name": "ACME Corporation",
          "customer_number": "CUS-2025-00001",
          "account_number": "987654321",
          "statement_number": null,
          "billing_address": "ACME Corporation\n123 Main St, Suite 500\nSan Francisco, CA 94105",
          
          // Billing period details
          "billing_period_start_date": "2025-01-25",
          "billing_period_end_date": "2025-02-25",
          "billing_period_duration_days": 31,
          "billing_date": "2025-02-25",
          "next_billing_date": "2025-03-25",
          "payment_due_date": "2025-03-15",
          "auto_pay_date": "2025-03-01",

          // Financial details
          "previous_total_due_amount": 12500.00,
          "balance_forward": 0,
          "total_due_amount": 11450.45,
          "currency_code": "USD",

          // Payments, corrections, and charges
          "payments": [
            {
              "date": "2025-02-20",
              "details": "Payment received via credit card",
              "amount": 12500.00
            }
          ],
          "corrections": [],
          "charges": [
            {
              "charge_name": "Customer charge",
              "amount": 68.2
            },
            {
              "charge_name": "Energy delivery 193239.00 kWh @2.041¢/kWh",
              "amount": 3943.14
            },
            {
              "charge_name": "Demand delivery 592.12 kW @ $41.530/kW",
              "amount": 24590.56
            },
            {
              "charge_name": "Reactive-Power demand 13.24 kVar @ $2.380/kW",
              "amount": 32.56
            },
            {
              "charge_name": "System Benefit Charge @0.677¢/kWh",
              "amount": 1308.61
            },
            {
              "charge_name": "Billing and payment processing charge",
              "amount": 0.64
            },
            {
              "charge_name": "GRT & other tax surcharges",
              "amount": 664.4
            },
            {
              "charge_name": "Sales tax @0%",
              "amount": 0
            }
          ]
        }
      ]
    }
  ]
}

Bill Endpoint Data Dictionary

Account Fields:

Field NameTypeDescription
account_numberStringThe account number assigned by the utility provider (e.g., 987654321).
statementsArrayA list of billing statements related to the account.

Statement Fields:

Field NameTypeDescriptionLikely Null
customer_nameStringName of the customer or business (e.g., ACME Corporation).No
customer_numberStringThe unique customer identifier (e.g., CUS-2025-00001).Yes
account_numberStringThe account number associated with this statement (e.g., 987654321). It mirrors the “account_number” field from the account section, provided for ease of reference at the statement level.No
statement_numberStringThe unique identifier for the statement (could be null if not applicable).Yes
billing_addressStringBilling address of the customer, formatted in three lines using \n.No

Billing Period Fields:

Field NameTypeDescription
billing_period_start_dateStringStart date of the billing period (e.g., 2025-01-25).
billing_period_end_dateStringEnd date of the billing period (e.g., 2025-02-25).
billing_period_duration_daysIntegerNumber of days in the billing period (e.g., 31).
billing_dateStringThe date the statement was issued (e.g., 2025-02-25).
next_billing_dateStringThe date of the next billing cycle (e.g., 2025-03-25).
payment_due_dateStringThe due date for payment (e.g., 2025-03-15).
auto_pay_dateStringThe scheduled date when the automatic payment will be withdrawn from the customer’s account (e.g., 2025-03-01). If automatic payments are not available or activated with the provider, this field will return null

Financial Details:

Field NameTypeDescription
previous_total_due_amountNumberThe amount due from the previous billing cycle (e.g., 12500.00).
balance_forwardNumberThe balance carried forward from previous statements (e.g., 0).
total_due_amountNumberThe total amount due for the current billing period (e.g., 11450.45).
currency_codeStringThe three-letter currency code (ISO 4217) used for the billing amount (e.g., USD).

Payments and Corrections:

Field NameTypeDescription
paymentsArrayList of payments applied to the statement.
payment_dateStringDate when the payment was made (e.g., 2025-02-20).
payment_detailsStringDescription of the payment (e.g., Payment received via credit card).
payment_amountStringAmount paid (e.g., 12500.00).
CorrectionsArrayList of any billing corrections (empty array if no corrections).
ChargesArrayList of charges applied to the account (detailed in the breakdown).
charge_nameStringName or description of the charge (e.g., Customer charge, Energy delivery, taxes).
amountNumberAmount for each specific charge (e.g., 68.2, 3943.14).