POST api/pod/billing/ListInvoice

Request Information

URI Parameters

None.

Body Parameters

ListInvoiceBindingModel
NameDescriptionTypeAdditional information
UserId

integer

None.

BillNumber

string

None.

FromDate

string

None.

ToDate

string

None.

PageSize

integer

Required

PageOffset

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "BillNumber": "sample string 2",
  "FromDate": "sample string 3",
  "ToDate": "sample string 4",
  "PageSize": 5,
  "PageOffset": 6
}

application/xml, text/xml

Sample:
<ListInvoiceBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Barg.WebAPI.Models">
  <PageOffset>6</PageOffset>
  <PageSize>5</PageSize>
  <BillNumber>sample string 2</BillNumber>
  <FromDate>sample string 3</FromDate>
  <ToDate>sample string 4</ToDate>
  <UserId>1</UserId>
</ListInvoiceBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ListInvoiceViewModel
NameDescriptionTypeAdditional information
Data

Collection of InvoiceDetail

None.

HasErrors

boolean

None.

Messages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "MaskedCardNumber": "sample string 1",
      "LastFourDigits": "sample string 2",
      "IsSuccessful": true,
      "TotalAmount": 4.0,
      "UserInfo": {
        "UserId": 1,
        "SssoId": "sample string 2",
        "SsoIssuerCode": 3,
        "Name": "sample string 4",
        "ProfileImage": "sample string 5",
        "Email": "sample string 6",
        "PhoneNumber": "sample string 7",
        "NationalCode": "sample string 8"
      },
      "InvoiceItems": [
        {
          "EntityId": 1,
          "Quantity": 2.0,
          "Price": 3.0,
          "Description": "sample string 4"
        },
        {
          "EntityId": 1,
          "Quantity": 2.0,
          "Price": 3.0,
          "Description": "sample string 4"
        }
      ],
      "PayableAmount": 5.0,
      "LastFourDigitsOfCardNumber": "sample string 6"
    },
    {
      "MaskedCardNumber": "sample string 1",
      "LastFourDigits": "sample string 2",
      "IsSuccessful": true,
      "TotalAmount": 4.0,
      "UserInfo": {
        "UserId": 1,
        "SssoId": "sample string 2",
        "SsoIssuerCode": 3,
        "Name": "sample string 4",
        "ProfileImage": "sample string 5",
        "Email": "sample string 6",
        "PhoneNumber": "sample string 7",
        "NationalCode": "sample string 8"
      },
      "InvoiceItems": [
        {
          "EntityId": 1,
          "Quantity": 2.0,
          "Price": 3.0,
          "Description": "sample string 4"
        },
        {
          "EntityId": 1,
          "Quantity": 2.0,
          "Price": 3.0,
          "Description": "sample string 4"
        }
      ],
      "PayableAmount": 5.0,
      "LastFourDigitsOfCardNumber": "sample string 6"
    }
  ],
  "HasErrors": false,
  "Messages": []
}

application/xml, text/xml

Sample:
<ListInvoiceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Barg.WebAPI.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Data>
    <InvoiceDetail>
      <InvoiceItems>
        <InvoiceItemBindingModel>
          <Description>sample string 4</Description>
          <EntityId>1</EntityId>
          <Price>3</Price>
          <Quantity>2</Quantity>
        </InvoiceItemBindingModel>
        <InvoiceItemBindingModel>
          <Description>sample string 4</Description>
          <EntityId>1</EntityId>
          <Price>3</Price>
          <Quantity>2</Quantity>
        </InvoiceItemBindingModel>
      </InvoiceItems>
      <IsSuccessful>true</IsSuccessful>
      <LastFourDigits>sample string 2</LastFourDigits>
      <MaskedCardNumber>sample string 1</MaskedCardNumber>
      <TotalAmount>4</TotalAmount>
      <UserInfo>
        <Email>sample string 6</Email>
        <Name>sample string 4</Name>
        <NationalCode>sample string 8</NationalCode>
        <PhoneNumber>sample string 7</PhoneNumber>
        <ProfileImage>sample string 5</ProfileImage>
        <SsoIssuerCode>3</SsoIssuerCode>
        <SssoId>sample string 2</SssoId>
        <UserId>1</UserId>
      </UserInfo>
    </InvoiceDetail>
    <InvoiceDetail>
      <InvoiceItems>
        <InvoiceItemBindingModel>
          <Description>sample string 4</Description>
          <EntityId>1</EntityId>
          <Price>3</Price>
          <Quantity>2</Quantity>
        </InvoiceItemBindingModel>
        <InvoiceItemBindingModel>
          <Description>sample string 4</Description>
          <EntityId>1</EntityId>
          <Price>3</Price>
          <Quantity>2</Quantity>
        </InvoiceItemBindingModel>
      </InvoiceItems>
      <IsSuccessful>true</IsSuccessful>
      <LastFourDigits>sample string 2</LastFourDigits>
      <MaskedCardNumber>sample string 1</MaskedCardNumber>
      <TotalAmount>4</TotalAmount>
      <UserInfo>
        <Email>sample string 6</Email>
        <Name>sample string 4</Name>
        <NationalCode>sample string 8</NationalCode>
        <PhoneNumber>sample string 7</PhoneNumber>
        <ProfileImage>sample string 5</ProfileImage>
        <SsoIssuerCode>3</SsoIssuerCode>
        <SssoId>sample string 2</SssoId>
        <UserId>1</UserId>
      </UserInfo>
    </InvoiceDetail>
  </Data>
</ListInvoiceViewModel>