PDF Statement Generation

This guide will walk you through how you can create a PDF version of your statement data and make it available within Canopy.

High-Level Steps:

Listen for the statement webhook.

Use the data in the webhook to populate a PDF statement template.

Make a call back to the pre_signed_url included in the webhook with the PDF in the request body.

Step 1: Get the Data

Where do I get the data?

When a statement cycle is cut within Canopy, you will be notified via the statement webhook.

If you have not already subscribed to receive webhooks, setup instructions to do so can be found here: Webhooks.

What Data is Included?

The data included in the statement webhook can be found in the Statement section of our api documentation here: Statements Endpoint.

👋

Heres’ an example statement webhook payload:

Statement schema statement_generation

json
{
  "event": "statement_generation",
  "data": {
    "account_id": {
      "type": "string",
      "description": "The Canopy-generated ID for the account",
      "example": "31mNprzLd2bKl6koVna68ARM"
    },
    "statement_id": {
      "type": "string",
      "description": "The Canopy-generated ID for the statement",
      "example": "31mNprzLd2bKl6koVna68ARM"
    },
    "effective_as_of_date": {
      "type": "string",
      "format": "date-time",
      "description": "The `Date-Time` you would like the system to return the data as of. IE tell me what the account information was as if I had asked on `2020-10-20 00:00:00 EST`. If empty it defaults to current time.",
      "example": "2018-07-20T09:10:14+00:00"
    },
    "account_overview": {
      "type": "object",
      "properties": {
        "promo_purchase_window_inclusive_start": {
          "type": "string",
          "format": "date-time",
          "description": "If applicable, the `Date-Time` the purchase window for the account ends.",
          "example": "2015-08-31T10:49:44.461+00:00"
        },
        "promo_purchase_window_exclusive_end": {
          "type": "string",
          "format": "date-time",
          "description": "If applicable, the `Date-Time` the purchase window for the account ends.",
          "example": "2015-08-31T10:49:44.461+00:00"
        },
        "promo_inclusive_start": {
          "type": "string",
          "format": "date-time",
          "description": "If applicable, the `Date-Time` the promo period for the account starts.",
          "example": "2015-08-31T10:49:44.461+00:00"
        },
        "promo_exclusive_end": {
          "type": "string",
          "format": "date-time",
          "description": "If applicable, the `Date-Time` the promo period for the account ends.",
          "example": "2015-08-31T10:49:44.461+00:00"
        },
        "account_status": {
          "type": "string",
          "description": "The Status of the Account. Active upon account creation.",
          "example": "suspended",
          "default": "active"
        },
        "account_status_subtype": {
          "type": "string",
          "description": "The subtype of the Status of the Account. Null upon account creation.",
          "example": "suspended-bankruptcy",
          "default": ""
        }
      }
    },
    "open_to_buy": {
      "type": "object",
      "properties": {
        "credit_limit_cents": {
          "type": "integer",
          "description": "Total Amount (in cents) that this account can borrow.",
          "example": 400000,
          "default": 0
        },
        "total_charges_cents": {
          "type": "integer",
          "description": "Sum of all charges that occurred on the account since account origination.",
          "example": 800000,
          "default": 0
        },
        "available_credit_cents": {
          "type": "integer",
          "description": "The total available credit balance (in cents) for the account.",
          "example": 600000,
          "default": 0
        },
        "open_to_buy_cents": {
          "type": "integer",
          "description": "If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.",
          "example": 600000,
          "default": 0
        }
      }
    },
    "cycle_summary": {
      "type": "object",
      "properties": {
        "cycle_inclusive_start": {
          "type": "string",
          "format": "date-time",
          "description": "The inclusive starting `Date-Time` that defines which transations are part of this statement."
        },
        "cycle_exclusive_end": {
          "type": "string",
          "format": "date-time",
          "description": "The inclusive ending `Date-Time` that defines which transations are part of this statement."
        },
        "cycle_charges_cents": {
          "type": "integer",
          "description": "Sum of all charges that occurred on the account during the billing cycle.",
          "example": 700000,
          "default": 0
        },
        "cycle_loans_cents": {
          "type": "integer",
          "description": "Sum of all loans amounts that were initiated on the account during the billing cycle.",
          "example": 700000,
          "default": 0
        },
        "cycle_charge_returns_cents": {
          "type": "integer",
          "description": "Sum of all returns that occurred on the account during the billing cycle.",
          "example": 100000,
          "default": 0
        },
        "cycle_payments_cents": {
          "type": "integer",
          "description": "Sum of all payments that occurred on the account during the billing cycle.",
          "example": 200000,
          "default": 0
        },
        "cycle_payment_reversals_cents": {
          "type": "integer",
          "description": "Sum of all payment reversal amounts that occurred on the account during the billing cycle.",
          "example": 200000,
          "default": 0
        },
        "cycle_debit_adjustments_cents": {
          "type": "integer",
          "description": "Sum of all debit adjustment amounts that occurred on the account during the billing cycle.",
          "example": 40000,
          "default": 0
        },
        "cycle_credit_adjustments_cents": {
          "type": "integer",
          "description": "Sum of all credit adjustment amounts that occurred on the account during the billing cycle.",
          "example": 53000,
          "default": 0
        },
        "cycle_interest_cents": {
          "type": "integer",
          "description": "Total interest accrued during the billing cycle.",
          "example": 110000,
          "default": 0
        },
        "cycle_am_interest_cents": {
          "type": "integer",
          "description": "The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.",
          "example": 0,
          "default": 0
        },
        "cycle_deferred_interest_cents": {
          "type": "integer",
          "description": "Total interest accrued during the billing cycle.",
          "example": 300000,
          "default": 0
        },
        "cycle_am_deferred_interest_cents": {
          "type": "integer",
          "description": "Total interest accrued during the billing cycle. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.",
          "example": 300000,
          "default": 0
        },
        "cycle_late_fees_cents": {
          "type": "integer",
          "description": "Total late fees incurred during the billing cycle.",
          "example": 300000,
          "default": 0
        },
        "cycle_payment_reversals_fees_cents": {
          "type": "integer",
          "description": "Total payment reversal fees incurred during the billing cycle.",
          "example": 300000,
          "default": 0
        },
        "cycle_waived_deferred_interest_cents": {
          "type": "integer",
          "description": "Total deferred interest that was forgiven on the account during the billing cycle.",
          "example": 40000,
          "default": 0
        }
      }
    },
    "min_pay_due": {
      "type": "object",
      "required": ["min_pay_cents", "min_pay_due_at"],
      "properties": {
        "min_pay_cents": {
          "type": "integer",
          "description": "Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.",
          "example": 160000
        },
        "min_pay_due_at": {
          "type": "string",
          "format": "date-time",
          "description": "The `Date-Time` the payment for this billing cycle is due.",
          "example": "2019-10-18T23:04:48.321+00:00"
        }
      }
    },
    "additional_min_pay_details": {
      "type": "object",
      "required": [
        "min_pay_charges_principal_cents",
        "min_pay_interest_cents",
        "min_pay_deferred_cents",
        "min_pay_fees_cents",
        "previous_min_pay_cents"
      ],
      "properties": {
        "min_pay_charges_principal_cents": {
          "type": "integer",
          "description": "Total principal due for the billing cycle.",
          "example": 100000
        },
        "min_pay_interest_cents": {
          "type": "integer",
          "description": "Total interest due for the billing cycle.",
          "example": 30000
        },
        "min_pay_am_interest_cents": {
          "type": "integer",
          "description": "Total am interest due for the billing cycle.",
          "example": 0
        },
        "min_pay_deferred_cents": {
          "type": "integer",
          "description": "Total deferred interest due for the billing cycle.",
          "example": 10000
        },
        "min_pay_am_deferred_interest_cents": {
          "type": "integer",
          "description": "The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.",
          "example": 200,
          "default": 0
        },
        "min_pay_fees_cents": {
          "type": "integer",
          "description": "Total fees due for the billing cycle.",
          "example": 20000
        },
        "previous_min_pay_cents": {
          "type": "integer",
          "description": "Previous amounts due, including fees. This is a subset of min_pay_cents.",
          "example": 400000
        }
      }
    },
    "balance_summary": {
      "type": "object",
      "properties": {
        "charges_principal_cents": {
          "type": "integer",
          "description": "Total principal balance for the account.",
          "example": 900000,
          "default": 0
        },
        "loans_principal_cents": {
          "type": "integer",
          "description": "Total principal balance for loans for the account.",
          "example": 900000,
          "default": 0
        },
        "interest_balance_cents": {
          "type": "integer",
          "description": "Total interest balance for the account.",
          "example": 100000,
          "default": 0
        },
        "am_interest_balance_cents": {
          "type": "integer",
          "description": "Total AM interest balance for the account.",
          "example": 100000,
          "default": 0
        },
        "deferred_interest_balance_cents": {
          "type": "integer",
          "description": "Total deferred interest balance for the account.",
          "example": 700000,
          "default": 0
        },
        "am_deferred_interest_balance_cents": {
          "type": "integer",
          "description": "The total deferred interest balance (in cents) associated with the account.",
          "example": 40000,
          "default": 0
        },
        "fees_balance_cents": {
          "type": "integer",
          "description": "Total fee balance for the account.",
          "example": 700000,
          "default": 0
        },
        "total_balance_cents": {
          "type": "integer",
          "description": "The total balance (in cents) associated with the account.",
          "example": 400000,
          "default": 0
        }
      }
    },
    "payoff": {
      "type": "object",
      "properties": {
        "total_payoff_cents": {
          "type": "integer",
          "description": "The total amount needed to pay off the loan at this exact moment.",
          "example": 900000,
          "default": 0
        },
        "expected_remaining_payment_amount_cents": {
          "type": "integer",
          "description": "The total amount slated to pay off the account over the lifecycle of the loan.",
          "example": 1100000,
          "default": 0
        }
      }
    }
  }
}

Example PDF Statement Field Mapping

Step 2: Create the PDF

There are a number of options for using webhook data to create your PDF statements. Ultimately, you are free to use whatever means best suits your situation, but below are a few options and guides to help you get started.

General Steps

Independent of the tool you choose, these will be the general steps:

Create a template PDF statement in the tooling of your choice.

Add placeholders for any values that will change from statement to statement. For example, borrower name, balance, due date, etc.

Use the data received in the statement webhook to populate the placeholders.

Low-Code Option

Anvil offers an easy, low-code REST API option for generating PDF statements.

Create your PDF statement template: Tutorial

Make a POST request to Anvil’s /fill endpoint with the relevant fields from the statement webhook payload in the body of the request: Tutorial

The body of the response from this call will contain your filled out PDF statement.

Custom Development Integration Option

If you have an in-house development team, you can make use of a PDF library to generate your PDF statements directly in your existing system. Based on your tech stack, there are a number of PDF manipulation libraries available.

Step 3: Make the PDF Available in Canopy

Great! You’ve generate your PDF statement! Now, we’ll want to save that PDF in a secure location within Canopy’s system to make it available within your Borrower Portal and CanopyOS.

Attaching a PDF Statement to a Canopy Account Cycle

The payload of the statement webhook contains a field called pre_signed_url

