Credit Statements

Learn how to retrieve data to generate statements for your credit programs

Lithic's Statements API provides the data needed for customers to generate statements for their business clients. The API includes both Summary data such as total amount due and detailed Line Item data on which transactions were included in the statement.

Statement Summary Schema

{
  "ach_period_total": Integer,
  "ach_ytd_total": Integer,
  "adjustments_period_total": Integer,
  "adjustments_ytd_total": Integer,
  "amount_due": Integer,
  "available_credit": Integer,
  "created": String,
  "credit_limit": Integer,
  "days_in_billing_cycle": Integer,
  "ending_balance": Integer,
  "financial_account_token": String,
  "payment_due_date": String,
  "purchases_period_total": Integer,
  "purchases_ytd_total": Integer,
  "starting_balance": Integer,
  "statement_start_date": String,
  "statement_end_date": String,
  "token": String,
  "updated": String
}
ach_period_totalTotal payments during this billing period
ach_ytd_totalTotal payments year-to-date
adjustments_period_totalTotal adjustments (e.g., late fees) during this billing period
adjustments_ytd_totalTotal adjustments year-to-date
amount_duePayment due at the end of the billing period. Negative amount indicates the account holder owes payment. Positive amount indicates a net credit and funds should be returned the account holder via ACH
available_creditRemaining amount of credit that the account holder can still spend
createdDate and time for when the statement was generated
credit_limitMaximum amount that the account holder can spend. Set by the program
days_in_billing_cycleNumber of days in the billing cycle
ending_balanceBalance at the end of the billing period. For charge cards, the ending_balance should be the same as the amount_due
financial_account_tokenGlobally unique identifier for a financial account
payment_due_dateDate of when payment is due
purchases_period_totalTotal settled card transactions during this billing period
purchases_ytd_totalTotal settled card transactions year-to-date
starting_balanceBalance at the start of the billing period
statement_end_dateDate of when the billing period ended
statement_start_dateDate of when the billing period began
tokenGlobally unique identifier for a statement
updatedDate and time for when the statement was updated

Statement Line Item Schema

{
  "amount": String,
  "card_token": String,
  "category": String,
  "created": String,
  "currency": String,
  "descriptor": String,
  "event_type": String,
  "financial_account_token": String,
  "financial_transaction_token": String,
  "settled_date": String,
  "token": String
}
amountAmount of the line item in the currency’s smallest unit (e.g., cents for USD)
card_tokenGlobally unique identifier for the card used in the transaction. Will be null if the transaction was of category ACH or TRANSFER
categoryCARD, ACH, TRANSFER
createdDate and time for when the line item was created
currency3-digit alphabetic ISO 4217 code for the settling currency of the transaction
descriptorA string that provides a description of the financial transaction to display to users
event_typeAUTHORIZATION, CREDIT_AUTHORIZATION, AUTHORIZATION_ADVICE, FINANCIAL_AUTHORIZATION, FINANCIAL_CREDIT_AUTHORIZATION, AUTHORIZATION_REVERSAL, CREDIT_AUTHORIZATION_ADVICE, AUTHORIZATION_EXPIRY, CLEARING, BALANCE_INQUIRY, RETURN, RETURN_REVERSAL, CORRECTION_DEBIT, CORRECTION_CREDIT, ACH_RECEIPT, ACH_ORIGINATION_PENDING, ACH_ORIGINATION_PROCESSED, ACH_ORIGINATION_RELEASED, ACH_RETURN_PENDING, ACH_RETURN, ACH_INSUFFICIENT_FUNDS, TRANSFER, TRANSFER_INSUFFICIENT_FUNDS
financial_account_tokenGlobally unique identifier for the financial account that this transaction posted to
financial_transaction_tokenGlobally unique identifier for a financial transaction
settled_dateDate that the transaction settled
tokenGlobally unique identifier for the line item

API Endpoints

Lithic supports the following endpoint to retrieve data on Statement Summaries and Statement Line Items:

  • LIST Statements: retrieve multiple statement summaries for a given financial_account_token
  • GET Statement: retrieve a single statement summary for a given statement_token
  • LIST Line items: retrieve the line items for a given statement_token