ImmobiNet
ImmobiNet API Docs - Invoices

Invoices, credit notes and the other document types (read only).


Retrieve invoices

GET
/api/v1/invoices
basic

Returns a paginated list of the invoices visible to the API user, ordered by id ascending. Requires the API key scope invoices:read.

Retrieve invoices › query Parameters

paging_limit
​integer · min: 1 · max: 50

Limit items returned in response. Must be between 1 and 50

Default: 20
next_cursor
​string | null

Retrieve invoices › Responses

Successful response

​object

Retrieve a single invoice, with its lines

GET
/api/v1/invoices/{invoiceId}
basic

Requires the API key scope invoices:read.

Retrieve a single invoice, with its lines › path Parameters

invoiceId
​integer · required

Retrieve a single invoice, with its lines › Responses

Invoice found

Invoice with lines (detail).
id
​integer
number
​string

Full invoice number, as printed (prefix, number and suffix).

status
​InvoiceStatus · enum

new, unpaid (to be collected), paid (collected), defaulted (payment failed or not received); other for a status not listed here.

Enum values:
new
unpaid
paid
defaulted
other
date
​string · date
due_date
​string | null · date
type
​string

Code of the document type in the installation (e.g. fattura, nota_credito); agencies can define their own types. Names and e-invoice data of the types are read once from GET /api/v1/invoice-types.

agency_id
​integer | null
contact_id
​integer | null

Id of the customer's contact (see /api/v1/contacts); null if the customer has no contact (only a typed name, which the API does not expose). Name, email and the other data of the customer are in the contact.

payment_method
​string | null

Code of the payment method (e.g. bonifico, contanti).

​InvoiceAmounts

Amounts in euro.

Example: {"net":100,"tax":22,"total":122}
​object

Custom fields defined by the agency (key → value). Always an empty object for invoices.