POST api/Transaction

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TransactionID	integer	None.
ExtTransactionID	integer	None.
Datetime	date	None.
LocationID	integer	None.
TillID	integer	None.
ClerkID	integer	None.
SaleTypeID	integer	None.
StockPeriodID	integer	None.
TagID	integer	None.
MemberID	integer	None.
Covers	integer	None.
TransactionType	integer	None.
SourceID	integer	None.
TableNo	integer	None.
SaleItems	Collection of SaleItems	None.
PaymentItems	Collection of PaymentItems	None.
Customer	TransactionCustomer	None.

Request Formats

application/json, text/json

Sample:

{
  "TransactionID": 1,
  "ExtTransactionID": 2,
  "Datetime": "2025-05-06T09:41:50.5513064+01:00",
  "LocationID": 3,
  "TillID": 4,
  "ClerkID": 5,
  "SaleTypeID": 6,
  "StockPeriodID": 7,
  "TagID": 8,
  "MemberID": 9,
  "Covers": 10,
  "TransactionType": 11,
  "SourceID": 12,
  "TableNo": 13,
  "SaleItems": [
    {
      "SaleID": 1,
      "ProductID": 2,
      "PriceLevelID": 3,
      "UnitPrice": 4.1,
      "Quantity": 5,
      "Gross": 6.1,
      "Tax": 7.1,
      "ComboProductID": 8,
      "PointsObtained": 9,
      "UnitRRPGross": 10.1,
      "ExtSaleID": 11,
      "ExtParentSaleID": 12,
      "Cost": 13.1,
      "ActualCost": 14.1,
      "Discount": 15.1,
      "SaleTypeID": 16
    },
    {
      "SaleID": 1,
      "ProductID": 2,
      "PriceLevelID": 3,
      "UnitPrice": 4.1,
      "Quantity": 5,
      "Gross": 6.1,
      "Tax": 7.1,
      "ComboProductID": 8,
      "PointsObtained": 9,
      "UnitRRPGross": 10.1,
      "ExtSaleID": 11,
      "ExtParentSaleID": 12,
      "Cost": 13.1,
      "ActualCost": 14.1,
      "Discount": 15.1,
      "SaleTypeID": 16
    }
  ],
  "PaymentItems": [
    {
      "PaymentID": 1,
      "MediaID": 2,
      "Amount": 3.1,
      "PointsObtained": 4,
      "ExtPaymentID": 5,
      "CardTypeName": "sample string 6",
      "CardNumber": "sample string 7"
    },
    {
      "PaymentID": 1,
      "MediaID": 2,
      "Amount": 3.1,
      "PointsObtained": 4,
      "ExtPaymentID": 5,
      "CardTypeName": "sample string 6",
      "CardNumber": "sample string 7"
    }
  ],
  "Customer": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "Surname": "sample string 3",
    "Email": "sample string 4",
    "Mobile": "sample string 5",
    "Landline": "sample string 6",
    "ExtCustomerID": "sample string 7",
    "Code": "sample string 8",
    "Address": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "City": "sample string 4",
      "County": "sample string 5",
      "PostCode": "sample string 6",
      "Country": "sample string 7"
    }
  }
}

application/xml, text/xml

Sample:

<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CentegraWebhook.Models">
  <ClerkID>5</ClerkID>
  <Covers>10</Covers>
  <Customer>
    <Address>
      <City>sample string 4</City>
      <Country>sample string 7</Country>
      <County>sample string 5</County>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
      <PostCode>sample string 6</PostCode>
    </Address>
    <Code>sample string 8</Code>
    <Email>sample string 4</Email>
    <ExtCustomerID>sample string 7</ExtCustomerID>
    <FirstName>sample string 2</FirstName>
    <Landline>sample string 6</Landline>
    <Mobile>sample string 5</Mobile>
    <Surname>sample string 3</Surname>
    <Title>sample string 1</Title>
  </Customer>
  <Datetime>2025-05-06T09:41:50.5513064+01:00</Datetime>
  <ExtTransactionID>2</ExtTransactionID>
  <LocationID>3</LocationID>
  <MemberID>9</MemberID>
  <PaymentItems>
    <PaymentItems>
      <Amount>3.1</Amount>
      <CardNumber>sample string 7</CardNumber>
      <CardTypeName>sample string 6</CardTypeName>
      <ExtPaymentID>5</ExtPaymentID>
      <MediaID>2</MediaID>
      <PaymentID>1</PaymentID>
      <PointsObtained>4</PointsObtained>
    </PaymentItems>
    <PaymentItems>
      <Amount>3.1</Amount>
      <CardNumber>sample string 7</CardNumber>
      <CardTypeName>sample string 6</CardTypeName>
      <ExtPaymentID>5</ExtPaymentID>
      <MediaID>2</MediaID>
      <PaymentID>1</PaymentID>
      <PointsObtained>4</PointsObtained>
    </PaymentItems>
  </PaymentItems>
  <SaleItems>
    <SaleItems>
      <ActualCost>14.1</ActualCost>
      <ComboProductID>8</ComboProductID>
      <Cost>13.1</Cost>
      <Discount>15.1</Discount>
      <ExtParentSaleID>12</ExtParentSaleID>
      <ExtSaleID>11</ExtSaleID>
      <Gross>6.1</Gross>
      <PointsObtained>9</PointsObtained>
      <PriceLevelID>3</PriceLevelID>
      <ProductID>2</ProductID>
      <Quantity>5</Quantity>
      <SaleID>1</SaleID>
      <SaleTypeID>16</SaleTypeID>
      <Tax>7.1</Tax>
      <UnitPrice>4.1</UnitPrice>
      <UnitRRPGross>10.1</UnitRRPGross>
    </SaleItems>
    <SaleItems>
      <ActualCost>14.1</ActualCost>
      <ComboProductID>8</ComboProductID>
      <Cost>13.1</Cost>
      <Discount>15.1</Discount>
      <ExtParentSaleID>12</ExtParentSaleID>
      <ExtSaleID>11</ExtSaleID>
      <Gross>6.1</Gross>
      <PointsObtained>9</PointsObtained>
      <PriceLevelID>3</PriceLevelID>
      <ProductID>2</ProductID>
      <Quantity>5</Quantity>
      <SaleID>1</SaleID>
      <SaleTypeID>16</SaleTypeID>
      <Tax>7.1</Tax>
      <UnitPrice>4.1</UnitPrice>
      <UnitRRPGross>10.1</UnitRRPGross>
    </SaleItems>
  </SaleItems>
  <SaleTypeID>6</SaleTypeID>
  <SourceID>12</SourceID>
  <StockPeriodID>7</StockPeriodID>
  <TableNo>13</TableNo>
  <TagID>8</TagID>
  <TillID>4</TillID>
  <TransactionID>1</TransactionID>
  <TransactionType>11</TransactionType>
</Transaction>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOutput

Name	Description	Type	Additional information
Response		boolean	None.
Error		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Error": "sample string 2"
}

application/xml, text/xml

Sample:

<ApiOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CentegraWebhook.Controllers">
  <Error>sample string 2</Error>
  <Response>true</Response>
</ApiOutput>