a transaction has been started but the result is unknown the transaction has completed with a payment (obsolete) there was a failure merchant has specified customer has payed during manual recovery this was a EFT ticket reprint action not an actual payment terminal has delegated the payment authorization to the POS POS delegated payment was completed, with a successful payment POS delegated payment was completed, but payment was rejected payment terminal has processed the transaction in offline mode group created succesfully definition of operators that can be used in overview filters, note some operators are type specific. for multiselection fields, all filter values must be set for a card to match (card is allowed to have additional values selected) for multiselection fields, atleast one filter value must be set for a card to match (card is allowed to have additional values selected) for multiselection fields, the values selected on the card must exactly be the same set as the filter. for stringable fields that are either NULL or have a length of 0 for stringable fields that are not NULL and do not have a length of 0 for multiselection fields, none of the filter value must be set for a card to match (card is allowed to have additional values selected) the specified operator cannot be used for the field specified deprecated, only for compatibility with older clients use categoryIds deprecated replacement for categoryId supporting multiple categories Not all members of this type are used in every context. Code for this VAT group. Percentage for this VAT group. Total amount over which the VAT was calculated. Total VAT amount. Account number of this VAT group for bookkeeping. this is the totalized balance made up of invoiceCredit and accountBalance. deprecated, only for compatibility with older clients use categoryIds replacement for categoryId supporting multiple categories set of branch numbers where articles of this supplier can't be ordered from unique identifier of this transaction, required to prevent storing dupplicates date and time according to the POS device date and time according to the payment terminal terminalId returned by the payment terminal leave empty if not used identification used by payment terminal for this transaction cardnumber returned by payment terminal leave empty if not used text to print for the customer, contains markup for printing number of customer copies to print text to print for the merchant, contains markup for printing number of merchant copies to print text that should be saved in the electronic transaction log (shoudl be formatted as supplied by terminal) identification of driver that performed the transaction current state of transaction ONBEKEND/BETAALD/NIET_BETAALD number of employee who initiated the transaction number of employee that authorized the transaction Internal ID for this payment. Date this payment was registered. Payment method (required when creating a new payment). Total amount paid (required when creating a new payment). Account number of this payment method for bookkeeping. Giftcard number if payment is done via a Giftcard Must be unique for every request that you only want to have executed once. If you want to recheck if a certain request came through, reuse the same idempotencyKey. Shows you whether you have received the original response or a replay of the response. Either way, all other properties of this response will be the same. This is just for informational purposes. Fields marked with process-readonly are read-only when used in the processX calls. readonly readonly readonly readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly deprecated, do not use process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly Id of the voucher issuance that was redeemed for this line. If the id is '00000000-0000-0000-0000-000000000000' it means that the voucher redeem routine will not try to redeem any vouchers on this line. Use this value if you don't want a relation voucher to be automatically applied to the line. Timestamp that will be used to create the voucher issuance associated to this line, instead of what the voucher system wants to use. Fields marked with process-readonly are read-only when used in the processX calls. process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly process-readonly Pass true to prevent the call from adding disposable products. This has only effect when the disposable behaviour for the consumption location is to add them and to allow removal. process-readonly If non-empty, this line is a condensed representation of the uncondensedLines. Can be used in the process calls to identify this specific line when the line isn't saved yet and thus the lineId is still empty. If supplied, the id of the article alteration (preparation method) that was chosen resulting in this preparation method. If supplied, it describes the purpose of the line. Defaults to LINE_KIND_DEFAULT Id of the voucher issuance that was redeemed for this line. If the id is '00000000-0000-0000-0000-000000000000' it means that the voucher redeem routine will not try to redeem any vouchers on this line. Use this value if you don't want a relation voucher to be automatically applied to the line. Timestamp that will be used to create the voucher issuance associated to this line, instead of what the voucher system wants to use. If supplied, the id of the article alteration (preparation method) that was chosen resulting in this preparation method. If supplied, this kind describes the purpose of the line Read-only display string for the transaction number. structure for the details of the current course of a table details of a subtable that is in use, partly state information and partly order details Time at which the table became occupied Last order time Total amount of order including VAT Total amount of order excluding VAT Total amount already paid There are dishes ready to be brought to the table (kitchen management module) The receipt has been printed Number of guest might be missing if it has not been set Set if a relation has been selected on the table Note PRINTED and SERVED are never used because they are stored in seperate fields data structure representing the physical not subdivided table as used in the floorplan Optional when not present the whole line is moved otherwise only the specified quantity Optional when absent or empty all lines will be moved. Otherwise the lines specified. if not specified 1 is assumed. if not specified false is assumed. overrules uncondensedLines. If true will not listen to the Q-line condense setting, but will always condense the returned lines. if not specified 1 is assumed. order id for which this is a payment, order must exist list of payments atleast method and amount should be specified method defaults to deposit, when receipt the payment should match the outstanding order amount When subNumber is not specified all subnumbers are returned. The internal UUID for this receipt. The nicely formatted unique string for this transaction. The type of this receipt. RECEIPT_TYPE_RECEIPT = receipt; RECEIPT_TYPE_CREDIT_RECEIPT = credit of receipt; RECEIPT_TYPE_CASH_INFLOW = inflow of cash; RECEIPT_TYPE_CASH_OUTFLOW = outflow of cash The employee that entered this receipt into the system. The time this receipt was entered into the system. The customer that paid for this receipt. The financial date that this receipt was entered into the system. The branch for which this receipt was entered into the system. This is the branch on which the turnover and stock changes are registered. The workplace on which this receipt was entered into the system. The branch on which this receipt was entered into the system. Can in theory be different from the financialBranchNumber. A textual reference for the receipt. The total amount including VAT. The total amount excluding VAT. The VAT method used for this receipt. The VAT codes used on this receipt, including their individual amounts. Use these VAT amounts in your financial reporting, do not calculate it yourself. Internal counter that updates everytime the order is changed. Internal counter that updates when the order is changed in important ways. The total amount that has been paid on this receipt. The current state of the receipt. The lines for this receipt. The payments registered for this receipt. The id of the receipt which this receipt is a credit receipt of. Search for receipts added or changed from this syncMarker. Search for receipts starting at this date. Search for receipts up to and including this date. Search for receipts booked on these branches. Search for receipts booked by these employees. Search for receipts paid by these customers. Search for receipts containing article with these numbers. Search for receipts containing articles in these turnover groups. Search for receipts containing articles with these PLU numbers. Search for receipts containing articles with these barcodes. Include references to the order(s) that the receipt is based on. If false only the base receipt information will be requested. This is significantly faster for large amounts of data. The order references will not be loaded. Used to determine the target printer and which receipt to print (if no further request parameters are specified). Use this to print the last receipt of the specified table. Use this to precisely specify the receipt to print. The type of this turnover group. The number of this turnover group. The name of this turnover group. The total amount on this turnover group, including VAT. The total amount on this turnover group, excluding VAT. The account number for this turnover group. List of extra workplaces that have also been included in this cash count. This journal is for this date. Which data the journal includes. Which branch the journal is for. List of summarized turnover groups. List of summarized payments. List of summarized VAT groups. Retrieve journals starting at this date. Retrieve journals up to and including this date. Retrieve journals for these branches. Specificy which data to include in the journal. read-only field Sales price including VAT, will be calculated from priceExcl if not explicitly set. Sales price excluding VAT, will be calculated from priceIncl if not explicitly set. when purchasing a multiple of this value should be purchased deprecated, only for compatibility with older clients use categoryIds replacement for categoryId supporting multiple categories uniquely identifies the variant, don't set for new variants readonly, cannot be used for NewArticleVariant/SaveArticleVariant. the number of the article this variant belongs to id of the variant contained in this packaging or null for top level the actual data of this variant, note packaging sublist must be empty insert the record before the record with this id (before_id should have same parent) use null to append the number of the article this variant belongs to the actual data of this variant the article from which to remove variants id's of the variants to remove Allows filtering on toplevel groups. the number of the group that should be removed not set or 0 means append > 0 insert at position number of group on which to replace the products the productsNumbers to link number of group on which to delete the products set to true to remove all product links when not null the purchase order with this number is returned, all other fields are ignored when not null and purchaseOrderNumber is null the purchase order with this extPurchaseOrderId is returned, all other fields are ignored set to FALSE to exclude the lineList in the response, this is faster if you only need information from the main structure readonly when not null the purchase order with this number is returned, all other fields are ignored when not null and purchaseOrderNumber is null the purchase order with this extPurchaseOrderId is returned, all other fields are ignored set to FALSE to exclude the lineList in the response, this is faster if you only need information from the main structure Required for new purchase orders Required for new purchase orders Required for new purchase orders Required for new purchase orders Required for new purchase orders Required for new purchase orders, when changing it can be left out and the lines will be unchanged. set to FALSE to exclude the lineList in the response, this is faster if you only need information from the main structure Sales price determined at time of delivery based on quality of product when not null the purchase delivery with this number is returned, all other fields are ignored when not null and purchaseDeliveryNumber is null the purchase delivery with this extPurchaseDeliveryId is returned, all other fields are ignored set to FALSE to exclude the lineList in the response, this is faster if you only need information from the main structure Sales price determined at time of delivery based on quality of product Leave empty to search for all possible entities (first match is returned) or specify entities you are interested in. Binary data hex encoded defaults to EQUAL for most types and to OVERLAP for multiselection fields Necessary to determine the correct VAT rate for conversions between VAT included and VAT excluded. defaults to 1 The cycle count id of an active and planned cycle count (getActiveCycleCount). This will save a reference to that planned cycle count on the correction. set to FALSE to exclude the stockCorrectionLineList in the response, this is faster if you only need information from the main structure How much of this product should be added to the order. At what price the product should be added. Omit to use default product price. UUID of a menu. Generated UUID that indicates which lines belong together in the specified menu. Provide with the employee how verified the bpe booking. Leave empty if no verrification happend Id of the voucher issuance that was redeemed for this line. If the id is '00000000-0000-0000-0000-000000000000' it means that the voucher redeem routine will not try to redeem any vouchers on this line. Use this value if you don't want a relation voucher to be automatically applied to the line. Timestamp that will be used to create the voucher issuance associated to this line, instead of what the voucher system wants to use. The article number of the product that should be added. Omit to add a text-only line, in which case you should not forget to add the text property. What text should be displayed on the article for this product. Omit to use default product description. A list of preparation items that should be added to this product. Can be used for such things as condiments or method of preparation. Pass true to prevent the call from adding disposable products. This has only effect when the disposable beaviour for the consumption location is to add them and to allow removal. Can be used for DeterminePricing to identify the returned lines. If supplied, the id of the article alteration (preparation method) that was chosen resulting in this preparation method. Which payment method should be used for this payment. You can get a list of available payment methods through calls like getPaymentMethodsV2 and getAvailablePaymentMethods. The amount of this payment. On which branch this table is located. The actual table number. When using a table with subdivisions, specify the subdivision through this property. Omit to use the default subdivision. Mutually exclusive with extOrderId. Specify if you want to ensure that the lines and/or payments are processed only when the order with that orderId is still the current table order. The request will fail with PLACE-TABLE-ORDER-RESULT-IDENTIFIER-FAILED if they do not match. Mutually exclusive with orderId. Specify if you want to ensure that the lines and/or payments are processed only when the order with that extOrderId is still the current table order. The request will fail with PLACE-TABLE-ORDER-RESULT-IDENTIFIER-FAILED if they do not match. The employee that is submitting this order. The workplace that this employee is using to submit the order. Does not have to be a terminal. A description that will be attached to the table of this order. The total number of guests currently seated at the table. Specify whether the order is eat-here or take-out. This can impact the calculated VAT in some regions and additional disposables may be added to the order. AVOID, better to use PlaceTableOrderLineDataElem::menuId and PlaceTableOrderLineDataElem::menuLinesId. Whether or not the call should try to automatically create menus for the new menu system. When empty all branches are returned otherwise only the specified branches. The specific variant to use or 0 when no variant was explicitly specified. Optional when specified limits the result to the specified branch Optional when specified limit results to the specified category set to TRUE to include the entries in the response, this is slower if you only need information from the main structure Required must be the id of an existing todolist Optional, when specified the branchNumber will be updated Optional, when specified the category will be updated Optional, when specified the name will be updated Optional, when specified all the entries will be replaced Required must be the id of an existing todolist These entries will be merged with the existing entries of the todolist Optional, leave empty for new items, or use existing preparationMethodItemId. Required, needs to be unique per group, represents position of preparationItem in group. Optional, article number of the preparationItem, when left empty the preparation will be text only. Required, text that will be displayed on the preparation button. Optional, translation for the remark. Optional, leave empty for new group (for future use, do not use for now) Specify whether the order is eat-here or take-out. This can impact the calculated VAT in some regions and additional disposables may be added to the order. Can be used to load in an existing order before calculating the price with the specified lines. Can be used to load in an existing order on the table before calculating the price with the specified lines. Only used on toplevel lines, subLines cannot have subLines themselves Only used on subLines Returns the same tempId as the one from the request for the current line. Can be used as an identifier for the source ("or reason") behind the update. ARTICLE_LINKED and TASKRUNNER are reserved and can't be used. Leave empty to use the current server datetime. Can be used to request an active cycle count based on the planned cycle count id, in case you already have a planned cycle count id, or want to get the active cycle count from an old active and planned cycle count. For the normal flow supply a todoListId that you gathered from getPlannedCycleCounts here. This will either make the cycle count active, or return the active cycle count information if it is already active. id of the queued payment use getQueueBranchOrderPaymentStatus to check its status the overall state of the result when OK this field contains the assigned groupNumber Use in case of employee or relation to return the number of said relation or employee The result of the request. Either OK or what part of the request failed, i.e. mismaching IDENTIFIERS, failure in processing the LINES or failure in processing the PAYMENTS. Gives more information in case of failure. The result of processing the lines. Either NOTHING happened or an order was CREATED or UPDATED. Returns the current orderId of the table. The result of processing the payments. Either NOTHING happened, a receipt was CREATED or the order was PREPAID. Returns the receiptId when a receipt was CREATED. Cause by specifying alteration Id's when a group is new For a group of type menu all alterations must have an article For a group of type menu the alterations must have unique articles Optional, if supplied workplaceNumber is ignored. The details will be read for the specified buttonLayoutGroupId for the specified branch. Optional, if supplied buttonLayoutGroupId is ignored. The details will be read for the currently active button layout group for the specified workplace and branch. Required, Branch specific items in layout are saved under this branchNumber Only Time part will ever be filled Only Time part will ever be filled use in combination with troughDate to get all sceduled plans in this period use in combination with fromDate to get all sceduled plans in this period use workplaceNumber 0 to get all workplaces from the branch. If software is configured to only allow one meallplan per branch this param is ignored. minimal number of choices that need to be selected in a group. maximal number of choices that are allowed to be selected in a group. Optional, leave empty for new group, or use existing group number. Optional, if not given will keep previous saved value. Optional, if not given will keep previous saved value. Required. For online provide the whole tree, its not allowed to remove items. Optional, allowed values "Online" or "KMS" defaults to "Online" Button layouts, screen layouts and sales & promotions, receipts can still reference to an owner label, even though the owner label was marked as inactive. If you want to get the definition of those owner labels too, set this to false. You can always filter yourself later. This is the same as the array values being returned in getOverview for the 'owners' field. Optional, references the parent branch group. (deprecated) STANDARD (qline), MOBILE (android handheld), ... the definition of the floorplan in JSON format. This contains the actual tables and their positions. (per subtable) If true will update the last table action time to the current time so that the table resets from orange to green. If provided, this will snooze the associated kitchen ticket (if any) for the specified number of seconds. A value of 0 will cancel the snooze. DEPRECATED use level, true == AUTHOR_LEVEL_FULL false == AUTHOR_LEVEL_NONE DEPRECATED use level, true == AUTHOR_LEVEL_FULL false == AUTHOR_LEVEL_NONE The id of the activity to set as active on the specified workplace. If not provided, the workplace's active activity will be cleared. Will only be filled if separateBranchesAndBranchGroups in the request is true. Descripter of how a label should be used by code Id of the label id's below 1000 are defined by code and will never change meaning Only a single image per card is allowed to have this label Should be switched on for new images (this option should be false when singleSelection is true). request structure for adding the new image to a set of cards. Limited to a single card type and all with the same labels. Optional if not provided defaultSelection will be used. request structure for uploading new images original filename or description of image the mimetime with which the file should be served the actual data of the image optionally the image can be linked to an article, employee or relation card. The list of images to associate with the card the order is persisted. Gives the result state of the response the Id of the created image or 0 when an error occured Can be acquired using i.e. getPaymentMethodsV2 with paymentMethodTypes `PAYMENT-METHOD-TYPE-VOUCHER-BOOK-BPE`. These should be UNIQUE. To minimize the chance of a `scanCode` already existing (perhaps even from other idents) use a specific prefix tied to you. I.e. company Test Company, could use codes like this: TC-V-000001. These should be UNIQUE. To minimize the chance of a `groupScanCode` already existing (perhaps even from other idents) use a specific prefix tied to you. I.e. company Test Company, could use codes like this: TC-G-000001. Optional, can be used to specify a specific datetime from which the voucher issuance should be active. Amount in cents Current balance in cents The lines that will be placed on the resulting turnover receipt. This call will always produce a receipt, and link the giftcard payment to it. The total payment amount is the price * quantity of each line added together. Can be retrieved with getGiftcardTypes Amount in cents Amount in cents Value in cents Current balance in cents Provide cardNumber or cardId Provide cardId or cardNumber Value in cents Provide cardNumber or cardId Provide cardId or cardNumber Value in cents Value in cents Get giftcards of this type Get only giftcards that are still active Get giftcards for this relation Means that the timeline events are saved as is. Means that the timeline events are enriched with the current employee number, workplace key, branch group id, owner id and activity id, if not provided by the caller. Hourly rate in cents Open amount including vat in cents Total amount including vat in cents Total amount excluding vat in cents If saveMode ENRICH was used, this will contain the saved timeline events. result of the check for a single BPE overall result of the call The supplied database connection is not compatible with the supplied fromWorkplace. No countEmployeeNumber was specified, but is required due to the settings. Something else went wrong. The internal UUID for this invoice. The nicely formatted unique string for this transaction. The type of this receipt. RECEIPT_TYPE_RECEIPT = receipt; RECEIPT_TYPE_CREDIT_RECEIPT = credit of receipt; RECEIPT_TYPE_CASH_INFLOW = inflow of cash; RECEIPT_TYPE_CASH_OUTFLOW = outflow of cash The employee that entered this receipt into the system. The time this receipt was entered into the system. The customer that paid for this invoice. The financial date that this invoice was entered into the system. The branch for which this invoice was entered into the system. This is the branch on which the turnover and stock changes are registered. The branch on which this invoice was entered into the system. Can in theory be different from the financialBranchNumber. A textual reference for the invoice. The total amount including VAT. The total amount excluding VAT. The VAT method used for this invoice. The VAT codes used on this invoice, including their individual amounts. Use these VAT amounts in your financial reporting, do not calculate it yourself. Internal counter that updates everytime the order is changed. Internal counter that updates when the order is changed in important ways. The total amount that has been paid on this invoice. The current state of the invoice. The lines for this invoice. The payments registered for this invoice. The id of the invoice which this invoice is a credit invoice of. Read-only for processInvoice. Read-only for processInvoice. Read-only Read-only If not supplied will be taken from the relation. If not supplied will be taken from the relation. If false only the base sales repeattemplate information will be requested. This is significantly faster for large amounts of data. details of the check for a single BPE The currently enforced limit, if the field is not present the employee either has unlimited budget or budgets are inactive for the BPE. How much of the trigger article should be selected before the SalePromotion applies. The article that is free when this SalePromotion applies. The quantity of this article that is free. The maximum quantity of this article that is free. If false only the base proposal information will be requested. This is significantly faster for large amounts of data. The packing packing slips/invoices references will not be loaded. If true, the timeline events for the last mail will be included in the response. If not supplied, defaults to SALES_ORDER, REPEAT_SALES_ORDER, and EXTERNAL_SALES_ORDER. If false only the base order information will be requested. This is significantly faster for large amounts of data. The proposals/invoices references will not be loaded. If true, the timeline events for the last mail will be included in the response. used for reading necessary settings and to save the financial transaction on. The 'factuur_boeken_op_huidig_filiaal' setting will determine whether or not it will also be used to save the invoice on. If not, it will use the packing slip branch number as the invoice branch number. Can be used to specify what activity should be used for the resulting invoice in case the specified packing slips have different activities. This will only work if the 'can_invoice_different_activities' setting is enabled. The payment method id. The opening balance for the current count. The amount that was booked using this payment method since the previuos count. The counted amount for the current payment method. This is 0.0 after a getCashCountInfo call, unless the payment method is an automatic deposit payment method. In that case it's the openingBalance + booked. The number of the workplace. The name of the workplace. The data of related transactions / cash counts. The timestamp of the previous cash count for this workplace. List of payment methods that can be used in the current count for this workplace. List of workplaces that will be used in the count of this workplace. NOTE: This can only go 1 layer deep. For example 1 <- 2 is possible, but 1 <- 2 <- 3 is not possible. The employee number that will be used for the current count. If 0, cash counts are not based on employees, but based on specific workplaces. List of workplaces that can be chosen from to perform a cash count on. Be aware that a workplace can have nested workplaces that must also be counted. The workplace number of the workplace where the fromWorkplace will be counted on. Empty in case the fromWorkplace will not be counted on a different workplace. This is the workplace that will be seen as source workplace. Cash count related settings will be read based on this workplace, and only the workplaces that can be counted from this workplace will be in the response. This is the employee number that will be used for the count. In case the employee based count setting is not enabled, this employee number will be ignored, and in the CashCountInfo the countEmployeeNumber will be 0. The employee number that performs this count. The employee number that is currently being counted for. Search for invoices added or changed from this syncMarker. Search for invoices starting at this date. Search for invoices up to and including this date. Search for invoices booked on these branches. Search for invoices booked by these employees. Search for invoices paid by these customers. Search for invoices containing article with these numbers. Search for invoices containing articles in these turnover groups. Search for invoices containing articles with these PLU numbers. Search for invoices containing articles with these barcodes. If false only the base invoice information will be requested. This is significantly faster for large amounts of data. The packing slips/orders references will not be loaded. Search for invoices with these branch invoice numbers. If true, the timeline events for the last mail will be included in the response. The UUID of the invoice to credit. REQUIRED The date that the credit happend. Default to the current data. An optional explenation why the credit was done. Default to cancellation by API. If false only the base packing slip information will be requested. This is significantly faster for large amounts of data. The packing order/invoice/proposal references will not be loaded. [DEPRECATED] The type filter is ignored. The call will now give back all packing slips. If true, and a single salesObjectId will be returned, the packing slip state of the latest CREATE/EDIT queue entry will also be returned. If true, only the latest queue entry for each sales object will be returned. Will contain the packing slip state for the latest CREATE/EDIT queue entry. Only returned if loadPackingSlip is true and a single salesObjectId will be returned. Deprecated, will always be empty as webhooks can now be configured in an overruling fashion per branch group, per branch or per workplace. Indicates if this config is enabled for the specified workplaceKey. This is the workplace for which this webhookConsumer was "resolved" (it's possible the config came from the parent branch(group)). Deprecated, this call wil now only function and listen to the workplace property. use to specify print information. If not used the layout will be rendered without data, which will render an example. If used, the layout will be supplied with the print information before being rendered. Call with invalid print information to see expected print information for the layout kind. use to specify the dots per inch for non-pdf render types. Must be equal to or higher than 26, and equal to or less than 300, default is 100. Leave empty to ship everything from the order. An empty set means this particular filter is not used. An empty set means this particular filter is not used. An empty set means this particular filter is not used. Generally, use mode DEFAULT during an active event and PREPARATORY before an event. Run the planner for the branches that are supplied by these branches, or leave empty to run for all. Run the planner for these branches, or leave empty to run for all. Fine-grained control over the specific articles that should be included in the planning. Only use increments of the "primary" packaging to create interbranch orders. If an article has no "primary" packaging configured, use this value instead. Override the "primary" packaging with this specific value.

Returns a list of all active employees with their number name and loginname.

Returns whether the password is correct

(deprecated) does not support subtables

Retrieve a list of (sub)table states

Retrieve a list of (sub)table states, without terminal requirement

Retrieve a list of main tables for the specified branch number.

Retrieve a list of sub tables for the specified branch number.

returns the current VAT rates of all branches. The exclAmount and vatAmount fields in the response type are not applicable to this call.

deprecated, does not support subtables use getTableOrderCourseListV2 instead

returns the list of courses for the specified table

returns the list of courses for the specified table

deprecated, does not support subtables use requestNextTableOrderCourseV2 instead

request serving of next course

request serving of next course

use this function to save EFT transactions that are not associated with a payment.

queues the supplied

retrieves the current state of a previously queued payment

Tries to cancel the specified order. If the order is already cancelled, the call will try to undo the cancel action (this behaviour does currently not work for branch orders).

Returns a list of all available order categories.

retrieves all the variants of the specified article

retrieves all the variants of the specified articles

adds a new variant to an article

updates an existing variant

removes the specified variants

creates a new articlegroup aka webgroup

delete a group and all its subgroups

searches in the database for an electronic id

Special `selectFieldNameList` fields can be found here: https://mpluskassa.support/en/#/public/f841b556-49b5-40d1-b520-8dee66c33279

Special fields which this call doesn't return can be found here: https://mpluskassa.support/en/#/public/f841b556-49b5-40d1-b520-8dee66c33279

returns the contents of the purchase book for the specified branch. The purchase book is a list of articles you wish to purchase.

DEPRECATED use getNutritionalCharacteristics with param nutritionalCharacteristicsType = NUTRITIONAL-TYPE-PRODUCT

DEPRECATED use ns__updateNutritionalCharacteristics with param nutritionalCharacteristicsType = NUTRITIONAL-TYPE-PRODUCT

als er geen syncMarker gezet wordt in de request wordt alle aanwezige groepen geretourneerd. Met een syncMarker wordt er ingelezen op basis van syncMarker en limit en worden ook verwijdere groepen geretourneerd tbv syncs.

Accepts a table and a combination of order lines and payments and processes them. When submitting lines, it creates or updates (i.e. appending the lines) the table order automatically. When submitting payments, it creates a receipt automatically or does a prepayment on the order if the payment amount does not match the remaining amount. Has idempotency support to ensure only-once execution.

Retrieves the current tap totals

Returns the main records for the todolists matching the filters (note that entries won't be filled).

Retrieves the single todolist identified by id

Creates a new todolist and return its id.

Overwrites the existing todolist with the supplied data. Fields not set do not change. All errors are reported as soapfaults.

Idempotently creates or updates a todolist. Fields not set do not change.

Add the records to the existing todolist. All errors are reported as soapfaults.

Removes the specified todolist. All errors are reported as soapfaults.

returns a list of available filterprofiles

use to save or update a preparation method group

haalt de voedingskenmerken op op basis van een lijst van kaartnummers of op basis van syncMarker. Bij gebruik van syncMarker wordt voor elke kaart de complete lijst geretourneerd. Deze kan minder elementen bevatten dan voorheen dus de gehele lijst van de kaart vervangen in een sync zodat er niet verwijderde elementen blijven staan.

(beta details including input and output may change) Returns pricing including rebates and promotions bases on quantities.

(deprecated) configuration heirarchy not clear, use getConfigurationTree and getConfigurationValues, updateConfigurationValues instead.

(deprecated) only useable in combination with getConfiguration, use getConfigurationTree and getConfigurationValues, updateConfigurationValues instead.

use to retrieve availible configuration tree.

use to save or update a preparation method group

use to update the configurations

use to retrieve the buttonLayoutGroup

Used to update existing ButtonLayoutGroup or create a new ButtonLayoutGroup. When creating, use 0 as id.

Use to delete a buttonLayoutGroup, only works if the layout is not assigned to workplaces.

Assign the given buttonLayoutGroup to workplaces.

Retrieve information about stock configuration per branch.

Store information about stock configuration per branch.

als er geen syncMarker gezet wordt in de request wordt alle aanwezige groepen geretourneerd. Met een syncMarker wordt er ingelezen op basis van syncMarker en limit en worden ook verwijdere groepen geretourneerd tbv syncs.

use to save or update an article alterations group

use to update the article menu for the specified article.

use to add autorisations to the online tree.

use to get all owner labels.

use to create new owner labels when not specifying an id, or changing existing owner labels.

returns the API version

Returns a list of all available terminals with their branchNumber, branchName, terminalNumber, terminalName and terminalStatus.

Changes one or more properties of a table.

use to update or create authorization groups

use to delete authorization group

returns the labels that are available for the cardType in the order in which the Qline will show them.

Returns an item for each cardnumber containing the images for that card in display order.

Replaces the lists of associated images for each of the cards the order of the items is persisted.

API for building integrations with the data of MplusKASSA