POST api/Catering/SendCorpInvoice

Request Information

URI Parameters

None.

Body Parameters

SendCorpInvoiceInput
NameDescriptionTypeAdditional information
OrderIds

Collection of integer

None.

CorpCompanyId

integer

None.

PeakCode

string

None.

InvoiceDate

string

None.

DueDate

string

None.

Request Formats

application/json, text/json

Sample:
{
  "orderIds": [
    1,
    2
  ],
  "corpCompanyId": 1,
  "peakCode": "sample string 2",
  "invoiceDate": "sample string 3",
  "dueDate": "sample string 4"
}

text/html

Sample:
{"orderIds":[1,2],"corpCompanyId":1,"peakCode":"sample string 2","invoiceDate":"sample string 3","dueDate":"sample string 4"}

application/xml, text/xml

Sample:
<SendCorpInvoiceInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EB.Service.Models.PeakApi">
  <CorpCompanyId>1</CorpCompanyId>
  <DueDate>sample string 4</DueDate>
  <InvoiceDate>sample string 3</InvoiceDate>
  <OrderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIds>
  <PeakCode>sample string 2</PeakCode>
</SendCorpInvoiceInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InvoiceView
NameDescriptionTypeAdditional information
Id

string

None.

Code

string

None.

DiscountTotal

string

None.

Tags

Collection of string

None.

Reference

string

None.

Status

string

None.

PreTaxAmount

decimal number

None.

VatAmount

decimal number

None.

NetAmount

decimal number

None.

PaymentAmount

decimal number

None.

OnlineViewLink

string

None.

ResCode

string

None.

ResDesc

string

None.

IssuedDate

string

None.

DueDate

string

None.

ContactId

string

None.

ContactCode

string

None.

IsTaxInvoice

integer

None.

PaidPayments

Collection of PaidPayment

None.

Products

Collection of ProductView

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "code": "sample string 2",
  "discountTotal": "sample string 3",
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "reference": "sample string 4",
  "status": "sample string 5",
  "preTaxAmount": 6.1,
  "vatAmount": 7.1,
  "netAmount": 8.1,
  "paymentAmount": 9.1,
  "onlineViewLink": "sample string 10",
  "resCode": "sample string 11",
  "resDesc": "sample string 12",
  "issuedDate": "sample string 13",
  "dueDate": "sample string 14",
  "contactId": "sample string 15",
  "contactCode": "sample string 16",
  "isTaxInvoice": 17,
  "paidPayments": [
    {
      "paymentDate": "sample string 1",
      "paymentGroupId": 2,
      "payments": [
        {
          "paymentMethodId": "sample string 1",
          "amount": 2.1
        },
        {
          "paymentMethodId": "sample string 1",
          "amount": 2.1
        }
      ]
    },
    {
      "paymentDate": "sample string 1",
      "paymentGroupId": 2,
      "payments": [
        {
          "paymentMethodId": "sample string 1",
          "amount": 2.1
        },
        {
          "paymentMethodId": "sample string 1",
          "amount": 2.1
        }
      ]
    }
  ],
  "products": [
    {
      "id": "sample string 1",
      "accountCode": "sample string 2",
      "description": "sample string 3",
      "quantity": 4,
      "price": 5.1,
      "discount": "sample string 6",
      "isDescription": 7,
      "vatType": 8
    },
    {
      "id": "sample string 1",
      "accountCode": "sample string 2",
      "description": "sample string 3",
      "quantity": 4,
      "price": 5.1,
      "discount": "sample string 6",
      "isDescription": 7,
      "vatType": 8
    }
  ]
}

text/html

