POST api/RetailInvoices/AddRetailInvoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceYear	integer	None.
ShopId	string	None.
EventType	string	None.
InvoiceBook	string	None.
InvoiceNumber	integer	None.
CustomerID	string	None.
CostCenterID	string	None.
CostUnitID	string	None.
ClerkID	string	None.
AnalyticID	string	None.
InvoiceDate	date	None.
Document	string	None.
CurrencyID	string	None.
RabatPercentage	decimal number	None.
CustomerTitle1	string	None.
CustomerTitle2	string	None.
CustomerTitle3	string	None.
CustomerAddress	string	None.
CustomerHouseNo	string	None.
CustomerPostalCode	string	None.
CustomerCity	string	None.
CustomerCountry	string	None.
RegistrationNumber	string	None.
CustomerAgriculturalID	string	None.
CustomerVATNo	string	None.
PriceListID	string	None.
VATCalculated	string	None.
CustomerType	string	None.
RoundingAmount	decimal number	None.
PaymentAmount	decimal number	None.
CashNumber	integer	None.
CashierID	string	None.
HeaderDescription	string	None.
FooterDescription	string	None.
Status	string	None.
AccordingToArticle34	boolean	None.
InsertedBy	string	None.
InsertedTime	date	None.
ModifiedBy	string	None.
ModifiedTime	date	None.
DueDate	date	None.
LoyaltyCard	string	None.
CustomerLoyaltyCardID	string	None.
SubsidyPaymentAmount	decimal number	None.
ReversalInvoice	string	None.
LoyaltyCardPoints	integer	None.
SubSequentSubmit	integer	None.
FiscalizationDate	date	None.
Fiscalization	boolean	None.
UniqueInvoiceID	string	None.
SecurityCodeOfInvoice	string	None.
VATReducedRateAmount	decimal number	None.
VATStandardRateAmount	decimal number	None.
RebateAmount	decimal number	None.
InvoiceID	string	None.
NrOfInvoiceCopies	integer	None.
IDEntered	boolean	None.
CHSEQ	string	None.
CHSEQN	integer	None.
CHSTAT	boolean	None.
VATInvoiceType	string	None.
VATSReducedRateAmount	decimal number	None.
StornoRelatedYear	integer	None.
StornoRelatedShopID	string	None.
StornoRelatedInvoiceNo	integer	None.
RelatedUserTDR	integer	None.
StornoRelatedInvoiceBookID	string	None.
RelatedAplicationID	string	None.
VKRInvoiceDate	date	None.
VKRSerialNumber	string	None.
VKRInvoiceNumber	string	None.
VKRSetSerialNumber	string	None.
ElectronicDeviceID	string	None.
InternalInvoiceNumberMP	string	None.
InvoiceNumberMP	string	None.
StornoElectronicDeviceId	string	None.
StornoInternalNumberMP	string	None.
SGUID	globally unique identifier	None.
StornoRelatedInvoiceDate	date	None.
RetailInvoiceLines	RetailInvoiceLines	None.
RetailInvoicePaymentLines	RetailInvoicePaymentLines	None.
RetailInvoiceTaxCertifications	RetailInvoiceTaxCertifications	None.
RetailInvoicePOSTerminalLogs	RetailInvoicePOSTerminalLogs	None.

Request Formats

application/xml, text/xml

Sample:

<RetailInvoiceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <InvoiceYear>1</InvoiceYear>
  <ShopId>sample string 2</ShopId>
  <EventType>sample string 3</EventType>
  <InvoiceBook>sample string 4</InvoiceBook>
  <InvoiceNumber>5</InvoiceNumber>
  <CustomerID>sample string 6</CustomerID>
  <CostCenterID>sample string 7</CostCenterID>
  <CostUnitID>sample string 8</CostUnitID>
  <ClerkID>sample string 9</ClerkID>
  <AnalyticID>sample string 10</AnalyticID>
  <InvoiceDate>2024-11-21T15:23:44.697484+01:00</InvoiceDate>
  <Document>sample string 11</Document>
  <CurrencyID>sample string 12</CurrencyID>
  <RabatPercentage>1.1</RabatPercentage>
  <CustomerTitle1>sample string 13</CustomerTitle1>
  <CustomerTitle2>sample string 14</CustomerTitle2>
  <CustomerTitle3>sample string 15</CustomerTitle3>
  <CustomerAddress>sample string 16</CustomerAddress>
  <CustomerHouseNo>sample string 17</CustomerHouseNo>
  <CustomerPostalCode>sample string 18</CustomerPostalCode>
  <CustomerCity>sample string 19</CustomerCity>
  <CustomerCountry>sample string 20</CustomerCountry>
  <RegistrationNumber>sample string 21</RegistrationNumber>
  <CustomerAgriculturalID>sample string 22</CustomerAgriculturalID>
  <CustomerVATNo>sample string 23</CustomerVATNo>
  <PriceListID>sample string 24</PriceListID>
  <VATCalculated>sample string 25</VATCalculated>
  <CustomerType>sample string 26</CustomerType>
  <RoundingAmount>1</RoundingAmount>
  <PaymentAmount>1</PaymentAmount>
  <CashNumber>1</CashNumber>
  <CashierID>sample string 27</CashierID>
  <HeaderDescription>sample string 28</HeaderDescription>
  <FooterDescription>sample string 29</FooterDescription>
  <Status>sample string 30</Status>
  <AccordingToArticle34>true</AccordingToArticle34>
  <InsertedBy>sample string 31</InsertedBy>
  <InsertedTime>2024-11-21T15:23:44.6984838+01:00</InsertedTime>
  <ModifiedBy>sample string 32</ModifiedBy>
  <ModifiedTime>2024-11-21T15:23:44.6984838+01:00</ModifiedTime>
  <DueDate>2024-11-21T15:23:44.6984838+01:00</DueDate>
  <LoyaltyCard>sample string 33</LoyaltyCard>
  <CustomerLoyaltyCardID>sample string 34</CustomerLoyaltyCardID>
  <SubsidyPaymentAmount>1</SubsidyPaymentAmount>
  <ReversalInvoice>sample string 35</ReversalInvoice>
  <LoyaltyCardPoints>1</LoyaltyCardPoints>
  <SubSequentSubmit>1</SubSequentSubmit>
  <FiscalizationDate>2024-11-21T15:23:44.6984838+01:00</FiscalizationDate>
  <Fiscalization>true</Fiscalization>
  <UniqueInvoiceID>sample string 36</UniqueInvoiceID>
  <SecurityCodeOfInvoice>sample string 37</SecurityCodeOfInvoice>
  <VATReducedRateAmount>1</VATReducedRateAmount>
  <VATStandardRateAmount>1</VATStandardRateAmount>
  <RebateAmount>1</RebateAmount>
  <InvoiceID>sample string 38</InvoiceID>
  <NrOfInvoiceCopies>1</NrOfInvoiceCopies>
  <IDEntered>true</IDEntered>
  <CHSEQ>sample string 39</CHSEQ>
  <CHSEQN>1</CHSEQN>
  <CHSTAT>true</CHSTAT>
  <VATInvoiceType>sample string 40</VATInvoiceType>
  <VATSReducedRateAmount>1</VATSReducedRateAmount>
  <StornoRelatedYear>1</StornoRelatedYear>
  <StornoRelatedShopID>sample string 41</StornoRelatedShopID>
  <StornoRelatedInvoiceNo>1</StornoRelatedInvoiceNo>
  <RelatedUserTDR>1</RelatedUserTDR>
  <StornoRelatedInvoiceBookID>sample string 42</StornoRelatedInvoiceBookID>
  <RelatedAplicationID>sample string 43</RelatedAplicationID>
  <VKRInvoiceDate>2024-11-21T15:23:44.6984838+01:00</VKRInvoiceDate>
  <VKRSerialNumber>sample string 44</VKRSerialNumber>
  <VKRInvoiceNumber>sample string 45</VKRInvoiceNumber>
  <VKRSetSerialNumber>sample string 46</VKRSetSerialNumber>
  <ElectronicDeviceID>sample string 47</ElectronicDeviceID>
  <InternalInvoiceNumberMP>sample string 48</InternalInvoiceNumberMP>
  <InvoiceNumberMP>sample string 49</InvoiceNumberMP>
  <StornoElectronicDeviceId>sample string 50</StornoElectronicDeviceId>
  <StornoInternalNumberMP>sample string 51</StornoInternalNumberMP>
  <SGUID>03a8897c-8c74-40ca-bb9c-ee0b388a713a</SGUID>
  <StornoRelatedInvoiceDate>2024-11-21T15:23:44.6984838+01:00</StornoRelatedInvoiceDate>
  <RetailInvoiceLines>
    <RetailInvoiceLine>
      <LineNumber>1</LineNumber>
      <InvoiceYear>2</InvoiceYear>
      <ShopId>sample string 3</ShopId>
      <MarkId>sample string 4</MarkId>
      <EventType>sample string 5</EventType>
      <InvoiceBook>sample string 6</InvoiceBook>
      <InvoiceNumber>1</InvoiceNumber>
      <ItemID>sample string 7</ItemID>
      <ItemIDType>sample string 8</ItemIDType>
      <VATRateID>sample string 9</VATRateID>
      <VATPercentage>1.1</VATPercentage>
      <Note>sample string 10</Note>
      <Series>sample string 11</Series>
      <QuantityOfIssue>1.1</QuantityOfIssue>
      <SellingPrice>1.1</SellingPrice>
      <RetailPrice>1.1</RetailPrice>
      <UnitOfMeasurementForPrice>1</UnitOfMeasurementForPrice>
      <IssueDiscountPercentage>1.1</IssueDiscountPercentage>
      <IssueAmount>1.1</IssueAmount>
      <GrossAmount>1.1</GrossAmount>
      <RowAmount>1.1</RowAmount>
      <NetAmount>1.1</NetAmount>
      <NetBasisAmount>1.1</NetBasisAmount>
      <AlternateEAN>sample string 12</AlternateEAN>
      <AlternateUnitOfMeasurement>sample string 13</AlternateUnitOfMeasurement>
      <AlternateConverterFactor>1.1</AlternateConverterFactor>
      <AlternateQuantitiy>1.1</AlternateQuantitiy>
      <LineStatus>sample string 14</LineStatus>
      <InsertedBy>sample string 15</InsertedBy>
      <InsertedTime>2024-11-21T15:23:44.6994838+01:00</InsertedTime>
      <ModifiedBy>sample string 16</ModifiedBy>
      <ModifiedTime>2024-11-21T15:23:44.6994838+01:00</ModifiedTime>
      <Reversal>sample string 17</Reversal>
      <ReversalLine>1</ReversalLine>
      <IncentiveFee>1.1</IncentiveFee>
      <Refunds>1.1</Refunds>
      <VATAmount>1</VATAmount>
      <VATCalculation>sample string 18</VATCalculation>
      <VATInvoiceType>sample string 19</VATInvoiceType>
      <EnrollmentStatus>sample string 20</EnrollmentStatus>
      <ItemTitle1>sample string 21</ItemTitle1>
      <ItemTitle2>sample string 22</ItemTitle2>
      <ItemUnitOfMeas>sample string 23</ItemUnitOfMeas>
      <Storno>sample string 24</Storno>
      <StornoLineNo>1</StornoLineNo>
      <Component>sample string 25</Component>
      <ComponentID>sample string 26</ComponentID>
      <ComponentIDRelatedLineNo>1</ComponentIDRelatedLineNo>
      <GiftVoucher>sample string 27</GiftVoucher>
      <PrepaymentInvoiceLineID>sample string 28</PrepaymentInvoiceLineID>
    </RetailInvoiceLine>
    <RetailInvoiceLine>
      <LineNumber>1</LineNumber>
      <InvoiceYear>2</InvoiceYear>
      <ShopId>sample string 3</ShopId>
      <MarkId>sample string 4</MarkId>
      <EventType>sample string 5</EventType>
      <InvoiceBook>sample string 6</InvoiceBook>
      <InvoiceNumber>1</InvoiceNumber>
      <ItemID>sample string 7</ItemID>
      <ItemIDType>sample string 8</ItemIDType>
      <VATRateID>sample string 9</VATRateID>
      <VATPercentage>1.1</VATPercentage>
      <Note>sample string 10</Note>
      <Series>sample string 11</Series>
      <QuantityOfIssue>1.1</QuantityOfIssue>
      <SellingPrice>1.1</SellingPrice>
      <RetailPrice>1.1</RetailPrice>
      <UnitOfMeasurementForPrice>1</UnitOfMeasurementForPrice>
      <IssueDiscountPercentage>1.1</IssueDiscountPercentage>
      <IssueAmount>1.1</IssueAmount>
      <GrossAmount>1.1</GrossAmount>
      <RowAmount>1.1</RowAmount>
      <NetAmount>1.1</NetAmount>
      <NetBasisAmount>1.1</NetBasisAmount>
      <AlternateEAN>sample string 12</AlternateEAN>
      <AlternateUnitOfMeasurement>sample string 13</AlternateUnitOfMeasurement>
      <AlternateConverterFactor>1.1</AlternateConverterFactor>
      <AlternateQuantitiy>1.1</AlternateQuantitiy>
      <LineStatus>sample string 14</LineStatus>
      <InsertedBy>sample string 15</InsertedBy>
      <InsertedTime>2024-11-21T15:23:44.6994838+01:00</InsertedTime>
      <ModifiedBy>sample string 16</ModifiedBy>
      <ModifiedTime>2024-11-21T15:23:44.6994838+01:00</ModifiedTime>
      <Reversal>sample string 17</Reversal>
      <ReversalLine>1</ReversalLine>
      <IncentiveFee>1.1</IncentiveFee>
      <Refunds>1.1</Refunds>
      <VATAmount>1</VATAmount>
      <VATCalculation>sample string 18</VATCalculation>
      <VATInvoiceType>sample string 19</VATInvoiceType>
      <EnrollmentStatus>sample string 20</EnrollmentStatus>
      <ItemTitle1>sample string 21</ItemTitle1>
      <ItemTitle2>sample string 22</ItemTitle2>
      <ItemUnitOfMeas>sample string 23</ItemUnitOfMeas>
      <Storno>sample string 24</Storno>
      <StornoLineNo>1</StornoLineNo>
      <Component>sample string 25</Component>
      <ComponentID>sample string 26</ComponentID>
      <ComponentIDRelatedLineNo>1</ComponentIDRelatedLineNo>
      <GiftVoucher>sample string 27</GiftVoucher>
      <PrepaymentInvoiceLineID>sample string 28</PrepaymentInvoiceLineID>
    </RetailInvoiceLine>
  </RetailInvoiceLines>
  <RetailInvoicePaymentLines>
    <RetailInvoicePaymentLine>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <GiftCardID>sample string 3</GiftCardID>
    </RetailInvoicePaymentLine>
    <RetailInvoicePaymentLine>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <GiftCardID>sample string 3</GiftCardID>
    </RetailInvoicePaymentLine>
  </RetailInvoicePaymentLines>
  <RetailInvoiceTaxCertifications>
    <RetailInvoiceTaxCertification>
      <TaxYear>1</TaxYear>
      <TurnoverType>sample string 2</TurnoverType>
      <InvoiceBookID>sample string 3</InvoiceBookID>
      <InvoiceNumber>1</InvoiceNumber>
      <TaxLineNo>1</TaxLineNo>
      <TaxMessage>sample string 4</TaxMessage>
      <ApplicationID>sample string 5</ApplicationID>
    </RetailInvoiceTaxCertification>
    <RetailInvoiceTaxCertification>
      <TaxYear>1</TaxYear>
      <TurnoverType>sample string 2</TurnoverType>
      <InvoiceBookID>sample string 3</InvoiceBookID>
      <InvoiceNumber>1</InvoiceNumber>
      <TaxLineNo>1</TaxLineNo>
      <TaxMessage>sample string 4</TaxMessage>
      <ApplicationID>sample string 5</ApplicationID>
    </RetailInvoiceTaxCertification>
  </RetailInvoiceTaxCertifications>
  <RetailInvoicePOSTerminalLogs>
    <RetailInvoicePOSTerminalLog>
      <CardName>sample string 1</CardName>
      <LineNumber>2</LineNumber>
      <TerminalID>sample string 3</TerminalID>
      <CardType>sample string 4</CardType>
      <CardNumber>sample string 5</CardNumber>
      <Amount>1</Amount>
      <POSMessage>sample string 6</POSMessage>
      <ID>sample string 7</ID>
      <Slip>sample string 8</Slip>
      <Storno>sample string 9</Storno>
      <InsertedTime>2024-11-21T15:23:44.7004837+01:00</InsertedTime>
      <MPEcrID>sample string 10</MPEcrID>
      <MPErrorID>sample string 11</MPErrorID>
      <MPPOSResponse>sample string 12</MPPOSResponse>
      <MPWhen>2024-11-21T15:23:44.7004837+01:00</MPWhen>
    </RetailInvoicePOSTerminalLog>
    <RetailInvoicePOSTerminalLog>
      <CardName>sample string 1</CardName>
      <LineNumber>2</LineNumber>
      <TerminalID>sample string 3</TerminalID>
      <CardType>sample string 4</CardType>
      <CardNumber>sample string 5</CardNumber>
      <Amount>1</Amount>
      <POSMessage>sample string 6</POSMessage>
      <ID>sample string 7</ID>
      <Slip>sample string 8</Slip>
      <Storno>sample string 9</Storno>
      <InsertedTime>2024-11-21T15:23:44.7004837+01:00</InsertedTime>
      <MPEcrID>sample string 10</MPEcrID>
      <MPErrorID>sample string 11</MPErrorID>
      <MPPOSResponse>sample string 12</MPPOSResponse>
      <MPWhen>2024-11-21T15:23:44.7004837+01:00</MPWhen>
    </RetailInvoicePOSTerminalLog>
  </RetailInvoicePOSTerminalLogs>
</RetailInvoiceHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateResult

Name	Type	Additional information
Keys	Collection of EntityKeyField	None.
ResultCode	ExternalResultCode	None.
Errors	Collection of Error	None.

Response Formats

application/xml, text/xml

Sample:

<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Keys>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
  </Keys>
  <ResultCode>None</ResultCode>
  <Errors>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
  </Errors>
</CreateResult>