POST api/Invoice/SendInvoice

Request Information

URI Parameters

None.

Body Parameters

SendInvoiceRequest
NameDescriptionTypeAdditional information
OrderId

string

None.

OrderItemIds

Collection of string

None.

InvoiceTime

date

None.

VatExemptionReason

string

None.

VatExemptionReasonText

string

None.

InvoiceType

string

None.

InvoiceProfile

string

None.

ReturnInvoiceId

string

None.

ReturnDate

date

None.

Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderId": "sample string 1",
  "OrderItemIds": [
    "sample string 1",
    "sample string 2"
  ],
  "InvoiceTime": "2021-07-28T17:09:32.3644962+03:00",
  "VatExemptionReason": "sample string 3",
  "VatExemptionReasonText": "sample string 4",
  "InvoiceType": "sample string 5",
  "InvoiceProfile": "sample string 6",
  "ReturnInvoiceId": "sample string 7",
  "ReturnDate": "2021-07-28T17:09:32.3644962+03:00",
  "Token": "sample string 9"
}

application/xml, text/xml

Sample:
<SendInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Invoice">
  <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 9</Token>
  <InvoiceProfile>sample string 6</InvoiceProfile>
  <InvoiceTime>2021-07-28T17:09:32.3644962+03:00</InvoiceTime>
  <InvoiceType>sample string 5</InvoiceType>
  <OrderId>sample string 1</OrderId>
  <OrderItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OrderItemIds>
  <ReturnDate>2021-07-28T17:09:32.3644962+03:00</ReturnDate>
  <ReturnInvoiceId>sample string 7</ReturnInvoiceId>
  <VatExemptionReason>sample string 3</VatExemptionReason>
  <VatExemptionReasonText>sample string 4</VatExemptionReasonText>
</SendInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendInvoiceResponse
NameDescriptionTypeAdditional information
Uiid

string

None.

InvoiceStatus

integer

None.

InvoiceType

integer

None.

InvoiceId

string

None.

InvoiceScenario

string

None.

InvoiceTime

date

None.

InvoiceExists

boolean

None.

References

Collection of InvoiceItemResultReference

None.

ErrorCode

string

None.

ErrorMessage

string

None.

ErrorCategory

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Uiid": "sample string 1",
  "InvoiceStatus": 2,
  "InvoiceType": 3,
  "InvoiceId": "sample string 4",
  "InvoiceScenario": "sample string 5",
  "InvoiceTime": "2021-07-28T17:09:32.3644962+03:00",
  "InvoiceExists": true,
  "References": [
    {
      "Key1": "sample string 1",
      "Key2": "sample string 2",
      "Param": {}
    },
    {
      "Key1": "sample string 1",
      "Key2": "sample string 2",
      "Param": {}
    }
  ],
  "ErrorCode": "sample string 8",
  "ErrorMessage": "sample string 9",
  "ErrorCategory": "sample string 10",
  "Result": true
}

application/xml, text/xml

Sample:
<SendInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Invoice">
  <ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 10</ErrorCategory>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 8</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 9</ErrorMessage>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
  <InvoiceExists>true</InvoiceExists>
  <InvoiceId>sample string 4</InvoiceId>
  <InvoiceScenario>sample string 5</InvoiceScenario>
  <InvoiceStatus>2</InvoiceStatus>
  <InvoiceTime>2021-07-28T17:09:32.3644962+03:00</InvoiceTime>
  <InvoiceType>3</InvoiceType>
  <References>
    <InvoiceItemResultReference>
      <Key1>sample string 1</Key1>
      <Key2>sample string 2</Key2>
      <Param />
    </InvoiceItemResultReference>
    <InvoiceItemResultReference>
      <Key1>sample string 1</Key1>
      <Key2>sample string 2</Key2>
      <Param />
    </InvoiceItemResultReference>
  </References>
  <Uiid>sample string 1</Uiid>
</SendInvoiceResponse>