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

ListFinancialEvents

Returns financial events for a given order, financial event group, or date range.

Description

The ListFinancialEvents operation returns a list of financial events that matches the filter specified in the request.

You can filter by financial event group ID, date range, or order ID. If you specify a financial event group ID in the request, then all financial events in that financial event group are returned. If you specify a time range in the request, then all financial events that are posted between the time ranges are returned. If you specify an order ID in the request, then all financial events that are part of the order are returned.

Events posted 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

AmazonOrderId The identifier of the order for which you want to obtain all financial events. You can only specify one of the following filter criteria:
  • AmazonOrderId
  • FinancialEventGroupId
  • PostedAfter and optionally PostedBefore
Any valid Amazon order identifier in 3-7-7 format.

Type: xs:string

FinancialEventGroupId The identifier of the financial event group for which you want to obtain all financial events. You can only specify one of the following filter criteria:
  • AmazonOrderId
  • FinancialEventGroupId
  • PostedAfter and optionally PostedBefore
Any valid financial event group identifier.

Type: xs:string

PostedAfter A date used for selecting financial events posted after (or at) a specified time. You can only specify one of the following filter criteria:
  • AmazonOrderId
  • FinancialEventGroupId
  • PostedAfter and optionally PostedBefore
Any date no later than two minutes before the request was submitted, in ISO 8601 date time format.

Type: xs:dateTime

PostedBefore A date used for selecting financial events posted before (but not at) a specified time. You can only specify one of the following filter criteria:
  • AmazonOrderId
  • FinancialEventGroupId
  • PostedAfter and optionally PostedBefore
Any date later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned.

You must specify the PostedAfter request parameter if you specify this request parameter.

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 ListFinancialEventsByNextToken. If NextToken is not returned, there are no more financial events to return.

Optional

Type: xs:string

FinancialEvents Contains the financial events that meet the criteria specified in the request.