Sample:
{"id":"sample string 1","code":"sample string 2","discountTotal":"sample string 3","tags":["sample string 1","sample string 2"],"reference":"sample string 4","status":"sample string 5","preTaxAmount":6.1,"vatAmount":7.1,"netAmount":8.1,"paymentAmount":9.1,"onlineViewLink":"sample string 10","resCode":"sample string 11","resDesc":"sample string 12","issuedDate":"sample string 13","dueDate":"sample string 14","contactId":"sample string 15","contactCode":"sample string 16","isTaxInvoice":17,"paidPayments":[{"paymentDate":"sample string 1","paymentGroupId":2,"payments":[{"paymentMethodId":"sample string 1","amount":2.1},{"paymentMethodId":"sample string 1","amount":2.1}]},{"paymentDate":"sample string 1","paymentGroupId":2,"payments":[{"paymentMethodId":"sample string 1","amount":2.1},{"paymentMethodId":"sample string 1","amount":2.1}]}],"products":[{"id":"sample string 1","accountCode":"sample string 2","description":"sample string 3","quantity":4,"price":5.1,"discount":"sample string 6","isDescription":7,"vatType":8},{"id":"sample string 1","accountCode":"sample string 2","description":"sample string 3","quantity":4,"price":5.1,"discount":"sample string 6","isDescription":7,"vatType":8}]}

application/xml, text/xml

Sample:
<InvoiceView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EB.Service.Models.PeakApi">
  <ContactCode>sample string 16</ContactCode>
  <ContactId>sample string 15</ContactId>
  <DueDate>sample string 14</DueDate>
  <IsTaxInvoice>17</IsTaxInvoice>
  <IssuedDate>sample string 13</IssuedDate>
  <PaidPayments>
    <PaidPayment>
      <PaymentDate>sample string 1</PaymentDate>
      <PaymentGroupId>2</PaymentGroupId>
      <Payments>
        <PeakPayment>
          <Amount>2.1</Amount>
          <PaymentMethodId>sample string 1</PaymentMethodId>
        </PeakPayment>
        <PeakPayment>
          <Amount>2.1</Amount>
          <PaymentMethodId>sample string 1</PaymentMethodId>
        </PeakPayment>
      </Payments>
    </PaidPayment>
    <PaidPayment>
      <PaymentDate>sample string 1</PaymentDate>
      <PaymentGroupId>2</PaymentGroupId>
      <Payments>
        <PeakPayment>
          <Amount>2.1</Amount>
          <PaymentMethodId>sample string 1</PaymentMethodId>
        </PeakPayment>
        <PeakPayment>
          <Amount>2.1</Amount>
          <PaymentMethodId>sample string 1</PaymentMethodId>
        </PeakPayment>
      </Payments>
    </PaidPayment>
  </PaidPayments>
  <Products>
    <ProductView>
      <AccountCode>sample string 2</AccountCode>
      <Description>sample string 3</Description>
      <Discount>sample string 6</Discount>
      <Id>sample string 1</Id>
      <IsDescription>7</IsDescription>
      <Price>5.1</Price>
      <Quantity>4</Quantity>
      <VatType>8</VatType>
    </ProductView>
    <ProductView>
      <AccountCode>sample string 2</AccountCode>
      <Description>sample string 3</Description>
      <Discount>sample string 6</Discount>
      <Id>sample string 1</Id>
      <IsDescription>7</IsDescription>
      <Price>5.1</Price>
      <Quantity>4</Quantity>
      <VatType>8</VatType>
    </ProductView>
  </Products>
  <Code>sample string 2</Code>
  <DiscountTotal>sample string 3</DiscountTotal>
  <Id>sample string 1</Id>
  <NetAmount>8.1</NetAmount>
  <OnlineViewLink>sample string 10</OnlineViewLink>
  <PaymentAmount>9.1</PaymentAmount>
  <PreTaxAmount>6.1</PreTaxAmount>
  <Reference>sample string 4</Reference>
  <ResCode>sample string 11</ResCode>
  <ResDesc>sample string 12</ResDesc>
  <Status>sample string 5</Status>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
  <VatAmount>7.1</VatAmount>
</InvoiceView>