Tevalis API Help Page

Introduction

This webpage describes the API provided by Tevalis for the use with certified partners.

This API is based on a RESTFUL service and can be accessed with any programming language.

This API is tested using Postman.

The API is currently rate limited to 40 requests/s

Click on a heading to collapse/expand

Click to Download the API Documentation Download Api Documentation

v1 - Accounts

API	Description
GET Accounts?SiteID={SiteID}&AccountID={AccountID}&AccountTypeID={AccountTypeID}	Gets A List Of All Accounts for Site given
GET Accounts/Types?SiteID={SiteID}	Gets A List Of All Account Types for Site given
POST Accounts	This call is used to create a new account
PUT Accounts	This call is used to update the integration details against an existing account.
DELETE Accounts	This call is used to delete (inactify) an account

v1 - Attendance

API	Description
GET Attendance/{SiteID}?StartDate={StartDate}&EndDate={EndDate}&UserID={UserID}	Returns clock in and clock out times for users
GET Attendance/GetAttendanceLogEdits/{SiteID}?UserID={UserID}&ChangedStartDate={ChangedStartDate}&ChangedEndDate={ChangedEndDate}	Returns attendance log edits from portal for a given site.

v1 - Cache

API	Description
GET Cache/ClearSiteCache/{SiteID}	Clears the cache for anything with {siteid}
GET Cache/ClearCompanyCache	Clears the cache for the entire company

v1 - CashManagement

API	Description
GET CashManagement/GetBankingList	Gets the Banking List based on SiteID or DateTime range
GET CashManagement/GetBankingSummary?SiteID={SiteID}&BankingID={BankingID}	Gets the Banking summary based on SiteID and Banking ID
GET CashManagement/GetUnbankedZReports?SiteID={SiteID}	Gets the Unbanked Z-Reports based on SiteID
GET CashManagement/GetUnbankedSafeDrops?SiteID={SiteID}	Gets the Unbanked Safe Drops based on SiteID

v1 - Cashup

API	Description
GET Cashup/{SiteID}?ZReportID={ZReportID}&ShowLocalCurrency={ShowLocalCurrency}	Returns Z Report Cashups

v1 - Catalogue

API	Description
GET Catalogue/GetCatalogues/{SiteID}	Returns Products (V3), Measure, OptionGroups (V2), PriceGroups Catalogues and TenderTypes.

v1 - CMDiscounts

API	Description
GET Discounts/Get/{SiteID}?PackageId={PackageId}	Returns All Discounts for The Site
POST Discounts/Post/{SiteID}?PackageId={PackageId}	Post to create Discount
GET Discounts/GetDiscountWithPrices?SiteID={SiteID}&DiscountID={DiscountID}	Returns the list of PriceIds that the discount is valid against
GET Discounts/GetReasonTypes?SiteID={SiteID}&PackageId={PackageId}	Returns All Reason Types for The Site

v1 - CMMeasure

API	Description
GET CMMeasure?CMPackageId={CMPackageId}	Returns a list of CM Measures

v1 - CMPackages

API	Description
GET CMPackages/Get?SiteID={SiteID}	Returns all Packages
GET CMPackages/GetLatestPackageForSite/{SiteID}	Returns the most recent package ran for the site.

v1 - CMPrice

API	Description
GET CMPrice?CMPackageId={CMPackageId}&CMProductID={CMProductID}	Returns a list of CM Prices with PriceLinks
DELETE CMPrice/DeleteCMProductPrice	Deletes a price from CM
POST CMPrice/{SiteID}?CMPriceLinkID={CMPriceLinkID}&GrossPrice={GrossPrice}	Updates the GrossPrice of a Price in CM

v1 - CMPriceBand

API	Description
GET CMPriceBand?CMPackageId={CMPackageId}	Returns a list of CM Price Bands

v1 - CMPriceGroup

API	Description
GET CMPriceGroup?CMPackageId={CMPackageId}	Returns a list of CM Price Groups

v1 - CMProduct

API	Description
GET CMProduct/GetProductsInPackage?CMPackageId={CMPackageId}	Returns a list of CM Products
GET CMProduct/GetAllProducts	Returns a list of CM Products
POST CMProduct/DeletePackageProduct?CMPackageID={CMPackageID}&CMProductID={CMProductID}	Deletes all references of a CM Product from a given CMPackage

