GET api/WebApiOdata/GetShopperLedgers?shopperID={shopperID}&providerID={providerID}&ledgerid={ledgerid}&fromdate={fromdate}&todate={todate}&nameFrom={nameFrom}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopperID

integer

Required

providerID

integer

Default value is 0

ledgerid

integer

Default value is 0

fromdate

string

Default value is

todate

string

Default value is

nameFrom

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of MyAccountShopperLedgersViewModel
NameDescriptionTypeAdditional information
ShopperLedgerHistoryID

integer

None.

PaymentProgramName

string

None.

Date

date

None.

ShopperID

integer

None.

LedgerID

integer

None.

PaymentProgrammID

integer

None.

LedgerName

string

None.

PreviousAmount

decimal number

None.

AdjustedAmount

decimal number

None.

AdjustmentType

integer

None.

LastestAmount

decimal number

None.

TermNumber

integer

None.

Reason

string

None.

CreatedUserName

string

None.

AdjustMentName

string

None.

DateDisplay

string

None.

Response Formats

application/json, text/json, text/html

Sample:
[
  {
    "ShopperLedgerHistoryID": 1,
    "PaymentProgramName": "sample string 2",
    "Date": "9/19/2024",
    "ShopperID": 4,
    "LedgerID": 5,
    "PaymentProgrammID": 6,
    "LedgerName": "sample string 7",
    "PreviousAmount": 8.1,
    "AdjustedAmount": 9.1,
    "AdjustmentType": 10,
    "LastestAmount": 11.1,
    "TermNumber": 12,
    "Reason": "sample string 13",
    "CreatedUserName": "sample string 14",
    "AdjustMentName": "sample string 15",
    "DateDisplay": "09/19/2024"
  },
  {
    "ShopperLedgerHistoryID": 1,
    "PaymentProgramName": "sample string 2",
    "Date": "9/19/2024",
    "ShopperID": 4,
    "LedgerID": 5,
    "PaymentProgrammID": 6,
    "LedgerName": "sample string 7",
    "PreviousAmount": 8.1,
    "AdjustedAmount": 9.1,
    "AdjustmentType": 10,
    "LastestAmount": 11.1,
    "TermNumber": 12,
    "Reason": "sample string 13",
    "CreatedUserName": "sample string 14",
    "AdjustMentName": "sample string 15",
    "DateDisplay": "09/19/2024"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMyAccountShopperLedgersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Settings">
  <MyAccountShopperLedgersViewModel>
    <AdjustMentName>sample string 15</AdjustMentName>
    <AdjustedAmount>9.1</AdjustedAmount>
    <AdjustmentType>10</AdjustmentType>
    <CreatedUserName>sample string 14</CreatedUserName>
    <Date>2024-09-19T08:35:43.9830634+00:00</Date>
    <LastestAmount>11.1</LastestAmount>
    <LedgerID>5</LedgerID>
    <LedgerName>sample string 7</LedgerName>
    <PaymentProgramName>sample string 2</PaymentProgramName>
    <PaymentProgrammID>6</PaymentProgrammID>
    <PreviousAmount>8.1</PreviousAmount>
    <Reason>sample string 13</Reason>
    <ShopperID>4</ShopperID>
    <ShopperLedgerHistoryID>1</ShopperLedgerHistoryID>
    <TermNumber>12</TermNumber>
  </MyAccountShopperLedgersViewModel>
  <MyAccountShopperLedgersViewModel>
    <AdjustMentName>sample string 15</AdjustMentName>
    <AdjustedAmount>9.1</AdjustedAmount>
    <AdjustmentType>10</AdjustmentType>
    <CreatedUserName>sample string 14</CreatedUserName>
    <Date>2024-09-19T08:35:43.9830634+00:00</Date>
    <LastestAmount>11.1</LastestAmount>
    <LedgerID>5</LedgerID>
    <LedgerName>sample string 7</LedgerName>
    <PaymentProgramName>sample string 2</PaymentProgramName>
    <PaymentProgrammID>6</PaymentProgrammID>
    <PreviousAmount>8.1</PreviousAmount>
    <Reason>sample string 13</Reason>
    <ShopperID>4</ShopperID>
    <ShopperLedgerHistoryID>1</ShopperLedgerHistoryID>
    <TermNumber>12</TermNumber>
  </MyAccountShopperLedgersViewModel>
</ArrayOfMyAccountShopperLedgersViewModel>