Integer value between 1 – 1000\*
If the date range on the report is within 24 hours you can request up to 5000 transactions
| For date-based reports, you can filter results using the following operators for any of the reporting fields: | Parameter | Operator | Description | Example | | --------- | --------- | ---------------------------------------------------------------------------------------------------- | --------------------- | | ai | In | Use for an exact match. | xBillCountry=aiCanada | | a= | Like | Use for fields that include your search string, but sometimes also include other information. | xAmount=a=40 | | a! | Not Like | Use for fields that do not include your search string, but sometimes also include other information. | xCardLastFour=a!4444 | | an | Not In | Shows results that don’t have the value you enter. | xBillPhone=an212 | | as | Ends With | Use when you know what your value starts with. | xName=asJane | | ae | Ends With | Use when you know what your value ends with. | xEmail=aeOrg | ### Customize report parameters To customize the transaction parameters included in a generated report, you can utilize the "xFields" parameter and specify the desired field names. Refer to the available parameters listed [here](https://docs.solapayments.com/#response-parameters). | Parameter | Description | Sample Value | | --------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------- | | xFields | Specify parameters to be returned in the report. | xrefnum, xcommand, xname, xmaskedcardnumber, xtoken, xamount, xentereddate, xresponseresult | ## Report Types Available report types include the following: ### Date-Based Reports #### Report:Approved xCommand: **Report:Approved** The Report:Approved command returns the following transactions: * CC:Sale * CC:Capture * CC:PostAuth * CC:Save * CC:Credit * CC:Refund The Report:Approved command does not return authorization-only transactions that have not been captured. **Required Parameters** | Parameter | Description | Sample Value | | ---------- | ------------------------------------------------------------------ | ------------------------------------------- | | xBeginDate | Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| #### Report:Declined xCommand: **Report:Declined** The Report:Declined command returns the following transactions: * CC:Sale * CC:AuthOnly * CC:Capture * CC:PostAuth * CC:Save * CC:Credit * CC:Refund **Required Parameters** | Parameter | Description | Sample Value | | ---------- | ------------------------------------------------------------------ | ------------------------------------------- | | xBeginDate | Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| #### Report:Auth xCommand: **ReportAuth** The Report:Auth command returns the following transaction: * CC:AuthOnly The ReportAuth command only returns approved authorizations. **Required Parameters** | Parameter | Description | Sample Value | | ---------- | ------------------------------------------------------------------ | ------------------------------------------- | | xBeginDate | Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| #### Report:All xCommand: **Report:All** The Report:All command returns the following transactions: * CC:Sale * CC:AuthOnly * CC:Capture * CC:PostAuth * CC:Save * CC:Credit * CC:Refund **Required Parameters** | Parameter | Description | Sample Value | | ---------- | ------------------------------------------------------------------ | ------------------------------------------- | | xBeginDate | Transaction begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Transaction end date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| {% hint style="info" %} **Note**: You can run a report against all accounts by adding the search parameter xSecondaryKeys:\[comma-delimited xKeys] and use all the xKeys for all accounts for the following date-based reports {% endhint %} | Parameter | Description | Sample Value | | -------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | xSecondaryKeys |Run a report for secondary accounts.
For multiple account keys, you can include comma-separated values.
| Bread\_Butter\_xxxdxxxecbxxxxaxxxdbexxx, Other\_Account\_xxxxfxxxexxfxxxfxbxxx, Yet\_Another\_Account\_xxxbexaxxddxxbabbxexcxxxafxfexx | Optional Field: xBatch:\[batch#]to get only the transactions of a specific batch. #### Report:Deposit xCommand: **Report:Deposit** {% hint style="warning" %} The **Report:Deposit** command will only return valid responses for accounts that have ongoing ACHQ activity. The Deposit ID given as a parameter must be an ACHQ deposit ID and the values shown in the response are only pertaining to ACHQ transaction activity. {% endhint %} The Report:Deposit command returns the following values: * Deposit Id * Deposit Date * Total Amount * Transactions * Refnum * Amount **Required Parameters** | **Parameter** | **Description** | **Sample Value** | | ------------- | ------------------------------------------------------ | ------------------------------------------- | | xDepositId\* | | | | xBeginDate\* | Begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEnd Date\* | End date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| \*Either xDepositId or xBeginDate and xEndDate are required. ### Transaction-Based Reports Single transaction * report:transaction xCommand: **Report:Transaction** **Required Parameters** | Parameter | Description | Sample Value | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | | xRefnum |Reference number
Multiple reference numbers are comma delimited.
This value is required only if you do not enter an Invoice number.
|r10000001
r10000001,r2000001,r3000001
| #### Multiple transactions * report:transactions xCommand: **Report:Transactions** {% hint style="info" %} Reports queried without `xBeginDate` and `xEndDate` will only return transactions from the past 2 years. {% endhint %} **Required Parameters** | Parameter | Description | Sample Value | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | | xRefnum |Reference number
Multiple reference numbers are comma delimited.
This value is required only if you do not enter an Invoice number.
|r10000001
r10000001,r2000001,r3000001
| | xInvoice |Invoice number
Multiple invoice numbers are comma delimited.
This value is required only if you do not enter a Reference number.
|1234
1234,5678,9012
| #### Related Transactions xCommand: **Report:Related** **Required Parameters** | Parameter | Description | Sample Value | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | | xRefnum |Reference number
Multiple reference numbers are comma delimited.
This value is required only if you do not enter an Invoice number.
|r10000001
r10000001,r2000001,r3000001
| #### Gift:Approved xCommand: **Report:GiftApproved** **Required Parameters** | xKey | Your Sola API key | Max Size: 250 Alphanumeric Characters | | ---------------- | ----------------------------------------- | ------------------------------------------- | | xCommand | Sola transaction type | Report:GiftApproved | | xBeginDate | Beginning date of range |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Ending date of range |2020-01-01
2019-08-15 09:00:00
| | xSoftwareName | Name of your software | \[xsoftwarecredentials] | | xSoftwareVersion | Version number of your software | The current version is 4.5.8 | | xFields | Optional. If not used, returns all fields | | **Response Fields** | xResult | “A” | | ---------------- | ------------- | | xStatus | “Approved” | | xError | ““ | | xRefNum | "10000016875" | | xRecordsReturned | “20” | | xReportData | | #### Gift:Summary xCommand: **Report:GiftSummary** **Required Parameters** | xKey | Your Sola API key | \[xkeycredentials] | | ---------------- | ----------------------------------------- | ------------------------------------------- | | xCommand | Sola transaction type | Report:GiftSummary | | xBeginDate | Beginning date of range |2020-01-01
2019-08-15 09:00:00
| | xEndDate | Ending date of range |2020-01-01
2019-08-15 09:00:00
| | xSoftwareName | Name of your software | \[xsoftwarecredentials] | | xSoftwareVersion | Version number of your software | The current version is 4.5.8 | | xFields | Optional. If not used, returns all fields | | **Response Fields** | xResult | “A” | | ---------------- | ------------- | | xStatus | “Approved” | | xError | ““ | | xRefNum | "10000016875" | | xRecordsReturned | “20” | | xReportData | | #### Liability xCommand: **Report:Liability** **Required Parameters** | xKey | Your Sola API key | \[xkeycredentials] | | ---------------- | ------------------------------- | ---------------------------- | | xCommand | Sola transaction type | Report:Liability | | xSoftwareName | Name of your software | \[xsoftwarecredentials] | | xSoftwareVersion | Version number of your software | The current version is 4.5.8 | **Response Fields** | Parameter | Example | | ---------------- | ------------- | | xResult | “A” | | xStatus | “Approved” | | xError | ““ | | xRefNum | "10000016875" | | xRecordsReturned | “20” | | xReportData | | ### Batch Report Obtain batch summary by date * report:batch xCommand: **Report:Batch** **Required Parameters** | Parameter | Description | Sample Value | | ---------- | ------------------------------------------------------ | ------------------------------------------- | | xBeginDate | Begin date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2020-01-01
2019-08-15 09:00:00
| | xEndDate | End date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format |2019-10-31
2020-06-30 12:00:00
| ## Send a Receipt for a Completed Transaction You can use the **Reporting API** feature to send a receipt for a completed transaction. ### Reporting URL Use the following Sola URL: