Allergen

APIDescription
GET api/Allergen

returns a list of Allergens/Ingredients with Code and description

ArtikelErfassung

APIDescription
POST api/AE/Uebernehmen

Provide a list (header and detail data) from a mobile device sent to KOST for INV,PERS,etc.

POST api/AE/SchreibeBarcodes

Add new Barcodes to existing item (either by using an existing BC or the IDCode)

GET api/AE/Betriebsinfo

Get Information for the current company

Cards

APIDescription
GET api/Cards/RechteAbfragen

Send client_id and client_secret; Server answers with AccesToken or RefreshToken

POST api/Cards/CardInfo

Send card_Id and type; Server answers with CardData

POST api/Cards/SaveCardTransaction

Send card transaction, server answers with valid true/false (transaction completed) and the new balance

POST api/Cards/BookTransaction

Send card transaction and Order to be booked

POST api/Cards/LockCard

Send card_Id Server answers with CardResponse

CateringEventList

APIDescription
GET api/CateringEventList?DaysAhead={DaysAhead}&ShowAll={ShowAll}

returns a list of Catering Events exportable for checkout with the status "30 - Ordered" or "45 - Billing"

ClientDeliveryNote

APIDescription
GET api/ClientDeliveryNote

Returns a list of client delivery notes

GET api/ClientDeliveryNote/{id}

Returns a list of client delivery notes

PUT api/ClientDeliveryNote

Updates the delivery note with the given value

CostCenter

APIDescription
GET api/CostCenter

returns a list of available Cost Centers

GET api/CostCenter/{id}

Returns a list of available sales items for the cost center with the id Code

eBon

APIDescription
POST api/Sales/eBon

Get a PDF for a salesBon

ElectronicDeliveryNote

APIDescription
POST api/ElectronicDeliveryNote

Creates a new electronic delivery note

Events

APIDescription
POST api/Events/GetEvents

Awaits startdate and enddate, returns a list of all matching Events

POST api/Events/Hospitality

Awaits

POST api/Events/QRCode

Awaits

FileUpload

APIDescription
POST api/FileUpload

Allows the Upload of a file; max. size (and buffersize) is to be handled within the web.config

IFCVersion

APIDescription
GET api/IFCVersion

Returns the compile date of the KostInterface. X-ApiKey and X-Apiuser is not mandatory

GET api/IFCVersion/{Id}

Returns DB-Infos of the Kostinstance with the given Id. X-ApiKey and X-Apiuser is mandatory

GET api/IFCVersion/{Id}?UserDB={UserDB}

No documentation available.

Import

APIDescription
GET api/Import/{id}

Returns the empty structure of a Receipt

POST api/Import

Import Sales

ImportHelloTess

APIDescription
POST api/ImportHelloTess

Import Sales from HelloTess

InvoiceInfo

APIDescription
GET api/InvoiceInfo?Invoicenumber={Invoicenumber}&Invoicedate={Invoicedate}&SupplierAccnumber={SupplierAccnumber}

returns Invoice Info for given InvoiceNumber, InvoiceDate and Supplier Accounting Number.

InvoiceInfoSAP

APIDescription
GET api/InvoiceInfoSAP?Invoicenumber={Invoicenumber}&Invoicedate={Invoicedate}&SupplierAccnumber={SupplierAccnumber}

returns Invoice Info for given InvoiceNumber, InvoiceDate and Supplier Accounting Number.

InvoiceList

APIDescription
GET api/InvoiceList?Invoicedate={Invoicedate}

Invoice List returns for given InvoiceDate : Supplier, Accounting Number and InvoiceNumber List

License

APIDescription
POST api/License/SetConfig

Function for writing the settings from the encrypted license file

APIDescription
GET api/Menu/MenuDisplayLastExport

returns the last time a user pressed the "An Display senden" button

GET api/Menu/MenuPlans

returns a list of all menu plans

GET api/Menu/MenuLines

returns a list of all menu lines

GET api/Menu/MenuLines?MPGNr={MPGNr}

returns a list of all menu lines

GET api/Menu/MenuComponents

