POST api/Partner/SendInvoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TerminalId	string	None.
Invoice	TerminalInvoice	None.
SendingSettings	SendingSettings	None.
Token	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TerminalId": "sample string 1",
  "Invoice": {
    "DocumentNumber": "sample string 1",
    "InvoiceTitle": "sample string 2",
    "IssueDate": "2024-11-21T14:22:53.6195753+03:00",
    "CustomerName": "sample string 4",
    "CustomerEmail": "sample string 5",
    "Lines": [
      {
        "MerchantSku": "sample string 1",
        "Quantity": 2.0,
        "Price": 3.0,
        "Currency": "sample string 4",
        "ProductName": "sample string 5",
        "ProductImage": "sample string 6",
        "ProductTaxRate": 7.0,
        "ProductVariantPhrase": "sample string 8",
        "LineOrder": 9,
        "Unit": "sample string 10",
        "LineDiscounts": [
          {
            "Title": "sample string 2",
            "Percentage": 3.0,
            "Value": 4.0,
            "Order": 5
          },
          {
            "Title": "sample string 2",
            "Percentage": 3.0,
            "Value": 4.0,
            "Order": 5
          }
        ]
      },
      {
        "MerchantSku": "sample string 1",
        "Quantity": 2.0,
        "Price": 3.0,
        "Currency": "sample string 4",
        "ProductName": "sample string 5",
        "ProductImage": "sample string 6",
        "ProductTaxRate": 7.0,
        "ProductVariantPhrase": "sample string 8",
        "LineOrder": 9,
        "Unit": "sample string 10",
        "LineDiscounts": [
          {
            "Title": "sample string 2",
            "Percentage": 3.0,
            "Value": 4.0,
            "Order": 5
          },
          {
            "Title": "sample string 2",
            "Percentage": 3.0,
            "Value": 4.0,
            "Order": 5
          }
        ]
      }
    ],
    "Note": "sample string 6",
    "InvoiceAddress": {
      "AddressId": "sample string 1",
      "UserId": "sample string 2",
      "UserAddressCompanyTypeId": 64,
      "Description": "sample string 4",
      "CompanyTitle": "sample string 5",
      "ContactTitle": "sample string 6",
      "Email": "sample string 7",
      "PhoneNumber": "sample string 8",
      "Website": "sample string 9",
      "Fax": "sample string 10",
      "TaxAuthority": "sample string 11",
      "TaxNumber": "sample string 12",
      "AddressLine1": "sample string 13",
      "AddressLine2": "sample string 14",
      "Neighborhood": "sample string 15",
      "District": "sample string 16",
      "City": "sample string 17",
      "PostalCode": "sample string 18",
      "Country": "sample string 19"
    },
    "DeliveryAddress": {
      "AddressId": "sample string 1",
      "UserId": "sample string 2",
      "UserAddressCompanyTypeId": 64,
      "Description": "sample string 4",
      "CompanyTitle": "sample string 5",
      "ContactTitle": "sample string 6",
      "Email": "sample string 7",
      "PhoneNumber": "sample string 8",
      "Website": "sample string 9",
      "Fax": "sample string 10",
      "TaxAuthority": "sample string 11",
      "TaxNumber": "sample string 12",
      "AddressLine1": "sample string 13",
      "AddressLine2": "sample string 14",
      "Neighborhood": "sample string 15",
      "District": "sample string 16",
      "City": "sample string 17",
      "PostalCode": "sample string 18",
      "Country": "sample string 19"
    }
  },
  "SendingSettings": {
    "InvoiceTime": "2024-11-21T14:22:53.6350912+03:00",
    "VatExemptionReason": "sample string 2",
    "VatExemptionReasonText": "sample string 3",
    "InvoiceType": "sample string 4",
    "InvoiceProfile": "sample string 5"
  },
  "Token": "sample string 2"
}

application/xml, text/xml

Sample:

