fiskaltrust PosDealer API (0.0)

This request lists all outlets of the PosOperator (i.e. the merchant) that is specified in the URL by their respective account ID.
Account IDs of connected PosOperators can either be obtained via the /api/posoperators endpoint, or via fiskaltrust's Portal.

Please note:

• While outlets have unique GUIDs, this API heavily uses the numeric outlet number to be closer to the workflows established in the Portal.
• The outlet number 2 is reserved for internal usage and can neither be obtained nor edited.

This request creates a new outlet in the account of a PosOperator (i.e. a merchant) that is specified in the URL by their respective account ID.
Account IDs of connected PosOperators can either be obtained via the /api/posoperators endpoint, or via fiskaltrust's Portal.

Please note:

• While outlets have unique GUIDs, this API heavily uses the numeric outlet number to be closer to the workflows established in the Portal.
• The outlet number 2 is reserved for internal usage and can neither be obtained nor edited.

This request returns a specific outlets of the PosOperator (i.e. the merchant) that is specified in the URL by their respective account ID.
Account IDs of connected PosOperators can either be obtained via the /api/posoperators endpoint, or via fiskaltrust's Portal.

Please note:

• While outlets have unique GUIDs, this API heavily uses the numeric outlet number to be closer to the workflows established in the Portal.
• The outlet number 2 is reserved for internal usage and can neither be obtained nor edited.

This request updates a specific outlets of the PosOperator (i.e. the merchant) that is specified in the URL by their respective account ID. As this is a PUT and not a PATCH endpoint, existing data is overwritten; make sure to pass all properties in each call.
Account IDs of connected PosOperators can either be obtained via the /api/posoperators endpoint, or via fiskaltrust's Portal.

Please note:

• While outlets have unique GUIDs, this API heavily uses the numeric outlet number to be closer to the workflows established in the Portal.
• The outlet number 2 is reserved for internal usage and can neither be obtained nor edited.

This endpoint executes a CashBox template in a PosOperator's (i.e. merchant's) account.
Templates can be used to create re-usable CashBox configurations, and either create new components or put already existing components (i.e. SCUs) into the defined CashBox.

More details about how to build templates can be found in our documentation.

This endpoint lists all PosOperators (i.e. merchants) that are connected to the PosDealer specified by the accountId header.
For performance the list is served from a short-lived cache (up to 60 seconds old) by default; changes you make through this API (e.g. auto-invite) are reflected immediately. Pass useCache=false to bypass the cache and read the current list directly from Dynamics.
Please note that only active connections (i.e. connections that the PosOperator has accepted) are returned in this version of the API.

This endpoint invites a new PosOperator (i.e. merchant) to fiskaltrust's Portal and connects them to the PosDealer's account that is specified by the accountId header.
After the request has completed, the PosOperator will receive an email with further instructions to activate their account.

This request returns a specific PosOperator (i.e. the merchant), that is specified in the URL by their respective account ID, if it is connected to the PosDealer specified by the accountId header.
Please note that only active connections (i.e. connections that the PosOperator has accepted) are returned in this version of the API.

This endpoint auto-invites a new PosOperator (i.e. merchant) to fiskaltrust's Portal and connects them to the PosDealer's account that is specified by the accountId header.
After the request has completed, the PosOperator account will be automatically created and connected.

This endpoint updates the master data for a company, specifically the information required for the notification-sending operation.

This endpoint lists all pending (i.e. not yet submitted to the Portal) PosOperator invitations for the PosDealer account specified by the accountId header.
Invitations can be created individually via POST /api/pos-operators-invitation or in bulk via the CSV import endpoint, and submitted later via the PosOperator endpoints.

Please note that completed invitations are not returned here; use GET /api/pos-operators-invitation/history instead.

This endpoint creates a new PosOperator invitation for the PosDealer account specified by the accountId header.
The invitation is only saved — it is not yet submitted to the Portal. Use the /api/posoperators endpoint to submit an invitation immediately instead.

Please note:

• The contact e-mail address must be unique per account; a 409 is returned if an invitation with the same contact e-mail already exists.
• Required fields are validated server-side, and a 400 with details is returned on validation errors.

This endpoint returns the completed (i.e. already processed) PosOperator invitations for the PosDealer account specified by the accountId header.
The result can optionally be narrowed down by passing the from and to query parameters (ISO-8601 date-time, inclusive).

Please note:

• A to value without a time of day, or at exactly midnight, covers that whole day.
• Without from and to, only the 50 most recent invitations are returned; a date range returns every match.

This endpoint returns the invitation settings of the PosDealer account specified by the accountId header: the access rights requested on the connection to an invited PosOperator (Full if none were chosen), the text added to the invitation e-mail, and whether a PDF document is attached to the invitation e-mails.

This endpoint changes the invitation settings of the PosDealer account specified by the accountId header and returns the resulting settings.
Only the properties that are passed are changed, so DefaultAccessRights and EmailContent can be updated independently.

