POST api/Customers/AccountActivitySearch

Retrieve customer account activity/history (i.e. payments, sales, adjustments.)

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.clsAccountActivitySearchArgs

Name	Type	Additional information
Till	integer	None.
Receipt	integer	None.
CustomerID	string	None.
DateFrom	date	None.
DateTo	date	None.
Types	Collection of EskimoClassLibraries.clsAccountActivity+AccountActivityTypeEnum	Required

Request Formats

application/json, text/json

Sample:

{
  "Till": 1,
  "Receipt": 1,
  "CustomerID": "sample string 1",
  "DateFrom": "2024-05-03T13:55:54.0093626+01:00",
  "DateTo": "2024-05-03T13:55:54.0093626+01:00",
  "Types": [
    0,
    0
  ]
}

application/xml, text/xml

Sample:

<clsAccountActivitySearchArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CustomerID>sample string 1</CustomerID>
  <DateFrom>2024-05-03T13:55:54.0093626+01:00</DateFrom>
  <DateTo>2024-05-03T13:55:54.0093626+01:00</DateTo>
  <Receipt>1</Receipt>
  <Till>1</Till>
  <Types>
    <clsAccountActivity.AccountActivityTypeEnum>OpeningBalance</clsAccountActivity.AccountActivityTypeEnum>
    <clsAccountActivity.AccountActivityTypeEnum>OpeningBalance</clsAccountActivity.AccountActivityTypeEnum>
  </Types>
</clsAccountActivitySearchArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsAccountActivityInfo

Name	Type	Additional information
Id	integer	None.
EntryIndex	integer	None.
ActivityTypeText	string	None.
ActivityType	EskimoClassLibraries.clsAccountActivity+AccountActivityTypeEnum	Required
ActivityDate	date	Required
BalanceBefore	decimal number	None.
Amount	decimal number	Required
BalanceAfter	decimal number	None.
CustomerID	string	Required Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10
Till	integer	None.
Receipt	integer	None.
InvoiceId	integer	None.
WebOrderId	integer	None.
OrderExternalId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "EntryIndex": 2,
    "ActivityTypeText": "OpeningBalance",
    "ActivityType": 0,
    "ActivityDate": "2024-05-03T13:55:54.0249935+01:00",
    "BalanceBefore": 4.0,
    "Amount": 5.0,
    "BalanceAfter": 6.0,
    "CustomerID": "sample string 7",
    "Till": 1,
    "Receipt": 1,
    "InvoiceId": 1,
    "WebOrderId": 1,
    "OrderExternalId": "sample string 8"
  },
  {
    "Id": 1,
    "EntryIndex": 2,
    "ActivityTypeText": "OpeningBalance",
    "ActivityType": 0,
    "ActivityDate": "2024-05-03T13:55:54.0249935+01:00",
    "BalanceBefore": 4.0,
    "Amount": 5.0,
    "BalanceAfter": 6.0,
    "CustomerID": "sample string 7",
    "Till": 1,
    "Receipt": 1,
    "InvoiceId": 1,
    "WebOrderId": 1,
    "OrderExternalId": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsAccountActivityInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsAccountActivityInfo>
    <ActivityDate>2024-05-03T13:55:54.0249935+01:00</ActivityDate>
    <ActivityType>OpeningBalance</ActivityType>
    <Amount>5</Amount>
    <BalanceAfter>6</BalanceAfter>
    <BalanceBefore>4</BalanceBefore>
    <CustomerID>sample string 7</CustomerID>
    <InvoiceId>1</InvoiceId>
    <OrderExternalId>sample string 8</OrderExternalId>
    <Receipt>1</Receipt>
    <Till>1</Till>
    <WebOrderId>1</WebOrderId>
    <EntryIndex>2</EntryIndex>
    <Id>1</Id>
  </clsAccountActivityInfo>
  <clsAccountActivityInfo>
    <ActivityDate>2024-05-03T13:55:54.0249935+01:00</ActivityDate>
    <ActivityType>OpeningBalance</ActivityType>
    <Amount>5</Amount>
    <BalanceAfter>6</BalanceAfter>
    <BalanceBefore>4</BalanceBefore>
    <CustomerID>sample string 7</CustomerID>
    <InvoiceId>1</InvoiceId>
    <OrderExternalId>sample string 8</OrderExternalId>
    <Receipt>1</Receipt>
    <Till>1</Till>
    <WebOrderId>1</WebOrderId>
    <EntryIndex>2</EntryIndex>
    <Id>1</Id>
  </clsAccountActivityInfo>
</ArrayOfclsAccountActivityInfo>