developer:soap-1.4:methods:getcustomerreport

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.4:methods:getcustomerreport [2010/07/27 11:45] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​
 +
 +====== 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** ( [[..:​objects:​ueSecurityToken]] Token, string Report, [[..:​objects:​FieldValue]] Options, string Format ) 
 +
 +
 +
 +===== Arguments =====
 +
 +^Type   ​^Name ​  ​^Description ​  ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and validate transaction.|
 +|string |Report |Name of report to retrieve.|
 +|[[..:​objects:​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 =====
 +
 +|string |Returns specified report data according to parameters set in search. |
 +
 +
 +===== Available Reports =====
 +
 +^Credit Card Reports ^^
 +|creditcard:​errors by date |Credit card transactions resulting in errors, ​ sorted by date |
 +|creditcard:​errors by source |Credit card transactions resulting in errors, ​ sorted by source key |
 +|creditcard:​errors by reason |Credit card transactions resulting in errors, ​ sorted by reason |
 +|creditcard:​errors by user |Credit card transactions resulting in errors, ​ sorted by user |
 +|creditcard:​declines by date |Credit card transactions resulting in declines, ​ sorted by date |
 +|creditcard:​declines by source |Credit card transactions resulting in declines, ​ sorted by source key |
 +|creditcard:​declines by reason |Credit card transactions resulting in declines, ​ sorted by reason |
 +|creditcard:​declines by user |Credit card transactions resulting in declines, ​ sorted by user |
 +|creditcard:​sales by date |Credit card transactions resulting in approval, ​ sorted by date |
 +|creditcard:​sales by source |Credit card transactions resulting in approval, ​ sorted by source key |
 +|creditcard:​sales by reason |Credit card transactions resulting in approval, ​ sorted by reason |
 +|creditcard:​sales by user |Credit card transactions resulting in approval, ​ sorted by user |
 +^Check Reports ^^
 +|check:​Deposit Report |Check transactions sorted by estimated deposit date | 
 +|check:All Transactions by Date|All Check transactions sorted by date (does not include errors) |
 +|check:​settled by date|Check transactions that have been marked as settled, sorted by date |
 +|check:​settled by source|Check transactions that have been marked as settled, sorted by source |
 +|check:​settled by users|Check transactions that have been marked as settled, sorted by user |
 +|check:​returns by date|Check transactions that have been marked as returned, sorted by date |
 +|check:​returns by source|Check transactions that have been marked as returned, sorted by source |
 +|check:​returns by reason|Check transactions that have been marked as returned, sorted by reason |
 +|check:​returns by user|Check transactions that have been marked as returned, sorted by user |
 +|check:​declines by date|Check transactions were rejected by check processor, sorted by date |
 +|check:​declines by source|Check transactions were rejected by check processor, sorted by sourcekey |
 +|check:​declines by reason|Check transactions were rejected by check processor, sorted by reason |
 +|check:​declines by user|Check transactions were rejected by check processor, sorted by user |
 +^Customer Reports ^^
 +|customer:​Pending Billing by Date |Customers that are pending for recurring billing, sorted by next bill date |
 +|customer:​Pending Billing by Source |Customers that are pending for recurring billing, 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 |
  
developer/soap-1.4/methods/getcustomerreport.txt ยท Last modified: 2010/07/27 11:45 by tem

Page Tools