Needio.Services

<back to all web services

GetMyStatementRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/GetMyStatement/
GetMyStatementRequest Parameters:
NameParameterData TypeRequiredDescription
statementqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetMyStatementResponse Parameters:
NameParameterData TypeRequiredDescription
StatementformStatementDetailDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
StatementDetailDTO Parameters:
NameParameterData TypeRequiredDescription
TransactionBriefsformList<TransactionBriefDTO>No
StatementSummariesformList<StatementSummaryDTO>No
StatementDTO Parameters:
NameParameterData TypeRequiredDescription
StatementIdformintNo
StatementPeriodIdformintNo
StartDateformDateTimeNo
EndDateformDateTimeNo
PaymentDateformDateTimeNo
StatementAmountformdecimalNo
CommisionAmoutformdecimalNo
StatementPayOutformdecimalNo
CargoAmountformdecimalNo
OtherCostsAmountformdecimalNo
StatementPayOutCCAmountformdecimalNo
StatementPayOutOtherAmountformdecimalNo
IsCompletedformboolNo
StatementPeriodformStatementPeriodDTONo
StoreIdformint?No
StoreformStoreInfoNo
StatementPeriodDTO Parameters:
NameParameterData TypeRequiredDescription
StatementPeriodIdformintNo
YearformshortNo
PeriodformstringNo
StartDateformDateTimeNo
EndDateformDateTimeNo
PaymentDateformDateTimeNo
StoreInfo Parameters:
NameParameterData TypeRequiredDescription
StoreIdformintNo
StoreNameformstringNo
StoreHeaderformstringNo
DescriptionformstringNo
PostTypeIdformshortNo
FriendlyURLformstringNo
StoreCategory1Idformshort?No
StoreSubCategory1Idformshort?No
TransactionBriefDTO Parameters:
NameParameterData TypeRequiredDescription
TransIdformintNo
StoreIdformintNo
StatementIdformintNo
BuyerIdformintNo
StatusformTransactionStatusesNo
PaymentStatusformPaymentStatusesNo
BuyerNameformstringNo
TransDateformDateTimeNo
ApproveDateformDateTimeNo
CancelDateformDateTimeNo
SaleAmountformdecimalNo
RefundTotalformdecimalNo
NetAmountformdecimalNo
MerchantPayoutformdecimalNo
MerchantPayoutCCAmountformdecimalNo
MerchantPayoutOtherCostAmountformdecimalNo
CommisionAmountformdecimalNo
CargoAmountformdecimalNo
OtherCostsAmountformdecimalNo
TransactionSummariesformList<TransactionSummaryDTO>No
TransactionStatuses Enum:
NameValue
Draft0
InProgress1
SalerApproved11
SalerRejected12
BuyerCancelled13
SalerStartShippment16
ShipmentStarted17
ShipmentCanceled19
BuyerApproved21
BuyerRejected22
AdminApproved41
AdminRejected42
Completed101
ReturnedItem102
SalerFirstNotification201
SalerSecondNotification202
BuyerFirstNotification203
BuyerSecondNotification204
PaymentStatuses Enum:
NameValue
Unknown0
InProgress1
Approved2
Refunded3
Cancelled4
TransactionSummaryDTO Parameters:
NameParameterData TypeRequiredDescription
AccountTransactionIdformintNo
TransIdformintNo
PaymentIdformint?No
StatementIdformintNo
AccountIdformintNo
AccountNameformstringNo
AccountTransactionTypeIdformshortNo
AccountTransactionTypeNameformstringNo
DescriptionformstringNo
TransactionDateformDateTimeNo
PaymentDateformDateTimeNo
AmountformdecimalNo
StatementSummaryDTO Parameters:
NameParameterData TypeRequiredDescription
StatementSummaryIdformintNo
StatementIdformintNo
AccountIdformintNo
AccountNameformstringNo
AccountTransactionTypeIdformshortNo
AccountTransactionTypeNameformstringNo
DescriptionformstringNo
AmountformdecimalNo
GetMyStatementResponse Parameters:
NameParameterData TypeRequiredDescription
StatementformStatementDetailDTONo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetMyStatement/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMyStatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <statement>0</statement>
</GetMyStatementRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMyStatementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Statement xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:CargoAmount>0</d2p1:CargoAmount>
    <d2p1:CommisionAmout>0</d2p1:CommisionAmout>
    <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
    <d2p1:IsCompleted>false</d2p1:IsCompleted>
    <d2p1:OtherCostsAmount>0</d2p1:OtherCostsAmount>
    <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
    <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
    <d2p1:StatementAmount>0</d2p1:StatementAmount>
    <d2p1:StatementId>0</d2p1:StatementId>
    <d2p1:StatementPayOut>0</d2p1:StatementPayOut>
    <d2p1:StatementPayOutCCAmount>0</d2p1:StatementPayOutCCAmount>
    <d2p1:StatementPayOutOtherAmount>0</d2p1:StatementPayOutOtherAmount>
    <d2p1:StatementPeriod>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
      <d2p1:Period>String</d2p1:Period>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:StatementPeriodId>0</d2p1:StatementPeriodId>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:StatementPeriod>
    <d2p1:StatementPeriodId>0</d2p1:StatementPeriodId>
    <d2p1:Store>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
      <d2p1:PostTypeId>0</d2p1:PostTypeId>
      <d2p1:StoreCategory1Id>0</d2p1:StoreCategory1Id>
      <d2p1:StoreHeader>String</d2p1:StoreHeader>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:StoreName>String</d2p1:StoreName>
      <d2p1:StoreSubCategory1Id>0</d2p1:StoreSubCategory1Id>
    </d2p1:Store>
    <d2p1:StoreId>0</d2p1:StoreId>
    <d2p1:StatementSummaries>
      <d2p1:StatementSummaryDTO>
        <d2p1:AccountId>0</d2p1:AccountId>
        <d2p1:AccountName>String</d2p1:AccountName>
        <d2p1:AccountTransactionTypeId>0</d2p1:AccountTransactionTypeId>
        <d2p1:AccountTransactionTypeName>String</d2p1:AccountTransactionTypeName>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:StatementId>0</d2p1:StatementId>
        <d2p1:StatementSummaryId>0</d2p1:StatementSummaryId>
      </d2p1:StatementSummaryDTO>
    </d2p1:StatementSummaries>
    <d2p1:TransactionBriefs>
      <d2p1:TransactionBriefDTO>
        <d2p1:ApproveDate>0001-01-01T00:00:00</d2p1:ApproveDate>
        <d2p1:BuyerId>0</d2p1:BuyerId>
        <d2p1:BuyerName>String</d2p1:BuyerName>
        <d2p1:CancelDate>0001-01-01T00:00:00</d2p1:CancelDate>
        <d2p1:CargoAmount>0</d2p1:CargoAmount>
        <d2p1:CommisionAmount>0</d2p1:CommisionAmount>
        <d2p1:MerchantPayout>0</d2p1:MerchantPayout>
        <d2p1:MerchantPayoutCCAmount>0</d2p1:MerchantPayoutCCAmount>
        <d2p1:MerchantPayoutOtherCostAmount>0</d2p1:MerchantPayoutOtherCostAmount>
        <d2p1:NetAmount>0</d2p1:NetAmount>
        <d2p1:OtherCostsAmount>0</d2p1:OtherCostsAmount>
        <d2p1:PaymentStatus>Unknown</d2p1:PaymentStatus>
        <d2p1:RefundTotal>0</d2p1:RefundTotal>
        <d2p1:SaleAmount>0</d2p1:SaleAmount>
        <d2p1:StatementId>0</d2p1:StatementId>
        <d2p1:Status>Draft</d2p1:Status>
        <d2p1:StoreId>0</d2p1:StoreId>
        <d2p1:TransDate>0001-01-01T00:00:00</d2p1:TransDate>
        <d2p1:TransId>0</d2p1:TransId>
        <d2p1:TransactionSummaries>
          <d2p1:TransactionSummaryDTO>
            <d2p1:AccountId>0</d2p1:AccountId>
            <d2p1:AccountName>String</d2p1:AccountName>
            <d2p1:AccountTransactionId>0</d2p1:AccountTransactionId>
            <d2p1:AccountTransactionTypeId>0</d2p1:AccountTransactionTypeId>
            <d2p1:AccountTransactionTypeName>String</d2p1:AccountTransactionTypeName>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
            <d2p1:PaymentId>0</d2p1:PaymentId>
            <d2p1:StatementId>0</d2p1:StatementId>
            <d2p1:TransId>0</d2p1:TransId>
            <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
          </d2p1:TransactionSummaryDTO>
        </d2p1:TransactionSummaries>
      </d2p1:TransactionBriefDTO>
    </d2p1:TransactionBriefs>
  </Statement>
</GetMyStatementResponse>