POST api/Invoice

Renders an invoice using the provided model.

Request Information

URI Parameters

None.

Body Parameters

The invoice model used to render the invoice.

Name	Type	Additional information
CampaignName	string	None.
Forename	string	None.
Surname	string	None.
CompanyName	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
City	string	None.
Postcode	string	None.
DistributionDate	string	None.
OrderPublicId	string	None.
OrderId	string	None.
OrderReference	string	None.
Volume	integer	None.
CostExVat	decimal number	None.
CostInclVat	decimal number	None.
TenantName	string	None.
VoucherCode	string	None.
VoucherAmount	decimal number	None.
Transactions	Collection of TransactionModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignName": "sample string 1",
  "Forename": "sample string 2",
  "Surname": "sample string 3",
  "CompanyName": "sample string 4",
  "AddressLine1": "sample string 5",
  "AddressLine2": "sample string 6",
  "AddressLine3": "sample string 7",
  "AddressLine4": "sample string 8",
  "City": "sample string 9",
  "Postcode": "sample string 10",
  "DistributionDate": "sample string 11",
  "OrderPublicId": "sample string 12",
  "OrderId": "sample string 13",
  "OrderReference": "sample string 14",
  "Volume": 15,
  "CostExVat": 16.0,
  "CostInclVat": 17.0,
  "TenantName": "sample string 18",
  "VoucherCode": "sample string 19",
  "VoucherAmount": 1.0,
  "Transactions": [
    {
      "Amount": 1.0,
      "Type": "sample string 2"
    },
    {
      "Amount": 1.0,
      "Type": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Gmc.Models">
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <AddressLine3>sample string 7</AddressLine3>
  <AddressLine4>sample string 8</AddressLine4>
  <CampaignName>sample string 1</CampaignName>
  <City>sample string 9</City>
  <CompanyName>sample string 4</CompanyName>
  <CostExVat>16</CostExVat>
  <CostInclVat>17</CostInclVat>
  <DistributionDate>sample string 11</DistributionDate>
  <Forename>sample string 2</Forename>
  <OrderId>sample string 13</OrderId>
  <OrderPublicId>sample string 12</OrderPublicId>
  <OrderReference>sample string 14</OrderReference>
  <Postcode>sample string 10</Postcode>
  <Surname>sample string 3</Surname>
  <TenantName>sample string 18</TenantName>
  <Transactions>
    <InvoiceModel.TransactionModel>
      <Amount>1</Amount>
      <Type>sample string 2</Type>
    </InvoiceModel.TransactionModel>
    <InvoiceModel.TransactionModel>
      <Amount>1</Amount>
      <Type>sample string 2</Type>
    </InvoiceModel.TransactionModel>
  </Transactions>
  <Volume>15</Volume>
  <VoucherAmount>1</VoucherAmount>
  <VoucherCode>sample string 19</VoucherCode>
</InvoiceModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.