POST api/invoices/issueinvoicegroup

Request Information

URI Parameters

None.

Body Parameters

InvoiceGroup
NameDescriptionTypeAdditional information
Id

integer

None.

UserName

string

None.

ConsumerId

integer

None.

ConsumerAlias

string

None.

ConsumerAddress

string

None.

ConsumerTown

string

None.

ConsumerCountry

string

None.

ConsumerEmail

string

None.

ConsumerExtra1

string

None.

ConsumerFolderType

CFTypes

None.

CustomerId

integer

None.

LeaderId

integer

None.

CustomerAlias

string

None.

CustomerJob

string

None.

CustomerAddress

string

None.

CustomerTown

string

None.

CustomerZip

string

None.

CustomerPhone

string

None.

CustomerAFM

string

None.

CustomerDOY

string

None.

FOPayerId

integer

None.

FOCustomerId

integer

None.

HotelAlias

string

None.

FOReservationId

string

None.

SaleTypeId

integer

None.

SaleTypeDescr

string

None.

InvOrder

string

None.

InvOrdinalNumber

integer

None.

InvTypeId

integer

None.

InvTypeDescription

string

None.

IssueDate

date

None.

IssueTime

date

None.

PayoutTypeId

integer

None.

PrepaidVoucherId

integer

None.

PrepaymentDepositId

integer

None.

PayoutTypeDescription

string

None.

ExternalReferenceId

integer

None.

Notes

string

None.

NetPriceBeforeDiscount

decimal number

None.

DiscountValue

decimal number

None.

PayoutState

INVPayoutStates

None.

NetPriceAfterDiscount

decimal number

None.

VATValue

decimal number

None.

DFValue

decimal number

None.

PayoutValue

decimal number

None.

Tips

decimal number

None.

IsPaymentSpecified

boolean

None.

SaleCategory

ProductGroupTypes

None.

InvCode

string

None.

FMUFiscalizationOnClient

boolean

None.

FMUWebApiAddress

string

None.

InvoiceType

InvoiceType

None.

ValidPaymentTypes

Collection of PaymentType

None.

DebitItems

Collection of InvoiceGroupDebitItem

None.

CreditItems

