> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vindicia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Credit History Report
This report provides all credit history, such as granted credits, credit consumption and revocation of credits during a given period. The Credit History report is good for tracking the results (subsequent consumption or revocation) of a credit grant over time. The Credit History reporting period is by the credit grant date.
This report can be generated using Reports 1.0 or Reports 2.0 data engine.
| **Reports 1.0** data engine | Provides the data you need in the reports up to near real-time. Reports data is displayed in UTC time zone. Reports 1.0 lets you select which display columns to include in the report. Report generation is slow and typically lasts several hours. |
| - | - |
| **Reports 2.0** data engine (default) | Supports 20 most commonly used Subscribe reports. Reports 2.0 operates in UTC time zone. You can select which time zone to use for the report data display. Reports display all the available columns. Data is available for the prior two years and up to the previous day according to UTC time. Report generation is quicker as data is prepared ahead of time, once a day. **Note:** For a list of reports 2.0, see [Subscribe Reports using the Vindicia Data Platform —Reports 2.0](reportsAbout#section_i3z_54w_mtb) |
## To generate a one time report:
1. Enter the date range
2. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.
3. Select the Affiliate ID as relevant for the report. Select **No Affiliate** if not required.
4. For **Reports 2.0**, select the relevant **Time Zone** for data range selection and display. Data is available for the previous day at 13:00 UTC time.
**Note:** A notification error message appears when attempting to run reports for which data is not yet available. The report can be submitted and includes data up to the available time.
5. For **Reports 1.0**, select the **Display Columns** you'd like to include in the report.
6. Click **Submit**.
View the report in the **My Reports** page.
## To schedule a recurring report:
1. Toggle **Recurring** toggle to **Yes**.
2. Select a date for the first reporting period.
**Note:** Reports display data occurring starting from the defined date. For example, a monthly report starting on March 1st displays data for the month of March up to March 31st.
3. Select the report's **Frequency**. Choose between Weekly, Monthly or Quarterly.
4. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.
5. Select the Affiliate ID as relevant for the report. Select **No Affiliate** if not required. The report is grouped by Affiliate, with a Summary for each grouping and a Grand Summary at the bottom of the report
6. For **Reports 2.0**, select the relevant **Time Zone** for data range selection and display.
7. Optional. If you want to receive the report uploaded to an **SFTP Server**, enable this option and provide the required details.
When enabled, a scheduled report will be uploaded to the specified SFTP Server. The SFTP report follows the **\-\-\.csv** naming convention where:
* **\** is the name of the report
* **\** is the defined frequency such as monthly, weekly, quarterly, daily or once
* **\** is the format **YYYY-MM-DD"T"HH\_MI\_SS.TZ**, where TZ is the timezone offset, for example, 2022-01-27T10\_57\_02.433174455Z.
**Note:** An email notification is sent if there is an issue in generating or downloading the report on the specified SFTP Server.
8. For **Reports 1.0**, select the **Display Columns** you'd like to include in the report.
9. Click **Submit**.
The report is submitted and will be generated according to the details provided. If you have provided an email or SFTP details, you will be notified when it is available for viewing.
10. View the report in the **My Reports** page.
**Note:**
If using SFTP upload, this report's **\** is **credit\_history\_report**.
## Display Columns
**Note:** The report's display columns **order** is machine-generated and may therefore change without prior notice.
| Field | Description |
| - | - |
| Merchant \| Subscription (AutoBill) | The Subscription to which the credit activity was applied. |
| Merchant \| Credit Amount | Amount of the credit activity. |
| Merchant \| Credit Balance | Balance after the credit activity. |
| Merchant \| Date Awarded | Date on which the credit activity was applied. |
| Merchant \| Activity Type | Type of credit activity. |
| Merchant \| Currency | Three letter ISO code for the currency used in the credit activity. |
| Merchant \| Credit Reason | Reason for the credit activity. |
| Merchant \| Affiliate ID | Merchant Affiliate ID associated with the Transaction. |
| Merchant \| Customer (Account) ID | Customer's account ID to whom this credit activity refers. |
| Merchant \| Transaction | Transaction to which the credit activity was applied. |
| Merchant \| Invoice | Invoice to which the credit activity was applied. |
| Merchant \| Report Start Date | Start date of this report. Credit activities since this date are included in the report. |
| Merchant \| Report End Date | End date of this report. Credit activities up to this date are included in the report. |
**Parent topic:**
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.