Recurly: Balance Transactions

Description

• Each record represents a specific line item charge, credit, or other balance change that accumulates into the final invoices.

Supported Data Sources

• Recurly

Columns

Type	Name	Description
STRING	balance_transaction_id	Unique identifier for the balance transaction line item
DATETIME	created_at	When the line item was created.
DATETIME	updated_at	When the line item was last updated.
STRING	account_id	Customer in Recurly responsible for the line item.
STRING	invoice_id	Invoice in Recurly these line items are associated with.
INTEGER	invoice_number	If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (e.g. FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
STRING	type	Charges are positive line items that debit the account. Credits are negative line items that credit the account. Enum: "charge", "credit"
STRING	state	Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an invoice_id value. Enum: "invoiced", "pending"
STRING	origin	A credit created from an original charge will have the value of the charge's origin
INTEGER	product_code	For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's external_sku.
DECIMAL	discount	The discount applied to the line item.
DECIMAL	tax	The tax amount for the line item.
STRING	description	Description that appears on the invoice. For subscription related items this will be filled in automatically.
INTEGER	plan_code	If the line item is a charge or credit for a plan or add-on, this is the plan's code.
INTEGER	add_on_code	If the line item is a charge or credit for an add-on, this is its code.
BOOLEAN	has_refund	True if the line item is refund, false if it is not.
INTEGER	refunded_quantity	For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
STRING	currency	3-letter ISO 4217 currency code.
DECIMAL	amount	Total after discounts and taxes (quantity * unit_amount) - (discount + tax).
DECIMAL	credit_applied	The amount of credit from this line item that was applied to the invoice.
INTEGER	quantity	This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
DECIMAL	unit_amount	Positive amount for a charge, negative amount for a credit.
DECIMAL	subtotal	Total before discounts and taxes (quantity * unit_amount).
DATETIME	started_at	If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date.
DATETIME	ended_at	If this date is provided, it indicates the end of a time range
INTEGER	original_line_item_invoice_id	The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
INTEGER	previous_line_item_id	Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
STRING	invoice_state	The invoice state. Enum: "open", "pending", "processing", "past_due", "paid", "closed", "failed", "voided".
STRING	invoice_origin	The event that created the invoice. Enum: "credit", "gift_card", "immediate_change", "line_item_refund", "open_amount_refund", "purchase", "renewal", "termination", "write_off", "prepayment".
STRING	invoice_type	Invoices are either "charge", "credit", or "legacy" invoices.
DATETIME	invoice_created_at	When the invoice was created.
DATETIME	invoice_due_at	Date invoice is due. This is the date the net terms are reached.
DATETIME	invoice_closed_at	Date invoice was marked paid or failed.
STRING	transaction_id	The id of the transaction associated with the invoice.
DATETIME	transaction_created_at	Time transaction was created.
STRING	transaction_type	Transaction types: authorization: verifies billing information and places a hold on money in the customer's account. capture: captures funds held by an authorization and completes a purchase. purchase: combines the authorization and capture in one transaction. refund: returns all or a portion of the money collected in a previous transaction to the customer. verify: a $0 or $1 transaction used to verify billing information which is immediately voided.Enum: "authorization", "capture", "purchase", "refund", "verify"
STRING	transaction_origin	Describes how the transaction was triggered. Enum: "api", "chargeback", "force_collect", "hpp", "merchant", "recurly_admin", "recurlyjs", "recurring", "refunded_externally", "transparent"
STRING	transaction_status	The current transaction status. Note that the status may change, e.g. a pending transaction may become declined or success may later become void. Enum: "chargeback", "declined", "error", "pending", "processing", "scheduled", "success", "void"
STRING	transaction_billing_country	Billing info - Country, 2-letter ISO code.
STRING	transaction_status_message	For declined (success=false) transactions, the message displayed to the merchant.
STRING	transaction_payment_method_object	Examples include: "amazon", "amazon_billing_agreement", "apple_pay", "bank_account_info", "check", "credit_card", "eft", "debit", "gateway_token", "iban_bank_account", "money_order", "other", "paypal", "paypal_billing_agreement", "roku", "sepadirectdebit", "wire_transfer"