API docs by Redocly

Tagor API (1.08.4000B2)

Download OpenAPI specification:

E-mail: info@organi.be

Release date: 07/12/2020

REQUIREMENTS

This version requires Tagor >= 1.08.4000B2. Use Config/Info to get the active API version.

CHANGELOG

INFO

  • Using the download button at the top you can import this collection of endpoints in Postman
  • In general all TQ(...)_Id fields are default fields which you can translate with the Code/GetDescription endpoint. If you need an id to post to one of the endpoints you can use the Code/GetList endpoint to get all possible values or Code/GetDescription to get a value by code. These id's will be marked as code id in the documentation.
  • We chose to return all ids as string because these are 64bit integers which are too big for javascript to handle.
  • All italic text below the endpoint description is meant for people with access to Tagor.
  • The user needs an email address configured in Tagor for the services to work properly.
  • Pass the Accept header with application/json as value to have the server return errors in json format.
  • Most endpoints can be batched/paged by passing a BATCH-SIZE and BATCH-NUMBER record in dsWebContext.

AUTHENTICATION

Pass your token via an Authorization header like this: Authorization: {bearer_format} {token}.

ex: Authorization: TGR IcoQbVw7wE...PPUPda61ET

Tgr

Authentication via Login/Token. Default authentication with Tagor username/password or API-key. For clients with an API-key there is a possibility to impersonate yourself as another Tagor user. This way the different user configurations can be used with the same key. To use this functionality simply pass an object in the ttWebContext array with:

  • key: user-login
  • value: the username

You can verify your call with the Config/User endpoint.

The user has to have the API permission set in the user management together with a valid email address. For an API-key to impersonate as another user the API impersonate toggle is required.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: Tgr

Hash

These endpoints can be directly called with the hash the defendant got by letter/email.

File hashes are generated with mergefield M_0585.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: Hash

Pin

These endpoints can be directly called with the pin the defendant got by letter/email in combination with the filename/archive number. Pass this as a base64 encoded string of {file}:{pin}

The value used in combination with the pincode is set in parameter 590. Pincodes are generated with mergefield M_0077.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: Pin

Orng

Pass the Orng token you received from the LDN backend (Organi only).

The customer id has to be set in parameter 589 and the environment code in parameter 587.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: Orng

Actions

Actions/SendMail

Send a mail. This endpoint will send a mail to the party entered in TPAR_Id if no TPAR_Id is passed it will send an email to the address passed in Emailadres. If TDOS_Id is passed the mail is only send if the file exists. When both TDOS_Id and TPAR_Id are passed, the party has to be a party connected to the file for the check to pass.

Parameter 569 has to contain the 117 connection string. In the office management screen a mailserver and mail template has to be configured. Logging about connection with the SMTP server can be found on c:\temp\YYYY\MM\DD\socketmail.log on the 117 server.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Actions/SendSms

Send a text.

Enter the RingRing API key in parameter 558. CodeSms can also be any TQCFG value configured in the office managment screen.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Code

Code/GetDescription

Converts code ids. Pass ttCodetabelIDs records with either Id or Code fields filled in. This endpoint will update the other fields and return the data.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Code/GetList

Returns a whole list of code ids. This endpoint can be used to populate dropdown lists in a front-end application.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config

Config/GetRequestableDocuments

Returns a list of all documents the user can generate.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config/Info

Returns info about the bailiff's office. When called with a valid Authorization header the endpoint will return some technical info about the API aswell.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config/Ping

Checks the connection to the API and Tagor

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config/Ping

Checks the connection to the API and Tagor

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config/User

Return info about the current user.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Config/DefendantSettings

Get general settings.

Authorizations:
HashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Document

Document/Generate

A list of all possible TDOCM_Id values can be retreived with User/GetPermissionsList.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Document/Get

Get all documents on a file. ttWebContext requires a TDOS_Id element. The Inhoud field will always be empty here.

