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

Provides a list of sales payment transactions, given a shop id, a from date and a to date.

Request Information

URI Parameters

Name	Description	Type	Additional information
shopId	The shop id.	integer	Required
from	The from date in yyyy-MM-dd format.	date	Required
to	The to date in yyyy-MM-dd format.	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of SalePaymentModel

Name	Description	Type	Additional information
DebtorNumber	If the item was bought on a debitor account then this will contain the debitor number.***	integer	None.
PosNumber	Containing the origine posnumber of the sales, 99 is normaly sales though webshop	integer	None.
ReceiptNumber	Contains the receipt number, this is unique on posnumber, date, shopid	integer	None.
ClerkId	The Salespersons employeeId	integer	None.
VAT		decimal number	None.
CustomerClubNumber	The customers loyalty club number if he has one.	string	None.
Amount	Amount including VAT, discount not deducted.	decimal number	None.
GiftVoucherAutoNumber	If a giftvaucher was used then the voucher number is contained here	string	None.
GiftVoucherAlternativeNumber	if a alternative giftvoucher was used then the voucher number is contained here***	string	None.
PosTransactionType	Payment or Item	PublicAPI.Models.PosTransactionTypeViewModel	None.
ConnectorId	The ID of the Connector which handled the sale. Any cash from the sale will be in the drawer connected to this connectorId.	integer	None.
ShopId	The shop id.	integer	None.
TransactionNumber	A unique auto increment number over ShopId.	integer	None.
TransactionDateTime	The date and time of the transaction.	date	None.
TransactionType	The type of transaction, this ranges from card type to return, this varies from country to country and is there for unknown to us.	integer	None.
Quantity	The number of items on this line.	integer	None.
ItemGroupNumber	The itemgroup this item belongs to.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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.4931826+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.4931826+02:00",
    "TransactionType": 14,
    "Quantity": 15,
    "ItemGroupNumber": 16
  }
]

application/xml, text/xml

Sample:

<ArrayOfPosPaymentTransactionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <PosPaymentTransactionViewModel>
    <ItemGroupNumber>16</ItemGroupNumber>
    <Quantity>15</Quantity>
    <ShopId>11</ShopId>
    <TransactionDateTime>2025-05-04T06:08:14.4931826+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.4931826+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>
</ArrayOfPosPaymentTransactionViewModel>