POST api/billing/finish

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HotelCode	string	None.
POSCenterCode	string	None.
TableNo	string	None.
GlobalToDay	date	None.
GlobalUserName	string	None.
GlobalUserID	integer	None.
GlobalRoomNo	string	None.
GlobalNoOfPAX	integer	None.
GlobalNameID	integer	None.
GlobalDeliveryMtd	string	None.
GlobalPhoneNo	string	None.
GlobalCustomerName	string	None.
GlobalEventID	integer	None.
GlobalComplementType	string	None.
Flags	Dictionary of string [key] and boolean [value]	None.
HeaderDiscount	decimal number	None.
SCRate	decimal number	None.
SC	decimal number	None.
TDLRate	decimal number	None.
TDL	decimal number	None.
SSCLRate	decimal number	None.
SSCL	decimal number	None.
VATRate	decimal number	None.
VAT	decimal number	None.
GrandTotal	decimal number	None.
Invoiceitems	Collection of TranDetailDto	None.
Settlements	Collection of SettlementLineDto	None.

Request Formats

application/json, text/json

Sample:

{
  "HotelCode": "sample string 1",
  "POSCenterCode": "sample string 2",
  "TableNo": "sample string 3",
  "GlobalToDay": "2026-01-21T16:49:06.1020012+05:30",
  "GlobalUserName": "sample string 5",
  "GlobalUserID": 6,
  "GlobalRoomNo": "sample string 7",
  "GlobalNoOfPAX": 8,
  "GlobalNameID": 9,
  "GlobalDeliveryMtd": "sample string 10",
  "GlobalPhoneNo": "sample string 11",
  "GlobalCustomerName": "sample string 12",
  "GlobalEventID": 13,
  "GlobalComplementType": "sample string 14",
  "Flags": {
    "sample string 1": true,
    "sample string 3": true
  },
  "HeaderDiscount": 15.0,
  "SCRate": 16.0,
  "SC": 17.0,
  "TDLRate": 18.0,
  "TDL": 19.0,
  "SSCLRate": 20.0,
  "SSCL": 21.0,
  "VATRate": 22.0,
  "VAT": 23.0,
  "GrandTotal": 24.0,
  "Invoiceitems": [
    {
      "ID": 1,
      "Cover": 2,
      "ItemCode": "sample string 3",
      "ItemName": "sample string 4",
      "Qty": 5.0,
      "Cost": 6.0,
      "Price": 7.0,
      "LineTotal": 8.0,
      "PriceGroup": "sample string 9",
      "IsDummy": true,
      "OriginalPrice": 11.0,
      "IsAddon": true
    },
    {
      "ID": 1,
      "Cover": 2,
      "ItemCode": "sample string 3",
      "ItemName": "sample string 4",
      "Qty": 5.0,
      "Cost": 6.0,
      "Price": 7.0,
      "LineTotal": 8.0,
      "PriceGroup": "sample string 9",
      "IsDummy": true,
      "OriginalPrice": 11.0,
      "IsAddon": true
    }
  ],
  "Settlements": [
    {
      "PaymentMethod": "sample string 1",
      "Amount": 2.0,
      "AmountInLKR": 3.0,
      "Currency": "sample string 4",
      "CardType": "sample string 5",
      "RefNo": "sample string 6"
    },
    {
      "PaymentMethod": "sample string 1",
      "Amount": 2.0,
      "AmountInLKR": 3.0,
      "Currency": "sample string 4",
      "CardType": "sample string 5",
      "RefNo": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<FinishBillRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitrusPOS_WebAPI2">
  <Flags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </Flags>
  <GlobalComplementType>sample string 14</GlobalComplementType>
  <GlobalCustomerName>sample string 12</GlobalCustomerName>
  <GlobalDeliveryMtd>sample string 10</GlobalDeliveryMtd>
  <GlobalEventID>13</GlobalEventID>
  <GlobalNameID>9</GlobalNameID>
  <GlobalNoOfPAX>8</GlobalNoOfPAX>
  <GlobalPhoneNo>sample string 11</GlobalPhoneNo>
  <GlobalRoomNo>sample string 7</GlobalRoomNo>
  <GlobalToDay>2026-01-21T16:49:06.1020012+05:30</GlobalToDay>
  <GlobalUserID>6</GlobalUserID>
  <GlobalUserName>sample string 5</GlobalUserName>
  <GrandTotal>24</GrandTotal>
  <HeaderDiscount>15</HeaderDiscount>
  <HotelCode>sample string 1</HotelCode>
  <Invoiceitems>
    <TranDetailDto>
      <Cost>6</Cost>
      <Cover>2</Cover>
      <ID>1</ID>
      <IsAddon>true</IsAddon>
      <IsDummy>true</IsDummy>
      <ItemCode>sample string 3</ItemCode>
      <ItemName>sample string 4</ItemName>
      <LineTotal>8</LineTotal>
      <OriginalPrice>11</OriginalPrice>
      <Price>7</Price>
      <PriceGroup>sample string 9</PriceGroup>
      <Qty>5</Qty>
    </TranDetailDto>
    <TranDetailDto>
      <Cost>6</Cost>
      <Cover>2</Cover>
      <ID>1</ID>
      <IsAddon>true</IsAddon>
      <IsDummy>true</IsDummy>
      <ItemCode>sample string 3</ItemCode>
      <ItemName>sample string 4</ItemName>
      <LineTotal>8</LineTotal>
      <OriginalPrice>11</OriginalPrice>
      <Price>7</Price>
      <PriceGroup>sample string 9</PriceGroup>
      <Qty>5</Qty>
    </TranDetailDto>
  </Invoiceitems>
  <POSCenterCode>sample string 2</POSCenterCode>
  <SC>17</SC>
  <SCRate>16</SCRate>
  <SSCL>21</SSCL>
  <SSCLRate>20</SSCLRate>
  <Settlements>
    <SettlementLineDto>
      <Amount>2</Amount>
      <AmountInLKR>3</AmountInLKR>
      <CardType>sample string 5</CardType>
      <Currency>sample string 4</Currency>
      <PaymentMethod>sample string 1</PaymentMethod>
      <RefNo>sample string 6</RefNo>
    </SettlementLineDto>
    <SettlementLineDto>
      <Amount>2</Amount>
      <AmountInLKR>3</AmountInLKR>
      <CardType>sample string 5</CardType>
      <Currency>sample string 4</Currency>
      <PaymentMethod>sample string 1</PaymentMethod>
      <RefNo>sample string 6</RefNo>
    </SettlementLineDto>
  </Settlements>
  <TDL>19</TDL>
  <TDLRate>18</TDLRate>
  <TableNo>sample string 3</TableNo>
  <VAT>23</VAT>
  <VATRate>22</VATRate>
</FinishBillRequestDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.