Default API

Die RELion Default API ist eine Standard-API für die Kommunikation zwischen Systemen.
Tags:

  43 Minuten Lesezeit  

Was ist die RELion Default API?

Die RELion Default API ist eine vorgefertigte, standardisierte Programmierschnittstelle, die speziell für RELion ONE entwickelt wurde. Sie fungiert als Brücke zwischen RELion ONE und externen Systemen, Anwendungen oder Diensten und ermöglicht es, bestimmte Funktionen des Systems einfach zu nutzen. Die klar definierten Methoden, Datenformate und Kommunikationsprotokolle machen die Integration effizient und benutzerfreundlich, ohne dass tiefgehende Systemkenntnisse erforderlich sind.

Installation

Die RELion Default API ermöglicht den Entwicklern, bestimmte Funktionen eines Systems, einer Anwendung oder eines Dienstes auf eine vorher festgelegte und standardisierte Weise zu nutzen. Die Default API definiert Methoden, Datenformate und Kommunikationsprotokolle, die Entwickler verwenden können, um auf Funktionen zuzugreifen und mit ihnen zu interagieren, ohne tiefergehende Kenntnisse über die interne Funktionsweise des zugrunde liegenden Systems zu benötigen.

In den AppSource von Microsoft wird die RELion Default API bereitgestellt.

Wir unterstützen Sie gerne bei der Integration. Kontaktieren Sie dazu unseren Support.

GetFileContent – Dateien einfach und zentral abrufen

Mit der Funktion GetFileContent können Dateien direkt abgerufen werden. Die Dateien liegen entweder in RELion oder im Archivsystem Archiv kompakt. Der Zugriff erfolgt über eine einheitliche Schnittstelle (API).

Was bringt das für Anwender?

  • Dokumente sind leicht und schnell erreichbar.
  • Es ist kein Wechsel zwischen verschiedenen Systemen nötig.
  • Prozesse laufen einfacher und schneller, besonders bei Portalen oder automatischen Abläufen.

Vorteile im Überblick

Ein Zugriff für alle Dateien: Egal, ob die Datei in RELion oder im Archiv liegt. Weniger manueller Aufwand: Systeme rufen Dateien automatisch ab. Einfachere Nutzung für Drittsysteme: Externe Portale können Dokumente direkt anzeigen.

Wichtiger Hinweis bei Archiv kompakt

Wenn Dateien aus Archiv kompakt abgerufen werden, sind technische Vorbereitungen nötig:

  • Für den Drittanbieter muss ein technischer Benutzer in Archiv kompakt eingerichtet werden.
  • Dieser Benutzer
  • benötigt kein Passwort
  • hat Administratorrechte
  • darf auf alle Archive und Dokumente zugreifen

Außerdem muss der Drittanbieter die Berechtigung RelAAK Basic erhalten, wenn auch RELion‑Dokumente über die API abgerufen werden.

Technische Dokumentation für Requests

relApiTabApiAllocGroupParticip

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiAllocGroupParticip
Entity (Plural/Endpunkt) relApiTabApiAllocGroupParticip
Quell-Tabelle RelC Unit Allocation
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiAllocGroupParticip

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter-Kennung
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
allocationCode Code Allocation Code Umlageschlüssel-Code
startDate Date Start Date Gültig ab
endDate Date End Date Gültig bis
description Text Description Beschreibung
reasonChange Text Reason for Change Änderungsgrund
factor Decimal Factor Faktor
accounting Boolean Accounting Buchhaltungsrelevanz
entryGrossNet Enum Entry Gross Net Brutto/Netto-Buchung
entryFactor Decimal Entry Factor Buchungsfaktor
noObjectTotaling Boolean No object totaling Kein Objektsummenbildung
tradeUnitTax Boolean Trade unit tax Gewerbesteuer Einheit
vatRate Decimal VAT Rate MwSt.-Satz
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressource (SubPage)
Navigation Beschreibung
RelApiTabApiUnitAllocation Zugehörige Einheitenzuweisungen

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiBudgetDebitPos

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiBudgetDebitPos
Entity (Plural/Endpunkt) relApiTabApiBudgetDebitPos
Quell-Tabelle RelC Budget Debit Position
Schlüsselfeld SystemId (GUID)
Schreibschutz Ja — nur Lesezugriff (GET)

Basis-URL

GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiBudgetDebitPos

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ❌
PATCH ❌
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von (Benutzer-GUID)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von (Benutzer-GUID)
ownerTenant Code Owner / Tenant Eigentümer/Mieter-Kennung
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
accountNo Code Account No. Kontonummer
startDate Date Start date Startdatum
contractNo Code Contract No. Vertragsnummer
contractCategory Code Contract Category Vertragskategorie
description Text Description Beschreibung
amount Decimal Amount Betrag

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiCompanyInformation

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiCompanyInformation
Entity (Plural/Endpunkt) relApiTabApiCompanyInformation
Quell-Tabelle Company Information (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiCompanyInformation

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key), nur lesbar
displayName Text Name Firmenname
addressLine1 Text Address Adresszeile 1
addressLine2 Text Address 2 Adresszeile 2
city Text City Stadt
state Text County Bundesland / Kanton
country Code Country/Region Code Ländercode
postalCode Code Post Code Postleitzahl
phoneNumber Text Phone No. Telefonnummer
faxNumber Text Fax No. Faxnummer
email Text E-Mail E-Mail-Adresse
website Text Home Page Webseite
taxRegistrationNumber Text VAT Registration No. Steuernummer / USt-IdNr. (berechnet)
currencyCode Code Berechnet Währungscode der Landeswährung (nur lesbar)
currentFiscalYearStartDate Date Berechnet Beginn des aktuellen Geschäftsjahres (nur lesbar)
industry Text Industrial Classification Branche
picture Blob Picture Firmenlogo (nur lesbar)
lastModifiedDateTime DateTime SystemModifiedAt Letztes Änderungsdatum

Hinweise für Entwickler

taxRegistrationNumber (berechnet)

Das Feld liefert je nach BC-Lokalisierung entweder die VAT Registration No. oder die belgische Enterprise No. (Feld 11310). Beim PATCH wird das Feld entsprechend zurückgeschrieben.

currencyCode und currentFiscalYearStartDate