Collection of InvoiceGroupCreditItem

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "UserName": "sample string 2",
  "ConsumerId": 3,
  "ConsumerAlias": "sample string 4",
  "ConsumerAddress": "sample string 5",
  "ConsumerTown": "sample string 6",
  "ConsumerCountry": "sample string 7",
  "ConsumerEmail": "sample string 8",
  "ConsumerExtra1": "sample string 9",
  "ConsumerFolderType": 0,
  "CustomerId": 10,
  "LeaderId": 11,
  "CustomerAlias": "sample string 12",
  "CustomerJob": "sample string 13",
  "CustomerAddress": "sample string 14",
  "CustomerTown": "sample string 15",
  "CustomerZip": "sample string 16",
  "CustomerPhone": "sample string 17",
  "CustomerAFM": "sample string 18",
  "CustomerDOY": "sample string 19",
  "FOPayerId": 20,
  "FOCustomerId": 21,
  "HotelAlias": "sample string 22",
  "FOReservationId": "sample string 23",
  "SaleTypeId": 24,
  "SaleTypeDescr": "sample string 25",
  "InvOrder": "sample string 26",
  "InvOrdinalNumber": 27,
  "InvTypeId": 28,
  "InvTypeDescription": "sample string 29",
  "IssueDate": "2025-05-04T13:45:57.0556491+03:00",
  "IssueTime": "2025-05-04T13:45:57.0556491+03:00",
  "PayoutTypeId": 1,
  "PrepaidVoucherId": 1,
  "PrepaymentDepositId": 1,
  "PayoutTypeDescription": "sample string 32",
  "ExternalReferenceId": 33,
  "Notes": "sample string 34",
  "NetPriceBeforeDiscount": 35.1,
  "DiscountValue": 36.1,
  "PayoutState": 0,
  "NetPriceAfterDiscount": 37.1,
  "VATValue": 38.1,
  "DFValue": 39.1,
  "PayoutValue": 40.1,
  "Tips": 41.1,
  "IsPaymentSpecified": true,
  "SaleCategory": 0,
  "InvCode": "sample string 43",
  "FMUFiscalizationOnClient": true,
  "FMUWebApiAddress": "sample string 45",
  "InvoiceType": {
    "Id": 1,
    "Description": "sample string 2",
    "Alias": "sample string 3",
    "IssueOnServer": true,
    "RequiresAFM": true,
    "RequiresPayment": true,
    "FMUFiscalizationOnClient": true,
    "FMUWebApiAddress": "sample string 8"
  },
  "ValidPaymentTypes": [
    {
      "Id": 1,
      "Description": "sample string 2",
      "Category": "sample string 3",
      "PMSValidateCustomer": true
    },
    {
      "Id": 1,
      "Description": "sample string 2",
      "Category": "sample string 3",
      "PMSValidateCustomer": true
    }
  ],
  "DebitItems": [
    {
      "Id": 1,
      "ChrgDate": "2025-05-04T13:45:57.057644+03:00",
      "InvId": 3,
      "SaleTypeId": 4,
      "InvSrvId": 5,
      "AccDeptId": 6,
      "CFPrId": 7,
      "CuFlId": 8,
      "CuFlAlias": "sample string 9",
      "Name": "sample string 10",
      "DepartmentId": 11,
      "ProdId": 12,
      "ProdDuration": 13,
      "LeaderId": 14,
      "LeaderDescription": "sample string 15",
      "ProductGroupDescription": "sample string 16",
      "ProdDescr": "sample string 17",
      "CuFlProdDescr": "sample string 18",
      "ChrgQuantity": 19.1,
      "ChrgVAT": 20.1,
      "VATValue": 21.1,
      "NetValue": 22.1,
      "Value": 23.1,
      "DiscountPercent": 24.1,
      "DiscountValue": 25.1,
      "CHGType": 0,
      "IsMaisonDebit": true,
      "FolderType": 0,
      "IsArrangement": true,
      "IsHidden": true,
      "PrepaidVoucherId": 29,
      "PrepaymentDepositId": 30,
      "BookingSourceId": 31
    },
    {
      "Id": 1,
      "ChrgDate": "2025-05-04T13:45:57.057644+03:00",
      "InvId": 3,
      "SaleTypeId": 4,
      "InvSrvId": 5,
      "AccDeptId": 6,
      "CFPrId": 7,
      "CuFlId": 8,
      "CuFlAlias": "sample string 9",
      "Name": "sample string 10",
      "DepartmentId": 11,
      "ProdId": 12,
      "ProdDuration": 13,
      "LeaderId": 14,
      "LeaderDescription": "sample string 15",
      "ProductGroupDescription": "sample string 16",
      "ProdDescr": "sample string 17",
      "CuFlProdDescr": "sample string 18",
      "ChrgQuantity": 19.1,
      "ChrgVAT": 20.1,
      "VATValue": 21.1,
      "NetValue": 22.1,
      "Value": 23.1,
      "DiscountPercent": 24.1,
      "DiscountValue": 25.1,
      "CHGType": 0,
      "IsMaisonDebit": true,
      "FolderType": 0,
      "IsArrangement": true,
      "IsHidden": true,
      "PrepaidVoucherId": 29,
      "PrepaymentDepositId": 30,
      "BookingSourceId": 31
    }
  ],
  "CreditItems": [
    {
      "Id": 1,
      "ChrgDate": "2025-05-04T13:45:57.0586411+03:00",
      "InvId": 3,
      "ParId": 4,
      "SaleTypeId": 5,
      "InvSrvId": 6,
      "AccDeptId": 7,
      "CFPrId": 8,
      "ExtPayerId": 9,
      "CustId": 10,
      "CuFlId": 11,
      "CuFlAlias": "sample string 12",
      "ProdId": 13,
      "ProdDuration": 14,
      "LeaderId": 15,
      "LeaderDescription": "sample string 16",
      "ProductGroupDescription": "sample string 17",
      "PaymentTypeId": 18,
      "PaymentDescription": "sample string 19",
      "ProdDescr": "sample string 20",
      "CuFlProdDescr": "sample string 21",
      "Value": 22.1,
      "CHGType": 0,
      "IsMaisonCredit": true,
      "ProductType": 0,
      "IsArrangement": true,
      "IsHidden": true,
      "PrepaidVoucherId": 26,
      "Notes": "sample string 27",
      "BookingSourceId": 28,
      "PrepaymentDepositId": 29
    },
    {
      "Id": 1,
      "ChrgDate": "2025-05-04T13:45:57.0586411+03:00",
      "InvId": 3,
      "ParId": 4,
      "SaleTypeId": 5,
      "InvSrvId": 6,
      "AccDeptId": 7,
      "CFPrId": 8,
      "ExtPayerId": 9,
      "CustId": 10,
      "CuFlId": 11,
      "CuFlAlias": "sample string 12",
      "ProdId": 13,
      "ProdDuration": 14,
      "LeaderId": 15,
      "LeaderDescription": "sample string 16",
      "ProductGroupDescription": "sample string 17",
      "PaymentTypeId": 18,
      "PaymentDescription": "sample string 19",
      "ProdDescr": "sample string 20",
      "CuFlProdDescr": "sample string 21",
      "Value": 22.1,
      "CHGType": 0,
      "IsMaisonCredit": true,
      "ProductType": 0,
      "IsArrangement": true,
      "IsHidden": true,
      "PrepaidVoucherId": 26,
      "Notes": "sample string 27",
      "BookingSourceId": 28,
      "PrepaymentDepositId": 29
    }
  ]
}

