Skip to content

Export API: Data Specification

The exported lines contain the following 39 fields:

Id, SystemName, TimeOfSale, DivisionId, DivisionName, MainGroupId, MaingroupName, ArticleGroupId, ArticleGroupName, ArticleId, ArticleName, SiteId, SiteName, ZoneId, ZoneName, OperatorId, OperatorName, Quantity, SalesExVat, SalesVat, DiscountExVat, DiscountVat, Cost, RecieptId, Guests, TableOpenTime, TableCloseTime, TableId, TakeAway, OnTheHouse, BusinessDate, UnitRule, Vendor, TicketOperatorId, TicketOperatorName, TicketTip, Payment, ProjectId, ProjectName

For csv export they will be in the order presented here.

Please note the following

Section titled “Please note the following”
  • Some fields may be marked as obsolete and are only used in rare legacy scenarios.
  • For JSON export, the data type of each field is listed beside the field name.
  • If a field represents an ID, it will always be supplied as a string. The string itself can contain either an integer value, a UUID/GUID, or a general string value.
  • The article hierarchy can be retrieved through the fields Division, MainGroup, ArticleGroup, and Article. The division represents the topmost level, and the article represents the lowest level.
  • The usage of these fields depends on the origin of the sale, and there is no guarantee that all fields will be populated with a value.
  • The datetime values provided for TimeOfSale, TableOpenTime, and TableCloseTime are all in local time for the sales venue and do not contain any time zone information.

Payload

Section titled “Payload”

ID Obsolete

  • SystemName - String
    Caspeco’s internal system name.
  • TimeOfSale - Datetime
    The time of sale of the specific line.
  • DivisionId - String
    The Vendor specific Division Id.
  • DivisionName - String
    The Vendor specific Division name.
  • MainGroupId - String
    The Vendor specific Main group id.
  • MainGroupName - String
    The Vendor specific Main group name.
  • ArticleGroupId - String
    The Vendor specific Article group Id.
  • ArticleGroupName - String
    The Vendor specific Article group name.
  • ArticleId - String
    The Vendor specific Id the article.
  • ArticleName - String
    The Vendor specific Name of the article.
  • SiteId - String
    The vendor Id of the venue.
  • SiteName - String
    The vendor Name of the venue.
  • ZoneId - String
    The vendor zone id that the sale occurred on at the venue, this can be the specific POS terminal but can also represent a zone that consists of multiple POS terminals.
  • ZoneName - String
    The vendor zone name the sale occurred on the venue, this can be the specific POS terminal but can also represent a zone that consists of multiple POS terminals.
  • OperatorId - String
    The vendor id of the cashier performing the sale.
  • OperatorName - String
    The name of the cashier performing the sale.
  • Quantity - Double
    Quantity of the article sold, this can be a decimal value.
  • SalesExVat - Double
    Total sales for the line excluding VAT.
  • SalesVat - Double
    The amount of Vat for the total sales.
  • DiscountExVat - Double
    Discount amount without Vat.
  • DiscountVat - Double
    Amount of Vat for discount.
  • Cost - Double
    Commodity Price of the items sold if available.
  • ReceiptId – String
    The id for the receipt.
  • Guest - Integer
    The number of Guests on a receipt. This value is shared across all lines of that receipt. Depending on origin system this value can be 0.
  • TableOpenTime - Datetime
    The opening time of the table. If the sale is not bound to a table this will be same value as TimeOfSale.
  • TableCloseTime - Datetime
    The close time of the table. If the sale is not bound to a table this will be same value as TimeOfSale.
  • TableId - String
    Contains the table id if the receipt is bound to a table. If the Vendor type is a PMS this might represent a room number. If the sale is a direct sale the value will be -1.
  • TakeAway - String
    If value is “ta” it signals that the line is a Take Away item.
  • OnTheHouse Obsolete
  • BusinessDate Obsolete
  • UnitRule
    Internal Caspeco system configuration.
  • Vendor - Integer
    Caspeco internal value for represtring the origin system, these can be POS, PMS or other types of sales systems.
  • TicketOperatorId
    The vendor id of the cashier closing the receipt. This should be identical to OperatorId unless the sale is bound to a table, then it might be a different cashier.
  • TicketOperatorName
    The name of the cashier closing the receipt. This should be identical to OperatorName unless the sale is bound to a table, then it might be a different cashier.
  • TicketTip - Double
    The amount of tip/gratuity given on a receipt. This value is shared across all lines of that receipt.
  • Payment - String
    Payment type used. The value is an internal Caspeco representation.
  • ProjectId – String
    Project Id if sale is associated with a project.
  • ProjectName – String
    Project Name if sale is associated with a project.
  • EmptyGroup – Boolean
    Is true if a record is empty

Multiple options can be selected.