ImmobiNet
ImmobiNet API Docs - Invoices

Invoices

​object

InvoiceListItem

Invoice without lines (list).
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.

Invoice

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.

InvoiceDirection

string · enum
Enum values:
in
out

in for a document that adds to the revenue (invoice, receipt, ...), out for one that reduces it (credit note). It comes from the document type: amounts are always positive.

InvoiceType

code
​string

Code used in type of the invoices (e.g. fattura).

name
​string

Description of the type (e.g. Fattura).

direction
​InvoiceDirection · enum

in for a document that adds to the revenue (invoice, receipt, ...), out for one that reduces it (credit note). It comes from the document type: amounts are always positive.

Enum values:
in
out

Data of the electronic invoice (SDI). null when the installation does not have the electronic invoice or the type has no SDI code.

InvoiceTypeEInvoice

Data of the electronic invoice (SDI). `null` when the installation does not have the electronic invoice or the type has no SDI code.
code
​string

SDI document type code (TipoDocumento, e.g. TD01 invoice, TD04 credit note).

InvoicePaymentMethod

Payment method printed on the invoice. Not to be confused with the payment accounts of the transactions, which are where the money goes in or out.
code
​string

Code used in payment_method of the invoices (e.g. bonifico).

name
​string

Description of the payment method.

Data of the electronic invoice (SDI). null when the installation does not have the electronic invoice or the method has no SDI code.

InvoicePaymentMethodEInvoice

Data of the electronic invoice (SDI). `null` when the installation does not have the electronic invoice or the method has no SDI code.
code
​string

SDI payment method code (ModalitaPagamento, e.g. MP01 cash, MP05 bank transfer).

InvoiceStatus

string · enum
Enum values:
new
unpaid
paid
defaulted
other

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

InvoiceAmounts

Amounts in euro.
net
​number · double

Taxable amount (VAT excluded).

Example: 120.5
tax
​number · double

VAT.

Example: 120.5
total
​number · double

Total, VAT included.

Example: 120.5

InvoiceLine

id
​integer
description
​string | null

Free text of the line. null when the customer is anonymised (the text may contain names).

quantity
​number
unit_price
​number · double

Unit price, VAT excluded.

Example: 120.5
​object

Amounts of the line: net is the unit price × quantity (VAT excluded), tax the VAT, total VAT included.

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

Whether the line is subject to withholding tax.

Data of the line for the electronic invoice (SDI). null when the installation does not have the electronic invoice.

InvoiceLineVat

rate
​number | null

VAT rate in percent (e.g. 22 for 22%). null when the line has no rate.

exigibility
​string · enum

immediate, deferred or split (split payment).

Enum values:
immediate
deferred
split

InvoiceLineEInvoice

Data of the line for the electronic invoice (SDI). `null` when the installation does not have the electronic invoice.
vat_nature
​string | null

VAT nature code of the Italian electronic invoice (e.g. N4) for lines without VAT. null if not set.

Amount

number · double

Amount of money in euro (e.g. 120.50).

Example: 120.5