Get billing period transactions

This request retrieves all transactions within a specified date range.

   Click here to learn more about this request

This request retrieves all transactions that applied to a line of credit account account during a specified date range. This is useful for retrieving all transactions that occurred during a billing cycle. Note the following when using this request:

This request uses a combination of query parameters to return results. Some query parameters are required while others are optional.

This request returns a list of transaction types. Here are all included transaction types:

TypeLabelDescription
Balance rolloversbalance-rolloverTransactions that move a balance from a line of credit account to an installment loan.
Bucket transfersbucket-transferTransactions that move a balance from one Bucket to another.
ChargeschargeFees that apply to the account.
CreditscreditTransactions that forgive a portion of a debt. Credits replenish an account's available credit and reduce the balance.
Finance chargesfinance-chargeInterest that has accrued on the account. Finance charges are applied when a borrower becomes past due.
PaymentspaymentTransactions that pay off a balance. Payments replenish an account's available credit.
Swipes/card transactionsswipeDraws made on the account. Swipes decrease the account's available credit, and they're typically created when a borrower uses their card to make a purchase.

Database

For information regarding Line of Credit statement and billing database tables, see the following articles:

Database – Line of Credit Account (line_of_credit_entity)

Database - Line of Credit Billing Cycle (line_of_credit_billing_cycle_entity)

Path Params
int32
required

The ID of the line of credit account.

Query Params
int32
required

Sets the number of pages included in the results.

int32
required

Determines the size of each page.

boolean
required
Defaults to true

Determines whether to include a results summary object.

string
required

Determines how to sort results. Sorting by transaction apply date is recommended.

string
enum
required

Determines whether to sort results in ascending or descending order.

Allowed:
string
enum

Filters results by a certain transaction status. Separate values by a comma to filter for multiple statuses.

string
enum

Filters by specified transaction type(s). Separate values by a comma to filter for multiple transaction types.

Allowed:
string

Filters results that occurred after a certain date. Formatted as YYYY-MM-DD

string

Filters results that occurred before a certain date. Formatted as YYYY-MM-DD

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json