returns a list of all menu components

GET api/Menu/MenuAdditionalInfos

returns a list of all menu plan additional information

GET api/Menu/MenuDisplay?MPGNr={MPGNr}&MenuDate={MenuDate}&Days={Days}&Lng={Lng}

returns a list of all menus in on menuplan

POST api/Menu/MenuOrder

Books ordered Menus into the system either with the amount ordered or the amount sold, optional a factor can be provided

POST api/Menu/MenuExport

Sends the (conformed) Menuitems for a specified period, menuplan, costcenter. Additionally informations if requested

POST api/Menu/DownloadItemPictures

Allows the download of pictures of salesitems

POST api/Menu/ItemExport

Sends the Menuitems and the corresponding salesitems for a specified period,menuplan,costcenter

Order

APIDescription
GET api/Order

Returns a list of actual orders (-10 days up to 10 days ahead, adjust in Settings of the rest service)

GET api/Order/{Id}

returns one order with the given OrderNumber (BestellNr)

OrderItem

APIDescription
GET api/OrderItem?ChangedAfter={ChangedAfter}

return a list of all orderitems. Optional param "ChangedAfter" : only Orderitems changed after yyyy.MM.dd HH:mm:ss

GET api/OrderItem/{id}

return the orderitem with the given code (IDCode)

PaymentMethods

APIDescription
GET api/PaymentMethods

returns a list of available payment methods

ProductGroupSales

APIDescription
GET api/ProductGroupSales

returns a list of Sales Product Groups

ProductionItem

APIDescription
GET api/ProductionItem/{id}

No documentation available.

GET api/ProductionItem?ChangedAfter={ChangedAfter}

return a list of all production items. Optional param "ChangedAfter" : only productionitems changed after yyyy.MM.dd HH:mm:ss

PurchaseList

APIDescription
POST api/Sales/CreatePurchaseList

Get all Informations about a voucher by his number

QCFactor

APIDescription
GET api/QCFactor

returns a list of Quality Control Factors

GET api/QCFactor/{id}

returns the Quality Control Factor with the given id

QCSupplierRating

APIDescription
GET api/QCSupplierRating

returns rating levels, general rating types for suppliers and a list of actions for quantity deviations in orders

SalesItem

APIDescription
POST api/Sales/SalesItemInfo

Send CCCode and various parameters, Get a list of all matching Sales Items

POST api/Sales/BookInvoiceReceipts

Book Sale (without card transaction)

POST api/Sales/CheckContainerCode

Get the informations of a container by providing its Code

GET api/SalesItem

Returns a list of available sales items

GET api/SalesItem/{id}

Returns detailed sales item information

GET api/SalesItem?PGCode={PGCode}&CCCode={CCCode}&ChangedAfter={ChangedAfter}

Returns a list of detailed sales item information

Supplier

APIDescription
GET api/Supplier

returns a list of Suppliers

GET api/Supplier/{id}

return the supplier with the provided Suppliercode

Vendingmachine

APIDescription
POST api/VendingMachine/ping

Send Timestamp of request; Server answers with timestamp of its own

POST api/VendingMachine/pickuptimes

Sets the defined pickup times of a date for orders for a vending machine

POST api/VendingMachine/filluplist

Returns a list of all pre-orders or a list of all available products including the order quantity for a machine.

POST api/VendingMachine/confirmfillup

Sets PickUp times for the provided vending machine for a date

POST api/VendingMachine/data

Returns the pre-order or a listing of all purchased products for the provided QRCode.

POST api/VendingMachine/itemstate

Sets the state of the purchased items and starts the booking process

POST api/VendingMachine/VerifyContainerCode

Checks a given Vytal Container-QR-Code against the Vytal_Webservice

POST api/VendingMachine/ReturnContainer

Checks a given Vytal Container-QR-Code against the Vytal_Webservice

Voucher

APIDescription
POST api/Voucher/Info

Get all Informations about a voucher by his number

POST api/Voucher/ChangeBalance

Change the balance of a voucher by adding or deducting money from it

Waiter

APIDescription
GET api/Waiter

returns the list of Waiters