POST v2/OnlineOrders/TablePaymentPost
Allows for a Transaction to be marked as paid
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
CreateTablePaymentCommand| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteId | integer |
None. |
|
| TransactionId | integer |
None. |
|
| ApiOrderId | integer |
None. |
|
| Gratuity | integer |
None. |
|
| CardSurchargeAmount | integer |
None. |
|
| CloseTableOnRequest | boolean |
None. |
|
| TablePaymentItems | Collection of TablePaymentItem |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteId": 1,
"TransactionId": 2,
"ApiOrderId": 3,
"Gratuity": 4,
"CardSurchargeAmount": 5,
"CloseTableOnRequest": true,
"TablePaymentItems": [
{
"PaymentType": "sample string 1",
"Value": 2,
"TenderTypeId": 3,
"ThirdPartyReference": "sample string 4"
},
{
"PaymentType": "sample string 1",
"Value": 2,
"TenderTypeId": 3,
"ThirdPartyReference": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
System.Xml.XmlDocument
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of TableRequestResult| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteId | integer |
None. |
|
| TableName | string |
None. |
|
| TableNumber | integer |
None. |
|
| TableListItems |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"SiteId": 1,
"TableName": "sample string 2",
"TableNumber": 3,
"TableListItems": [
{
"TransactionId": 1,
"TotalValue": 2,
"BalanceValue": 3,
"ServiceCharge": 4,
"Covers": 5,
"LastUser": "sample string 6",
"SalesArea": "sample string 7",
"DateTimeOpened": "sample string 8",
"PurchaseList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"DiscountList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"PaymentList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"TaxList": [
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
},
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
}
],
"BillHeader": "sample string 9",
"BillFooter": "sample string 10"
},
{
"TransactionId": 1,
"TotalValue": 2,
"BalanceValue": 3,
"ServiceCharge": 4,
"Covers": 5,
"LastUser": "sample string 6",
"SalesArea": "sample string 7",
"DateTimeOpened": "sample string 8",
"PurchaseList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"DiscountList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"PaymentList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"TaxList": [
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
},
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
}
],
"BillHeader": "sample string 9",
"BillFooter": "sample string 10"
}
],
"IsSuccess": true,
"Message": "sample string 5"
},
{
"SiteId": 1,
"TableName": "sample string 2",
"TableNumber": 3,
"TableListItems": [
{
"TransactionId": 1,
"TotalValue": 2,
"BalanceValue": 3,
"ServiceCharge": 4,
"Covers": 5,
"LastUser": "sample string 6",
"SalesArea": "sample string 7",
"DateTimeOpened": "sample string 8",
"PurchaseList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"DiscountList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"PaymentList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"TaxList": [
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
},
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
}
],
"BillHeader": "sample string 9",
"BillFooter": "sample string 10"
},
{
"TransactionId": 1,
"TotalValue": 2,
"BalanceValue": 3,
"ServiceCharge": 4,
"Covers": 5,
"LastUser": "sample string 6",
"SalesArea": "sample string 7",
"DateTimeOpened": "sample string 8",
"PurchaseList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"DiscountList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"PaymentList": [
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"OptionItemList": [
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
},
{
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"ProductID": 1,
"MeasureID": 2,
"Quantity": "sample string 3",
"VATRate": 4.0,
"Name": "sample string 5",
"Value": 6
}
],
"TaxList": [
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
},
{
"Name": "sample string 1",
"TaxRate": 2.0,
"Value": 3
}
],
"BillHeader": "sample string 9",
"BillFooter": "sample string 10"
}
],
"IsSuccess": true,
"Message": "sample string 5"
}
]
application/xml, text/xml
Sample:
System.Xml.XmlDocument