POST api/TransactionHeader

Request Information

URI Parameters

None.

Body Parameters

Name	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": "32f563b8-bc52-4376-9e64-554ecbfa09a0",
  "PosTransactionId": "3d86c405-779e-432a-b748-346aac7da21c",
  "PosReservationNumber": 1,
  "PosReservationComments": "sample string 3",
  "CsrComments": "sample string 4",
  "TransactionDate": "2025-05-04T16:47:01.5314349",
  "PosOriginalTransactionId": "fa437d49-252d-41fe-8361-021ef0a56b6e",
  "PosTransactionStatus": 1,
  "ServiceDate": "2025-05-04T16:47:01.5314349",
  "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": "f0882980-d274-4e1b-b5a1-8407a69fc1d4",
      "PosTransactionId": "7389f1e8-9cbf-4ff8-b943-884424fa9e77",
      "Status": 3,
      "LineNumber": 4,
      "ParentLineNumber": 5,
      "ItemDate": "2025-05-04T16:47:01.5314349",
      "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": "2025-05-04T16:47:01.5314349",
      "AddOnType": "sample string 9",
      "ItemType": "sample string 10",
      "ServiceChargeAmount": 1.0,
      "Comments": "sample string 11",
      "IsPaid": true,
      "RequestedDate": "2025-05-04T16:47:01.5314349",
      "RequestedUserId": "sample string 12",
      "AssignedDate": "2025-05-04T16:47:01.5314349",
      "AssignedByUserId": "sample string 13",
      "AssignedToUserId": "sample string 14",
      "PriceState": 1,
      "LastUpdatedBy": "sample string 15"
    },
    {
      "LineId": "f0882980-d274-4e1b-b5a1-8407a69fc1d4",
      "PosTransactionId": "7389f1e8-9cbf-4ff8-b943-884424fa9e77",
      "Status": 3,
      "LineNumber": 4,
      "ParentLineNumber": 5,
      "ItemDate": "2025-05-04T16:47:01.5314349",
      "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": "2025-05-04T16:47:01.5314349",
      "AddOnType": "sample string 9",
      "ItemType": "sample string 10",
      "ServiceChargeAmount": 1.0,
      "Comments": "sample string 11",
      "IsPaid": true,
      "RequestedDate": "2025-05-04T16:47:01.5314349",
      "RequestedUserId": "sample string 12",
      "AssignedDate": "2025-05-04T16:47:01.5314349",
      "AssignedByUserId": "sample string 13",
      "AssignedToUserId": "sample string 14",
      "PriceState": 1,
      "LastUpdatedBy": "sample string 15"
    }
  ],
  "TransactionPayments": [
    {
      "PosTransactionId": "60a88a3e-94db-42e2-a3f7-c84b19aca150",
      "PosPaymentId": 2,
      "PaymentType": 3,
      "Amount": 4.0,
      "IsAccountOnFile": true,
      "Status": 5,
      "LastUpdatedBy": "sample string 6"
    },
    {
      "PosTransactionId": "60a88a3e-94db-42e2-a3f7-c84b19aca150",
      "PosPaymentId": 2,
      "PaymentType": 3,
      "Amount": 4.0,
      "IsAccountOnFile": true,
      "Status": 5,
      "LastUpdatedBy": "sample string 6"
    }
  ],
  "TransactionReservationDetail": {
    "ReservationDetailId": 1,
    "PosTransactionId": "5682a4ba-c7f0-4f8e-8275-aa2c475325c6",
    "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": "2025-05-04T16:47:01.5314349",
    "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>fa437d49-252d-41fe-8361-021ef0a56b6e</PosOriginalTransactionId>
  <PosReservationComments>sample string 3</PosReservationComments>
  <PosReservationNumber>1</PosReservationNumber>
  <PosTransactionId>3d86c405-779e-432a-b748-346aac7da21c</PosTransactionId>
  <PosTransactionStatus>1</PosTransactionStatus>
  <PosVisitId>32f563b8-bc52-4376-9e64-554ecbfa09a0</PosVisitId>
  <ServiceDate>2025-05-04T16:47:01.5314349+00:00</ServiceDate>
  <SubTotalAmount>1</SubTotalAmount>
  <TaxAmount>1</TaxAmount>
  <TerminalNumber>1</TerminalNumber>
  <TotalAmount>1</TotalAmount>
  <TrainingMode>true</TrainingMode>
  <TransactionDate>2025-05-04T16:47:01.5314349+00:00</TransactionDate>
  <TransactionDetails>
    <TransactionDetail>
      <AddOnType>sample string 9</AddOnType>
      <AssignedByUserId>sample string 13</AssignedByUserId>
      <AssignedDate>2025-05-04T16:47:01.5314349+00:00</AssignedDate>
      <AssignedToUserId>sample string 14</AssignedToUserId>
      <Comments>sample string 11</Comments>
      <EffectiveDate>2025-05-04T16:47:01.5314349+00:00</EffectiveDate>
      <IsPaid>true</IsPaid>
      <ItemDate>2025-05-04T16:47:01.5314349+00:00</ItemDate>
      <ItemType>sample string 10</ItemType>
      <LastUpdatedBy>sample string 15</LastUpdatedBy>
      <LineId>f0882980-d274-4e1b-b5a1-8407a69fc1d4</LineId>
      <LineNumber>4</LineNumber>
      <ParentLineNumber>5</ParentLineNumber>
      <PosTransactionId>7389f1e8-9cbf-4ff8-b943-884424fa9e77</PosTransactionId>
      <PriceState>1</PriceState>
      <ProductCategory>sample string 8</ProductCategory>
      <ProductCode>sample string 6</ProductCode>
      <ProductDescription>sample string 7</ProductDescription>
      <Quantity>1</Quantity>
      <RequestedDate>2025-05-04T16:47:01.5314349+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>2025-05-04T16:47:01.5314349+00:00</AssignedDate>
      <AssignedToUserId>sample string 14</AssignedToUserId>
      <Comments>sample string 11</Comments>
      <EffectiveDate>2025-05-04T16:47:01.5314349+00:00</EffectiveDate>
      <IsPaid>true</IsPaid>
      <ItemDate>2025-05-04T16:47:01.5314349+00:00</ItemDate>
      <ItemType>sample string 10</ItemType>
      <LastUpdatedBy>sample string 15</LastUpdatedBy>
      <LineId>f0882980-d274-4e1b-b5a1-8407a69fc1d4</LineId>
      <LineNumber>4</LineNumber>
      <ParentLineNumber>5</ParentLineNumber>
      <PosTransactionId>7389f1e8-9cbf-4ff8-b943-884424fa9e77</PosTransactionId>
      <PriceState>1</PriceState>
      <ProductCategory>sample string 8</ProductCategory>
      <ProductCode>sample string 6</ProductCode>
      <ProductDescription>sample string 7</ProductDescription>
      <Quantity>1</Quantity>
      <RequestedDate>2025-05-04T16:47:01.5314349+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>60a88a3e-94db-42e2-a3f7-c84b19aca150</PosTransactionId>
      <Status>5</Status>
    </TransactionPayment>
    <TransactionPayment>
      <Amount>4</Amount>
      <IsAccountOnFile>true</IsAccountOnFile>
      <LastUpdatedBy>sample string 6</LastUpdatedBy>
      <PaymentType>3</PaymentType>
      <PosPaymentId>2</PosPaymentId>
      <PosTransactionId>60a88a3e-94db-42e2-a3f7-c84b19aca150</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>2025-05-04T16:47:01.5314349+00:00</LastUpdatedDate>
    <LmStatus>sample string 10</LmStatus>
    <Newspaper>7</Newspaper>
    <NewspaperComments>sample string 17</NewspaperComments>
    <NewspaperStatus>8</NewspaperStatus>
    <PosTransactionId>5682a4ba-c7f0-4f8e-8275-aa2c475325c6</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	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.