POST api/CustomerActivityLedger/search

Retrieve CustomerActivityLedger by CustomerNumber and other optional parameters

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerId	CustomerID or CustomerNumber is required; displays Activity Ledger for this specific Customer	integer	None.
CustomerNumber	CustomerID or CustomerNumber is required; displays Activity Ledger for this specific Customer	string	None.
TransactionStartDate	displays activity after and including this date	string	None.
TransactionEndDate	displays activity before and including this date	string	None.
TransactionTypeID	numeric value for Transaction Type	integer	None.
TransactionType	Transaction Type: Invoice, Payment, Payment Applied, Check Rcvd, Credit, Applied Credit, Taken Credit, Unapplied Cash, etc.	string	None.
Amount	payment amount	decimal number	Required

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CustomerNumber": "sample string 2",
  "TransactionStartDate": "sample string 3",
  "TransactionEndDate": "sample string 4",
  "TransactionTypeID": 5,
  "TransactionType": "sample string 6",
  "Amount": 7.0
}

application/xml, text/xml

Sample:

<CustomerActivityLedgerSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Amount>7</Amount>
  <CustomerId>1</CustomerId>
  <CustomerNumber>sample string 2</CustomerNumber>
  <TransactionEndDate>sample string 4</TransactionEndDate>
  <TransactionStartDate>sample string 3</TransactionStartDate>
  <TransactionType>sample string 6</TransactionType>
  <TransactionTypeID>5</TransactionTypeID>
</CustomerActivityLedgerSearch>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerActivityLedgerSearch'.

Response Information

Resource Description

Collection of CustomerActivityLedger

Name	Description	Type	Additional information
TransactionDate	date this transaction will post to the GL	date	None.
TransactionTypeID	numeric value for Transaction Type	integer	None.
TransactionType	Transaction Type: Invoice, Payment, Payment Applied, Check Rcvd, Credit, Applied Credit, Taken Credit, Unapplied Cash, etc.	string	String length: inclusive between 0 and 25
Description	Description	string	String length: inclusive between 0 and 25
Amount	Amount	decimal number	Required
Balance	Balance	decimal number	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "TransactionDate": "2024-10-22T06:45:17.9006917-05:00",
    "TransactionTypeID": 2,
    "TransactionType": "sample string 3",
    "Description": "sample string 4",
    "Amount": 5.0,
    "Balance": 6.0
  },
  {
    "TransactionDate": "2024-10-22T06:45:17.9006917-05:00",
    "TransactionTypeID": 2,
    "TransactionType": "sample string 3",
    "Description": "sample string 4",
    "Amount": 5.0,
    "Balance": 6.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerActivityLedger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <CustomerActivityLedger>
    <Amount>5</Amount>
    <Balance>6</Balance>
    <Description>sample string 4</Description>
    <TransactionDate>2024-10-22T06:45:17.9006917-05:00</TransactionDate>
    <TransactionType>sample string 3</TransactionType>
    <TransactionTypeID>2</TransactionTypeID>
  </CustomerActivityLedger>
  <CustomerActivityLedger>
    <Amount>5</Amount>
    <Balance>6</Balance>
    <Description>sample string 4</Description>
    <TransactionDate>2024-10-22T06:45:17.9006917-05:00</TransactionDate>
    <TransactionType>sample string 3</TransactionType>
    <TransactionTypeID>2</TransactionTypeID>
  </CustomerActivityLedger>
</ArrayOfCustomerActivityLedger>