Beide Felder sind schreibgeschützt und werden über OnAfterGetRecord befüllt.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiContact

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiContact
Entity (Plural/Endpunkt) relApiTabApiContact
Quell-Tabelle Contact (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiContact

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
contactNo Code No. Kontaktnummer
satuationCode Code Salutation Code Anredecode
jobTitle Text Job Title Berufsbezeichnung
firstName Text First Name Vorname
firstName2 Text Middle Name Zweiter Vorname
surName Text Surname Nachname
name Text Name Vollständiger Name
name2 Text Name 2 Namenszusatz
address Text Address Adresse
address2 Text Address 2 Adresszusatz
postCode Code Post Code Postleitzahl
city Text City Stadt
phoneNo Text Phone No. Telefonnummer
mobileNo Text Mobile Phone No. Mobilnummer
email Text E-Mail E-Mail-Adresse
partnerJobTitle Text RelC Partner Title Berufsbezeichnung Partner
partnerFirstName Text RelC Partner first name Vorname Partner
partnerFirstName2 Text RelC Partner first name 2 Zweiter Vorname Partner
partnerSurName Text RelC Partner last name Nachname Partner
dateOfBirth Date RelC Date of birth Geburtsdatum
nameAtBirth Text RelC Name at birth Geburtsname
partnerDateOfBirth Date RelC Partner Date of birth Geburtsdatum Partner
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiCustomer

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiCustomer
Entity (Plural/Endpunkt) relApiTabApiCustomer
Quell-Tabelle Customer (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiCustomer

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
customerNo Code No. Kundennummer
name Text Name Name
name2 Text Name 2 Namenszusatz
address Text Address Adresse
address2 Text Address 2 Adresszusatz
postCode Code Post Code Postleitzahl
city Text City Stadt
phoneNo Text Phone No. Telefonnummer
mobileNo Text Mobile Phone No. Mobilnummer
email Text E-Mail E-Mail-Adresse
vatBusPostingGroup Code VAT Bus. Posting Group MwSt.-Geschäftsbuchungsgruppe
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiDebitPosition

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiDebitPosition
Entity (Plural/Endpunkt) relApiTabApiDebitPosition
Quell-Tabelle RelC Debit Position
Schlüsselfeld SystemId (GUID)
Schreibschutz Ja — nur Lesezugriff (GET)

Basis-URL

GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiDebitPosition

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ❌
PATCH ❌
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
ownerTenant Code Owner / Tenant Eigentümer/Mieter-Kennung
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
unitHistory Integer Unit history Einheitenhistorie
accountNo Code Account No. Kontonummer
startDate Date Start date Startdatum
contractCategory Code Contract Category Vertragskategorie
contractNo Code Contract No. Vertragsnummer
amount Decimal Amount Betrag
description Text Description Beschreibung

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiDocument

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiDocument
Entity (Plural/Endpunkt) relApiTabApiDocument
Quell-Tabelle RelC Document
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiDocument

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Auswahl der wichtigsten Felder

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
archiveFileName Text ArchiveFileName Dateiname im Archiv
archiveFileExtension Text ArchiveFileExtension Dateiendung
archiveFileSize Integer ArchiveFileSize Dateigröße
attachment Blob Attachment Anhang (Dateiinhalt)
archivID Code ArchivID Archiv-ID
archivename Text Archivename_ Archivname
archiveSystem Code Archive System Archivsystem
archivedAt DateTime Archived at Archivierungsdatum
archivedByUserID Code Archived by User ID Archiviert von
archivingProcess Code Archiving process Archivierungsprozess
contactNo Code Contact No. Kontaktnummer
contactName Text ContactName_ Kontaktname
customerNo Code Customer No. Kundennummer
customerName Text CustomerName_ Kundenname
createdAt DateTime Created at Erstellt am
createdByUserID Code Created by User ID Erstellt von
deleteAt DateTime Delete at Löschzeitpunkt
deletePlannedAt DateTime Delete planned at Geplanter Löschzeitpunkt
aakDocumentID Text AAK_DocumentID AAK-Dokument-ID
aakFileID Text AAK_FileID AAK-Datei-ID
aakFileVersion Text AAK_FileVersion AAK-Versionsnummer
aakFileVersionID Text AAK_FileVersionID AAK-Versions-ID
aakCatchword Text AAK_Catchword AAK-Stichwort
aakCreationDate Date AAK_CreationDate AAK-Erstellungsdatum
aakCreator Text AAK_Creator AAK-Ersteller
aakArcRetentionDate Date AAKArcRetentionDate AAK-Aufbewahrungsfrist
aakIndexValues Text AAKIndexValues_ AAK-Indexwerte
accountHolder Text Account holder Kontoinhaber
accountingCode Code Accounting code Buchhaltungscode
accountingNo Code Accounting No. Buchhaltungsnummer
accountingFrom Date Accounting from Abrechnungszeitraum von
accountingUntil Date Accounting until Abrechnungszeitraum bis
accountingYear Integer Accounting year Abrechnungsjahr
bankAccount Code Bank Account Bankkonto
bankname Text Bankname Bankname
barcodeID Text Barcode ID Barcode-ID
bic Text BIC BIC
cancellationNo Code Cancellation No. Stornierungsnummer

Hinweis Die Tabelle zeigt eine Auswahl. Das vollständige Feldset ist umfangreich – bitte $select für minimale Datenmengen nutzen.

Hinweise für Entwickler

attachment (Blob)

Enthält den binären Dateiinhalt. Wird nur bei expliziter Anforderung übertragen. $select verwenden, um unnötige Datenmengen zu vermeiden.

Change Tracking

ChangeTrackingAllowed = true — OData $deltatoken wird unterstützt für inkrementellen Datenabruf.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiDocumentArchiv

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiDocumentArchiv
Entity (Plural/Endpunkt) relApiTabApiDocumentArchiv
Quell-Tabelle RelC Document AAK-Archive
Schlüsselfeld SystemId (GUID)
Schreibschutz Ja — nur Lesezugriff (GET)
Change Tracking Aktiviert

Basis-URL

GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiDocumentArchiv

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ❌
PATCH ❌
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
aakTBStructIndex Text AAK-TBStructIndex_ AAK-Strukturindex
archivID Code ArchivID Archiv-Code
archivname Text Archivname Archivname
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiDocumentIndexValue

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiDocumentIndexValue
Entity (Plural/Endpunkt) relApiTabApiDocumentIndexValue
Quell-Tabelle RelC AAK-IndexValues
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiDocumentIndexValue

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
entryNo Integer Entry No. Laufende Nummer
lineNo Integer Line No. Zeilennummer
fieldNo Integer FieldNo Feldnummer
indexValue Text IndexValue Indexwert
dataType Text DataType_ Datentyp
positionNo Integer Position No. Positionsnummer
multipleIndexNo Integer Multiple Index No. Mehrfachindex-Nr.
aakIndexExists Boolean AAK-IndexExists AAK-Index vorhanden
aakTBStructCatchwordListName Text AAK-TBStructCatchwordListName_ Name der Stichwortliste
aakTBStructCatchwords Text AAK-TBStructCatchwords_ Stichwörter
numArchivID Integer num_archivID Archiv-ID (numerisch)
numIndexID Integer num_indexID Index-ID
numListID Integer num_listID_ Listen-ID
strIndexName Text str_indexName Indexname
strDefault Text str_default_ Standardwert
boolMandatory Boolean bool_mandatory_ Pflichtfeld
boolHidden Boolean bool_hidden_ Ausgeblendet
boolAutoDate Boolean bool_autoDate_ Automatisches Datum
boolCatchWordsOnly Boolean bool_catchWordsOnly_ Nur Stichwörter
numDecimalPlaces Integer num_decimalPlaces_ Dezimalstellen
numMaxLength Integer num_maxLength_ Maximale Länge
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiEditor

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiEditor
Entity (Plural/Endpunkt) relApiTabApiEditor
Quell-Tabelle RelC Editor
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiEditor

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
ownerTenant Code Owner / Tenant Eigentümer/Mieter-Kennung
objectNo Code Object No. Objektnummer
partCode Code Part code Teilcode
name Text Name_ Name des Bearbeiters
description Text Description_ Beschreibung
competenceUnitCode Code Competence unit code Zuständigkeitseinheitscode
mainAgent Code Main agent Hauptverantwortlicher
personResponsible Code Person responsible Verantwortliche Person
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressourcen (SubPages)
Navigation Beschreibung
RelApiTabApiSalespersonPurch Verknüpfter Verkäufer/Einkäufer (via partCode)
RelApiTabApiEditorPart Editor-Teile (via partCode)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiEditorPart

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiEditorPart
Entity (Plural/Endpunkt) relApiTabApiEditorPart
Quell-Tabelle RelC Editor Part
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiEditorPart

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
partCode Code Part code Teilcode
description Text Description Beschreibung
recordId RecordId RecordId Datensatz-ID

Hinweise für Entwickler

Diese Ressource wird in der Regel als SubPage von relApiTabApiEditor konsumiert. Ein Direktabruf ist ebenfalls möglich.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiExploitationMethod

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiExploitationMethod
Entity (Plural/Endpunkt) relApiTabApiExploitationMethod
Quell-Tabelle RelC Exploitation Method
Schlüsselfeld SystemId (GUID)
Schreibzugriff Lesend (GET) — keine expliziten Schreibrechte gesetzt
Change Tracking Aktiviert

Basis-URL

GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiExploitationMethod

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST —
PATCH —
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
exploitationMethodCode Code Exploitation method code Nutzungsart-Code
exploitationMethodType Enum Exploitation method type Nutzungsart-Typ (z. B. Einheit, Objekt)
exploitationMethodClass Code Exploitation Method Class Nutzungsart-Kategorie
description Text Description Beschreibung
standardAllocationCodeFArea Code StandardAllocationCode f. area Standard-Umlageschlüssel für Fläche
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiRelCIFOContractLine

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiRelCIFOContractLine
Entity (Plural/Endpunkt) relApiTabApiRelCIFOContractLine
Quell-Tabelle RelC IFO Contract Line
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiRelCIFOContractLine

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
contractNo Code Contract No. Vertragsnummer
supplementNo Integer Supplement No. Nachtragnummer
startDate Date Start Date Startdatum
completionDate Date Completion date Abschlussdatum
ownersAssociationCompany Code Owners Association Company Gesellschaft WEG
ownersAssocOwnerTenant Code Owners Assoc. Owner/Tenant WEG Eigentümer/Mieter
ownersAssocObjectNo Code Owners Assoc. Object No. WEG Objektnummer
ownersAssocUnitNo Code Owners Assoc. Unit No. WEG Einheitennummer
iFOCompany Code IFO Company IFO-Gesellschaft
iFOOwnerTenant Code IFO Owner/Tenant IFO Eigentümer/Mieter
iFOObjectNo Code IFO Object No. IFO Objektnummer
iFOUnitNo Code IFO Unit No. IFO Einheitennummer
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressource (SubPage)
Navigation Beschreibung
RelApiTabApiReObject Verknüpftes Objekt (IFO Eigentümer/Mieter + Objektnr.)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiIssuedReminders

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiIssuedReminder
Entity (Plural/Endpunkt) relApiTabApiIssuedReminders
Quell-Tabelle Issued Reminder Header (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiIssuedReminders

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
no Code No. Mahnnummer
customerNo Code Customer No. Kundennummer
name Text Name Name
name2 Text Name 2 Namenszusatz
address Text Address Adresse
address2 Text Address 2 Adresszusatz
postCode Code Post Code Postleitzahl
city Text City Stadt
county Text County Bundesland
countryRegionCode Code Country/Region Code Ländercode
contact Text Contact Ansprechpartner
documentDate Date Document Date Belegdatum
dueDate Date Due Date Fälligkeitsdatum
reminderTermsCode Code Reminder Terms Code Mahnbedingungscode
reminderLevel Integer Reminder Level Mahnstufe
remainingAmount Decimal Remaining Amount Restbetrag
interestAmount Decimal Interest Amount Zinsbetrag
vatAmount Decimal VAT Amount MwSt.-Betrag
relCMemberNo Code RelC Member No. Mitgliedsnummer
relCGrouping Code RelC Grouping Gruppierung
relCObjectBankAccount Code RelC Object Bank Account Objekt-Bankkonto
relCReminderProcessNo Code RelC Reminder Process No. Mahnprozessnummer
relCContractNo Code RelC Contract No. Vertragsnummer
relCPersonResponsible Code RelC Person Responsible Verantwortliche Person
relCInstallmentPayer Code RelC Installment Payer Ratenzahler
relCCancellationReason Text RelC Cancellation Reason Stornierungsgrund
relCReminderDescription Text RelC Reminder Description Mahnbeschreibung
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressource (SubPage)
Navigation Beschreibung
RelApiTabApiReminderTerms Mahnbedingungen (via reminderTermsCode)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiLocationFloor

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiLocationFloor
Entity (Plural/Endpunkt) relApiTabApiLocationFloor
Quell-Tabelle RelC Location / Floor
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiLocationFloor

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
kind Enum Kind Art (Lage oder Etage)
code Code Code Code
description Text Description Beschreibung
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiMeterMasterData

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiMeterMasterData
Entity (Plural/Endpunkt) relApiTabApiMeterMasterData
Quell-Tabelle RelC Meter Master Data
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiMeterMasterData

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
meterNo Code Meter no. Zählernummer
meterSerialNo Code Master Data No. Seriennummer / Stammdatennummer
kindOfMeter Code Kind of Meter Zählerart
unitOfConsumption Code Unit of consumption Verbrauchseinheit
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
building Code Building Gebäude
house Code House Haus
unitNo Code Unit No. Einheitennummer
unitLocation Code Unit Location Einheitenlage
unitFloor Code Unit Floor Einheitenetage
meterLocation Text Meter Location Zählerstandort
installationDate Date Date of installation Installationsdatum
calibrationDate Date Year of calibration Eichjahr
initialReading Decimal Opening Score Anfangsstand
manufacturer Text Manufacturer Hersteller
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiMeterReading

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiMeterReading
Entity (Plural/Endpunkt) relApiTabApiMeterReading
Quell-Tabelle RelC Meter Reading
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiMeterReading

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
meterSerialNo Code Master Data No. Seriennummer / Stammdatennummer
lineNo Integer Line No. Zeilennummer
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
unitHistory Integer Unit history Einheitenhistorie
readingDate Date Reading date Ablesedatum
openingReading Decimal Opening Score Anfangsstand
finalReading Decimal Final Score Endstand
recordId RecordId RecordId Datensatz-ID

Typischer Anwendungsfall

// Alle Ablesungen für einen bestimmten Zähler
GET .../relApiTabApiMeterReading?$filter=meterSerialNo eq 'Z-0001'&$orderby=readingDate desc

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiObjectBuilding

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiObjectBuilding
Entity (Plural/Endpunkt) relApiTabApiObjectBuilding
Quell-Tabelle RelC Object Building
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiObjectBuilding

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
code Code Code Gebäudecode
description Text Description Beschreibung
type Enum Type Gebäudetyp
buildingCode Code Building Code Gebäudeclassifizierungscode
address Text Address Straße
houseEntranceText Text Address Number Hausnummer (Text)
houseNumberInt Integer House number Hausnummer (Zahl)
houseNumberText Text House number letter Hausnummernzusatz
postCode Code Post Code Postleitzahl
city Text City Stadt
districtCode Code District departmentcode Bezirkscode
geoCode Text Geo Code Geokoordinate
exploitationMethodCode Code Exploitation Method Code Nutzungsart-Code
numberOfFloors Integer Number of floors Anzahl Stockwerke
startOfUsage Date Start Of Usage Nutzungsbeginn
endOfUsage Date End Of Usage Nutzungsende
completionDate Date Finish Date Fertigstellungsdatum
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiObjectTax

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiObjectTax
Entity (Plural/Endpunkt) relApiTabApiObjectTax
Quell-Tabelle RelC Object tax
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiObjectTax

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
asOfDate Date As of date Gültig ab
accountingGroup Code Accounting Group Buchhaltungsgruppe
inputTaxShare Decimal Input Tax Share Vorsteueranteil %
calculatedInputTaxShare Decimal Calculated Input Tax Share Berechneter Vorsteueranteil %
description Text Description Beschreibung
vatBusPostingGroupTax Code VAT Bus. Posting Group Tax MwSt.-Geschäftsbuchungsgruppe (Steuer)
vatBusPostingGroupUnreal Code VAT Bus. Posting Group Unreal MwSt.-Buchungsgruppe (unecht steuerfrei)
modifiedCreatedOn DateTime Modified/created on Erstellt/Geändert am
modifiedCreatedByUserID Code Modified/created by User ID Erstellt/Geändert von
apartmentShare Decimal Apartment share % Wohnungsanteil %
tradeQuota Decimal Trade quota % Gewerbeanteil %
parkingShare Decimal Parking share % Stellplatzanteil %
quotaUnrealTaxExempt Decimal Quota unreal tax-exempt % Anteil unecht steuerfrei %
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseCreditMemos

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseCreditMemo
Entity (Plural/Endpunkt) relApiTabApiPurchaseCreditMemos
Quell-Tabelle Purch. Cr. Memo Entity Buffer (Business Central Standard)
Schlüsselfeld Id (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseCreditMemos

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Wichtigste Felder

Feldname Typ Quelle Beschreibung
id GUID Id Eindeutiger Schlüssel (OData-Key)
number Code No. Belegnummer (nur lesbar)
creditMemoDate Date Document Date Gutschriftsdatum
postingDate Date Posting Date Buchungsdatum
dueDate Date Due Date Fälligkeitsdatum
vendorId GUID Vendor Id Lieferanten-ID
vendorNumber Code Buy-from Vendor No. Lieferantennummer
vendorName Text Buy-from Vendor Name Lieferantenname (nur lesbar)
vendorCreditMemoNumber Text Vendor Cr. Memo No. Lieferanten-Gutschriftsnummer
payToVendorId GUID Pay-to Vendor Id Zahlung-an-Lieferanten-ID
payToVendorNumber Code Pay-to Vendor No. Zahlung-an-Lieferantennummer
payToName Text Pay-to Name Zahlung-an-Name (nur lesbar)
buyFromAddressLine1 Text Buy-from Address Lieferantenadresse Zeile 1
buyFromAddressLine2 Text Buy-from Address 2 Lieferantenadresse Zeile 2
buyFromCity Text Buy-from City Stadt (Lieferant)
buyFromCountry Code Buy-from Country/Region Code Land (Lieferant)

Das vollständige Feldset ist umfangreich (BC Standard-API). Bitte $select für optimierte Abfragen verwenden.

Hinweise für Entwickler

Vendor-Verlinkung

Beim Anlegen per POST kann entweder vendorId (GUID) oder vendorNumber (Code) angegeben werden. Beide Felder werden automatisch synchronisiert.

Verknüpfte Positionen

Zeilenpositionen werden über die API relApiTabApiPurchaseCreditMemoLines abgerufen (separate Ressource).

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseInvoices

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseInvoice
Entity (Plural/Endpunkt) relApiTabApiPurchaseInvoices
Quell-Tabelle Purch. Inv. Entity Aggregate (Business Central Standard)
Schlüsselfeld Id (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseInvoices

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Wichtigste Felder

Feldname Typ Quelle Beschreibung
id GUID Id Eindeutiger Schlüssel (OData-Key)
number Code No. Rechnungsnummer (nur lesbar)
postingDate Date Posting Date Buchungsdatum
invoiceDate Date Document Date Rechnungsdatum
dueDate Date Due Date Fälligkeitsdatum
vendorInvoiceNumber Text Vendor Invoice No. Lieferantenrechnungsnummer
vendorId GUID Vendor Id Lieferanten-ID
vendorNumber Code Buy-from Vendor No. Lieferantennummer
vendorName Text Buy-from Vendor Name Lieferantenname (nur lesbar)
payToName Text Pay-to Name Zahlung-an-Name (nur lesbar)
payToContact Text Pay-to Contact Zahlung-an-Ansprechpartner
payToVendorId GUID Pay-to Vendor Id Zahlung-an-Lieferanten-ID
payToVendorNumber Code Pay-to Vendor No. Zahlung-an-Lieferantennummer
shipToName Text Ship-to Name Lieferadresse Name
buyFromAddressLine1 Text Buy-from Address Lieferantenadresse Zeile 1
buyFromAddressLine2 Text Buy-from Address 2 Lieferantenadresse Zeile 2
buyFromCity Text Buy-from City Stadt (Lieferant)
buyFromCountry Code Buy-from Country/Region Code Land (Lieferant)
buyFromPostCode Code Buy-from Post Code PLZ (Lieferant)

Das vollständige Feldset entspricht dem BC-Standard-API. Bitte $select für optimierte Abfragen verwenden.

Verknüpfte Ressource

Rechnungszeilen werden über relApiTabApiPurchaseInvoiceLines abgerufen (separate Ressource, verknüpft via documentId).

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseOrder

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseOrder
Entity (Plural/Endpunkt) relApiTabApiPurchaseOrder
Quell-Tabelle Purchase Order Entity Buffer (Business Central Standard)
Schlüsselfeld Id (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseOrder

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Wichtigste Felder

Feldname Typ Quelle Beschreibung
id GUID Id Eindeutiger Schlüssel (OData-Key)
number Code No. Bestellnummer (nur lesbar)
orderDate Date Document Date Bestelldatum
postingDate Date Posting Date Buchungsdatum
vendorId GUID Vendor Id Lieferanten-ID
vendorNumber Code Buy-from Vendor No. Lieferantennummer
vendorName Text Buy-from Vendor Name Lieferantenname (nur lesbar)
payToName Text Pay-to Name Zahlung-an-Name (nur lesbar)
payToVendorId GUID Pay-to Vendor Id Zahlung-an-Lieferanten-ID
payToVendorNumber Code Pay-to Vendor No. Zahlung-an-Lieferantennummer
shipToName Text Ship-to Name Lieferadresse Name
shipToContact Text Ship-to Contact Lieferadresse Ansprechpartner
buyFromAddressLine1 Text Buy-from Address Lieferantenadresse Zeile 1
buyFromAddressLine2 Text Buy-from Address 2 Lieferantenadresse Zeile 2
buyFromCity Text Buy-from City Stadt (Lieferant)

Das vollständige Feldset entspricht dem BC-Standard-API. Bitte $select für optimierte Abfragen verwenden.

Verknüpfte Ressource

Bestellpositionen werden über relApiTabApiPurchaseOrderLine abgerufen (separate Ressource, verknüpft via documentId).

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseOrderLine

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseOrderLine
Entity (Plural/Endpunkt) relApiTabApiPurchaseOrderLine
Quell-Tabelle Purch. Inv. Line Aggregate (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseOrderLine

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Schlüssel (OData-Key)
documentId GUID Document Id Verknüpfung zum Bestellkopf
sequence Integer Line No. Positionsnummer
itemId GUID Item Id Artikel-ID
accountId GUID Account Id Sachkonto-ID
lineType Enum API Type Positionstyp (Item / Account)
lineObjectNumber Code No. Artikel- oder Kontonummer
description Text Description Beschreibung
description2 Text Description 2 Beschreibung 2
unitOfMeasureId GUID Unit of Measure Id Maßeinheit-ID
unitOfMeasureCode Code Unit of Measure Code Maßeinheitscode
quantity Decimal Quantity Menge
directUnitCost Decimal Direct Unit Cost Einstandspreis
discountAmount Decimal Line Discount Amount Rabattbetrag
discountPercent Decimal Line Discount % Rabattprozent

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseCreditMemoLines

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseCreditMemoLine
Entity (Plural/Endpunkt) relApiTabApiPurchaseCreditMemoLines
Quell-Tabelle Purch. Inv. Line Aggregate (temporär, Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert
Erlaubte

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseCreditMemoLines

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Schlüssel (OData-Key)
documentId GUID Document Id Verknüpfung zum Gutschriftskopf
sequence Integer Line No. Positionsnummer
itemId GUID Item Id Artikel-ID
accountId GUID Account Id Sachkonto-ID
lineType Enum API Type Positionstyp (Item / Account)
lineObjectNumber Code No. Artikel- oder Kontonummer
description Text Description Beschreibung
unitOfMeasureId GUID Unit of Measure Id Maßeinheit-ID
unitOfMeasureCode Code Unit of Measure Code Maßeinheitscode
unitCost Decimal Direct Unit Cost Stückkosten
quantity Decimal Quantity Menge
discountAmount Decimal Line Discount Amount Rabattbetrag
discountPercent Decimal Line Discount % Rabattprozent
discountAppliedBeforeTax Boolean Discount Applied Before Tax Rabatt vor Steuer (nur lesbar)
amountExcludingTax Decimal Line Amount Excluding Tax Betrag ohne Steuer (nur lesbar)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiPurchaseInvoiceLines

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiPurchaseInvoiceLine
Entity (Plural/Endpunkt) relApiTabApiPurchaseInvoiceLines
Quell-Tabelle Purch. Inv. Line Aggregate (temporär, Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiPurchaseInvoiceLines

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Schlüssel (OData-Key)
documentId GUID Document Id Verknüpfung zum Rechnungskopf
sequence Integer Line No. Positionsnummer
itemId GUID Item Id Artikel-ID
accountId GUID Account Id Sachkonto-ID
lineType Enum API Type Positionstyp (Item / Account)
lineObjectNumber Code No. Artikel- oder Kontonummer
description Text Description Beschreibung
description2 Text Description 2 Beschreibung 2
unitOfMeasureId GUID Unit of Measure Id Maßeinheit-ID
unitOfMeasureCode Code Unit of Measure Code Maßeinheitscode
unitCost Decimal Direct Unit Cost Stückkosten
quantity Decimal Quantity Menge
discountAmount Decimal Line Discount Amount Rabattbetrag
discountPercent Decimal Line Discount % Rabattprozent

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReContactBusinessRelation

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReContactBusinessRelation
Entity (Plural/Endpunkt) relApiTabApiReContactBusinessRelation
Quell-Tabelle RelC Contact Business Relation
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReContactBusinessRelation

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
unitHistory Integer Unit history Einheitenhistorie
businessRelation Code Business Relation Geschäftsbeziehungsart
contactNo Code Contact No. Kontaktnummer
contractNo Code Contract No. Vertragsnummer
sectorMember Code Sector/Member Sektor/Mitglied
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReContract

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReContract
Entity (Plural/Endpunkt) relApiTabApiReContract
Quell-Tabelle RelC Contract
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReContract

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
no Code No. Vertragsnummer
supplementNo Integer Supplement No. Nachtragnummer
supplementDate Date Supplement Date Nachtragsdatum
contractCategory Code Contract Category Vertragskategorie
tenancyAgreementType Enum Tenancy agreement type Mietvertragsart
customerVendorNo Code Customer/Vendor No. Kunden-/Lieferantennummer
contactType Enum Contact Type Kontaktart
contactNo Code Contact No. Kontaktnummer
contractStart Date Beginning of contract Vertragsbeginn
contractEnd Date Expiration date of contract Vertragsablauf
terminatedOn Date Terminated on Gekündigt am
terminatedAsOf Date Terminated as of Kündigung zum
terminationReceiptDate Date Date receipt of termination Eingang Kündigung
terminationConfirmDate Date Date termination confirmation Kündigungsbestätigung
signatureTenant Date Signature tenant Unterschrift Mieter
signatureLandlord Date Signature landlord Unterschrift Vermieter
moveInDate Date Delivery date Einzugsdatum
moveOutDate Date Taking back date Auszugsdatum
externalContractNo Code External contract no. Externe Vertragsnummer
preferredMoveOutDate Date Desired return date Gewünschter Auszugstermin
preferredInspectionDate Date Desired date of acceptance Gewünschter Abnahmedatum
acceptedBy Code Accepted by Abgenommen von
actualInspectionDate Date Date of acceptance Tatsächliches Abnahmedatum
plannedInspectionDate Date Acceptance deadline Geplantes Abnahmedatum
plannedInspectionTime Time Time of acceptance Abnahmezeit
recordId RecordId RecordId Datensatz-ID

Typische Anwendungsfälle

// Aktive Verträge
GET .../relApiTabApiReContract?$filter=contractEnd eq null or contractEnd gt 2026-01-01

// Verträge eines bestimmten Kontakts
GET .../relApiTabApiReContract?$filter=contactNo eq 'K-0001'

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiRelCMEXARecord

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiRelCMEXARecord
Entity (Plural/Endpunkt) relApiTabApiRelCMEXARecord
Quell-Tabelle RelC MEX A-Record
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiRelCMEXARecord

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
mexAKeyBillingCompany Code MexAKey Billing Company MEX-Schlüssel Abrechnungsgesellschaft
serviceCompName Text Service Comp. Name$ Name der Servicegesellschaft
mexAOurAccountNo Code MexAOur Account No. Unser MEX-Kontonummer
externalID Text External ID Externe ID (Auftragsterm Abrechnungsgesellschaft)
version Text Version$ Version
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReminderLevels

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReminderLevel
Entity (Plural/Endpunkt) relApiTabApiReminderLevels
Quell-Tabelle Reminder Level (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReminderLevels

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
reminderTermsCode Code Reminder Terms Code Mahnbedingungscode (Verknüpfung zu relApiTabApiReminderTerms)
no Integer No. Mahnstufe (1, 2, 3, …)
gracePeriod DateFormula Grace Period Karenzzeit
dueDateCalculation DateFormula Due Date Calculation Fälligkeitsberechnung
relCReminderTitle1 Text RelC Reminder Title 1 Mahntitel 1
relCReminderTitle2 Text RelC Reminder Title 2 Mahntitel 2
relCAddFeeDescription Text RelC Add. Fee Description Beschreibung Zusatzgebühr

Hinweise für Entwickler

Diese Ressource wird in der Regel als SubPage von relApiTabApiReminderTerms konsumiert. Ein Direktabruf ist ebenfalls möglich.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReminderTerms

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReminderTerms
Entity (Plural/Endpunkt) relApiTabApiReminderTerms
Quell-Tabelle Reminder Terms (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReminderTerms

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
code Code Code Mahnbedingungscode
description Text Description Beschreibung
maxNoOfReminders Integer Max. No. of Reminders Maximale Anzahl Mahnungen
postAdditionalFee Boolean Post Additional Fee Zusatzgebühr buchen
Verknüpfte Ressource (SubPage)
Navigation Beschreibung
RelApiTabApiReminderLevel (EntitySet: relApiTabApiReminderLevels) Zugehörige Mahnstufen (via code)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReObject

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReObject
Entity (Plural/Endpunkt) relApiTabApiReObject
Quell-Tabelle RelC Object
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReObject

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code No. Objektnummer
description Text Description Objektbeschreibung
address Text Address Adresse
postCode Code Post Code Postleitzahl
city Text City Stadt
countryRegion Code Country/Region Code Ländercode
countyCode Code County Code Kreis-/Bezirkscode
yearOfConstruction Integer Year Of Construction Baujahr
completionDate Date Finish Date Fertigstellungsdatum
responsibilityCenterOwnerNo Code Responsibility Center Owner Zuständigkeitscenter Eigentümer (Code)
responsibilityCenterOwnerId GUID OwnerRespID Zuständigkeitscenter Eigentümer (GUID)
responsibilityCenterManagerNo Code Responsibility Center Manager Zuständigkeitscenter Verwalter (Code)
responsibilityCenterManagerId GUID ManagerRespID Zuständigkeitscenter Verwalter (GUID)
managementStartDate Date Management Start Date Verwaltungsbeginn
managementEndDate Date Management End Date Verwaltungsende
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressourcen (SubPages)
Navigation Beschreibung
RelApiTabApiUnitMasterData Einheitenstammdaten des Objekts
RelApiTabApiEditor Bearbeiter/Verwalter des Objekts

Typische Anwendungsfälle

// Alle Objekte eines Eigentümers
GET .../relApiTabApiReObject?$filter=ownerTenant eq 'OT-001'

// Einzelnes Objekt per ID
GET .../relApiTabApiReObject({id})

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiReportInboxes

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiReportInbox
Entity (Plural/Endpunkt) relApiTabApiReportInboxes
Quell-Tabelle Report Inbox (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibschutz Ja — nur Lesezugriff (GET)

Basis-URL

GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReportInboxes

Erlaubte HTTP-Methoden

Methode Erlaubt Beschreibung
GET ✅ Einträge abrufen (Liste oder einzeln)
POST ❌ Nicht erlaubt
PATCH ❌ Nicht erlaubt
DELETE ❌ Nicht erlaubt

Endpunkte

Alle Einträge abrufen
GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReportInboxes
Einzelnen Eintrag abrufen (via SystemId)
GET /api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiReportInboxes({id})

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel des Datensatzes (OData-Key)
reportId Integer Report ID ID des Reports in Business Central
reportName Text Report Name Name des Reports
description Text Description Beschreibung des Berichtseintrags
createdDateTime DateTime Created Date-Time Zeitstempel der Erstellung des Eintrags
entryNo Integer Entry No. Fortlaufende Eintragsnummer
jobQueueLogEntryID GUID Job Queue Log Entry ID Verknüpfung zum Job-Queue-Logeintrag
outputType Enum Output Type Ausgabeformat (z. B. PDF, Word, Excel)
read Boolean Read Gibt an, ob der Eintrag bereits gelesen wurde
reportOutput Blob Report Output Binärer Inhalt des generierten Reports
fileName Text Berechnet Dateiname: reportName + . + outputType (Kleinbuchstaben), z. B. Rechnung.pdf
userID Text User ID BC-Benutzer, dem der Bericht zugeordnet ist
systemCreatedAt DateTime Systemfeld Zeitstempel der Datensatzerstellung (BC intern)
systemCreatedBy GUID Systemfeld Benutzer-GUID, der den Datensatz erstellt hat
systemModifiedAt DateTime Systemfeld Zeitstempel der letzten Änderung
systemModifiedBy GUID Systemfeld Benutzer-GUID, der zuletzt geändert hat

Hinweise für Entwickler

reportOutput (Blob)

Das Feld enthält die binären Rohdaten des Reports. Es wird per CalcFields auf Anfrage befüllt (OnAfterGetRecord-Trigger). Beim Abrufen über OData wird dieses Feld standardmäßig nicht mitgeliefert — es muss explizit per $expand oder direktem Abruf angefordert werden, sofern die BC-Version dies unterstützt. Alternativ kann der Blob-Inhalt über einen separaten Stream-Endpunkt abgerufen werden.

fileName (berechnet)

Dieses Feld ist nicht in der Datenbank gespeichert. Es wird zur Laufzeit zusammengesetzt:

FileNameTxt := Rec."Report Name" + '.' + LowerCase(Format(Rec."Output Type"));

Beispiel: Report Name = "Jahresabrechnung", Output Type = PDF → fileName = "Jahresabrechnung.pdf"

OData-Filterung

Typische Filter-Beispiele:

// Nur ungelesene Einträge
GET .../relApiTabApiReportInboxes?$filter=read eq false

// Berichte eines bestimmten Benutzers
GET .../relApiTabApiReportInboxes?$filter=userID eq 'MUSTER'

// PDF-Berichte nach Erstellungsdatum sortiert
GET .../relApiTabApiReportInboxes?$filter=outputType eq 'PDF'&$orderby=createdDateTime desc

// Felder einschränken
GET .../relApiTabApiReportInboxes?$select=id,fileName,createdDateTime,read

Beispiel-Response (JSON)

{
  "@odata.context": "...",
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportId": 1306,
      "reportName": "Jahresabrechnung",
      "description": "Jahresabrechnung 2025 - Objekt 0815",
      "createdDateTime": "2026-01-15T08:30:00Z",
      "entryNo": 42,
      "jobQueueLogEntryID": "8e3f1a2b-0000-0000-0000-000000000000",
      "outputType": "PDF",
      "read": false,
      "fileName": "Jahresabrechnung.pdf",
      "userID": "MUSTER",
      "reportOutput": "<base64-encoded-blob>",
      "systemCreatedAt": "2026-01-15T08:30:00Z",
      "systemCreatedBy": "00000000-0000-0000-0000-000000000001",
      "systemModifiedAt": "2026-01-15T08:30:00Z",
      "systemModifiedBy": "00000000-0000-0000-0000-000000000001"
    }
  ]
}

Für Frontend-Entwickler: Typische Anwendungsfälle

Szenario Empfehlung
Posteingang anzeigen $filter=read eq false, $orderby=createdDateTime desc
Report herunterladen reportOutput (Blob) dekodieren, fileName als Dateinamen verwenden
Benutzer-spezifische Berichte $filter=userID eq '{BC-Username}'
Paginierung $top und $skip verwenden
Minimale Datenmenge laden $select verwenden, reportOutput nur bei Bedarf laden

Authentifizierung

Die API folgt dem Standard-Authentifizierungsverfahren von Business Central:

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud-Umgebungen
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiResponsabilityCenter

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiResponsabilityCenter
Entity (Plural/Endpunkt) relApiTabApiResponsabilityCenter
Quell-Tabelle Responsibility Center (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiResponsabilityCenter

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
code Code Code Zuständigkeitscenter-Code
name Text Name Name
address Text Address Adresse
postCode Code Post Code Postleitzahl
city Text City Stadt
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSalesCreditMemos

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSalesCreditMemo
Entity (Plural/Endpunkt) relApiTabApiSalesCreditMemos
Quell-Tabelle Sales Cr. Memo Entity Buffer (Business Central Standard)
Schlüsselfeld Id (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSalesCreditMemos

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Wichtigste Felder

Feldname Typ Quelle Beschreibung
id GUID Id Eindeutiger Schlüssel (OData-Key)
number Code No. Belegnummer (nur lesbar)
externalDocumentNumber Text External Document No. Externe Belegnummer
creditMemoDate Date Document Date Gutschriftsdatum
postingDate Date Posting Date Buchungsdatum
dueDate Date Due Date Fälligkeitsdatum
customerId GUID Customer Id Kunden-ID
customerNumber Code Sell-to Customer No. Kundennummer
customerName Text Sell-to Customer Name Kundenname (nur lesbar)
billToName Text Bill-to Name Rechnungsempfänger Name (nur lesbar)
billToCustomerId GUID Bill-to Customer Id Rechnungsempfänger-ID
billToCustomerNumber Code Bill-to Customer No. Rechnungsempfängernummer
sellToAddressLine1 Text Sell-to Address Lieferadresse Zeile 1
sellToAddressLine2 Text Sell-to Address 2 Lieferadresse Zeile 2
sellToCity Text Sell-to City Stadt (Lieferadresse)
sellToCountry Code Sell-to Country/Region Code Land (Lieferadresse)

Zeilenpositionen werden über relApiTabApiSalesCreditMemoLines abgerufen.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSalesCreditMemoLines

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSalesCreditMemoLine
Entity (Plural/Endpunkt) relApiTabApiSalesCreditMemoLines
Quell-Tabelle Sales Invoice Line Aggregate (temporär, Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSalesCreditMemoLines

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Schlüssel (OData-Key)
documentId GUID Document Id Verknüpfung zum Gutschriftskopf
sequence Integer Line No. Positionsnummer
itemId GUID Item Id Artikel-ID
accountId GUID Account Id Sachkonto-ID
lineType Enum API Type Positionstyp (Item / Account)
lineObjectNumber Code No. Artikel- oder Kontonummer
description Text Description Beschreibung
description2 Text Description 2 Beschreibung 2
unitOfMeasureId GUID Unit of Measure Id Maßeinheit-ID
unitOfMeasureCode Code Unit of Measure Code Maßeinheitscode
unitPrice Decimal Unit Price Einzelpreis
quantity Decimal Quantity Menge
discountAmount Decimal Line Discount Amount Rabattbetrag
discountPercent Decimal Line Discount % Rabattprozent
discountAppliedBeforeTax Boolean Discount Applied Before Tax Rabatt vor Steuer (nur lesbar)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSalesInvoice

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSalesInvoice
Entity (Plural/Endpunkt) relApiTabApiSalesInvoice
Quell-Tabelle Sales Invoice Entity Aggregate (Business Central Standard)
Schlüsselfeld Id (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSalesInvoice

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema) — Wichtigste Felder

Feldname Typ Quelle Beschreibung
id GUID Id Eindeutiger Schlüssel (OData-Key)
number Code No. Rechnungsnummer (nur lesbar)
externalDocumentNumber Text External Document No. Externe Belegnummer
invoiceDate Date Document Date Rechnungsdatum
postingDate Date Posting Date Buchungsdatum
dueDate Date Due Date Fälligkeitsdatum
customerPurchaseOrderReference Text Your Reference Bestellreferenz des Kunden
customerId GUID Customer Id Kunden-ID
customerNumber Code Sell-to Customer No. Kundennummer
customerName Text Sell-to Customer Name Kundenname (nur lesbar)
billToName Text Bill-to Name Rechnungsempfänger Name (nur lesbar)
billToCustomerId GUID Bill-to Customer Id Rechnungsempfänger-ID
billToCustomerNumber Code Bill-to Customer No. Rechnungsempfängernummer
shipToName Text Ship-to Name Lieferadresse Name
shipToContact Text Ship-to Contact Lieferadresse Ansprechpartner
sellToAddressLine1 Text Sell-to Address Lieferadresse Zeile 1
sellToAddressLine2 Text Sell-to Address 2 Lieferadresse Zeile 2
sellToCity Text Sell-to City Stadt (Lieferadresse)
sellToCountry Code Sell-to Country/Region Code Land (Lieferadresse)

Das vollständige Feldset entspricht dem BC-Standard-API. Rechnungspositionen über relApiTabApiSalesInvoiceLine.

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSalesInvoiceLine

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSalesInvoiceLine
Entity (Plural/Endpunkt) relApiTabApiSalesInvoiceLine
Quell-Tabelle Sales Invoice Line Aggregate (temporär, Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSalesInvoiceLine

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Schlüssel (OData-Key)
documentId GUID Document Id Verknüpfung zum Rechnungskopf
sequence Integer Line No. Positionsnummer
itemId GUID Item Id Artikel-ID
accountId GUID Account Id Sachkonto-ID
lineType Enum API Type Positionstyp (Item / Account)
lineObjectNumber Code No. Artikel- oder Kontonummer
description Text Description Beschreibung
description2 Text Description 2 Beschreibung 2
unitOfMeasureId GUID Unit of Measure Id Maßeinheit-ID
unitOfMeasureCode Code Unit of Measure Code Maßeinheitscode
quantity Decimal Quantity Menge
unitPrice Decimal Unit Price Einzelpreis
discountAmount Decimal Line Discount Amount Rabattbetrag
discountPercent Decimal Line Discount % Rabattprozent

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSalespersonPurchaser

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSalespersonPurchaser
Entity (Plural/Endpunkt) relApiTabApiSalespersonPurchaser
Quell-Tabelle Salesperson/Purchaser (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSalespersonPurchaser

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
code Code Code Verkäufer/Einkäufer-Code
name Text Name Name
jobTitle Text Job Title Berufsbezeichnung
eMail Text E-Mail E-Mail
eMail2 Text E-Mail 2 E-Mail 2
phoneNo Text Phone No. Telefon
blocked Boolean Blocked Gesperrt
commission Decimal Commission % Provision %
relCContactNo Code RelC Contact No. Kontaktnummer (RELion)
relCFaxNo Text RelC Fax No. Faxnummer (RELion)
relCMobilePhoneNo Text RelC Mobile Phone No. Mobilnummer (RELion)
relCRepresentative Boolean RelC Representative Vertreter
relCSignature Text RelC Signature Unterschrift
globalDimension1Code Code Global Dimension 1 Code Globale Dimension 1
globalDimension2Code Code Global Dimension 2 Code Globale Dimension 2
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSecurityForRent

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v1.0
Entity (Singular) relApiTabApiSecurityForRent
Entity (Plural/Endpunkt) relApiTabApiSecurityForRent
Quell-Tabelle RelC Security For Rent
Schlüsselfeld SystemId (GUID)
Schreibschutz Ja — nur Lesezugriff (GET)

Hinweis: Diese API verwendet Version v1.0 (abweichend von den meisten anderen Endpunkten mit v2.0).

Basis-URL

GET /api/aareon/relionBaseApi/v1.0/companies({companyId})/relApiTabApiSecurityForRent

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ❌
PATCH ❌
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemCreatedAt DateTime SystemCreatedAt Erstellungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemModifiedBy GUID SystemModifiedBy Zuletzt geändert von
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
unitHistory Integer Unit history Einheitenhistorie
no Code No. Mietkautionsnummer
contractNo Code Contract No. Vertragsnummer
kindOfSecurityForRent Code Kind of security for rent Art der Mietkaution
rentSecurityAmountUpdated Decimal Rent security amount updated Aktualisierter Kautionsbetrag

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiSpaceAndSurface

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiSpaceAndSurface
Entity (Plural/Endpunkt) relApiTabApiSpaceAndSurface
Quell-Tabelle RelC Space and surface
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiSpaceAndSurface

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
code Code Area code Flächencode
startDate Date Valid as of Gültig ab
endDate Date Valid to Gültig bis
roomNo Code Room no. Raumnummer
roomName Text Room name Raumname
building Code Building Gebäude
house Code House Haus
quantity Decimal Quantity Anzahl
areaSqm Decimal Area in sqm Fläche in m²
unitCode Code Unit code Einheitencode
exploitationMethod Code Exploitation method Nutzungsart
recordId RecordId RecordId Datensatz-ID

Typische Anwendungsfälle

// Flächen einer bestimmten Einheit
GET .../relApiTabApiSpaceAndSurface?$filter=ownerTenant eq 'OT-001' and objectNo eq 'OBJ-001' and unitNo eq 'E-001'

// Aktuelle Flächen (Gültigkeitsprüfung)
GET .../relApiTabApiSpaceAndSurface?$filter=startDate le 2026-04-24 and (endDate eq null or endDate ge 2026-04-24)

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiTenantContractDraft

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiTenantContractDraft
Entity (Plural/Endpunkt) relApiTabApiTenantContractDraft
Quell-Tabelle RelC Tenant Contract Draft
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiTenantContractDraft

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
address Text Address Adresse
postCode Code Post Code Postleitzahl
city Text City Stadt
importDateTime DateTime Import DateTime Import-Zeitstempel
importSource Text Import Source Importquelle
beginningOfContract Date Beginning of Contract Vertragsbeginn
salutationCode Code Salutation Code Anredecode
jobTitle Text Job Title Berufsbezeichnung
firstName Text First Name Vorname
surname Text Surname Nachname
phoneNo Text Phone No. Telefon
remarkPhoneNo Text Remark Phone No. Bemerkung Telefon
phoneCompany Text Phone Company Firmentelefon
mobilePhoneNo Text Mobile Phone No. Mobilnummer
remarkMobilePhoneNo Text Remark Mobile Phone No. Bemerkung Mobilnummer
faxNo Text Fax No. Faxnummer
eMail Text E-Mail E-Mail-Adresse
dateOfBirth Date Date of Birth Geburtsdatum
nameAtBirth Text Name at Birth Geburtsname
occupation Text Occupation Beruf
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiRelCTicketInput

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiRelCTicketInput
Entity (Plural/Endpunkt) relApiTabApiRelCTicketInput
Quell-Tabelle RelC Ticket Input
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiRelCTicketInput

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
systemCreatedBy GUID SystemCreatedBy Erstellt von
status Enum Status Ticketstatus
issue Text Issue Problem/Störung
description Text Description Beschreibung
priority Enum Priority Priorität
contactNo Code Contact No. Kontaktnummer
contactName Text Contact Name Kontaktname
contractNo Code Contract No. Vertragsnummer
completedDate Date Completed Date Erledigungsdatum
ticketReportedByName Code Ticket Reported By Name Gemeldet von (Kontakt)
ticketTypeCode Code Ticket Type Code Tickettyp-Code
ticketType Text Ticket Type Tickettyp
assignedPerson Code Assigned Person Zugewiesene Person
ticketProcessorPerson Code Ticket processor Person Bearbeitender Benutzer
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressourcen (SubPages)
Navigation Beschreibung
RelApiTabApiSalespersonPurch Verknüpfter Sachbearbeiter (via assignedPerson)
RelApiTabApiTicketInputMessage Nachrichten/Kommentare zum Ticket

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiRelCTicketInputMessage

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiRelCTicketInputMessage
Entity (Plural/Endpunkt) relApiTabApiRelCTicketInputMessage
Quell-Tabelle RelC Ticket Input Message
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiRelCTicketInputMessage

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ticketInputNo Code Ticket Input No. Ticket-Nummer (Verknüpfung)
noticeNo Integer Notice No. Hinweisnummer
lineNo Integer Line No. Zeilennummer
headLine Text Headline Betreff/Überschrift
comment Text Comment Kommentartext

Hinweise für Entwickler

Diese Ressource wird in der Regel als SubPage von relApiTabApiRelCTicketInput konsumiert. Ein Direktabruf mit Filter auf ticketInputNo ist ebenfalls möglich.

// Alle Nachrichten zu einem Ticket
GET .../relApiTabApiRelCTicketInputMessage?$filter=ticketInputNo eq 'TICKET-0001'

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiRelCTicketType

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiRelCTicketType
Entity (Plural/Endpunkt) relApiTabApiRelCTicketType
Quell-Tabelle RelC Ticket Type
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiRelCTicketType

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
code Code Code Tickettyp-Code
type Enum Type Typ
level Integer Level Hierarchieebene
codeFault Code Code Fault Fehlercode
belongsToCode Code Belongs to Code Übergeordneter Code
description Text Description Beschreibung
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiUnitAllocation

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiUnitAllocation
Entity (Plural/Endpunkt) relApiTabApiUnitAllocation
Quell-Tabelle RelC Unit Allocation
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiUnitAllocation

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
allocationCode Code Allocation Code Umlageschlüssel-Code
startDate Date Start Date Gültig ab
endDate Date End Date Gültig bis
description Text Description Beschreibung
reasonChange Text Reason for Change Änderungsgrund
factor Decimal Factor Faktor
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiUnitEquipment

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiUnitEquipment
Entity (Plural/Endpunkt) relApiTabApiUnitEquipment
Quell-Tabelle RelC Unit Equipment
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiUnitEquipment

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
unitEquipmentSerialNo Code Unit Equipment Serial No. Seriennummer der Ausstattung
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
building Code Building Gebäude
house Code House Haus
unitNo Code Unit No. Einheitennummer
room Code Room Raum
code Code Code Ausstattungscode
equipmentCategory Code Equipment category Ausstattungskategorie
typeOfDesign Text Type of design Designtyp
material Text Material Material
colour Text Color Farbe
description Text Description Beschreibung
description2KeyId Text Description 2 Beschreibung 2 / Schlüssel-ID
installationDate Date Installation date Installationsdatum
removeDate Date Addition date Hinzufügungsdatum
isKey Boolean Key Ist Schlüssel (Hinweis: Feldname key ist AL-Keyword)
numberOfKeys Integer Number Anzahl Schlüssel
quantity Decimal Quantity Menge
quantityUnit Code Quantity unit Mengeneinheit
inventoryNo Code Inventory No Inventarnummer
attribute1 Text Attribute1 Attribut 1
attribute2 Text Attribute2 Attribut 2
attribute3 Text Attribute3 Attribut 3
lastTestDate Date Last test date Letztes Prüfdatum
nextTestDate Date Next test date Nächstes Prüfdatum
length Decimal Length Länge
width Decimal Width Breite
height Decimal Height Höhe
areaSquareMeters Decimal Area Fläche m² (Feldname area ist AL-Keyword)
propertyOf Code PropertyOf Eigentum von
costTakeover Decimal Cost Takeover Kostenübernahme
manufacturingDate Date Manufacturing date Herstellungsdatum
recordId RecordId RecordId Datensatz-ID

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiUnitMasterData

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiUnitMasterData
Entity (Plural/Endpunkt) relApiTabApiUnitMasterData
Quell-Tabelle RelC Unit Master Data
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiUnitMasterData

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
address Text Address Adresse
address2 Text Address 2 Adresszusatz
postCode Code Post Code Postleitzahl
city Text City Stadt
description Text Description Beschreibung
building Code Building Gebäude
house Code House Haus
location Code Location Lage
floor Code Floor Etage
mgtStartDate Date Management Start Verwaltungsbeginn
mgtEndDate Date Management End Verwaltungsende
exploitationMethod Code Exploitation Method Nutzungsart
vatBusinessPostingGroup Code Vat business posting group MwSt.-Geschäftsbuchungsgruppe
numberOfRoomsText Text Number rooms (text) Anzahl Zimmer (Text)
numberOfWholeRooms Decimal Number whole rooms Anzahl ganze Zimmer
numberOfHalfRooms Decimal Number half rooms Anzahl halbe Zimmer
areaAllocationCode Code Area allocation code Flächenverteilungscode
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressourcen (SubPages)
Navigation Beschreibung
RelApiTabApiExploitationMethod Nutzungsart-Details (via exploitationMethod)
RelApiTabApiUnitAllocation Einheitenzuweisungen (via areaAllocationCode)
Service-Prozedur
Prozedur Rückgabe Beschreibung
VacanciesExportXml() Text Gibt OpenImmo-konformes XML für Leerstandsexporte zurück

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiUnitsContract

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiUnitsContract
Entity (Plural/Endpunkt) relApiTabApiUnitsContract
Quell-Tabelle RelC Unit Contract
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiUnitsContract

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
systemModifiedAt DateTime SystemModifiedAt Letztes Änderungsdatum
ownerTenant Code Owner / Tenant Eigentümer/Mieter
objectNo Code Object No. Objektnummer
unitNo Code Unit No. Einheitennummer
history Integer History Historiennummer
serialNo Integer Serial No. Laufende Nummer
contractNo Code Contract No. Vertragsnummer
description Text Description Beschreibung
customerNo Code Customer No. Kundennummer
unitContractStart Date Beginning of contract Vertragsbeginn
unitContractEnd Date Exp. date of contr. Vertragsablauf
dateMoveIn Date Date move-in Einzugsdatum
dateMoveOut Date Date excerpt Auszugsdatum
vacancy Boolean Vacancy Leerstand
externalUnitNo Code External Unit No. Externe Einheitennummer
vatBusinessPostingGroup Code VAT business posting group MwSt.-Buchungsgruppe
reasonForTermination Code Reason for termination Kündigungsgrund
reasonForVacancy Code Reason for vacancy Leerstandsgrund
areaAllocationCode Code Area Allocation Code Flächenverteilungscode
areaAllocationSqm Decimal Area Allocation Sqm Flächenverteilung m²
recordId RecordId RecordId Datensatz-ID
Verknüpfte Ressourcen (SubPages)
Navigation Beschreibung
RelApiTabApiRelCMexARecord MEX A-Records der Einheit
RelApiTabApiAllocGroupParticip Umlagegruppenverteilungen (via areaAllocationCode)

Typische Anwendungsfälle

// Leerstände abrufen
GET .../relApiTabApiUnitsContract?$filter=vacancy eq true

// Aktive Verträge einer Einheit
GET .../relApiTabApiUnitsContract?$filter=ownerTenant eq 'OT-001' and objectNo eq 'OBJ-001' and unitContractEnd eq null

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises

relApiTabApiVendor

Übersicht

Eigenschaft Wert
Publisher aareon
API-Gruppe relionBaseApi
Version v2.0
Entity (Singular) relApiTabApiVendor
Entity (Plural/Endpunkt) relApiTabApiVendor
Quell-Tabelle Vendor (Business Central Standard)
Schlüsselfeld SystemId (GUID)
Schreibzugriff Ja — GET, POST, PATCH
Change Tracking Aktiviert

Basis-URL

/api/aareon/relionBaseApi/v2.0/companies({companyId})/relApiTabApiVendor

Erlaubte HTTP-Methoden

Methode Erlaubt
GET ✅
POST ✅
PATCH ✅
DELETE ❌

Felder (Response-Schema)

Feldname Typ Quelle Beschreibung
id GUID SystemId Eindeutiger Systemschlüssel (OData-Key)
number Code No. Lieferantennummer
displayName Text Name Name
addressLine1 Text Address Adresse Zeile 1
addressLine2 Text Address 2 Adresse Zeile 2
city Text City Stadt
state Text County Bundesland
country Code Country/Region Code Ländercode
postalCode Code Post Code Postleitzahl
phoneNumber Text Phone No. Telefon
email Text E-Mail E-Mail
website Text Home Page Webseite
taxRegistrationNumber Text VAT Registration No. Steuernummer / USt-IdNr. (berechnet)
currencyId GUID Currency Id Währungs-ID
currencyCode Code Berechnet Währungscode

Das vollständige Feldset ist umfangreich (BC Standard-API). Bitte $select für optimierte Abfragen verwenden.

Hinweise für Entwickler

taxRegistrationNumber (berechnet)

Je nach Lokalisierung wird entweder VAT Registration No. oder die belgische Enterprise No. zurückgeliefert. Beim PATCH wird das Feld entsprechend zurückgeschrieben.

currencyCode

Beim PATCH kann entweder currencyId (GUID) oder currencyCode (Code) angegeben werden. Beide Felder werden synchronisiert. Ein leeres currencyId setzt die Währung auf Leer (Landeswährung).

Authentifizierung

  • OAuth 2.0 (Azure AD / Entra ID) für Cloud
  • Basic Auth / Windows Auth für On-Premises
Zuletzt geändert June 3, 2026: Merged PR 7327: hotfix 12.35 CU2 (e359344)