Some parameters can be used to configure this endpoint:

  • Parameter 192: Only show PDF files.
  • Parameter 369: Blacklist some security codes.
Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Document/GetFile

Get a single document on a file. ttWebContext requires a TDOC_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Document/GetMergefield

Get one of the available mergefields on a file. ttWebContext requires TDOS_Id and Mergefield elements. You can get a list of all available mergefields by calling the User/GetPermissionsList endpoint and passing WL_QRY_FIELD as type.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Dossier

Dossier/AddAttachment

Add a document to a file. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Dossier/CreateInfoLine

Create an info record in a file.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Dossier/CreateLine

Add a transaction to a file.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/Get

Get a single file. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetAgenda

Get all calendar items for a single file. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetAppearance

ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetBalances

Get all balances of a file i.e. returns a summarized version of Dossier/GetLines. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetCorrespondence

Returns all correspondence on a file. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Dossier/GetInfo

Returns all info records on a file. ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetLines

Returns all transaction records on a file. ttWebContext requires a TDOS_Id element. Other options are optional:

  • is-defendant (boolean): returns the overview from the defendants perspective.
  • evolution-only (boolean): only returns records the office marked as 'important in the evolution of the file'.
  • unfinished-deeds (boolean)

To get files in the evolution-only view you have to mark TQAARD records as evolution.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetParties

ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetPaymentPlans

ttWebContext requires a TDOS_Id element. Other options are optional:

  • active-only (boolean): only return active payment plans.
Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetSub

ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetTitle

ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/Search

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example

Get all files of a defendant. The TQPARSOORT_Id can be retreived with the Code/GetDescription endpoint by getting the TQPARSOORT record with code VERW. This id will always stay the same so in theory you could also hardcode this.

