Credit Payments Export
The Credit Payments export contains a row for each credit payment. A credit payment is primarily the use of an outstanding credit balance to pay an invoice, but does include the record of write-offs, credit balance removals, and credit payments later refunded as cash transaction. This export is only visible and populated if the Credit Invoices feature enabled on your Recurly site.
Action Filter
The Credit Payments export can be pre-filtered in the Admin Console by Action. The credit payment actions are as follows:
Action | Description |
---|---|
Payment | The payment action is a normal credit payment that took a all or a portion of a credit invoice balance and applied it as payment to a charge invoice. |
Gift Card | The gift card action is also a normal credit payment, but the credit invoice the amount is from has an invoice origin of "gift_card". This action is useful in tracking what invoices were paid with gift card credit. |
Write-Off | The write-off action is used to take the balance of a write-off invoice and apply it to a failed invoice, reducing the failed invoice balance to zero. |
Reduction | The reduction action is used to remove a credit balance from a credit invoice. Filter on this action to see all credits that were "deleted" from an account. Look at the corresponding original invoice status to see if the balance reduction resulted in a voided credit invoice or a closed credit invoice. |
Refund | The refund action is used when a credit payment is refunded as a refund transaction. This event creates a new credit payment that records the id of the original credit payment that was refunded and the id of the new refund transaction that the value was converted to. |
Date Range Filters
Created
Lists all credit payments created during the selected timeframe.
Modified
Lists all credit payments modified during the selected timeframe. A credit payment is given a modified_at value at the time of creation. This value is updated only when a credit payment is voided (voided_at value set) due to the invoice it was applied to being failed.
Export Contents
Column Name | Example | Description |
---|---|---|
id | 41872c1bf4bcfcd5658d86401194f63b | The unique id of the credit payment. |
created_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was created. |
modified_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was modified, which would be when it was created or voided. |
voided_at | 2017-12-02 17:58:09 UTC | The date and time the credit payment was voided due to the applied invoice being failed. |
action | payment, gift_card, write_off, reduction, refund | The action that resulted in the credit payment being created. See action filter table above for details. |
currency | USD | The currency of the credit payment amount. |
amount | 54.38 | The amount of the credit payment, which will always be positive. |
original_invoice_billed_date | 2017-12-02 17:58:09 UTC | The date the credit invoice the credit payment came from was issued. |
original_invoice_status | open, processing, closed, voided | The current status of the credit invoice the credit payment came from. This is helpful to identify voided vs. closed credit invoices for reduction action credit payments. |
original_invoice_number | 1372 | The invoice number of the credit invoice the credit payment came from. |
applied_to_invoice_number | 1375 | The invoice number the credit payment was applied to. If action is payment, gift_card, or write_off, this is a charge invoice. If action is reduction or refund, this is a credit invoice. |
original_credit_payment_id | 41a6030f2d98cb60f25f5e4dff8d39fd | The unique id of the credit payment the refund action credit payment is refunding. Will only populate if the action on the row is "refund". |
refund_transaction_id | 41a6030f2d98cb60f25f5e4dff8d39fd | The unique id of the new refund transaction the refund action credit payment is transferring value to. Will only populate if the action on the row is "refund". |
Updated about 3 years ago