v1 - CMProductBulkUpdate

API	Description
GET CMProductBulkUpdate/Download?PackageId={PackageId}	No documentation available.
POST CMProductBulkUpdate?CMPackageId={CMPackageId}&CreateIfNotExists={CreateIfNotExists}	No documentation available.

v1 - CMProductGroup

API	Description
GET CMProductGroup?CMPackageId={CMPackageId}	Returns a list of CM Product Groups

v1 - CMProductMeasure

API	Description
GET CMProductMeasure?CMPackageId={CMPackageId}	Returns a list of CM Product Types

v1 - CMProductType

API	Description
GET CMProductType?CMPackageId={CMPackageId}	Returns a list of CM Product Types

v1 - CMPromotions

API	Description
GET CMPromotions?SiteID={SiteID}&PackageId={PackageId}	Returns All Promotions From The Site
POST CMPromotions?SiteID={SiteID}&PackageId={PackageId}	Create CM Promotion
PUT CMPromotions	Update CM Promotion
GET CMPromotions/GetWeekDays	Returns a list of the weekdays to avoid confusion, sunday = 0
GET CMPromotions/GetPromotionTypes	Returns a list of Promotion Types that are exposed through the API

v1 - CMTaxGroup

API	Description
GET CMTaxGroup?CMPackageId={CMPackageId}	Returns a list of CM Tax Groups

v1 - CMUser

API	Description
POST CMUser/RestoreUser?UserId={UserId}	Restores a CM User by ID
GET CMUser/GetNextRecallNumber	Returns the next unique RecallNumber
GET CMUser/GetRecallNumberExists?recallNumber={recallNumber}	Returns True or False if number in use
GET CMUser?UserID={UserID}&ExternalEmployeeID={ExternalEmployeeID}&IncludeInactive={IncludeInactive}&ScheduleDaysOld={ScheduleDaysOld}	If the client uses CM and Centralised Users, This Call Returns A List Of All Users.
POST CMUser?UserName={UserName}&LevelID={LevelID}&ExternalEmployeeID={ExternalEmployeeID}&RecallNumber={RecallNumber}&HourlyRate={HourlyRate}&CardNumber={CardNumber}&AllowedToOpenTableFromOtherClerks={AllowedToOpenTableFromOtherClerks}&SignOffAtSaleFinalisation={SignOffAtSaleFinalisation}&CompulsoryClockOn={CompulsoryClockOn}&ShowButtonOnLoginScreen={ShowButtonOnLoginScreen}&AutoDisplayFloorPlan={AutoDisplayFloorPlan}&UseSecondLanguage={UseSecondLanguage}&DispName={DispName}&EmployeeEmail={EmployeeEmail}	If the client uses CM and Centralised Users, This call creates a new Cm User, Required Username and LevelID
PUT CMUser	Updates a CM User
DELETE CMUser/Delete?UserId={UserId}	Deletes a CM User by ID
POST CMUser/CreateUser	If the client uses CM and Centralised Users, This call creates a new Cm User, Required Username and LevelID

v1 - CMUserJob

API	Description
GET CMUserJobs/Get	No documentation available.
POST CMUserJobs/Post	No documentation available.
DELETE CMUserJobs/Delete	No documentation available.

v1 - CMUserJobDay

API	Description
GET CMUserJobDays/Get	No documentation available.
POST CMUserJobDays/Post	No documentation available.

v1 - CMUserJobLink

API	Description
GET CMUserJobLinks/Get	No documentation available.
POST CMUserJobLinks/Post	No documentation available.
DELETE CMUserJobLinks/Delete?UserID={UserID}&JobID={JobID}	No documentation available.

v1 - CMUserLevel

API	Description
GET CMUserLevel?UserLevelId={UserLevelId}&externalGroupId={externalGroupId}	Returns the UserLevel
POST CMUserLevel?UserLevelName={UserLevelName}&externalGroupId={externalGroupId}	Creates a new UserLevel
PUT CMUserLevel	Updates the UserLevel
DELETE CMUserLevel/Delete?userLevelId={userLevelId}	Deletes the UserLevel if there are no users using it