{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/Stop

ttWebContext requires a TDOS_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossier/GetByDefendant

ttWebContext requires a TPAR_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossierlijn

Dossierlijn/GetInfo

Returns all info records on a financial record. ttWebContext requires a TDOSLIJN_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossierlijn/DeleteInfoLine

Deletes a single info record.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Dossierlijn/CreateInfoLine

Create an info record on a financial record

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

Login

Login/Token

If you received an API key from Organi there is no need to call this endpoint. The API key can be passed directly in the Authorization header.

  • client_credentials requires you to pass the Tagor credentials in client_id and client_secret.
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
Value: "client_credentials"
client_id
string
client_secret
required
string

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message

Message/Add

ttWebContext requires a TDOS_Id element. Pass a message in dsTBERICHTWeb. Optional attachments can be passed in dsAttachmentWeb.

Param 436 will be used to determine the message's disgroep. Defaults to 7006

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/GetList

Message status (read/unread) can be found in the TJOB_TQSTATUS_Id field.

  • from (date dd/mm/yyyy): filter by send date.
  • until (date dd/mm/yyyy): filter by send date.
  • read (boolean): Only get read (true) or unread (false) messages.
  • box (enum inbox of outbox): gets al incoming/outgoing messages.
  • TPAR_Id_Verzender (party id): return only messages where passed party is the sender. This only works in combination with box = INBOX.
  • TPAR_Id_Ontvanger (party id): return only messages where passed party is the receiver. This only works in combination with box = OUTBOX.
Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/GetListFilter

Same endpoint as Message/GetList. See this endpoint for the possible values in dsWebContext. This endpoint also accepts a dsFilter object that works the same as Dossier/Search.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/GetLog

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/GetMessage

Gets a single message based on id. ttWebContext requires a TBERICHT_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/GetSenderReceiverList

When this endpoint is called without any ttWebContext records it will return all groups a user belongs to. Other options are optional:

  • Type (enum senders or receivers): when senders is passed TPAR_Id is required.
  • TDOS_Id: active file you want to send a message on. This is required to get the groups of the user. Otherwise only the active user will be returned (if this user is allowed to send messages).
  • TPAR_Id: Id of the party you want to send messages to/from.
Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Message/ToggleRead

Toggles the status of a message. ttWebContext requires a TBERICHT_Id element.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Party

Parties represent natural persons as well as legal entities.

Party/Search

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json

Get by id.

{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Party/AddContactDetail

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json

Get by id.

{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Party/DeleteContactDetail

Deletes a single contact record.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Party/GetContactDetails

Get all contact details for a single party.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Party/GetAddresses

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json

Get by id.

{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

Pay

Endpoints for interaction with a payment gateway.

These endpoints require some configuration. Enter the correct parameters:

  • 573 SIPS merchant id

  • 574 SIPS secret

  • 575 SIPS URL. This should be a base url without https prefix. ex: payment-webinit.sips-atos.com

  • 576 SIPS Redirect URL. This is the page where SIPS should redirect to after payment. Like your front-end app.

  • 577 SIPS Response URL. This is the page where SIPS posts its data after a payment. This should be the location of the Tagor 3 API. ex: https://api.organi.be/v1/rest/Pay/Finish

  • 596: SIPS key version. Defaults to 1.

    These parameters can be overwritten on the filetype configuration (TQDOSSOORT).

Pay/Finish

Finishes the payment process. This should only be called by the SIPS servers.

This endpoint will use the TagorService/OnlinePaymentReceived endpoint to create an informative payment record on the file.

query Parameters
redirectUrl
string
Request Body schema: application/x-www-form-urlencoded
Seal
string
InterfaceVersion
string
locale
string
Data
string

Responses

Pay/Start

Starts the payment process. This endpoint will return data that you'll have to post as a form to the given endpoint. Post redirectionVersion and redirectionData to redirectionUrl. You'll end up on the payment page. Look at the request samples for a javascript implementation.

Set parameter 576 with the return domain for the payment provider.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService

TagorService/ApprovePaymentPlan

Approve the last paymentplan on a file. If the given Telnr is a belgian mobile number the confirmation will be send as a text to that number. If not a mail will be send to the defendant on the file.

The formula with code BEVAFBET will be used as a template to send texts/mails. Be sure this record exists.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/ClipToFile

Search for a phone number. This endpoint will return only the first matching party and its corresponding files.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/FileToHash

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetDosInfo

Get info about a file.

DossiersoortId will be mapped if a mapping with code VOXTRON is available. Otherwise the id will be prefixed with DSO. DosbehId depends on parameter 259. See the result below for possible values.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetPaymentPlanCriteria

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetSaldo

Get the defendants balance on a file. This endpoint will create an info record (type OPSV) on the file indicating the balance was requested unless.

The auto created info records can be disabled with parameter 568. This endpoint returns the balance with code VRW which is the defendants balance on the file.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetVoxtronReferentie

DossiersoortId and DosStatus will be mapped if a mapping with code VOXTRON is available. Otherwise the id will be prefixed with DSO.Parameter 303 effects the way the Referentie field is used to search for a file. DosbehId depends on parameter 259. See the result below for possible values. Parameter 233 decides whether the file status or file stage status is returned in the DosStatus field.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetVoxtronVerwByHuisNr

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/GetVoxtronVerwByPin

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/HashToFile

Get the corresponding file for a file-hash.

The tokens validity period is configurable in parameter 502

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/KantoorOpen

Checks if an employe is available based on file type.

Opening hours can be entered via the configuration menu in Tagor.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/OnlinePaymentReceived

Creates an informative payment record on a file.

The line's nature has to be configured in Tagor's office managment tool.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/PaymentInfo

Get info about ongoing payment plans on a file.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/PinToFile

Get the file id from a filename/pin combination. The value used in combination with the pin doesn't have to be a file name. This is configurable in Tagor.

The value used in combination with the pincode is set in parameter 590. Pincodes are generated with mergefield M_0077.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/SavePaymentPlan

Add a payment plan to a file. This will always create a new payment plan and put all existing payment plans inactive. The input data is validated. Periodes has to be less than configured on the file type. An info records will be generated to indicate a new payment plan was requested.

Payment plans can be auto accepted with parameter 358. The auto created info records can be disabled with parameter 568. The default date can be configured in the file type config and in the office managment.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/SelfServiceAllowed

Checks whether a user is allowed to request his/her file.

Configuration should be done in Tagor's office management tool.

Authorizations:
OrngTgrHashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
Example
{
  • "response": {
    }
}

TagorService/SendMail Deprecated

Deprecated in favor of Actions/SendMail. Will be removed in 1.08.3000B0.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/SendSms Deprecated

Deprecated in favor of Actions/SendSms. Will be removed in 1.08.3000B0.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/SetUserDossier

Adds shortcut to a specific file for a specific user in Tagor.

Default info type can be changed in the CURCALL mapping.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/PaymentDetails

Endpoint to get a detailed overview of the file.

Authorizations:
HashPin

Responses

Response samples

Content type
application/json
{
  • "response": {
    }
}

TagorService/ScanBarcode

Get the file/financial line connected to a barcode.

Authorizations:
HashPin
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

User

Users represents Tagor users. This can be software users and api users. A user extends a Party by adding a username and some other extras.

User/Add

Add/Create a user. Pass the TPAR_Id if you want to create a User for an existing Party.

Optional you can pass a BASE-USER context record with as value a TUSER_Id to inherit the web configuration of this user.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

User/Get

Get a user by id

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

User/GetPermissions

Get all (single) permissions of a user. This will return all the permissions that are represented as a toggle in Tagor. i.e. all permissions on the Web permissies tab.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

User/GetPermissionsList

List all permissions of a user by type. Via this endpoint you'll be able to retreive al permissions with mutliple values. In general this endpoint is for all permissions on the Web configuratie tab in Tagor.

Possible type values:

  • WEBT3001 or TPAR = Party

    • Get a list of parties + party types. These have to be on a file for a user to be allowed to view the file.
    • Unlike the other types this will return a pipe separated value of both party id and party type id

  • WEBT3002 or TQDOSSOORT = File type

    • Returns a list of all file types a user is allowed to see

  • WEBT3006 or TQDISGROEP = Document types

    • Returns a list of all document types a user can use when adding a document

  • WEBT3007 or WL_QRY_FIELD = Mergefields

    • Returns a list of all mergefields a user is able to request with Document/GetMergefield
    • If a user doesn't have any mergefields configured the default setting from the office configuration screen will be used.

  • WEBT3005 or TDOCM = Document types

  • WEBT3004 or TQDOCSECURITY = Document security

    • Returns a list of all document security types a user is able to see
Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

User/SavePermissions

Save all (single) permissions of a user.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

User/SavePermissionsList

Save a list of all permissions of a user by type. See User/GetPermissionsList for all possible type values. All current values for the specified user + type will be deleted and overwritten with the posted valued. If you want to add a value use User/GetPermissionsList to get all current values, add the value to the array and post it to this endpoint. Note: for the TPAR permissions two values are required and should be passed in the id field, seperated by a pipe.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

User/CanAccess

This endpoint returns the users that have access to the given asset. E.g. If you pass TQDOSSOORT_Id, you'll get all users allowed to view files of this type. Pass one or more of the following filetypes:

  • TQDOSSOORT_Id
  • TPAR_Id. For filtering a party regardless of type.
  • TPAR|TQPARSOORT_Id. For filtering a party with matching party type. Pass both TPAR_Id and TQPARSOORT_Id in a context record separated by a pipe. ex: 9000000000000000001|9000000000000000001.

This searches the values configured on the web configuration tab in the user managment.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

SolvencyReport

SolvencyReport/GetList

You can pass an additional TQDOSSOORT_Id to get file type specific config.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

SolvencyReport/Get

This endpoint expects some values in ttWebContext. See example.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}

SolvencyReport/Save

This endpoint expects some values in ttWebContext. See example.

Authorizations:
OrngTgr
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "response": {
    }
}