application/xml, text/xml

Sample:
<InvoiceGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <ConsumerAddress>sample string 5</ConsumerAddress>
  <ConsumerAlias>sample string 4</ConsumerAlias>
  <ConsumerCountry>sample string 7</ConsumerCountry>
  <ConsumerEmail>sample string 8</ConsumerEmail>
  <ConsumerExtra1>sample string 9</ConsumerExtra1>
  <ConsumerFolderType>Inhouse</ConsumerFolderType>
  <ConsumerId>3</ConsumerId>
  <ConsumerTown>sample string 6</ConsumerTown>
  <CreditItems>
    <InvoiceGroupCreditItem>
      <AccDeptId>7</AccDeptId>
      <BookingSourceId>28</BookingSourceId>
      <CFPrId>8</CFPrId>
      <CHGType>ALL</CHGType>
      <ChrgDate>2025-05-04T13:45:57.0586411+03:00</ChrgDate>
      <CuFlAlias>sample string 12</CuFlAlias>
      <CuFlId>11</CuFlId>
      <CuFlProdDescr>sample string 21</CuFlProdDescr>
      <CustId>10</CustId>
      <ExtPayerId>9</ExtPayerId>
      <Id>1</Id>
      <InvId>3</InvId>
      <InvSrvId>6</InvSrvId>
      <IsArrangement>true</IsArrangement>
      <IsHidden>true</IsHidden>
      <IsMaisonCredit>true</IsMaisonCredit>
      <LeaderDescription>sample string 16</LeaderDescription>
      <LeaderId>15</LeaderId>
      <Notes>sample string 27</Notes>
      <ParId>4</ParId>
      <PaymentDescription>sample string 19</PaymentDescription>
      <PaymentTypeId>18</PaymentTypeId>
      <PrepaidVoucherId>26</PrepaidVoucherId>
      <PrepaymentDepositId>29</PrepaymentDepositId>
      <ProdDescr>sample string 20</ProdDescr>
      <ProdDuration>14</ProdDuration>
      <ProdId>13</ProdId>
      <ProductGroupDescription>sample string 17</ProductGroupDescription>
      <ProductType>PT_THERAPY</ProductType>
      <SaleTypeId>5</SaleTypeId>
      <Value>22.1</Value>
    </InvoiceGroupCreditItem>
    <InvoiceGroupCreditItem>
      <AccDeptId>7</AccDeptId>
      <BookingSourceId>28</BookingSourceId>
      <CFPrId>8</CFPrId>
      <CHGType>ALL</CHGType>
      <ChrgDate>2025-05-04T13:45:57.0586411+03:00</ChrgDate>
      <CuFlAlias>sample string 12</CuFlAlias>
      <CuFlId>11</CuFlId>
      <CuFlProdDescr>sample string 21</CuFlProdDescr>
      <CustId>10</CustId>
      <ExtPayerId>9</ExtPayerId>
      <Id>1</Id>
      <InvId>3</InvId>
      <InvSrvId>6</InvSrvId>
      <IsArrangement>true</IsArrangement>
      <IsHidden>true</IsHidden>
      <IsMaisonCredit>true</IsMaisonCredit>
      <LeaderDescription>sample string 16</LeaderDescription>
      <LeaderId>15</LeaderId>
      <Notes>sample string 27</Notes>
      <ParId>4</ParId>
      <PaymentDescription>sample string 19</PaymentDescription>
      <PaymentTypeId>18</PaymentTypeId>
      <PrepaidVoucherId>26</PrepaidVoucherId>
      <PrepaymentDepositId>29</PrepaymentDepositId>
      <ProdDescr>sample string 20</ProdDescr>
      <ProdDuration>14</ProdDuration>
      <ProdId>13</ProdId>
      <ProductGroupDescription>sample string 17</ProductGroupDescription>
      <ProductType>PT_THERAPY</ProductType>
      <SaleTypeId>5</SaleTypeId>
      <Value>22.1</Value>
    </InvoiceGroupCreditItem>
  </CreditItems>
  <CustomerAFM>sample string 18</CustomerAFM>
  <CustomerAddress>sample string 14</CustomerAddress>
  <CustomerAlias>sample string 12</CustomerAlias>
  <CustomerDOY>sample string 19</CustomerDOY>
  <CustomerId>10</CustomerId>
  <CustomerJob>sample string 13</CustomerJob>
  <CustomerPhone>sample string 17</CustomerPhone>
  <CustomerTown>sample string 15</CustomerTown>
  <CustomerZip>sample string 16</CustomerZip>
  <DFValue>39.1</DFValue>
  <DebitItems>
    <InvoiceGroupDebitItem>
      <AccDeptId>6</AccDeptId>
      <BookingSourceId>31</BookingSourceId>
      <CFPrId>7</CFPrId>
      <CHGType>ALL</CHGType>
      <ChrgDate>2025-05-04T13:45:57.057644+03:00</ChrgDate>
      <ChrgQuantity>19.1</ChrgQuantity>
      <ChrgVAT>20.1</ChrgVAT>
      <CuFlAlias>sample string 9</CuFlAlias>
      <CuFlId>8</CuFlId>
      <CuFlProdDescr>sample string 18</CuFlProdDescr>
      <DepartmentId>11</DepartmentId>
      <DiscountPercent>24.1</DiscountPercent>
      <DiscountValue>25.1</DiscountValue>
      <FolderType>Inhouse</FolderType>
      <Id>1</Id>
      <InvId>3</InvId>
      <InvSrvId>5</InvSrvId>
      <IsArrangement>true</IsArrangement>
      <IsHidden>true</IsHidden>
      <IsMaisonDebit>true</IsMaisonDebit>
      <LeaderDescription>sample string 15</LeaderDescription>
      <LeaderId>14</LeaderId>
      <Name>sample string 10</Name>
      <NetValue>22.1</NetValue>
      <PrepaidVoucherId>29</PrepaidVoucherId>
      <PrepaymentDepositId>30</PrepaymentDepositId>
      <ProdDescr>sample string 17</ProdDescr>
      <ProdDuration>13</ProdDuration>
      <ProdId>12</ProdId>
      <ProductGroupDescription>sample string 16</ProductGroupDescription>
      <SaleTypeId>4</SaleTypeId>
      <VATValue>21.1</VATValue>
      <Value>23.1</Value>
    </InvoiceGroupDebitItem>
    <InvoiceGroupDebitItem>
      <AccDeptId>6</AccDeptId>
      <BookingSourceId>31</BookingSourceId>
      <CFPrId>7</CFPrId>
      <CHGType>ALL</CHGType>
      <ChrgDate>2025-05-04T13:45:57.057644+03:00</ChrgDate>
      <ChrgQuantity>19.1</ChrgQuantity>
      <ChrgVAT>20.1</ChrgVAT>
      <CuFlAlias>sample string 9</CuFlAlias>
      <CuFlId>8</CuFlId>
      <CuFlProdDescr>sample string 18</CuFlProdDescr>
      <DepartmentId>11</DepartmentId>
      <DiscountPercent>24.1</DiscountPercent>
      <DiscountValue>25.1</DiscountValue>
      <FolderType>Inhouse</FolderType>
      <Id>1</Id>
      <InvId>3</InvId>
      <InvSrvId>5</InvSrvId>
      <IsArrangement>true</IsArrangement>
      <IsHidden>true</IsHidden>
      <IsMaisonDebit>true</IsMaisonDebit>
      <LeaderDescription>sample string 15</LeaderDescription>
      <LeaderId>14</LeaderId>
      <Name>sample string 10</Name>
      <NetValue>22.1</NetValue>
      <PrepaidVoucherId>29</PrepaidVoucherId>
      <PrepaymentDepositId>30</PrepaymentDepositId>
      <ProdDescr>sample string 17</ProdDescr>
      <ProdDuration>13</ProdDuration>
      <ProdId>12</ProdId>
      <ProductGroupDescription>sample string 16</ProductGroupDescription>
      <SaleTypeId>4</SaleTypeId>
      <VATValue>21.1</VATValue>
      <Value>23.1</Value>
    </InvoiceGroupDebitItem>
  </DebitItems>
  <DiscountValue>36.1</DiscountValue>
  <ExternalReferenceId>33</ExternalReferenceId>
  <FMUFiscalizationOnClient>true</FMUFiscalizationOnClient>
  <FMUWebApiAddress>sample string 45</FMUWebApiAddress>
  <FOCustomerId>21</FOCustomerId>
  <FOPayerId>20</FOPayerId>
  <FOReservationId>sample string 23</FOReservationId>
  <HotelAlias>sample string 22</HotelAlias>
  <Id>1</Id>
  <InvCode>sample string 43</InvCode>
  <InvOrder>sample string 26</InvOrder>
  <InvOrdinalNumber>27</InvOrdinalNumber>
  <InvTypeDescription>sample string 29</InvTypeDescription>
  <InvTypeId>28</InvTypeId>
  <InvoiceType>
    <Alias>sample string 3</Alias>
    <Description>sample string 2</Description>
    <FMUFiscalizationOnClient>true</FMUFiscalizationOnClient>
    <FMUWebApiAddress>sample string 8</FMUWebApiAddress>
    <Id>1</Id>
    <IssueOnServer>true</IssueOnServer>
    <RequiresAFM>true</RequiresAFM>
    <RequiresPayment>true</RequiresPayment>
  </InvoiceType>
  <IsPaymentSpecified>true</IsPaymentSpecified>
  <IssueDate>2025-05-04T13:45:57.0556491+03:00</IssueDate>
  <IssueTime>2025-05-04T13:45:57.0556491+03:00</IssueTime>
  <LeaderId>11</LeaderId>
  <NetPriceAfterDiscount>37.1</NetPriceAfterDiscount>
  <NetPriceBeforeDiscount>35.1</NetPriceBeforeDiscount>
  <Notes>sample string 34</Notes>
  <PayoutState>NotSpecified</PayoutState>
  <PayoutTypeDescription>sample string 32</PayoutTypeDescription>
  <PayoutTypeId>1</PayoutTypeId>
  <PayoutValue>40.1</PayoutValue>
  <PrepaidVoucherId>1</PrepaidVoucherId>
  <PrepaymentDepositId>1</PrepaymentDepositId>
  <SaleCategory>NoGroup</SaleCategory>
  <SaleTypeDescr>sample string 25</SaleTypeDescr>
  <SaleTypeId>24</SaleTypeId>
  <Tips>41.1</Tips>
  <UserName>sample string 2</UserName>
  <VATValue>38.1</VATValue>
  <ValidPaymentTypes>
    <PaymentType>
      <Category>sample string 3</Category>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <PMSValidateCustomer>true</PMSValidateCustomer>
    </PaymentType>
    <PaymentType>
      <Category>sample string 3</Category>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <PMSValidateCustomer>true</PMSValidateCustomer>
    </PaymentType>
  </ValidPaymentTypes>
