Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

ListFinancialEventGroups

Returns financial event groups for a given date range.

Description

The ListFinancialEventGroups operation returns a list of financial event groups opened during a time frame specified by the FinancialEventGroupStartedAfter or the FinancialEventGroupStartedBefore request parameters.

Event groups opened more than 18 months before the current date are not returned.

Availability

This operation is available in all marketplaces.

Throttling

Maximum request quota Restore rate Hourly request quota
30 requests One request every two seconds 1800 requests per hour
For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Name Description Required Valid values
MaxResultsPerPage The maximum number of results to return per page. No Minimum: 1

Maximum: 100

Default: 100

Type: xs:int

FinancialEventGroupStartedAfter A date used for selecting financial event groups that opened after (or at) a specified time. Yes Any date no later than two minutes before the request was submitted, in ISO 8601 date time format.

Type: xs:dateTime

FinancialEventGroupStartedBefore A date used for selecting financial event groups that opened before (but not at) a specified time. No Any date later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.

Default: Now minus two minutes

Type: xs:dateTime

Response elements

Name Description
NextToken A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to ListFinancialEventGroupsByNextToken. If NextToken is not returned, there are no more financial event groups to return.

Optional

Type: xs:string

FinancialEventGroupList Contains the financial event groups that meet the criteria specified in the request.

Type: List of FinancialEventGroup

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

POST /Finances/2015-05-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: <Your User Agent Header>

AWSAccessKeyId=0PB842EXAMPLESDX
&Action=ListFinancialEventGroups
&FinancialEventGroupStartedAfter=2015-03-01T00%3A00%3A00.000Z
&FinancialEventGroupStartedBefore=2015-05-01T00%3A00%3A00.000Z
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&SellerId=A1XEXAMPLEDF
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2015-05-01T18%3A12%3A21.687Z
&Version=2015-05-01
&Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<ListFinancialEventGroupsResponse
    xmlns="https://mws.amazonservices.com/Finances/2015-05-01">
    <ListFinancialEventGroupsResult>
        <NextToken>2YgYW55IGNhcm5hbCBwbGVhcEXAMPLE</NextToken>
        <FinancialEventGroupList>
            <FinancialEventGroup>
                <FinancialEventGroupId>
                    22YgYW55IGNhcm5hbCBwbGVhEXAMPLE
                </FinancialEventGroupId>
                <ProcessingStatus>Closed</ProcessingStatus>
                <FundTransferStatus>Successful</FundTransferStatus>
                <OriginalTotal>
                    <CurrencyCode>USD</CurrencyCode>
                    <Amount>19.00</Amount>
                </OriginalTotal>
                <ConvertedTotal>
                    <CurrencyCode>USD</CurrencyCode>
                    <Amount>19.00</Amount>
                </ConvertedTotal>
                <FundTransferDate>2014-09-09T01:30:00.000-06:00</FundTransferDate>
                <TraceId>128311029381HSADJEXAMPLE</TraceId>
                <AccountTail>1212</AccountTail>
                <BeginningBalance>
                    <CurrencyCode>USD</CurrencyCode>
                    <Amount>0.00</Amount>
                </BeginningBalance>
                <FinancialEventGroupStart>
                    2014-09-01T01:30:00.000-06:00
                </FinancialEventGroupStart>
                <FinancialEventGroupEnd>
                    2014-09-09T01:30:00.000-06:00
                </FinancialEventGroupEnd>
            </FinancialEventGroup>
        </FinancialEventGroupList>
    </ListFinancialEventGroupsResult>
    <ResponseMetadata>
        <RequestId>1105b931-6f1c-4480-8e97-f3b46EXAMPLE</RequestId>
    </ResponseMetadata>
</ListFinancialEventGroupsResponse>

↑ Top