GET api/transactions/sales/{shopId}/{from}

Provides a list of sales transactions, given a shop id and a from date. Will provide up to 31 days of data.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The shop id.

integer

Required

from

The from date in yyyy-MM-dd format.

date

Required

Body Parameters

None.

Response Information

Resource Description

SaleModel
NameDescriptionTypeAdditional information
SaleItems

List of sale item transactions.

Collection of SaleItemModel

None.

SalePayment

List of sale payment transactions.

Collection of SalePaymentModel

None.

Response Formats

application/json, text/json

Sample:
{
  "SaleItems": [
    {
      "CostPrice": 1.0,
      "UniqueItemNumber": 2,
      "SupplierId": 3,
      "EAN": 4,
      "WholeSaleCostPrice": 5.0,
      "EffectiveSalesPrice": 22.0,
      "Discount": 6.0,
      "DiscountCode": 7,
      "ReturnCode": 8,
      "WebOrderReference": "sample string 9",
      "CustomText": "sample string 10",
      "PosNumber": 11,
      "ReceiptNumber": 12,
      "ClerkId": 13,
      "VAT": 14.0,
      "CustomerClubNumber": "sample string 15",
      "Amount": 16.0,
      "GiftVoucherAutoNumber": "sample string 17",
      "GiftVoucherAlternativeNumber": "sample string 18",
      "PosTransactionType": "Item",
      "ConnectorId": 19,
      "ShopId": 20,
      "TransactionNumber": 21,
      "TransactionDateTime": "2025-05-04T06:08:14.6181862+02:00",
      "TransactionType": 23,
      "Quantity": 24,
      "ItemGroupNumber": 25
    },
    {
      "CostPrice": 1.0,
      "UniqueItemNumber": 2,
      "SupplierId": 3,
      "EAN": 4,
      "WholeSaleCostPrice": 5.0,
      "EffectiveSalesPrice": 22.0,
      "Discount": 6.0,
      "DiscountCode": 7,
      "ReturnCode": 8,
      "WebOrderReference": "sample string 9",
      "CustomText": "sample string 10",
      "PosNumber": 11,
      "ReceiptNumber": 12,
      "ClerkId": 13,
      "VAT": 14.0,
      "CustomerClubNumber": "sample string 15",
      "Amount": 16.0,
      "GiftVoucherAutoNumber": "sample string 17",
      "GiftVoucherAlternativeNumber": "sample string 18",
      "PosTransactionType": "Item",
      "ConnectorId": 19,
      "ShopId": 20,
      "TransactionNumber": 21,
      "TransactionDateTime": "2025-05-04T06:08:14.6181862+02:00",
      "TransactionType": 23,
      "Quantity": 24,
      "ItemGroupNumber": 25
    }
  ],
  "SalePayment": [
    {
      "DebtorNumber": 1,
      "PosNumber": 2,
      "ReceiptNumber": 3,
      "ClerkId": 4,
      "VAT": 5.0,
      "CustomerClubNumber": "sample string 6",
      "Amount": 7.0,
      "GiftVoucherAutoNumber": "sample string 8",
      "GiftVoucherAlternativeNumber": "sample string 9",
      "PosTransactionType": "Item",
      "ConnectorId": 10,
      "ShopId": 11,
      "TransactionNumber": 12,
      "TransactionDateTime": "2025-05-04T06:08:14.6181862+02:00",
      "TransactionType": 14,
      "Quantity": 15,
      "ItemGroupNumber": 16
    },
    {
      "DebtorNumber": 1,
      "PosNumber": 2,
      "ReceiptNumber": 3,
      "ClerkId": 4,
      "VAT": 5.0,
      "CustomerClubNumber": "sample string 6",
      "Amount": 7.0,
      "GiftVoucherAutoNumber": "sample string 8",
      "GiftVoucherAlternativeNumber": "sample string 9",
      "PosTransactionType": "Item",
      "ConnectorId": 10,
      "ShopId": 11,
      "TransactionNumber": 12,
      "TransactionDateTime": "2025-05-04T06:08:14.6181862+02:00",
      "TransactionType": 14,
      "Quantity": 15,
      "ItemGroupNumber": 16
    }
  ]
}

application/xml, text/xml

