POST Report/CourierBalanceV2

Request Information

URI Parameters

None.

Body Parameters

ReportDate
NameDescriptionTypeAdditional information
CourierID

integer

None.

start

string

None.

end

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CourierID": 1,
  "start": "sample string 2",
  "end": "sample string 3"
}

application/xml, text/xml

Sample:
<ReportDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlpaslanKuryeMobilAPI.Models">
  <CourierID>1</CourierID>
  <end>sample string 3</end>
  <start>sample string 2</start>
</ReportDate>

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 'ReportDate'.

Response Information

Resource Description

CourierBalance
NameDescriptionTypeAdditional 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/AlpaslanKuryeMobilAPI.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>