# 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

* <img src="https://fivetran.com/integrations/recurly/resources/recurly.svg" alt="" data-size="line"> 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"                                                                                                                                                                                                                                          |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://endash-guidance-docs.gitbook.io/cigro-data-templates/data-model-templates/recurly-balance-transactions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
