ImmobiNet
ImmobiNet API Docs - Invoices

ImmobiNet API Docs - Invoices

PMS ImmobiNet - Invoices (read only).

Visibility: the API requires the privilege that gives access to the invoice list in the application (fatture_crea), and returns only the invoices of the agencies the API user belongs to (has a role in). The customer is given only as contact_id: the personal data are in /api/v1/contacts, with their own visibility rules. For an anonymised customer the free text of the lines (lines[].description) is null too, as it may contain names.

Document types: invoices, credit notes, debit notes, receipts and the other document types are the same resource, told apart by type (the code of the type in the installation). Names, direction (in or out: a credit note is out) and electronic invoice data of the types and the payment methods are read once from GET /api/v1/invoice-types and GET /api/v1/invoice-payment-methods. Pro forma invoices are not invoices in ImmobiNet and are not exposed here.

No updated_since: invoices have no modification date, so they cannot be polled for changes. Items are ordered by id ascending and new invoices have a higher id. _pagination.next_cursor only moves through the pages of one read: it is null on the last page, so it cannot be kept to resume later, and there is no filter by id. To find new invoices, read the list again from the first page and skip the ids you have already processed (or the ones up to the highest id you have read). Changes to existing invoices and deletions are not visible through polling.

List and detail: the list is flat (no lines); /api/v1/invoices/{invoiceId} adds lines.

Optional fields: fields that are not available to every installation (e.g. e_invoice of the lines) are always present and null when not available or without a value. custom_fields is always present. Custom fields are not available for invoices yet, so it is an empty object.

Amounts: amounts are decimal numbers in euro (not in cents), always positive: a credit note has positive amounts and a type with direction: out (see GET /api/v1/invoice-types). vat.rate is a percentage, not an amount.

Security Schemes
basicAuth
HTTP basic
http