v1 - CMUserSchedules

API	Description
POST CMUserSchedules/Post	No documentation available.
PUT CMUserSchedules	Updates a CM User

v1 - CSVExport

API	Description
GET Integrations/CSV/V1/GetDailySales	Returns the daily sales export data
GET Integrations/CSV/V1/GetCreditNotes	Returns the credit notes export data
GET Integrations/CSV/V1/GetPurchaseInvoices	Returns the purchase invoices export data

v1 - Deposits

API	Description
GET Deposits/Get?SiteID={SiteID}&DepositID={DepositID}&IsRedeemed={IsRedeemed}	Gets A List Of All Deposits for Site given
POST Deposits/Create	This call is used to create a new discount

v1 - DesignModes

API	Description
GET DesignModes/Get?SiteID={SiteID}&PackageId={PackageId}&Active={Active}	Returns All Design Modes From The Site default active
GET DesignModes/GetSiteSalesAreaDesignModes/{SiteID}	Returns All Design Modes From The Site where a DesignMode-Site-SalesArea link has been defined
GET DesignMode/{DesignModeID}	No documentation available.

v2 - Discounts

API	Description
GET v{version}/Discounts/Get?SiteID={SiteID}	Returns All Discounts for The Site
GET v{version}/Discounts/GetDiscountWithPrices?SiteID={SiteID}&DiscountID={DiscountID}	Returns the list of PriceIds that the discount is valid against
GET v{version}/Discounts/GetReasonTypes?SiteID={SiteID}	Returns All Reason Types for The Site

v1 - Floorplans

API	Description
GET Floorplans/{SiteID}?FloorplanID={FloorplanID}&FloorplanAreaID={FloorplanAreaID}&ColourCode={ColourCode}&IsDeleted={IsDeleted}	Gets A List Of All Floorplans, which include Table Numbers at the site

v1 - Health

API	Description
GET Health	Endpoint with no validation for checking the current health of the API - Returns a 200 OK or a 500 if the API is down.

v1 - Measures

API	Description
GET Measures/{SiteID}	Returns All Measures From The Site

v2 - OnlineOrders

API	Description
GET v{version}/OnlineOrders/CheckConnection?SiteID={SiteID}	Checks if the Site is currently connected to the API, Returns BadRequest if it is not currently connected, or Ok if it is
GET v{version}/OnlineOrders/TablePaymentRequest?SiteId={SiteId}&TableNumber={TableNumber}&TransactionID={TransactionID}	Allows for the the Pos to be queried for open tables bill data
POST v{version}/OnlineOrders/TablePaymentPost	Allows for a Transaction to be marked as paid
GET v{version}/OnlineOrders/GetLiveBillData?SiteID={SiteID}&TableNumber={TableNumber}&TransactionID={TransactionID}&TransactionComplete={TransactionComplete}	Allows for the the Pos to be queried for live bill data
GET v{version}/OnlineOrders/GetKmsAverageTicketTime?SiteID={SiteID}	Retrieves the current KMS Average Ticket Time for the requested Site
GET v{version}/OnlineOrders/PMSChargeToRoom	No documentation available.
POST v{version}/OnlineOrders/GetStockCount	Retrieve current stock level for Product IDs specified.
POST v{version}/OnlineOrders/PostStockCount	Set stock level and stock warning level of Products.
POST v{version}/OnlineOrders/CalculateOnlineOrder	Sends an order to the POS to be calculated.
POST v{version}/OnlineOrders/SubmitCalculatedOnlineOrder	Sends an order to the POS
POST v{version}/OnlineOrders/CancelOnlineOrder	Sends an order to the POS
GET v{version}/OnlineOrders/GetOpenTables	Allows for the the Pos to be queried for live bill data
POST v{version}/OnlineOrders/CreateDailyBrief	Create Daily Brief to be displayed on the EPOS upon sign-on.

v2 - OpenBillData

API	Description
POST OpenBillData/PostPOSTicketsDocumentation	This endpoint does nothing and exists solely for the Auto Generated Documentation

v2 - OptionGroups

API	Description
GET v{version}/OptionGroups?SiteID={SiteID}	V2 Version of Option Groups

