getCustomerReport
An alias of getreport. Pull a built-in or custom report from the merchant console.
Description
This method retrieves a report from the merchant console. Any reports, including custom reports, may be retrieved. The returned data is base 64 encoded. The format of the returned data can be HTML, comma separated (cvs), or tab separated (tab).
Names of built-in reports are prefaced with "CreditCard:", "Check:" or "Customer:". For example, to pull "Sales by Date" for credit cards, the "Report" parameter would be set to "CreditCard:Sales by Date."
To pull a custom credit card or check report, prefix the name with "Custom:" or "CustomCheck:" For example, to pull a custom report titled "Recurring Declines" set the "Report" parameter to "Custom:Recurring Declines." Customer reports can only be created from within the merchant console. If none of the built-in or custom reports provide data required, see the custom search methods (ie searchTransactionsCustom) for more flexibility.
See also searchTransactionCustom, getReport, searchCustomersCustom
Syntax
string getCustomerReport ( ueSecurityToken Token, string Report, FieldValue Options, string Format )
Arguments
| Type | Name | Description |
|---|---|---|
| ueSecurityToken | Token | Merchant security token: used to identify merchant and validate transaction. |
| string | Report | Name of report to retrieve. |
| FieldValue | Options | Array of FieldValue objects specifying report options such as (StartDate and EndDate) |
| string | Format | Format of returned report data. Possible values are: html, csv, or tab. |
Return Value
| Type | Description |
|---|---|
| string | Returns specified report data according to parameters set in search. |
Available Reports
| Report Name | Description |
|---|---|
| customer:Pending Billing by Date | The next instance of a customer's recurring billing, sorted by next bill date |
| customer:Pending Billing by Source | The next instance of a customer's recurring billing, sorted by Source |
| customer:Future Billing by Date | All instances of a customer's recurring billing within the specified date range, sorted by bill date |
| customer:Future Billing by Source | All instances of a customer's recurring billing within the specified date range, sorted by Source |
| customer:Billing History by Date | Transactions results for recurring billing, sorted by billing date |
| customer:Billing History by Source | Transactions results for recurring billing, sorted by Source |
| customer:Expired Cards | Customers who have an expired credit card on file |
| customer:Expiring before Next Billing | Customers that have a credit card that will expire before the next payment is scheduled to run |
| customer:Expiring by Date Range | Customers that have a credit card expiring in the future |
Change History
| Version | Change |
|---|---|
| 1.3 | Method added in this release |