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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	statement: 0,
	start: 2021-11-29T03:15:50.5868921+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Statement: 
	{
		TransactionBriefs: 
		[
			{
				TransId: 0,
				StoreId: 0,
				StatementId: 0,
				BuyerId: 0,
				Status: 0,
				PaymentStatus: 0,
				BuyerName: String,
				TransDate: 0001-01-01,
				ApproveDate: 0001-01-01,
				CancelDate: 0001-01-01,
				SaleAmount: 0,
				RefundTotal: 0,
				NetAmount: 0,
				MerchantPayout: 0,
				MerchantPayoutCCAmount: 0,
				MerchantPayoutOtherCostAmount: 0,
				CommisionAmount: 0,
				CargoAmount: 0,
				OtherCostsAmount: 0,
				TransactionSummaries: 
				[
					{
						AccountTransactionId: 0,
						TransId: 0,
						PaymentId: 0,
						StatementId: 0,
						AccountId: 0,
						AccountName: String,
						AccountTransactionTypeId: 0,
						AccountTransactionTypeName: String,
						Description: String,
						TransactionDate: 0001-01-01,
						PaymentDate: 0001-01-01,
						Amount: 0
					}
				]
			}
		],
		StatementSummaries: 
		[
			{
				StatementSummaryId: 0,
				StatementId: 0,
				AccountId: 0,
				AccountName: String,
				AccountTransactionTypeId: 0,
				AccountTransactionTypeName: String,
				Description: String,
				Amount: 0
			}
		],
		StatementId: 0,
		StatementPeriodId: 0,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		PaymentDate: 0001-01-01,
		StatementAmount: 0,
		CommisionAmout: 0,
		StatementPayOut: 0,
		CargoAmount: 0,
		OtherCostsAmount: 0,
		StatementPayOutCCAmount: 0,
		StatementPayOutOtherAmount: 0,
		IsCompleted: False,
		StatementPeriod: 
		{
			StatementPeriodId: 0,
			Year: 0,
			Period: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			PaymentDate: 0001-01-01
		},
		StoreId: 0,
		Store: 
		{
			StoreId: 0,
			StoreName: String,
			StoreHeader: String,
			Description: String,
			PostTypeId: 0,
			FriendlyURL: String,
			StoreCategory1Id: 0,
			StoreSubCategory1Id: 0
		}
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}