This method returns transactions for a single constituent record, optionally filtered by transaction type and date range.
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
CRConsAPI | SRConsAPI | GET, POST | Yes. |
The structure of this method's response document may vary. The <donation_detail> element is only returned if transaction_type=DONATION donation transactions. It is omitted for other transaction_type values. Similarly, whether <credit_card_> or <check_number> elements are returned depends on what method of payment was used for the transaction.
See topic Common Parameters.
Optional. The beginning of the date range of the transactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.
Type xsd:string.
Optional. The ending of the date range of the transactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
Optional. Specifies the type of transactions to return.
Type crm:transactionType.
See topic Common Parameters.
Optional. The beginning of the date range of the transactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.
Type xsd:string.
Optional. The ending of the date range of the transactions to return, formatted per the ISO 8601 specification.
Type xsd:dateTime.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The member ID (Client ID) that uniquely identifies the constituent.
Type xsd:string.
Optional. The primary email address that uniquely identifies the constituent.
Type xsd:string.
Optional. Specifies the type of transactions to return.
Type crm:transactionType.
See topic HTTP Status Codes.
XML response<?xml version="1.0" encoding="UTF-8"?> <getConsTransactionsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <transaction> <timestamp>2016-02-01T09:43:54.428-06:00</timestamp> <confirmation_code/> <amount> <decimal>50.00</decimal> <formatted>$50.00</formatted> </amount> <tender_type>INVALID</tender_type> <pay_method>ONLINE</pay_method> <transaction_type>DONATION</transaction_type> <billing_name> <title xsi:nil="true"/> <first>John</first> <middle xsi:nil="true"/> <last>Smith</last> <suffix xsi:nil="true"/> <prof_suffix xsi:nil="true"/> </billing_name> <billing_address> <street1 xsi:nil="true"/> <street2 xsi:nil="true"/> <street3 xsi:nil="true"/> <city xsi:nil="true"/> <state xsi:nil="true"/> <zip xsi:nil="true"/> <county xsi:nil="true"/> <country xsi:nil="true"/> </billing_address> <donation_detail> <campaign> <id>9901</id> <title>API Campaign</title> <description>Sample campaign for API documentation.</description> </campaign> <form> <id>9999</id> <title>API Form</title> <description>Sample form for API documentation.</description> </form> <level> <id>9921</id> <title>API Donation Level</title> </level> <value_of_goods> <decimal>0.00</decimal> <formatted>$0.00</formatted> </value_of_goods> <tax_deductible_amount> <decimal>0.00</decimal> <formatted>$0.00</formatted> </tax_deductible_amount> </donation_detail> </transaction> </getConsTransactionsResponse>JSON response
{"getConsTransactionsResponse":{"transaction":{"amount":{"formatted":"$50.00","decimal":"50.00"},"timestamp":"2016-02-01T09:43:54.458-06:00","pay_method":"ONLINE","billing_name":{"title":null,"last":"Smith","suffix":null,"middle":null,"first":"John","prof_suffix":null},"transaction_type":"DONATION","tender_type":"INVALID","confirmation_code":{},"donation_detail":{"value_of_goods":{"formatted":"$0.00","decimal":"0.00"},"tax_deductible_amount":{"formatted":"$0.00","decimal":"0.00"},"level":{"id":"9921","title":"API Donation Level"},"form":{"id":"9999","title":"API Form","description":"Sample form for API documentation."},"campaign":{"id":"9901","title":"API Campaign","description":"Sample campaign for API documentation."}},"billing_address":{"street2":null,"zip":null,"street1":null,"county":null,"state":null,"street3":null,"country":null,"city":null}}}}