v1 - OrderWebhooks

API	Description
PUT OrderWebhooks/UpdateWebhook	Updates a webhook
DELETE OrderWebhooks/DeleteWebhook?OnlineOrdersWebhookSettingId={OnlineOrdersWebhookSettingId}	Deletes the webhook
POST OrderWebhooks/CreateWebhook	Creates a webhook
GET OrderWebhooks/GetWebhooks	Lists a webhook
GET OrderWebhooks/GetWebhookTypes	Returns all webhook types

v1 - PlaceOrder

API	Description
POST PlaceOrder/CheckTransactions	Returns the current Status of the Api Order with Timestamps for each action from the pos
POST PlaceOrder/CreateOrder?Terminal={Terminal}	Creates a new Order for the pos to process, use CheckTransactions to query the status of the order
POST PlaceOrder/CancelOrders?Terminal={Terminal}	Lets the POS know that the order is to be Cancelled

v1 - PriceGroups

API	Description
GET PriceGroups/{SiteID}	Returns All Price Groups From The Site

v3 - ProductCatalogue

API	Description
GET v{version}/ProductCatalogue	Gets A List Of Products For The SiteID Given, V3 will also give you a price for every price group, instead of just giving you a price if it exists. E.g. if the site has 100 products, and only 20 of these products have a takeaway price, this endpoint will return the 100 prices, 20 of them using the takeaway price, and the rest using the standard. This endpoint is how the epos works when it’s setup to use a different price group, the price group essentially acts as an override to the standard prices

API

Description

GET v{version}/ProductCatalogue

Gets A List Of Products For The SiteID Given, V3 will also give you a price for every price group, instead of just giving you a price if it exists. E.g. if the site has 100 products, and only 20 of these products have a takeaway price, this endpoint will return the 100 prices, 20 of them using the takeaway price, and the rest using the standard. This endpoint is how the epos works when it’s setup to use a different price group, the price group essentially acts as an override to the standard prices

v1 - ProductGroups

API	Description
GET ProductGroups/{SiteID}	Returns All Product Groups From The Site

v1 - ProductImage

API	Description
GET ProductImage?ProductId={ProductId}	Gets A Product Image from a Product ID
POST ProductImage/Images	Gets a list of product images for Product Ids returning the product ids image binary in a byte array

v1 - ProductTypes

API	Description
GET ProductTypes/{SiteID}	Returns All Product Types From The Site

v1 - Promotions

API	Description
GET Promotions/GetPromoTypes?SiteID={SiteID}	Returns All Promo Types for The Site
GET Promotions/{SiteID}?PromoID={PromoID}&PromoType={PromoType}&PromoIsActive={PromoIsActive}&PromoGroupIsActive={PromoGroupIsActive}&PromoGroupProductIsActive={PromoGroupProductIsActive}	Gets A List Of All Promotions for Site given

v1 - Reporting