Sample:
<TransactionSalesViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <SaleItems>
    <PosItemTransactionViewModel>
      <ItemGroupNumber>25</ItemGroupNumber>
      <Quantity>24</Quantity>
      <ShopId>20</ShopId>
      <TransactionDateTime>2025-05-04T06:08:14.6181862+02:00</TransactionDateTime>
      <TransactionNumber>21</TransactionNumber>
      <TransactionType>23</TransactionType>
      <Amount>16</Amount>
      <ClerkId>13</ClerkId>
      <ConnectorId>19</ConnectorId>
      <CustomerClubNumber>sample string 15</CustomerClubNumber>
      <GiftVoucherAlternativeNumber>sample string 18</GiftVoucherAlternativeNumber>
      <GiftVoucherAutoNumber>sample string 17</GiftVoucherAutoNumber>
      <PosNumber>11</PosNumber>
      <PosTransactionType>Item</PosTransactionType>
      <ReceiptNumber>12</ReceiptNumber>
      <VAT>14</VAT>
      <CostPrice>1</CostPrice>
      <CustomText>sample string 10</CustomText>
      <Discount>6</Discount>
      <DiscountCode>7</DiscountCode>
      <EAN>4</EAN>
      <ReturnCode>8</ReturnCode>
      <SupplierId>3</SupplierId>
      <UniqueItemNumber>2</UniqueItemNumber>
      <WebOrderReference>sample string 9</WebOrderReference>
      <WholeSaleCostPrice>5</WholeSaleCostPrice>
    </PosItemTransactionViewModel>
    <PosItemTransactionViewModel>
      <ItemGroupNumber>25</ItemGroupNumber>
      <Quantity>24</Quantity>
      <ShopId>20</ShopId>
      <TransactionDateTime>2025-05-04T06:08:14.6181862+02:00</TransactionDateTime>
      <TransactionNumber>21</TransactionNumber>
      <TransactionType>23</TransactionType>
      <Amount>16</Amount>
      <ClerkId>13</ClerkId>
      <ConnectorId>19</ConnectorId>
      <CustomerClubNumber>sample string 15</CustomerClubNumber>
      <GiftVoucherAlternativeNumber>sample string 18</GiftVoucherAlternativeNumber>
      <GiftVoucherAutoNumber>sample string 17</GiftVoucherAutoNumber>
      <PosNumber>11</PosNumber>
      <PosTransactionType>Item</PosTransactionType>
      <ReceiptNumber>12</ReceiptNumber>
      <VAT>14</VAT>
      <CostPrice>1</CostPrice>
      <CustomText>sample string 10</CustomText>
      <Discount>6</Discount>
      <DiscountCode>7</DiscountCode>
      <EAN>4</EAN>
      <ReturnCode>8</ReturnCode>
      <SupplierId>3</SupplierId>
      <UniqueItemNumber>2</UniqueItemNumber>
      <WebOrderReference>sample string 9</WebOrderReference>
      <WholeSaleCostPrice>5</WholeSaleCostPrice>
    </PosItemTransactionViewModel>
  </SaleItems>
  <SalePayment>
    <PosPaymentTransactionViewModel>
      <ItemGroupNumber>16</ItemGroupNumber>
      <Quantity>15</Quantity>
      <ShopId>11</ShopId>
      <TransactionDateTime>2025-05-04T06:08:14.6181862+02:00</TransactionDateTime>
      <TransactionNumber>12</TransactionNumber>
      <TransactionType>14</TransactionType>
      <Amount>7</Amount>
      <ClerkId>4</ClerkId>
      <ConnectorId>10</ConnectorId>
      <CustomerClubNumber>sample string 6</CustomerClubNumber>
      <GiftVoucherAlternativeNumber>sample string 9</GiftVoucherAlternativeNumber>
      <GiftVoucherAutoNumber>sample string 8</GiftVoucherAutoNumber>
      <PosNumber>2</PosNumber>
      <PosTransactionType>Item</PosTransactionType>
      <ReceiptNumber>3</ReceiptNumber>
      <VAT>5</VAT>
      <DebtorNumber>1</DebtorNumber>
    </PosPaymentTransactionViewModel>
    <PosPaymentTransactionViewModel>
      <ItemGroupNumber>16</ItemGroupNumber>
      <Quantity>15</Quantity>
      <ShopId>11</ShopId>
      <TransactionDateTime>2025-05-04T06:08:14.6181862+02:00</TransactionDateTime>
      <TransactionNumber>12</TransactionNumber>
      <TransactionType>14</TransactionType>
      <Amount>7</Amount>
      <ClerkId>4</ClerkId>
      <ConnectorId>10</ConnectorId>
      <CustomerClubNumber>sample string 6</CustomerClubNumber>
      <GiftVoucherAlternativeNumber>sample string 9</GiftVoucherAlternativeNumber>
      <GiftVoucherAutoNumber>sample string 8</GiftVoucherAutoNumber>
      <PosNumber>2</PosNumber>
      <PosTransactionType>Item</PosTransactionType>
      <ReceiptNumber>3</ReceiptNumber>
      <VAT>5</VAT>
      <DebtorNumber>1</DebtorNumber>
    </PosPaymentTransactionViewModel>
  </SalePayment>
</TransactionSalesViewModel>