Skip to content
Last updated

Access

Refer to the API Reference for full attribute and endpoint details.

Read access (required)

EntityAccessPurpose
organization.companyreadScope and company-level data.
accounting.invoicereadOriginal invoices not paid on time.
accounting.invoicerecipientreadRecipients of invoices.
accounting.debtinvoicereadDebt invoices (fees, interest, due dates).
accounting.invoicepaymentreadPayments against invoices or debt invoices.
accounting.debtinvoiceeventreadCommunication and status updates on debt invoice processing.
accounts.tenantreadRecipient details for tenants.
accounts.subtenantreadRecipient details for sub-tenants.

Read access (optional)

EntityAccessPurpose
accounting.invoicerelatedpdffilereadInvoice PDFs.
objects.apartmentreadInvoiced spaces.
objects.industrialpremisesreadInvoiced spaces.
objects.parkingspotreadInvoiced spaces.
objects.brfapartmentreadInvoiced spaces.
objects.outdoorsectionreadInvoiced spaces.
contracts.apartmentcontractreadInvoiced contracts.
contracts.industrialpremisescontractreadInvoiced contracts.
contracts.parkingspotcontractreadInvoiced contracts.
contracts.outdoorsectioncontractreadInvoiced contracts.
contracts.blockcontractreadInvoiced contracts.
contracts.othercontractreadInvoiced contracts.
contracts.signedcontractdocumentreadContract-related PDFs.
documents.signabledocumentreadContract-related PDFs.

Write access

EntityAccessPurpose
accounting.debtinvoiceread + create + updateCreate or annul debt invoices.
accounting.invoicepaymentread + createCreate payments.
accounting.debtinvoiceeventread + createReport progress to the customer.