API	Description
GET Reporting/v1/Stock/GetWastageReport	Gets the Wastage report data for given sites.
GET Reporting/v1/Stock/GetAccountTransfersReport	Gets the Account Transfers report data for given sites.
GET Reporting/V1/Stock/GetTransfersReport	Gets the Transfers report data for given sites.
GET Reporting/v1/Stock/GetSupplierPurchasesReport	Gets the Supplier Purchases report data for given sites and suppliers.
GET Reporting/V1/Stock/GetStockReconciliationReport?periodEndDateUtc={periodEndDateUtc}	Gets the Stock Reconciliation report data for given period date.
GET Reporting/v1/Stock/GetStockPeriodItemsReport?SiteID={SiteID}&StockPeriodID={StockPeriodID}&ItemName={ItemName}&StocktakeCategoryID={StocktakeCategoryID}&ProductTypeID={ProductTypeID}&ProductGroupID={ProductGroupID}&ProductID={ProductID}	Gets the Stock Period Items report data for given Stock Period ID.
GET Reporting/v1/Stock/GetCompanyStockPeriodSummary?SiteIDs[0]={SiteIDs[0]}&SiteIDs[1]={SiteIDs[1]}&periodEndDate={periodEndDate}	Gets the Company Stock Period Summary report data for given sites and period date.
GET Reporting/v1/Stock/GetPurchaseOrdersReport	Gets the Purchase Orders report data for given sites.
GET Reporting/v1/Enterprise/GetDepositsReport?SiteID={SiteID}&DateFrom={DateFrom}&DateTo={DateTo}	Gets the Deposits Report data for given sites.
GET Reporting/v1/Enterprise/GetDiscountReport	Gets the Discounts Report data for given sites.
GET Reporting/v1/Enterprise/GetFullTransactionsReport	Gets the Full Transactions Report data for given sites.
GET Reporting/v1/Enterprise/GetFullTransactionItemsReport	Gets the Full Transactions Report data for given sites.
GET Reporting/v1/Enterprise/GetFullSalesBreakdownReportByDay	Gets the Full Sales Breakdown Report By Day report data for given sites.
GET Reporting/v1/Enterprise/GetGratuityByUserReport	Gets the Gratuity By User Report data for given sites.
GET Reporting/v1/Enterprise/GetTenderBreakdownByUserReport	Gets the Tender Breakdown By User Report data for given sites.
GET Reporting/v1/Enterprise/GetTradingSummaryReport	Gets the Trading Summary Report By Day report data for given sites.
GET Reporting/v1/Enterprise/GetTradingSummaryReportByDay	Gets the Trading Summary Report By Day report data for given sites.
GET Reporting/v1/Enterprise/GetVoidsReport	Gets the Discounts Report data for given sites.
GET Reporting/v1/Enterprise/GetWastageReport	Gets the Wastage Report report data for given sites.

v1 - Reservation

API	Description
POST Reservation/PostPOSTicketsDocumentation	This endpoint does nothing and exists solely for the Auto Generated Documentation
POST Reservation/SyncReservationsDocumentation	This endpoint does nothing and exists solely for the Auto Generated Documentation
POST Reservation/CreateReservation/{SiteID}	Endpoint for Creating or Updating a Reservation in the Tevalis EPOS system

v2 - Sales

API	Description
GET v{version}/Sales/GetSalesExport/{SiteID}?StartDate={StartDate}&EndDate={EndDate}	Returns heavy amounts of transaction information between dates, with a maximum of 1 day; Cache Time: 60 minutes.

v1 - SalesArea

API	Description
GET SalesArea/{SiteID}	Only Returns Preconfigured Sales Areas

v1 - Sites

API	Description
GET Sites	Gets A List Of All Sites for Company

v1 - Stock

API	Description
GET Stock/GetInventoryLevelsAtLocation/{SiteID}?StockLocationId={StockLocationId}	Returns the Estimated Stock Levels at the Site + Quantity on Order. Optional Stock Location
GET Stock/GetClosingLevelsAtLocation/{SiteID}?StocktakeID={StocktakeID}	Returns the Closing Stock Levels at the Site.Optional Stock Location
GET Stock/GetInventoryCatalogue/{SiteID}	Returns all products for a site including nutritional information and allergen information
GET Stock/GetPurchaseUnits/{SiteID}	Returns a list of available Purchase Units

v1 - StockCostPrice

API	Description
POST StockCostPrice/UpdateCostPrices	Allows External updates to Cost Prices based on the PLU in the Tevalis Stock System which feeds to the POS via the Stock Cost Price Service

v1 - StockLocations

API	Description
GET StockLocations/{SiteID}	Returns a list of stock locations for the Site

v1 - StockPeriods

API	Description
GET StockPeriods/v1/GetStockPeriods?SiteID={SiteID}&StartDateFromUtc={StartDateFromUtc}&EndDateToUtc={EndDateToUtc}	Returns the stock period info for a given site.

v1 - Stocktake

API	Description
GET Stocktakes/v1/GetStocktakes?SiteID={SiteID}&StartDateFromUtc={StartDateFromUtc}&EndDateToUtc={EndDateToUtc}&StockLocationID={StockLocationID}	Returns the stocktake info for a given site.

v1 - StripeAuthentication

API	Description
GET Integrations/Stripe/Authentication/ConnectionToken?stripeAccountId={stripeAccountId}	Returns a connection token for a given Stripe Account Id

v1 - StripePayments