</InvoiceGroup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FiscalizedInvoice
NameDescriptionTypeAdditional information
ClientCode

string

None.

AccId

integer

None.

Content

string

None.

FMUFiscalizationOnClient

boolean

None.

FMUWebApiAddress

string

None.

FMUSignature

string

None.

QRCode

string

None.

IssueOnServer

boolean

None.

PrintOnServer

boolean

None.

Fiscalized

boolean

None.

SignedSuccess

boolean

None.

PaymentSuccess

boolean

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ClientCode": "sample string 1",
  "AccId": 2,
  "Content": "sample string 3",
  "FMUFiscalizationOnClient": true,
  "FMUWebApiAddress": "sample string 5",
  "FMUSignature": "sample string 6",
  "QRCode": "sample string 7",
  "IssueOnServer": true,
  "PrintOnServer": true,
  "Fiscalized": true,
  "SignedSuccess": true,
  "PaymentSuccess": true,
  "ErrorMessage": "sample string 13"
}

application/xml, text/xml

Sample:
<FiscalizedInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Library.Web.Models">
  <AccId>2</AccId>
  <ClientCode>sample string 1</ClientCode>
  <Content>sample string 3</Content>
  <ErrorMessage>sample string 13</ErrorMessage>
  <FMUFiscalizationOnClient>true</FMUFiscalizationOnClient>
  <FMUSignature>sample string 6</FMUSignature>
  <FMUWebApiAddress>sample string 5</FMUWebApiAddress>
  <Fiscalized>true</Fiscalized>
  <IssueOnServer>true</IssueOnServer>
  <PaymentSuccess>true</PaymentSuccess>
  <PrintOnServer>true</PrintOnServer>
  <QRCode>sample string 7</QRCode>
  <SignedSuccess>true</SignedSuccess>
</FiscalizedInvoice>