Type: FinancialEvents

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=ListFinancialEvents
&AmazonOrderId=333-7777777-7777777
&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"?>
<ListFinancialEventsResponse xmlns="http://mws.amazonservices.com/Finances/2015-05-01">
  <ListFinancialEventsResult>
    <FinancialEvents>
      <ProductAdsPaymentEventList/>
      <RentalTransactionEventList/>
      <PayWithAmazonEventList/>
      <ServiceFeeEventList/>
      <ServiceProviderCreditEventList/>
      <SellerDealPaymentEventList>
        <SellerDealPaymentEvent>
          <PostedDate>2016-11-21T16:18:15.000Z</PostedDate>
          <DealDescription>test fees</DealDescription>
          <DealId>fec11097c1f4379426a7de68bf938b684f677de2</DealId>
          <EventType>SellerDealComplete</EventType>
          <FeeType>RunLightningDealFee</FeeType>
          <FeeAmount>
            <CurrencyAmount>16.38</CurrencyAmount>
            <CurrencyCode>USD</CurrencyCode>
          </FeeAmount>
          <TaxAmount>
            <CurrencyAmount>3.18</CurrencyAmount>
            <CurrencyCode>USD</CurrencyCode>
          </TaxAmount>
        </SellerDealPaymentEvent>
      </SellerDealPaymentEventList>
      <ProductAdsPaymentEventList>
        <ProductAdsPaymentEvent>
          <PostedDate>2017-01-11T13:17:15.000Z</PostedDate>
          <transactionType>Charge</transactionType>
          <invoiceId>TR1W0B4YB-6</invoiceId>
          <baseValue>
            <CurrencyAmount>115.34</CurrencyAmount>
            <CurrencyCode>USD</CurrencyCode>
          </baseValue>
          <taxValue>
            <CurrencyAmount>21.91</CurrencyAmount>
            <CurrencyCode>USD</CurrencyCode>
          </taxValue>
          <transactionValue>
            <CurrencyAmount>137.25</CurrencyAmount>
            <CurrencyCode>USD</CurrencyCode>
          </transactionValue>
        </ProductAdsPaymentEvent>
      </ProductAdsPaymentEventList>
      <DebtRecoveryEventList/>
      <ShipmentEventList>
        <ShipmentEvent>
          <ShipmentItemList>
            <ShipmentItem>
              <ItemChargeList>
                <ChargeComponent>
                  <ChargeType>Principal</ChargeType>
                  <ChargeAmount>
                    <CurrencyAmount>25.99</CurrencyAmount>
                    <CurrencyCode>USD</CurrencyCode>
                  </ChargeAmount>
                </ChargeComponent>
                <ChargeComponent>
                  <ChargeType>Tax</ChargeType>
                  <ChargeAmount>
                    <CurrencyAmount>0.0</CurrencyAmount>
                    <CurrencyCode>USD</CurrencyCode>
                  </ChargeAmount>
                </ChargeComponent>                  
                <FeeType>ShippingChargeback</FeeType>
                <FeeAmount>
                  <CurrencyAmount>0.0</CurrencyAmount>
                  <CurrencyCode>USD</CurrencyCode>
                </FeeAmount>
                </FeeComponent>
                <FeeComponent>
                  <FeeType>VariableClosingFee</FeeType>
                  <FeeAmount>
                    <CurrencyAmount>0.0</CurrencyAmount>
                    <CurrencyCode>USD</CurrencyCode>
                  </FeeAmount>
                </FeeComponent>
                </ItemFeeList>
                <OrderItemId>46432915698730</OrderItemId>
                <QuantityShipped>1</QuantityShipped>
                <SellerSKU>HS223A-C00</SellerSKU>
            </ShipmentItem>
          </ShipmentItemList>
          <AmazonOrderId>105-0457358-1245022</AmazonOrderId>
          <PostedDate>2017-01-23T01:31:25Z</PostedDate>
          <MarketplaceName>Amazon.com</MarketplaceName>
          <SellerOrderId>105-0457358-1245022</SellerOrderId>
        </ShipmentEvent>
      </ShipmentEventList>
      <AffordabilityExpenseEventList>
        <AffordabilityExpenseEvent>
          <PostedDate>2018-02-08T13:17:15.000Z</PostedDate>
          <TransactionType>Charge</TransactionType>
          <AmazonOrderId>931-2463294-5740665</AmazonOrderId >
          <MarketplaceId>A2XZLSVIQ0F4JT</MarketplaceId>
          <BaseExpense>
            <CurrencyAmount>-100.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </BaseExpense > 
          <TaxTypeIGST>
            <CurrencyAmount>-18.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeIGST>
          <TaxTypeSGST>
            <CurrencyAmount>0.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeSGST>
          <TaxTypeCGST>
            <CurrencyAmount>0.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeCGST>
          <TotalExpense>
            <CurrencyAmount>-118.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TotalExpense>
        </AffordabilityExpenseEvent>
      </AffordabilityExpenseEventList>
      <RetrochargeEventList/>
      <GuaranteeClaimEventList/>
      <ChargebackEventList/>
      <LoanServicingEventList/>
      <RefundEventList/>
      <AdjustmentEventList/>
      <PerformanceBondRefundEventList/>
      <AffordabilityExpenseReversalEventList>
        <AffordabilityExpenseReversalEvent>
          <PostedDate>2018-02-08T13:17:15.000Z</PostedDate>
          <TransactionType>Refund</TransactionType>
          <AmazonOrderId>931-2463294-5740665</AmazonOrderId>
          <MarketplaceId>A2XZLSVIQ0F4JT</MarketplaceId>
          <BaseExpense>
            <CurrencyAmount>100.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </BaseExpense >
          <TaxTypeIGST>
            <CurrencyAmount>18.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeIGST>
          <TaxTypeSGST>
            <CurrencyAmount>0.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeSGST>
          <TaxTypeCGST>
            <CurrencyAmount>0.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TaxTypeCGST>
          <TotalExpense>
            <CurrencyAmount>118.00</CurrencyAmount>
            <CurrencyCode>INR</CurrencyCode>
          </TotalExpense>
        </AffordabilityExpenseReversalEvent>
      </AffordabilityExpenseReversalEventList>
    </FinancialEvents>
  </ListFinancialEventsResult>
  <ResponseMetadata>
    <RequestId>6a2929e5-5c77-470e-ad71-36f30bfaffcc</RequestId>
  </ResponseMetadata>
</ListFinancialEventsResponse>

↑ Top