This API provides functionalities for PosDealers to onboard PosOperators and configure and rollout their Middleware installations.
All operations that the PosDealer API offers are also available in the fiskaltrust.Portal, if you prefer to use a graphical user interface over this API.
The PosDealer API was designed in a RESTful and follows those design principles. The API accepts and returns JSON data and uses standard HTTP status codes for responses.
The PosDealer API can only be used with the access data of a PosDealer. These credentials can be found on the fiskaltrust.Portal in the API Access section of your account profile.
You will need both AccountId and AccessToken to use this API.\r\nThese values can be obtained from the fiskaltrust.Portal only; access data will not be sent via, e.g., E-Mail by fiskaltrust.
Please note that you can change the AccessToken of your account (Company / Overview / Reset), e.g., if your credentials got leaked. The AccountId is unchangeable.
If you face authorization problems, check your account's assigned roles in fiskaltrust.Portal (Company / Overview) and ensure you have the appropriate permissions to access the account of your PosOperator.
This API uses semantic versioning, meaning only major version changes contain breaking changes. Non-breaking changes (like returning additional data without changing the original model) will not increase the major version.
/api/posoperators endpoint, or via fiskaltrust's Portal./api/posoperators endpoint, or via fiskaltrust's Portal./api/posoperators endpoint, or via fiskaltrust's Portal./api/posoperators endpoint, or via fiskaltrust's Portal.useCache=false to bypass the cache and read the current list directly from Dynamics.accountId header.POST /api/pos-operators-invitation or in bulk via the CSV import endpoint, and submitted later via the PosOperator endpoints.GET /api/pos-operators-invitation/history instead.",
"operationId": "ListPosOperatorInvitations",
"parameters": [
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PosOperatorInvitationResponse"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"post": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Create a new PosOperator invitation",
"description": "This endpoint creates a new PosOperator invitation for the PosDealer account specified by the accountId header./api/posoperators endpoint to submit an invitation immediately instead.409 is returned if an invitation with the same contact e-mail already exists.400 with details is returned on validation errors.accountId header.from and to query parameters (ISO-8601 date-time, inclusive).id in the URL, for the PosDealer account specified by the accountId header.404 is returned if the invitation does not exist or does not belong to the requesting account.",
"operationId": "GetPosOperatorInvitation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PosOperatorInvitationResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"put": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Update a PosOperator invitation",
"description": "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.404 is returned if the invitation does not exist or does not belong to the requesting account.409 is returned.id in the URL, for the PosDealer account specified by the accountId header.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.",
"operationId": "DeletePosOperatorInvitation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/pos-operators-invitation/{id}/submit": {
"post": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Submit a PosOperator invitation",
"description": "This endpoint submits a previously created invitation, identified by its id in the URL, to fiskaltrust's Portal for the account specified by the accountId header.409 is returned if the invitation was already processed (recover it first to re-submit) or the contact e-mail is already in use.id in the URL, to fiskaltrust's Portal for the account specified by the accountId header.409/400 is returned if a matching account already exists or the invitation was already processed.",
"operationId": "SubmitPosOperatorAutoInvitation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": { }
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/pos-operators-invitation/{id}/recover": {
"post": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Recover a completed PosOperator invitation",
"description": "This endpoint resets a completed invitation, identified by its id in the URL, back to pending for the account specified by the accountId header.accountId header, by uploading a single semicolon-separated .csv file.GET /api/pos-operators-invitation/import/csv/template.400 is returned.400 describing the offending lines.Skipped result list..csv template file containing the correct column headers expected by the bulk invitation import endpoint (POST /api/pos-operators-invitation/import/csv)..pdf document for the PosDealer account specified by the accountId header.400 is returned if the uploaded file is not a .pdf.",
"operationId": "UploadPosOperatorInvitationPdf",
"parameters": [
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": { }
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"get": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Download invitation PDF document",
"description": "This endpoint returns the .pdf document currently stored for the PosDealer account specified by the accountId header.404 is returned if no PDF document has been uploaded for this account.",
"operationId": "DownloadPosOperatorInvitationPdf",
"parameters": [
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"delete": {
"tags": [
"Pos Operator Invitation Management"
],
"summary": "Delete invitation PDF document",
"description": "This endpoint removes the .pdf document stored for the PosDealer account specified by the accountId header./api/rollout-plans endpoint; the rolloutType property specifies if the target of the plan is either an outlet or a Queue./api/rollout-plans endpoint; the rolloutType property specifies if the target of the plan is either an outlet or a Queue./api/posoperators endpoint, or via fiskaltrust's Portal.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Queue"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/queues/{queueId}": {
"patch": {
"tags": [
"Read Middleware configurations"
],
"summary": "Update Queue data (DE only)",
"description": "This endpoint partially updates the queue data. Information related to cash register notifications can be updated. The endpoint is only available in Germany.",
"parameters": [
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "queueId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseQueueDEModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"get": {
"tags": [
"Read Middleware configurations"
],
"summary": "Get queue of a posoperator (DE only)",
"description": "This endpoint returns data for a specific Queue(DE) of the PosOperator. The endpoint is only available in Germany.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "queueId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueDE"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/queues/{queueId}/prepare-scu-switch": {
"post": {
"tags": [
"Read Middleware configurations"
],
"summary": "Prepare an SCU switch (DE only)",
"description": "Performs all backend (\"presetup\") steps to switch a Queue to a new, already-existing SCU/TSE: it adds the SCU to the CashBox (unless addToCashBox=false), connects it to the Queue (a two-step switch when the Queue is already active, otherwise a direct assignment), and rebuilds the configuration. The target SCU must already exist and be assigned to the same outlet. When the Queue is already active, the switch is completed by the POS sending the Daily-Closing, Initiate-SCU-Switch and Finish-SCU-Switch receipts; this endpoint does not remove the old SCU. Available in Germany (DE) only.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "queueId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepareScuSwitchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepareScuSwitchResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/signature-creation-units": {
"get": {
"tags": [
"Read Middleware configurations"
],
"summary": "List SCUs of a PosOperator (DE only)",
"description": "Returns the DE Signature Creation Units (TSEs) registered for the PosOperator, with certificate/serial information where available. Optionally filter to a single outlet via the 'outletNumber' query parameter (e.g. the outlet of the queue being switched), which yields only the SCUs eligible to be attached to that queue's CashBox. Available in Germany (DE) only.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "outletNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignatureCreationUnitDE"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/signature-creation-units/{scuId}": {
"get": {
"tags": [
"Read Middleware configurations"
],
"summary": "Get an SCU of a PosOperator (DE only)",
"description": "Returns a single DE Signature Creation Unit (TSE) of the PosOperator by its ID, with certificate/serial information where available. Available in Germany (DE) only.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "scuId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignatureCreationUnitDE"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/cashboxes/{cashBoxId}/signature-creation-units/{scuId}": {
"put": {
"tags": [
"Read Middleware configurations"
],
"summary": "Add an SCU to a CashBox (DE only)",
"description": "Adds an existing DE SCU to the CashBox (idempotent). The SCU must already exist, belong to the PosOperator and sit on the same outlet as the CashBox. Publishes the configuration afterwards unless rebuild=false. Available in Germany (DE) only. Direct-API only: not reachable through the portal posdealerapiproxy, which forwards GET/POST/PATCH only.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "cashBoxId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "scuId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "rebuild",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": { }
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
},
"delete": {
"tags": [
"Read Middleware configurations"
],
"summary": "Remove an SCU from a CashBox (DE only)",
"description": "Removes a DE SCU from the CashBox (idempotent). IMPORTANT: when retiring the previous SCU after a switch, only call this AFTER the POS has sent the Finish-SCU-Switch receipt — removing the source SCU earlier breaks the switch. Publishes the configuration afterwards unless rebuild=false. Available in Germany (DE) only. Direct-API only: not reachable through the portal posdealerapiproxy, which forwards GET/POST/PATCH only.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "cashBoxId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "scuId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "rebuild",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": { }
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/cashboxes/{cashBoxId}": {
"get": {
"tags": [
"Read Middleware configurations"
],
"summary": "Get a CashBox of a PosOperator",
"description": "Returns a single CashBox of the PosOperator (i.e. the merchant) as a hybrid payload: the portal-parity dataset read from the fiskaltrust database — the CashBox itself (description, IP address, outlet number, state, timestamp, product type), its Queues (including the German commissioning/purchase/decommissioning dates), one flat market-tagged list of Signature Creation Units (AT/DE/IT/ES/GR/PT), its Helpers, and the Austrian Queue properties (cashbox identification, encryption key, closed-system fields and connected SCUs) — plus the CashBox access token and, verbatim, the full published middleware configuration under configuration (byte-identical to the configuration of the template-execution response, POST /api/posoperators/{posOperatorId}/templates). configuration is null (not an error) when the CashBox has never been rebuilt/published; the database-sourced blocks are returned regardless.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "cashBoxId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CashBoxDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/posoperators/{posOperatorId}/cashboxes/{cashBoxId}/instore-pin": {
"post": {
"tags": [
"Read Middleware configurations"
],
"summary": "Generate an InStore-App pairing PIN for a CashBox",
"description": "Generates a fresh 4-digit PIN for pairing the fiskaltrust InStore-App with the CashBox. The PIN is issued by the fiskaltrust receipt service, is valid for 5 minutes and can be redeemed once in the InStore-App. Pairing hands the CashBox credentials to the app instance that redeems the PIN and invalidates the previous pairing of the CashBox — which is why a ReadWrite claim on the PosOperator connection is required. Returns the PIN as a JSON string, e.g. \"1234\". The Portal's Rollout CashBoxes success view uses this endpoint to offer InStore-App pairing right after a CashBox was created for a connected PosOperator.",
"parameters": [
{
"name": "posOperatorId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "cashBoxId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountId",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessToken",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomError"
}
}
}
}
}
}
},
"/api/order/{ordernumber}/details": {
"get": {
"tags": [
"Retrieve order details"
],
"summary": "Get Details of an Order",
"description": "This request returns the details of an order (including its status) that is specified in the URL by its respective ordernumber./api/posoperators/{{posoperatorid}}/produce/outlets endpoints. The SalesOrderState can have one of the following values: