Overview
The Customer Credit Balance Report shows all outstanding credits a Business has issued to its customers. Customer credits are created when payments exceed the balance of an Invoice, or when a Refund is issued as a credit rather than cash. These credits can later be applied to future Invoices. Key components:- Total Credits – The total dollar value of credits issued to a customer.
- Total Applied Credits – The portion of credits already used against Invoices.
- Total Available Credits – The remaining credits that can still be applied.
How to Generate a Customer Credit Balance Report
-
Call the Retrieve the Customer Credit Balance Report endpoint with:
- Business ID
-
Use the response to present customer-level credit balances:
- Customer ID – Unique identifier for the customer.
- Customer Name – Display name of the customer.
- Total Credits – Value of all credits ever issued to this customer.
- Total Applied Credits – Credits already applied to Invoices.
- Total Available Credits – Credits still available to be applied.
Customer Credit Report Use Cases
- Highlight Available Credits – The
total_available_credits
field represents actionable credits that can be applied to reduce future Invoice payments. - Apply to New Invoices – Credits can be applied when Invoices are created using the Create an Invoice endpoint.
- Monitor Liability Exposure – Credits represent an obligation of the Business. Regularly reviewing this report ensures liabilities to customers are properly accounted for.
Questions? Reach out via our Contact form.