\n\nPlease note that the PosDealer API is currently in preview and may not be fully stable yet. Our team is working hard on finalizing the last bits of this API.
\n
This collection provides PosDealers with sample requests demonstrating how to manage PosOperators, their outlets and even perform product rollouts.
You may start using the PosDealer API by retrieving a list with all your PosOperators' relevant data for further actions. You can further invite new PosOperators, and create and manage outlets for them. Then you can check available permissions and use Rollout plans accordingly to transfer entitlements and produce subscriptions for your customers. Finally, you can use the template endpoint to create Middleware configurations.
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.
\nThe 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.
\nThe PosDealer API can only be used with the access data of a PosDealer.
These credentials can be found on the fiskaltrust.Portal (AT / DE / FR / IT) in the API Access section of your account profile.
You will need both AccountId and AccessToken to use this API.
These 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.
\nThe latest version is used if no version is specified (like in the samples in this collection).
\nUsers can specify versions by explicitly stating it in the URL once more versions are released.
\nOpen the fiskaltrust.Portal and go to Company / Overview.
Scroll in the AccountProfile for the API Access section.
You will find an AccountId and an AccessToken. You will need both values for authorization with the fiskaltrust PosDealer API.
Switch to Postman
\nSelect the Workspace with the fiskaltrust PosDealer API Postman collection.
Tick the burger menu and select Edit.
Switch to the tab Variables.
Enter your access data as Current Values at PosDealer_AccountID and at PosDealer_AccessToken.
Save your values
Do not change the entry at base_url. The fiskaltrust PosDealer API is not country-specific.
Select Invite and manage PosOperators and List connected PosOperators.
With Send your first request of the fiskaltrust PosDealer API Postman collection is done and the response shows all PosOperators, that are connected with your account.
The account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accessToken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators","description":"This request lists the PosOperators (i.e. the merchants) that are connected to the PosDealer specified by the accountId header.
Please note that only active connections (i.e. connection that the PosOperator has accepted) are returned in this version of the API.
\n","urlObject":{"path":["api","posoperators"],"host":["https://posdealer-api-sandbox.fiskaltrust.cloud"],"query":[],"variable":[]}},"response":[],"_postman_id":"5aebc0e2-3a87-421e-a82c-7ced3025e104"},{"name":"Invite a new PosOperator","id":"816569a3-ac69-4310-aa2c-ed972d110363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accountId","value":"00000000-0000-0000-0000-000000000000","description":"The account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accessToken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"company\": {\r\n \"name\": \"The name of the company\",\r\n \"email\": \"E-Mail address of the primary account\",\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"postalCode\": \"Postal code, e.g. 5020\",\r\n \"city\": \"City, e.g. Salzburg\",\r\n \"country\": \"2-digit ISO code of the country, e.g. AT\",\r\n \"website\": \"Website (optional)\",\r\n \"phoneNumber\": \"Phone number of the company (optional)\",\r\n \"identifiers\": {\r\n \"vatId\": \"VAT number, e.g. AT123456789\",\r\n \"taxId\": \"Local tax ID, depending on the country\",\r\n \"fibuNr\": \"Local FIBU number (Austria only)\",\r\n \"gln\": \"GLN number\",\r\n \"siren\": \"Local SIREN number (France only)\"\r\n }\r\n },\r\n \"primaryContact\": {\r\n \"firstName\": \"First name of the primary contact\",\r\n \"lastName\": \"Last name of the primary contact\",\r\n \"email\": \"E-Mail address of the primary account\",\r\n \"title\": \"Title of the primary contact (optional)\",\r\n \"suffix\": \"Suffix of the primary contact (optional)\",\r\n \"phone\": \"Phone number of the primary contact (optional)\"\r\n },\r\n \"accessRights\": \"Either 'full', 'read', or 'readwrite'\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators","description":"This request invites a new PosOperator (i.e. merchant) to fiskaltrust's Portal and connects them to the PosDealer's account, which is specified by the accountId header.
After the request has completed, the PosOperator will receive an email with further instructions to activate their account.
\nPlease note that not all fields in the body of this request are mandatory (e.g. it is not required to include a SIREN number in non-French accounts). More details about required fields can be found on docs.fiskaltrust.cloud.
\n","urlObject":{"path":["api","posoperators"],"host":["https://posdealer-api-sandbox.fiskaltrust.cloud"],"query":[],"variable":[]}},"response":[],"_postman_id":"816569a3-ac69-4310-aa2c-ed972d110363"}],"id":"b4b97763-a8d4-4117-9bf5-494eccbe2636","description":"Please note to enter your access data as Variables, as described in the Quickstart section. This allows you to leave the type of authorization unchanged and to omit further specifications under Pre-request Script or Tests.
Additional requested values are described below; each request is started using Send.
The account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/outlets","description":"This request lists all outlets of a PosOperator (i.e. the merchant) that is specified in the URL via their respective account ID.
\nThe account IDs of connected PosOperators can be either obtained via the /api/posoperators, or via fiskaltrust's Portal.
Please note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/outlets/1","description":"This request returns a specific outlet of a PosOperator (i.e. the merchant) that is specified in the URL via their respective account ID.
\nThe account IDs of connected PosOperators can be either obtained via the /api/posoperators, or via fiskaltrust's Portal.
Please note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"locationId\": \"User-defined ID of the location\",\r\n \"name\": \"Name of the outlet\",\r\n \"address\": \"Address line of the outlet\",\r\n \"postalCode\": \"Postal code of the outlet\",\r\n \"city\": \"City of the outlet\",\r\n \"county\": \"County of the outlet\",\r\n \"stateOrProvince\": \"State or province of the outlet\",\r\n \"country\": \"2-digit ISO code of the outlet's country, e.g. 'AT'\",\r\n \"contactName\": \"Name of the contact person related to the outlet\",\r\n \"telephone\": \"Phone number of the contact person related to the outlet\",\r\n \"fax\": \"Fax number of the contact person related to the outlet\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/outlets/1","description":"This request updates a specific outlet of a PosOperator (i.e. the merchant) that is specified in the URL via their respective account ID.
\nThe account IDs of connected PosOperators can be either obtained via the /api/posoperators, or via fiskaltrust's Portal.
Please note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"locationId\": \"User-defined ID of the location\",\r\n \"outletNumber\": 3,\r\n \"name\": \"Name of the outlet\",\r\n \"address\": \"Address line of the outlet\", \r\n \"postalCode\": \"Postal code of the outlet\",\r\n \"city\": \"City of the outlet\",\r\n \"county\": \"County of the outlet\",\r\n \"stateOrProvince\": \"State or province of the outlet\",\r\n \"country\": \"2-digit ISO code of the outlet's country, e.g. 'AT'\",\r\n \"contactName\": \"Name of the contact person related to the outlet\",\r\n \"telephone\": \"Phone number of the contact person related to the outlet\",\r\n \"fax\": \"Fax number of the contact person related to the outlet\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/outlets","description":"This request creates a new outlet of a PosOperator (i.e. the merchant) that is specified in the URL via their respective account ID.
\nThe account IDs of connected PosOperators can be either obtained via the /api/posoperators, or via fiskaltrust's Portal.
Please note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/rollout-plans","description":"This request lists all available rollout plans that are available for the given PosDealer in their respective market.
\nThe rollout plans returned by this endpoint can be executed to create products and subscriptions for conencted PosOperators (i.e. merchants), based on entitlements that need to be purchased via the Portal first (for more details, refer to \"Produce a product based on a rollout plan\").
\nPlease note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/entitlements","description":"This request lists the active entitlements that are available for the given PosDealer in their respective market.
\nThese entitlements are consumed when rollout plans are executed, and converted into products and subscriptions for conencted PosOperators (i.e. merchants) (for more details, refer to \"Produce a product based on a rollout plan\").
\nPlease note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"rolloutPlanNumber\": \"4445-0001\",\r\n \"outletNumbers\": [\r\n \"numbers of outlets\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/produce/outlets","description":"This request executes the specified rollout plan in a PosOperator's (i.e. merchant's) account, consuming entitlements from the PosDealer's account.
\nExecuting a rollout plan will create a specific yearly subscription, e.g. for a carefree bundle. These subscriptions are assigned to an outlet (e.g. for the carefree bundle).
\nThe outlet numbers need to be specified correctly in the body of this request.
\nDetails about the rollout plans can be obtained via the /api/rollout-plans endpoint; the rolloutType property specified if the target of the plan is either an outlet or a Queue.
Please note:
\nThe account ID of the PosDealer account - can be taken from the Portal
\n","type":"text"},{"key":"accesstoken","value":"","description":"The account access token of the PosDealer account - can be taken from the Portal
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"rolloutPlanNumber\": \"4445-0110\",\r\n \"queueIds\": [\r\n \"IDs of the queues\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://posdealer-api-sandbox.fiskaltrust.cloud/api/posoperators/00000000-0000-0000-0000-000000000000/produce/queues","description":"This request executes the specified rollout plan in a PosOperator's (i.e. merchant's) account, consuming entitlements from the PosDealer's account.
\nExecuting a rollout plan will create a specific yearly subscription, e.g. for a PosArchive. These subscriptions are either assigned to a Middleware component (e.g. a Queue for the PosArchive standalone product).
\nThe Queue IDs need to be specified correctly in the body of this request.
\nDetails about the rollout plans can be obtained via the /api/rollout-plans endpoint; the rolloutType property specified if the target of the plan is either an outlet or a Queue.
Please note:
\n