GET api/Invoice/GetInvoice?invoiceId={invoiceId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
invoiceId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

InvoiceResponseModel
NameDescriptionTypeAdditional information
InvoiceNumber

integer

None.

FinalAmountToBePaid

decimal number

None.

NextAmountToBePaid

decimal number

None.

PriceBreakdown

Collection of PriceResponseModel

None.

InvoiceId

string

None.

GSTFreeProduct

boolean

None.

LastPaymentMethod

string

None.

Result

ResponseResult

None.

Response Formats

application/json, text/json

Sample:
{
  "InvoiceNumber": 1,
  "FinalAmountToBePaid": 1.0,
  "NextAmountToBePaid": 1.0,
  "PriceBreakdown": [
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Id": "sample string 3"
    },
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Id": "sample string 3"
    }
  ],
  "InvoiceId": "sample string 2",
  "GSTFreeProduct": true,
  "LastPaymentMethod": "sample string 4",
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<InvoiceResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
  <FinalAmountToBePaid>1</FinalAmountToBePaid>
  <GSTFreeProduct>true</GSTFreeProduct>
  <InvoiceId>sample string 2</InvoiceId>
  <InvoiceNumber>1</InvoiceNumber>
  <LastPaymentMethod>sample string 4</LastPaymentMethod>
  <NextAmountToBePaid>1</NextAmountToBePaid>
  <PriceBreakdown>
    <PriceResponseModel>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
      <Id>sample string 3</Id>
    </PriceResponseModel>
    <PriceResponseModel>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
      <Id>sample string 3</Id>
    </PriceResponseModel>
  </PriceBreakdown>
</InvoiceResponseModel>