POST api/TransactionHeader
Request Information
URI Parameters
None.
Body Parameters
TransactionHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| PosVisitId | globally unique identifier |
None. |
|
| PosTransactionId | globally unique identifier |
None. |
|
| PosReservationNumber | integer |
None. |
|
| PosReservationComments | string |
None. |
|
| CsrComments | string |
None. |
|
| TransactionDate | date |
None. |
|
| PosOriginalTransactionId | globally unique identifier |
None. |
|
| PosTransactionStatus | integer |
None. |
|
| ServiceDate | date |
None. |
|
| TrainingMode | boolean |
None. |
|
| TerminalNumber | integer |
None. |
|
| OperatorId | string |
None. |
|
| SubTotalAmount | decimal number |
None. |
|
| TaxAmount | decimal number |
None. |
|
| VatTotalTax | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| PaidAmount | decimal number |
None. |
|
| InvoiceType | string |
None. |
|
| InvoiceNumber | string |
None. |
|
| LastUpdatedBy | string |
None. |
|
| NotInFlightboard | boolean |
None. |
|
| TransactionDetails | Collection of TransactionDetail |
None. |
|
| TransactionPayments | Collection of TransactionPayment |
None. |
|
| TransactionReservationDetail | TransactionReservationDetail |
None. |
Request Formats
application/json, text/json
Sample:
{
"PosVisitId": "3b76a684-8884-4330-b570-40ec2494663b",
"PosTransactionId": "356b17cf-1d0c-4018-9b29-e773af8ac192",
"PosReservationNumber": 1,
"PosReservationComments": "sample string 3",
"CsrComments": "sample string 4",
"TransactionDate": "2026-02-04T02:37:14.3899844",
"PosOriginalTransactionId": "6134f0cb-e373-4995-adec-d6f013d82490",
"PosTransactionStatus": 1,
"ServiceDate": "2026-02-04T02:37:14.3899844",
"TrainingMode": true,
"TerminalNumber": 1,
"OperatorId": "sample string 7",
"SubTotalAmount": 1.0,
"TaxAmount": 1.0,
"VatTotalTax": 1.0,
"TotalAmount": 1.0,
"PaidAmount": 1.0,
"InvoiceType": "sample string 8",
"InvoiceNumber": "sample string 9",
"LastUpdatedBy": "sample string 10",
"NotInFlightboard": true,
"TransactionDetails": [
{
"LineId": "0741973e-6cf0-49c9-8468-d065560f4997",
"PosTransactionId": "7afb57f8-2700-4c1b-b0c0-b28a0b952c74",
"Status": 3,
"LineNumber": 4,
"ParentLineNumber": 5,
"ItemDate": "2026-02-04T02:37:14.3899844",
"ProductCode": "sample string 6",
"ProductDescription": "sample string 7",
"ProductCategory": "sample string 8",
"Quantity": 1.0,
"UnitAmount": 1.0,
"TotalAmount": 1.0,
"TaxAmount": 1.0,
"EffectiveDate": "2026-02-04T02:37:14.3899844",
"AddOnType": "sample string 9",
"ItemType": "sample string 10",
"ServiceChargeAmount": 1.0,
"Comments": "sample string 11",
"IsPaid": true,
"RequestedDate": "2026-02-04T02:37:14.3899844",
"RequestedUserId": "sample string 12",
"AssignedDate": "2026-02-04T02:37:14.3899844",
"AssignedByUserId": "sample string 13",
"AssignedToUserId": "sample string 14",
"PriceState": 1,
"LastUpdatedBy": "sample string 15"
},
{
"LineId": "0741973e-6cf0-49c9-8468-d065560f4997",
"PosTransactionId": "7afb57f8-2700-4c1b-b0c0-b28a0b952c74",
"Status": 3,
"LineNumber": 4,
"ParentLineNumber": 5,
"ItemDate": "2026-02-04T02:37:14.3899844",
"ProductCode": "sample string 6",
"ProductDescription": "sample string 7",
"ProductCategory": "sample string 8",
"Quantity": 1.0,
"UnitAmount": 1.0,
"TotalAmount": 1.0,
"TaxAmount": 1.0,
"EffectiveDate": "2026-02-04T02:37:14.3899844",
"AddOnType": "sample string 9",
"ItemType": "sample string 10",
"ServiceChargeAmount": 1.0,
"Comments": "sample string 11",
"IsPaid": true,
"RequestedDate": "2026-02-04T02:37:14.3899844",
"RequestedUserId": "sample string 12",
"AssignedDate": "2026-02-04T02:37:14.3899844",
"AssignedByUserId": "sample string 13",
"AssignedToUserId": "sample string 14",
"PriceState": 1,
"LastUpdatedBy": "sample string 15"
}
],
"TransactionPayments": [
{
"PosTransactionId": "4eaeb7c5-8d59-44f5-a36f-229d6881829d",
"PosPaymentId": 2,
"PaymentType": 3,
"Amount": 4.0,
"IsAccountOnFile": true,
"Status": 5,
"LastUpdatedBy": "sample string 6"
},
{
"PosTransactionId": "4eaeb7c5-8d59-44f5-a36f-229d6881829d",
"PosPaymentId": 2,
"PaymentType": 3,
"Amount": 4.0,
"IsAccountOnFile": true,
"Status": 5,
"LastUpdatedBy": "sample string 6"
}
],
"TransactionReservationDetail": {
"ReservationDetailId": 1,
"PosTransactionId": "3befefe2-449a-447c-a4bf-99e5c1e6184d",
"Coffee": 3,
"CoffeeStatus": 4,
"Ice": 5,
"IceStatus": 6,
"Newspaper": 7,
"NewspaperStatus": 8,
"CustomsRequired": true,
"LmStatus": "sample string 10",
"PullOnLine": "sample string 11",
"PullOnLineComplete": true,
"LastUpdatedDate": "2026-02-04T02:37:14.3899844",
"LastUpdatedBy": "sample string 14",
"CoffeeComments": "sample string 15",
"IceComments": "sample string 16",
"NewspaperComments": "sample string 17"
}
}
application/xml, text/xml
Sample:
<TransactionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bba.Reservations.Models">
<CsrComments>sample string 4</CsrComments>
<InvoiceNumber>sample string 9</InvoiceNumber>
<InvoiceType>sample string 8</InvoiceType>
<LastUpdatedBy>sample string 10</LastUpdatedBy>
<NotInFlightboard>true</NotInFlightboard>
<OperatorId>sample string 7</OperatorId>
<PaidAmount>1</PaidAmount>
<PosOriginalTransactionId>6134f0cb-e373-4995-adec-d6f013d82490</PosOriginalTransactionId>
<PosReservationComments>sample string 3</PosReservationComments>
<PosReservationNumber>1</PosReservationNumber>
<PosTransactionId>356b17cf-1d0c-4018-9b29-e773af8ac192</PosTransactionId>
<PosTransactionStatus>1</PosTransactionStatus>
<PosVisitId>3b76a684-8884-4330-b570-40ec2494663b</PosVisitId>
<ServiceDate>2026-02-04T02:37:14.3899844+00:00</ServiceDate>
<SubTotalAmount>1</SubTotalAmount>
<TaxAmount>1</TaxAmount>
<TerminalNumber>1</TerminalNumber>
<TotalAmount>1</TotalAmount>
<TrainingMode>true</TrainingMode>
<TransactionDate>2026-02-04T02:37:14.3899844+00:00</TransactionDate>
<TransactionDetails>
<TransactionDetail>
<AddOnType>sample string 9</AddOnType>
<AssignedByUserId>sample string 13</AssignedByUserId>
<AssignedDate>2026-02-04T02:37:14.3899844+00:00</AssignedDate>
<AssignedToUserId>sample string 14</AssignedToUserId>
<Comments>sample string 11</Comments>
<EffectiveDate>2026-02-04T02:37:14.3899844+00:00</EffectiveDate>
<IsPaid>true</IsPaid>
<ItemDate>2026-02-04T02:37:14.3899844+00:00</ItemDate>
<ItemType>sample string 10</ItemType>
<LastUpdatedBy>sample string 15</LastUpdatedBy>
<LineId>0741973e-6cf0-49c9-8468-d065560f4997</LineId>
<LineNumber>4</LineNumber>
<ParentLineNumber>5</ParentLineNumber>
<PosTransactionId>7afb57f8-2700-4c1b-b0c0-b28a0b952c74</PosTransactionId>
<PriceState>1</PriceState>
<ProductCategory>sample string 8</ProductCategory>
<ProductCode>sample string 6</ProductCode>
<ProductDescription>sample string 7</ProductDescription>
<Quantity>1</Quantity>
<RequestedDate>2026-02-04T02:37:14.3899844+00:00</RequestedDate>
<RequestedUserId>sample string 12</RequestedUserId>
<ServiceChargeAmount>1</ServiceChargeAmount>
<Status>3</Status>
<TaxAmount>1</TaxAmount>
<TotalAmount>1</TotalAmount>
<UnitAmount>1</UnitAmount>
</TransactionDetail>
<TransactionDetail>
<AddOnType>sample string 9</AddOnType>
<AssignedByUserId>sample string 13</AssignedByUserId>
<AssignedDate>2026-02-04T02:37:14.3899844+00:00</AssignedDate>
<AssignedToUserId>sample string 14</AssignedToUserId>
<Comments>sample string 11</Comments>
<EffectiveDate>2026-02-04T02:37:14.3899844+00:00</EffectiveDate>
<IsPaid>true</IsPaid>
<ItemDate>2026-02-04T02:37:14.3899844+00:00</ItemDate>
<ItemType>sample string 10</ItemType>
<LastUpdatedBy>sample string 15</LastUpdatedBy>
<LineId>0741973e-6cf0-49c9-8468-d065560f4997</LineId>
<LineNumber>4</LineNumber>
<ParentLineNumber>5</ParentLineNumber>
<PosTransactionId>7afb57f8-2700-4c1b-b0c0-b28a0b952c74</PosTransactionId>
<PriceState>1</PriceState>
<ProductCategory>sample string 8</ProductCategory>
<ProductCode>sample string 6</ProductCode>
<ProductDescription>sample string 7</ProductDescription>
<Quantity>1</Quantity>
<RequestedDate>2026-02-04T02:37:14.3899844+00:00</RequestedDate>
<RequestedUserId>sample string 12</RequestedUserId>
<ServiceChargeAmount>1</ServiceChargeAmount>
<Status>3</Status>
<TaxAmount>1</TaxAmount>
<TotalAmount>1</TotalAmount>
<UnitAmount>1</UnitAmount>
</TransactionDetail>
</TransactionDetails>
<TransactionPayments>
<TransactionPayment>
<Amount>4</Amount>
<IsAccountOnFile>true</IsAccountOnFile>
<LastUpdatedBy>sample string 6</LastUpdatedBy>
<PaymentType>3</PaymentType>
<PosPaymentId>2</PosPaymentId>
<PosTransactionId>4eaeb7c5-8d59-44f5-a36f-229d6881829d</PosTransactionId>
<Status>5</Status>
</TransactionPayment>
<TransactionPayment>
<Amount>4</Amount>
<IsAccountOnFile>true</IsAccountOnFile>
<LastUpdatedBy>sample string 6</LastUpdatedBy>
<PaymentType>3</PaymentType>
<PosPaymentId>2</PosPaymentId>
<PosTransactionId>4eaeb7c5-8d59-44f5-a36f-229d6881829d</PosTransactionId>
<Status>5</Status>
</TransactionPayment>
</TransactionPayments>
<TransactionReservationDetail>
<Coffee>3</Coffee>
<CoffeeComments>sample string 15</CoffeeComments>
<CoffeeStatus>4</CoffeeStatus>
<CustomsRequired>true</CustomsRequired>
<Ice>5</Ice>
<IceComments>sample string 16</IceComments>
<IceStatus>6</IceStatus>
<LastUpdatedBy>sample string 14</LastUpdatedBy>
<LastUpdatedDate>2026-02-04T02:37:14.3899844+00:00</LastUpdatedDate>
<LmStatus>sample string 10</LmStatus>
<Newspaper>7</Newspaper>
<NewspaperComments>sample string 17</NewspaperComments>
<NewspaperStatus>8</NewspaperStatus>
<PosTransactionId>3befefe2-449a-447c-a4bf-99e5c1e6184d</PosTransactionId>
<PullOnLine>sample string 11</PullOnLine>
<PullOnLineComplete>true</PullOnLineComplete>
<ReservationDetailId>1</ReservationDetailId>
</TransactionReservationDetail>
<VatTotalTax>1</VatTotalTax>
</TransactionHeader>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |