Needio.Services

<back to all web services

GetMyStatementsRequest

The following routes are available for this service:
All Verbs/GetMyStatements/
GetMyStatementsRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryintNo
YearqueryintNo
MonthqueryintNo
pagequeryintNo
countqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetMyStatementsResponse Parameters:
NameParameterData TypeRequiredDescription
StatementsformList<StatementDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
StatementDTO Parameters:
NameParameterData TypeRequiredDescription
StatementIdformintNo
StatementPeriodIdformintNo
StartDateformDateTimeNo
EndDateformDateTimeNo
PaymentDateformDateTimeNo
StatementAmountformdecimalNo
CommisionAmoutformdecimalNo
StatementPayOutformdecimalNo
CargoAmountformdecimalNo
OtherCostsAmountformdecimalNo
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
GetMyStatementsResponse Parameters:
NameParameterData TypeRequiredDescription
StatementsformList<StatementDTO>No

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 /GetMyStatements/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMyStatementsRequest 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>
  <Month>0</Month>
  <StoreId>0</StoreId>
  <Year>0</Year>
  <count>0</count>
  <page>0</page>
</GetMyStatementsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMyStatementsResponse 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>
  <Statements xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:StatementDTO>
      <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: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:StatementDTO>
  </Statements>
</GetMyStatementsResponse>