API	Description
GET Integrations/Stripe/Payments/Capture?stripeAccountId={stripeAccountId}&paymentIntentId={paymentIntentId}	Captures a payment intent for a given Stripe Account Id

v1 - StripeRefunds

API	Description
POST Integrations/Stripe/Refunds/Create	No documentation available.

v1 - Sun

API	Description
GET Integrations/Sun/V1/GetIntegrationEnabled	Check if SSC Integration is enabled.
POST Integrations/Sun/V1/PostRefreshLookups	Trigger refresh lookups.
GET Integrations/Sun/V1/RecordIntegrationLog?SiteID={SiteID}&Action={Action}&Success={Success}&Description={Description}	Used to record log.
GET Integrations/Sun/V1/GetSitesToProcessSalesInvoice	Get a list of Sites configured to return daily sales.
GET Integrations/Sun/V1/GetZReportsForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Z-Reports for Site from date specified.
GET Integrations/Sun/V1/GetGenerateSalesInvoiceLines?SiteID={SiteID}&ZReportID={ZReportID}	Retrieve a list of sales invoice lines for Z-Report specified.
GET Integrations/Sun/V1/GetMarkZReportAsSentToSun?SiteID={SiteID}&ZReportID={ZReportID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent sales invoice.
GET Integrations/Sun/V1/GetSitesToProcessStockInvoice	Get a list of Sites configured to return stock invoices.
GET Integrations/Sun/V1/GetStockInvoicesForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Stock invoices for Site from date specified.
GET Integrations/Sun/V1/GetGenerateStockInvoiceLines?SiteID={SiteID}&ZReportID={ZReportID}	Retrieve a list of stock invoice lines for Z-Report specified.
GET Integrations/Sun/V1/GetMarkStockInvoiceAsSentToSun?SiteID={SiteID}&ZReportID={ZReportID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent stock invoice.
GET Integrations/Sun/V1/GetSitesToProcessCashups	Get a list of Sites configured to return cashups.
GET Integrations/Sun/V1/GetCashupsForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Cashups for Site from date specified.
GET Integrations/Sun/V1/GetGenerateCashupLines?SiteID={SiteID}&ZReportID={ZReportID}	Retrieve a list of cashup lines for Z-Report specified.
GET Integrations/Sun/V1/GetMarkCashupAsSentToSun?SiteID={SiteID}&ZReportID={ZReportID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent cashup.
GET Integrations/Sun/V1/GetSitesToProcessCashmanCashups	Get a list of Sites configured to return Cashman cashups.
GET Integrations/Sun/V1/GetCashmanCashupsForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Cashman Cashups for Site from date specified.
GET Integrations/Sun/V1/GetGenerateCashmanCashupLines?SiteID={SiteID}&ZReportID={ZReportID}	Retrieve a list of cashman cashup lines for Z-Report specified.
GET Integrations/Sun/V1/GetMarkCashmanCashupAsSentToSun?SiteID={SiteID}&ZReportID={ZReportID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent cashman cashup.
GET Integrations/Sun/V1/GetSitesToProcessRechargeAccounts	Get a list of Sites configured to return Recharges.
GET Integrations/Sun/V1/GetRechargeAccountsForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Recharges for Site from date specified.
GET Integrations/Sun/V1/GetGenerateRechargeLines?SiteID={SiteID}&ZReportID={ZReportID}	Retrieve a list of Recharge lines for Z-Report specified.
GET Integrations/Sun/V1/GetMarkRechargeAsSentToSun?SiteID={SiteID}&ZReportID={ZReportID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent Recharge.
GET Integrations/Sun/V1/GetSitesToProcessGoodsReceivedNotes	Get a list of Sites configured to return Goods Received Notes.
GET Integrations/Sun/V1/GetGoodsReceivedNotesForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Goods Received Notes for Site from date specified.
GET Integrations/Sun/V1/GetGenerateGoodsReceivedNoteLines?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}	Retrieve a list of Goods Received Note lines for Purchase Order ID specified.
GET Integrations/Sun/V1/GetMarkGoodsReceivedNoteAsSentToSun?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}&JournalNumber={JournalNumber}	Used to update Purchase Order to be marked as sent Goods Received Note.
GET Integrations/Sun/V1/GetSitesToProcessGoodsReversalNotes	Get a list of Sites configured to return Goods Reversal Notes.
GET Integrations/Sun/V1/GetGoodsReversalNotesForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Goods Reversal Notes for Site from date specified.
GET Integrations/Sun/V1/GetGenerateGoodsReversalNoteLines?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}	Retrieve a list of Goods Reversal Note lines for Purchase Order ID specified.
GET Integrations/Sun/V1/GetMarkGoodsReversalNoteAsSentToSun?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}&JournalNumber={JournalNumber}	Used to update Purchase Order to be marked as sent Goods Reversal Note.
GET Integrations/Sun/V1/GetSitesToProcessPurchaseOrders	Get a list of Sites configured to return Purchase Orders.
GET Integrations/Sun/V1/GetPurchaseOrdersForSite?SiteID={SiteID}&StartDate={StartDate}	Get a list of Unsent Purchase Orders for Site from date specified.
GET Integrations/Sun/V1/GetGeneratePurchaseOrderLines?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}	Retrieve a list of Purchase Order lines for Purchase Order ID specified.
GET Integrations/Sun/V1/GetMarkPurchaseOrderAsSentToSun?SiteID={SiteID}&PurchaseOrderID={PurchaseOrderID}&JournalNumber={JournalNumber}	Used to update Z-Report to be marked as sent Purchase Order.
GET Integrations/Sun/V1/GetStockLocationMappings?SiteID={SiteID}	Gets the Stock Location Mappings for given site.
GET Integrations/Sun/V1/GetSupplierMappings?SiteID={SiteID}	Gets the Supplier Mappings for given site.

