GET Report/CourierBalance?user={user}&start={start}&end={end}

Request Information

URI Parameters

Name	Type	Additional information
user	integer	Required
start	string	Required
end	string	Required

Body Parameters

None.

Response Information

Resource Description

CourierBalance

Name	Type	Additional information
Balance	decimal number	None.
History	Collection of CourierPaymentHistoryItem	None.
Report	CourierPackageDeliveryReportItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Balance": 1.1,
  "History": [
    {
      "CourierID": 1,
      "CourierName": "sample string 2",
      "Amount": 3.1,
      "Description": "sample string 4",
      "Type": "sample string 5",
      "Date": "sample string 6"
    },
    {
      "CourierID": 1,
      "CourierName": "sample string 2",
      "Amount": 3.1,
      "Description": "sample string 4",
      "Type": "sample string 5",
      "Date": "sample string 6"
    }
  ],
  "Report": {
    "ID": 1,
    "Name": "sample string 2",
    "PPP": 3.1,
    "Count": 4,
    "Earning": 5.1,
    "Payments": {
      "Cash": 1.1,
      "Card": 2.1,
      "Online": 3.1,
      "FoodCard": 4.1,
      "OnlineFoodCard": 5.1,
      "Other": 6.1,
      "Commission": 7.1,
      "Total": 8.1
    }
  }
}

application/xml, text/xml

Sample:

<CourierBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
  <Balance>1.1</Balance>
  <History>
    <CourierPaymentHistoryItem>
      <Amount>3.1</Amount>
      <CourierID>1</CourierID>
      <CourierName>sample string 2</CourierName>
      <Date>sample string 6</Date>
      <Description>sample string 4</Description>
      <Type>sample string 5</Type>
    </CourierPaymentHistoryItem>
    <CourierPaymentHistoryItem>
      <Amount>3.1</Amount>
      <CourierID>1</CourierID>
      <CourierName>sample string 2</CourierName>
      <Date>sample string 6</Date>
      <Description>sample string 4</Description>
      <Type>sample string 5</Type>
    </CourierPaymentHistoryItem>
  </History>
  <Report>
    <Count>4</Count>
    <Earning>5.1</Earning>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <PPP>3.1</PPP>
    <Payments>
      <Card>2.1</Card>
      <Cash>1.1</Cash>
      <Commission>7.1</Commission>
      <FoodCard>4.1</FoodCard>
      <Online>3.1</Online>
      <OnlineFoodCard>5.1</OnlineFoodCard>
      <Other>6.1</Other>
      <Total>8.1</Total>
    </Payments>
  </Report>
</CourierBalance>