Make a PUT call to the URL provided from the pre_signed_url field with your statement PDF in the request body.

When successful, calls to The PDF will also be available for download from the borrower portal and CanopyOS.

Where can I find the statement PDFs in Canopy?

CanopyOS

From an Account page, look for the Account Statements section.

Click on View for a listed statement.

A drawer will appear appear displaying statement data.

In the upper right hand corner, there will be a download button if a statement PDF has been attached.

Clicking on this button will download the statement PDF you attached.

Borrower Portal

From an Account page, look for the Statements tab at the top.

This page will contain a list of statement cycles for that account.

On the right hand side of each statement cycle there will be a download icon if a statement PDF has been attached.

Clicking on this icon will download the statement PDF you attached.

API Request

GET /accounts/{account_id}/statements/list will include a downloadable URL for the PDF.

Label	Data Field
Company Details	organization.organization_overview
Header Statement Start Date	statement.cycle_summary.cycle_inclusive_start
Header Statement End Date	Subtract 1 second from: statement.cycle_summary.cycle_exclusive_end
Customer Details	account.customers[0]
Account Number	account.account_id
Payments Received	statement.cycle_summary.cycle_payments_cents
Other Credits	statement.cycle_summary.cycle_debit_adjustments_cents
Past Due Amount	statement.additional_min_pay_details.previous_min_pay_cents
Returned Payments	statement.cycle_summary.cycle_payment_reversals_cents
Fees Charged	Sum of statement.cycle_summary.[Fee_Fields]
Interest Charged	statement.cycle_summary.cycle_interest_cents + statement.cycle_summary.cycle_am_interest_cents
New Balance	statement.balance_summary.total_balance_cents
Credit Limit	statement.open_to_buy.credit_limit_cents
Available Balance	account.summary.available_credit_cents
Payment Due	statement.min_pay_due.min_pay_cents
Due Date	Subtract 1 second from: statement.min_pay_due.min_pay_due_at
Autopay Enabled	account.payment_processor_config.autopay_enabled
Return Payment Fee	account.account_product.product_lifecycle.payment_reversal_fee_impl_cents
Late Fee	account.account_product.product_lifecycle.late_fee_impl_cents
Transaction Created Date	statement.line_items.created_at
Transaction Effective Date	statement.line_items.effective_at
Transaction Description	statement.line_items.line_item_overview.description
Transaction Amount	statement.line_items.line_item_summary.original_amount_cents
Total Payments and Other Credits	statement.cycle_summary.cycle_payments_cents + statement.cycle_summary.cycle_debit_adjustments_cents
Total Period Interest	statement.cycle_summary.cycle_am_interest_cents + statement.cycle_summary.cycle_interest_cents
APR	account.summary.interest_rate_percent