v1 - Suppliers

API	Description
GET Suppliers/Get?SiteID={SiteID}&IsActive={IsActive}	Gets A List Of all Supplier for Company

v1 - TaxGroup

API	Description
GET TaxGroup/{SiteID}?IsActive={IsActive}&ShowServiceCharge={ShowServiceCharge}	Gets A List Of all Supplier for Company

v1 - Tenders

API	Description
GET Tenders/GetTenderAmountsForTransaction/{SiteId}?TransactionID={TransactionID}	Gets A List Of the Tenders against the Transaction ID
GET Tenders/GetTenderAmountsForDate/{SiteId}?StartDate={StartDate}&EndDate={EndDate}&IncludeCashout={IncludeCashout}	Gets A List Of All Tenders with their amount, with the optional flag Include Cashout defaulted to false.

v1 - TenderTypes

API	Description
GET TenderTypes/GetTenderTypes/{SiteId}?Active={Active}	Gets A List Of All Tender Types defaulted to Active only

v1 - TransactionRefund

API	Description
GET RefundTransaction/Get?SiteID={SiteID}&StartDate={StartDate}&EndDate={EndDate}	Gets A List Of All Transaction Refund Links for a given date range and site. Max 14 days

v1 - Users

API	Description
GET Users/{SiteID}?UserId={UserId}	Returns All Users From The Site

v1 - ValidateAuthorization

API	Description
GET ValidateAuthorization/Get	Returns true if authorization passed, or a 401 unauthorized
POST ValidateAuthorization/Post	Returns true if authorization passed, or a 401 unauthorized

v1 - VatTypes

API	Description
GET VatTypes/GetVatTypes/{SiteId}	Gets A List Of All VAT Types for the Site

v1 - WebVouchers

API	Description
GET WebVouchers/GetActiveVouchers	Returns Back All Active Vouchers For The Company Provided In The Headers
GET WebVouchers/GetVoucherBySerial?SerialNo={SerialNo}	Returns Back A Active Voucher With The Serial Number Provided
GET WebVouchers/GetVoucherByID?VoucherID={VoucherID}	Returns Back A Active Voucher With The ID Provided
POST WebVouchers/CreateVoucher	This call is used to create a web voucher

v1 - ZReport

API	Description
GET ZReport/{SiteID}?StartDate={StartDate}&EndDate={EndDate}	Returns Z Reports between the dates; Max 14Days

Disclaimer

Tevalis reserves the right to view and comment on any code that accesses the API for recieve, cerfitifaction and testing.

By using the API you agree to this condition.