<SendTerminalInvoiceRequest 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 2</Token>
  <Invoice>
    <CustomerEmail>sample string 5</CustomerEmail>
    <CustomerName>sample string 4</CustomerName>
    <DeliveryAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account">
      <d3p1:AddressId>sample string 1</d3p1:AddressId>
      <d3p1:AddressLine1>sample string 13</d3p1:AddressLine1>
      <d3p1:AddressLine2>sample string 14</d3p1:AddressLine2>
      <d3p1:City>sample string 17</d3p1:City>
      <d3p1:CompanyTitle>sample string 5</d3p1:CompanyTitle>
      <d3p1:ContactTitle>sample string 6</d3p1:ContactTitle>
      <d3p1:Country>sample string 19</d3p1:Country>
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:District>sample string 16</d3p1:District>
      <d3p1:Email>sample string 7</d3p1:Email>
      <d3p1:Fax>sample string 10</d3p1:Fax>
      <d3p1:Neighborhood>sample string 15</d3p1:Neighborhood>
      <d3p1:PhoneNumber>sample string 8</d3p1:PhoneNumber>
      <d3p1:PostalCode>sample string 18</d3p1:PostalCode>
      <d3p1:TaxAuthority>sample string 11</d3p1:TaxAuthority>
      <d3p1:TaxNumber>sample string 12</d3p1:TaxNumber>
      <d3p1:UserAddressCompanyTypeId>64</d3p1:UserAddressCompanyTypeId>
      <d3p1:UserId>sample string 2</d3p1:UserId>
      <d3p1:Website>sample string 9</d3p1:Website>
    </DeliveryAddress>
    <DocumentNumber>sample string 1</DocumentNumber>
    <InvoiceAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Account">
      <d3p1:AddressId>sample string 1</d3p1:AddressId>
      <d3p1:AddressLine1>sample string 13</d3p1:AddressLine1>
      <d3p1:AddressLine2>sample string 14</d3p1:AddressLine2>
      <d3p1:City>sample string 17</d3p1:City>
      <d3p1:CompanyTitle>sample string 5</d3p1:CompanyTitle>
      <d3p1:ContactTitle>sample string 6</d3p1:ContactTitle>
      <d3p1:Country>sample string 19</d3p1:Country>
      <d3p1:Description>sample string 4</d3p1:Description>
      <d3p1:District>sample string 16</d3p1:District>
      <d3p1:Email>sample string 7</d3p1:Email>
      <d3p1:Fax>sample string 10</d3p1:Fax>
      <d3p1:Neighborhood>sample string 15</d3p1:Neighborhood>
      <d3p1:PhoneNumber>sample string 8</d3p1:PhoneNumber>
      <d3p1:PostalCode>sample string 18</d3p1:PostalCode>
      <d3p1:TaxAuthority>sample string 11</d3p1:TaxAuthority>
      <d3p1:TaxNumber>sample string 12</d3p1:TaxNumber>
      <d3p1:UserAddressCompanyTypeId>64</d3p1:UserAddressCompanyTypeId>
      <d3p1:UserId>sample string 2</d3p1:UserId>
      <d3p1:Website>sample string 9</d3p1:Website>
    </InvoiceAddress>
    <InvoiceTitle>sample string 2</InvoiceTitle>
    <IssueDate>2024-11-21T14:22:53.6195753+03:00</IssueDate>
    <Lines>
      <TerminalInvoiceLine>
        <Currency>sample string 4</Currency>
        <LineDiscounts>
          <LineDiscount>
            <DiscountType>1</DiscountType>
            <Order>5</Order>
            <Percentage>3</Percentage>
            <Title>sample string 2</Title>
            <Value>4</Value>
          </LineDiscount>
          <LineDiscount>
            <DiscountType>1</DiscountType>
            <Order>5</Order>
            <Percentage>3</Percentage>
            <Title>sample string 2</Title>
            <Value>4</Value>
          </LineDiscount>
        </LineDiscounts>
        <LineOrder>9</LineOrder>
        <MerchantSku>sample string 1</MerchantSku>
        <Price>3</Price>
        <ProductImage>sample string 6</ProductImage>
        <ProductName>sample string 5</ProductName>
        <ProductTaxRate>7</ProductTaxRate>
        <ProductVariantPhrase>sample string 8</ProductVariantPhrase>
        <Quantity>2</Quantity>
        <Unit>sample string 10</Unit>
      </TerminalInvoiceLine>
      <TerminalInvoiceLine>
        <Currency>sample string 4</Currency>
        <LineDiscounts>
          <LineDiscount>
            <DiscountType>1</DiscountType>
            <Order>5</Order>
            <Percentage>3</Percentage>
            <Title>sample string 2</Title>
            <Value>4</Value>
          </LineDiscount>
          <LineDiscount>
            <DiscountType>1</DiscountType>
            <Order>5</Order>
            <Percentage>3</Percentage>
            <Title>sample string 2</Title>
            <Value>4</Value>
          </LineDiscount>
        </LineDiscounts>
        <LineOrder>9</LineOrder>
        <MerchantSku>sample string 1</MerchantSku>
        <Price>3</Price>
        <ProductImage>sample string 6</ProductImage>
        <ProductName>sample string 5</ProductName>
        <ProductTaxRate>7</ProductTaxRate>
        <ProductVariantPhrase>sample string 8</ProductVariantPhrase>
        <Quantity>2</Quantity>
        <Unit>sample string 10</Unit>
      </TerminalInvoiceLine>
    </Lines>
    <Note>sample string 6</Note>
  </Invoice>
  <SendingSettings>
    <InvoiceProfile>sample string 5</InvoiceProfile>
    <InvoiceTime>2024-11-21T14:22:53.6350912+03:00</InvoiceTime>
    <InvoiceType>sample string 4</InvoiceType>
    <VatExemptionReason>sample string 2</VatExemptionReason>
    <VatExemptionReasonText>sample string 3</VatExemptionReasonText>
  </SendingSettings>
  <TerminalId>sample string 1</TerminalId>
</SendTerminalInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendInvoiceResponse

Name	Type	Additional information
Uiid	string	None.
InvoiceStatus	integer	None.
InvoiceType	integer	None.
InvoiceId	string	None.
CustomerInvoiceId	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",
  "CustomerInvoiceId": "sample string 5",
  "InvoiceScenario": "sample string 6",
  "InvoiceTime": "2024-11-21T14:22:53.6507435+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 9",
  "ErrorMessage": "sample string 10",
  "ErrorCategory": "sample string 11",
  "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 11</ErrorCategory>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 9</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 10</ErrorMessage>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
  <CustomerInvoiceId>sample string 5</CustomerInvoiceId>
  <InvoiceExists>true</InvoiceExists>
  <InvoiceId>sample string 4</InvoiceId>
  <InvoiceScenario>sample string 6</InvoiceScenario>
  <InvoiceStatus>2</InvoiceStatus>
  <InvoiceTime>2024-11-21T14:22:53.6507435+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>