Please note:

• The e-mail text is limited to 1000 characters.
• The PDF document is managed via /api/pos-operators-invitation/pdf.
• A 409 is returned if the settings kept being changed concurrently (e.g. in the Portal) while the update was applied (retry it), or if the stored settings cannot be read (they are then left untouched).

This endpoint returns the company and contact details of a single invitation, identified by its id in the URL, for the PosDealer account specified by the accountId header.

Please note that a 404 is returned if the invitation does not exist or does not belong to the requesting account.

This endpoint updates the company and contact details of an invitation, identified by its id in the URL, for the PosDealer account specified by the accountId header.
As this is a PUT and not a PATCH endpoint, existing data is overwritten; make sure to pass all properties in each call.

Please note:

• A 404 is returned if the invitation does not exist or does not belong to the requesting account.
• If the contact e-mail address is changed to one that is already used by another invitation, a 409 is returned.

This endpoint removes a pending invitation, identified by its id in the URL, for the PosDealer account specified by the accountId header, from the pending list. As in the fiskaltrust.Portal, the invitation is kept and marked completed (without a result); like there, the history lists it only when no date range is given.

Please note that only pending invitations can be deleted: a 409 is returned for an already-processed invitation (retained for history), and a 404 if the invitation does not exist or does not belong to the requesting account.

This endpoint executes a pending invitation, identified by its id in the URL, for the PosDealer account specified by the accountId header, exactly as the fiskaltrust.Portal's invitations page does: it creates or links the PosOperator's account and contact, creates the connection with the requested access rights and sends the invitation e-mail.
Pass DefaultAccessRights in the body to choose the access rights; without it the invitation's own are used (Full if it has none). Messages follow the Accept-Language header.

Please note that a refusal or failure is answered as a result with Success = false, the reason in Error and, for a business rule (e.g. the invitation was already processed, the company already exists), its code in ErrorCode.

This endpoint executes a pending invitation, identified by its id in the URL, as an auto-invitation for the PosDealer account specified by the accountId header, exactly as the fiskaltrust.Portal's invitations page does: the PosOperator's account is provisioned and connected without the e-mail round trip.

Please note:

• The PosDealer must have opted in to auto-invitation; otherwise a 403 is returned.
• A refusal or failure is answered as a result with Success = false, Error and, for a business rule, ErrorCode.

This endpoint sends the invitation e-mail of an executed invitation, identified by its id in the URL, again, for the PosDealer account specified by the accountId header, exactly as the fiskaltrust.Portal's invitations page does.
With copyToClipboard=true nothing is sent; the invitation link is returned in Text instead.

Please note that a refusal or failure is answered as a result with Success = false and Error.

This endpoint resets a completed invitation, identified by its id in the URL, back to pending for the account specified by the accountId header.
Only the completion flag is cleared so the invitation returns to the pending list and can be edited and submitted again; the previous run details (last run, last result and result IDs) are retained as an audit trail.

This endpoint creates multiple PosOperator invitations at once for the PosDealer account specified by the accountId header, by uploading a single .csv file. Values may be quoted (RFC 4180); a file without a byte-order mark is read as UTF-8, or as Windows-1252 when it is not valid UTF-8. Every 400 carries a Message; an empty file or another file type is refused with only that.

Two formats are accepted, told apart by the header:

• This API's template (GET /api/pos-operators-invitation/import/csv/template; the header must match it exactly, separated by ;). Every row is validated; if any row fails, the whole import is rejected with a 400 whose Message describes the offending lines. Rows whose contact e-mail already has an invitation are skipped and listed in skipped.
• The fiskaltrust.Portal's invitation CSV (any other header; GET …/template?format=portal), read exactly as the Portal's invitations page reads it: columns matched by the market's headers in any order, ; or ,, no access-rights column (invitations get the PosDealer's default access rights). Every problem of the file is reported in validationErrors (an unknown header, a wrong column count, each failing field under its CSV header, a contact e-mail that already has an invitation or appears twice in the file) and nothing is created unless the file is clean. Each has the record's line (the header being 1, empty lines not counted), for a field error its CSV header, the Portal's translation key as error and the values of its {0} placeholders in errorArgs.

This endpoint returns a .csv template for the bulk invitation import (POST /api/pos-operators-invitation/import/csv).

• By default, this API's template: its column headers, separated by ;.
• With format=portal, the fiskaltrust.Portal's template for the market of the account specified by the accountId header: the market's columns and one sample row with the PosDealer's own company data, separated by ; for de-AT or no Accept-Language and otherwise by that culture's list separator, UTF-8 with a byte-order mark.

This endpoint stores a single .pdf document for the PosDealer account specified by the accountId header.
The stored document is attached to the invitation e-mails sent for this account.

Please note that uploading a new document overwrites any previously stored one, and a 400 is returned if the uploaded file is not a .pdf.