POST api/Public/SetInvoice

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Integrator		Integrator	None.
Invoice		Invoice	None.

Request Formats

application/json, text/json

Sample:

{
  "Integrator": {
    "Name": "sample string 1",
    "Identifier": "sample string 2",
    "Params": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2",
        "Description": "sample string 3"
      }
    ]
  },
  "Invoice": {
    "InvoiceProfile": "sample string 1",
    "Type": "sample string 2",
    "SendingType": "sample string 3",
    "Uuid": "sample string 4",
    "IssueDate": "sample string 5",
    "IssueTime": "2025-01-30T17:37:23.3034853+03:00",
    "InvoiceNumber": "sample string 7",
    "Currency": "sample string 8",
    "LineExtensionAmount": 9,
    "TaxExclusiveAmount": 10.0,
    "TaxInclusiveAmount": 11,
    "AllowanceTotalAmount": 12,
    "ChargeTotalAmount": 13,
    "PayableAmount": 14,
    "Lines": [
      {
        "Quantity": 1.0,
        "QuantityType": "sample string 2",
        "ProductName": "sample string 3",
        "UnitPrice": 4.0,
        "TotalUnitPrice": 5.0,
        "LineExtensionAmount": 6.0,
        "AllowanceCharges": [
          {
            "Amount": 1.0,
            "Percent": 2.0,
            "BaseAmount": 3.0
          },
          {
            "Amount": 1.0,
            "Percent": 2.0,
            "BaseAmount": 3.0
          }
        ],
        "Tax": {
          "Amount": 1.0,
          "TaxSubtotals": [
            {
              "TaxExemptionReasonCode": "sample string 1",
              "TaxExemptionReason": "sample string 2",
              "TaxableAmount": 3.0,
              "TaxAmount": 4.0,
              "Percent": 5
            },
            {
              "TaxExemptionReasonCode": "sample string 1",
              "TaxExemptionReason": "sample string 2",
              "TaxableAmount": 3.0,
              "TaxAmount": 4.0,
              "Percent": 5
            }
          ]
        },
        "WithholdingTaxTotal": {
          "TaxAmount": 1.0,
          "TaxSubTotals": [
            {
              "TaxableAmount": 1.0,
              "TaxAmount": 2.0,
              "Percent": 3,
              "Name": "sample string 4",
              "Code": "sample string 5"
            },
            {
              "TaxableAmount": 1.0,
              "TaxAmount": 2.0,
              "Percent": 3,
              "Name": "sample string 4",
              "Code": "sample string 5"
            }
          ]
        },
        "ProductDescription": "sample string 7"
      },
      {
        "Quantity": 1.0,
        "QuantityType": "sample string 2",
        "ProductName": "sample string 3",
        "UnitPrice": 4.0,
        "TotalUnitPrice": 5.0,
        "LineExtensionAmount": 6.0,
        "AllowanceCharges": [
          {
            "Amount": 1.0,
            "Percent": 2.0,
            "BaseAmount": 3.0
          },
          {
            "Amount": 1.0,
            "Percent": 2.0,
            "BaseAmount": 3.0
          }
        ],
        "Tax": {
          "Amount": 1.0,
          "TaxSubtotals": [
            {
              "TaxExemptionReasonCode": "sample string 1",
              "TaxExemptionReason": "sample string 2",
              "TaxableAmount": 3.0,
              "TaxAmount": 4.0,
              "Percent": 5
            },
            {
              "TaxExemptionReasonCode": "sample string 1",
              "TaxExemptionReason": "sample string 2",
              "TaxableAmount": 3.0,
              "TaxAmount": 4.0,
              "Percent": 5
            }
          ]
        },
        "WithholdingTaxTotal": {
          "TaxAmount": 1.0,
          "TaxSubTotals": [
            {
              "TaxableAmount": 1.0,
              "TaxAmount": 2.0,
              "Percent": 3,
              "Name": "sample string 4",
              "Code": "sample string 5"
            },
            {
              "TaxableAmount": 1.0,
              "TaxAmount": 2.0,
              "Percent": 3,
              "Name": "sample string 4",
              "Code": "sample string 5"
            }
          ]
        },
        "ProductDescription": "sample string 7"
      }
    ],
    "Customer": {
      "Vkn": "sample string 1",
      "CompanyName": "sample string 2",
      "TaxOffice": "sample string 3",
      "CompanyAddress": {
        "Name": "sample string 1",
        "Country": "sample string 2",
        "PostalZone": "sample string 3",
        "CityName": "sample string 4",
        "CitySubdivisionName": "sample string 5",
        "BuildingNumber": "sample string 6",
        "BuildingName": "sample string 7",
        "StreetName": "sample string 8"
      },
      "Contact": {
        "Telephone": "sample string 1",
        "Fax": "sample string 2",
        "Email": "sample string 3"
      },
      "Person": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2"
      }
    },
    "Supplier": {
      "Vkn": "sample string 1",
      "CompanyName": "sample string 2",
      "TaxOffice": "sample string 3",
      "CompanyAddress": {
        "Name": "sample string 1",
        "Country": "sample string 2",
        "PostalZone": "sample string 3",
        "CityName": "sample string 4",
        "CitySubdivisionName": "sample string 5",
        "BuildingNumber": "sample string 6",
        "BuildingName": "sample string 7",
        "StreetName": "sample string 8"
      },
      "Contact": {
        "Telephone": "sample string 1",
        "Fax": "sample string 2",
        "Email": "sample string 3"
      },
      "Person": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2"
      }
    },
    "AllowanceCharge": {
      "Amount": 1.0,
      "Percent": 2.0,
      "BaseAmount": 3.0
    },
    "WithholdingTaxTotal": {
      "TaxAmount": 1.0,
      "TaxSubTotals": [
        {
          "TaxableAmount": 1.0,
          "TaxAmount": 2.0,
          "Percent": 3,
          "Name": "sample string 4",
          "Code": "sample string 5"
        },
        {
          "TaxableAmount": 1.0,
          "TaxAmount": 2.0,
          "Percent": 3,
          "Name": "sample string 4",
          "Code": "sample string 5"
        }
      ]
    },
    "Notes": [
      "sample string 1",
      "sample string 2"
    ],
    "SendMail": true,
    "UseDefaultXslt": 16,
    "CustomerUuid": "sample string 17",
    "PaymentMeans": {
      "PaymentMeansCode": "sample string 1",
      "PaymentChannelCode": "sample string 2",
      "PaymentDueDate": "2025-01-30T17:37:23.3034853+03:00",
      "InstructionNote": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:

<SetTerminalInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Invoice">
  <Integrator>
    <Identifier>sample string 2</Identifier>
    <Name>sample string 1</Name>
    <Params>
      <Param>
        <Description>sample string 3</Description>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Param>
      <Param>
        <Description>sample string 3</Description>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Param>
    </Params>
  </Integrator>
  <Invoice>
    <AllowanceCharge>
      <Amount>1</Amount>
      <BaseAmount>3</BaseAmount>
      <Percent>2</Percent>
    </AllowanceCharge>
    <AllowanceTotalAmount>12</AllowanceTotalAmount>
    <ChargeTotalAmount>13</ChargeTotalAmount>
    <Currency>sample string 8</Currency>
    <Customer>
      <CompanyAddress>
        <BuildingName>sample string 7</BuildingName>
        <BuildingNumber>sample string 6</BuildingNumber>
        <CityName>sample string 4</CityName>
        <CitySubdivisionName>sample string 5</CitySubdivisionName>
        <Country>sample string 2</Country>
        <Name>sample string 1</Name>
        <PostalZone>sample string 3</PostalZone>
        <StreetName>sample string 8</StreetName>
      </CompanyAddress>
      <CompanyName>sample string 2</CompanyName>
      <Contact>
        <Email>sample string 3</Email>
        <Fax>sample string 2</Fax>
        <Telephone>sample string 1</Telephone>
      </Contact>
      <Person>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
      </Person>
      <TaxOffice>sample string 3</TaxOffice>
      <Vkn>sample string 1</Vkn>
    </Customer>
    <CustomerUuid>sample string 17</CustomerUuid>
    <InvoiceNumber>sample string 7</InvoiceNumber>
    <InvoiceProfile>sample string 1</InvoiceProfile>
    <IssueDate>sample string 5</IssueDate>
    <IssueTime>2025-01-30T17:37:23.3034853+03:00</IssueTime>
    <LineExtensionAmount>9</LineExtensionAmount>
    <Lines>
      <Line>
        <AllowanceCharges>
          <AllowanceCharge>
            <Amount>1</Amount>
            <BaseAmount>3</BaseAmount>
            <Percent>2</Percent>
          </AllowanceCharge>
          <AllowanceCharge>
            <Amount>1</Amount>
            <BaseAmount>3</BaseAmount>
            <Percent>2</Percent>
          </AllowanceCharge>
        </AllowanceCharges>
        <LineExtensionAmount>6</LineExtensionAmount>
        <ProductDescription>sample string 7</ProductDescription>
        <ProductName>sample string 3</ProductName>
        <Quantity>1</Quantity>
        <QuantityType>sample string 2</QuantityType>
        <Tax>
          <Amount>1</Amount>
          <TaxSubtotals>
            <TaxSubtotal1>
              <Percent>5</Percent>
              <TaxAmount>4</TaxAmount>
              <TaxExemptionReason>sample string 2</TaxExemptionReason>
              <TaxExemptionReasonCode>sample string 1</TaxExemptionReasonCode>
              <TaxableAmount>3</TaxableAmount>
            </TaxSubtotal1>
            <TaxSubtotal1>
              <Percent>5</Percent>
              <TaxAmount>4</TaxAmount>
              <TaxExemptionReason>sample string 2</TaxExemptionReason>
              <TaxExemptionReasonCode>sample string 1</TaxExemptionReasonCode>
              <TaxableAmount>3</TaxableAmount>
            </TaxSubtotal1>
          </TaxSubtotals>
        </Tax>
        <TotalUnitPrice>5</TotalUnitPrice>
        <UnitPrice>4</UnitPrice>
        <WithholdingTaxTotal>
          <TaxAmount>1</TaxAmount>
          <TaxSubTotals>
            <TaxSubtotal>
              <Code>sample string 5</Code>
              <Name>sample string 4</Name>
              <Percent>3</Percent>
              <TaxAmount>2</TaxAmount>
              <TaxableAmount>1</TaxableAmount>
            </TaxSubtotal>
            <TaxSubtotal>
              <Code>sample string 5</Code>
              <Name>sample string 4</Name>
              <Percent>3</Percent>
              <TaxAmount>2</TaxAmount>
              <TaxableAmount>1</TaxableAmount>
            </TaxSubtotal>
          </TaxSubTotals>
        </WithholdingTaxTotal>
      </Line>
      <Line>
        <AllowanceCharges>
          <AllowanceCharge>
            <Amount>1</Amount>
            <BaseAmount>3</BaseAmount>
            <Percent>2</Percent>
          </AllowanceCharge>
          <AllowanceCharge>
            <Amount>1</Amount>
            <BaseAmount>3</BaseAmount>
            <Percent>2</Percent>
          </AllowanceCharge>
        </AllowanceCharges>
        <LineExtensionAmount>6</LineExtensionAmount>
        <ProductDescription>sample string 7</ProductDescription>
        <ProductName>sample string 3</ProductName>
        <Quantity>1</Quantity>
        <QuantityType>sample string 2</QuantityType>
        <Tax>
          <Amount>1</Amount>
          <TaxSubtotals>
            <TaxSubtotal1>
              <Percent>5</Percent>
              <TaxAmount>4</TaxAmount>
              <TaxExemptionReason>sample string 2</TaxExemptionReason>
              <TaxExemptionReasonCode>sample string 1</TaxExemptionReasonCode>
              <TaxableAmount>3</TaxableAmount>
            </TaxSubtotal1>
            <TaxSubtotal1>
              <Percent>5</Percent>
              <TaxAmount>4</TaxAmount>
              <TaxExemptionReason>sample string 2</TaxExemptionReason>
              <TaxExemptionReasonCode>sample string 1</TaxExemptionReasonCode>
              <TaxableAmount>3</TaxableAmount>
            </TaxSubtotal1>
          </TaxSubtotals>
        </Tax>
        <TotalUnitPrice>5</TotalUnitPrice>
        <UnitPrice>4</UnitPrice>
        <WithholdingTaxTotal>
          <TaxAmount>1</TaxAmount>
          <TaxSubTotals>
            <TaxSubtotal>
              <Code>sample string 5</Code>
              <Name>sample string 4</Name>
              <Percent>3</Percent>
              <TaxAmount>2</TaxAmount>
              <TaxableAmount>1</TaxableAmount>
            </TaxSubtotal>
            <TaxSubtotal>
              <Code>sample string 5</Code>
              <Name>sample string 4</Name>
              <Percent>3</Percent>
              <TaxAmount>2</TaxAmount>
              <TaxableAmount>1</TaxableAmount>
            </TaxSubtotal>
          </TaxSubTotals>
        </WithholdingTaxTotal>
      </Line>
    </Lines>
    <Notes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Notes>
    <PayableAmount>14</PayableAmount>
    <PaymentMeans>
      <InstructionNote>sample string 4</InstructionNote>
      <PaymentChannelCode>sample string 2</PaymentChannelCode>
      <PaymentDueDate>2025-01-30T17:37:23.3034853+03:00</PaymentDueDate>
      <PaymentMeansCode>sample string 1</PaymentMeansCode>
    </PaymentMeans>
    <SendMail>true</SendMail>
    <SendingType>sample string 3</SendingType>
    <Supplier>
      <CompanyAddress>
        <BuildingName>sample string 7</BuildingName>
        <BuildingNumber>sample string 6</BuildingNumber>
        <CityName>sample string 4</CityName>
        <CitySubdivisionName>sample string 5</CitySubdivisionName>
        <Country>sample string 2</Country>
        <Name>sample string 1</Name>
        <PostalZone>sample string 3</PostalZone>
        <StreetName>sample string 8</StreetName>
      </CompanyAddress>
      <CompanyName>sample string 2</CompanyName>
      <Contact>
        <Email>sample string 3</Email>
        <Fax>sample string 2</Fax>
        <Telephone>sample string 1</Telephone>
      </Contact>
      <Person>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
      </Person>
      <TaxOffice>sample string 3</TaxOffice>
      <Vkn>sample string 1</Vkn>
    </Supplier>
    <TaxExclusiveAmount>10</TaxExclusiveAmount>
    <TaxInclusiveAmount>11</TaxInclusiveAmount>
    <Type>sample string 2</Type>
    <UseDefaultXslt>16</UseDefaultXslt>
    <Uuid>sample string 4</Uuid>
    <WithholdingTaxTotal>
      <TaxAmount>1</TaxAmount>
      <TaxSubTotals>
        <TaxSubtotal>
          <Code>sample string 5</Code>
          <Name>sample string 4</Name>
          <Percent>3</Percent>
          <TaxAmount>2</TaxAmount>
          <TaxableAmount>1</TaxableAmount>
        </TaxSubtotal>
        <TaxSubtotal>
          <Code>sample string 5</Code>
          <Name>sample string 4</Name>
          <Percent>3</Percent>
          <TaxAmount>2</TaxAmount>
          <TaxableAmount>1</TaxableAmount>
        </TaxSubtotal>
      </TaxSubTotals>
    </WithholdingTaxTotal>
  </Invoice>
</SetTerminalInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SetTerminalInvoiceResponse

Name	Type	Additional information
Uuid	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:

{
  "Uuid": "sample string 1",
  "InvoiceStatus": 2,
  "InvoiceType": 3,
  "InvoiceId": "sample string 4",
  "CustomerInvoiceId": "sample string 5",
  "InvoiceScenario": "sample string 6",
  "InvoiceTime": "2025-01-30T17:37:23.3816128+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:

<SetTerminalInvoiceResponse 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>2025-01-30T17:37:23.3816128+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>
  <Uuid>sample string 1</Uuid>
</SetTerminalInvoiceResponse>