Sign in
invoices

List invoices

List invoices (faturas) with filters and pagination.

Translates VBA: PTQ_Financeiro_list

get/api/invoices

Query parameters

yearinteger nullable

Filter by year

Filter by year

monthstring nullable

Filter by month(s) — CSV of 1-12 (#695 multi)

Filter by month(s) — CSV of 1-12 (#695 multi)

tipo_documentostring nullable

Filter by document type(s) — CSV (#695 multi)

Filter by document type(s) — CSV (#695 multi)

enviado_contabilidadeboolean nullable

Filter by sent to accountant

Filter by sent to accountant

searchstring nullable

Search in number, ATCUD, emitter/acquirer NIF or client name

Search in number, ATCUD, emitter/acquirer NIF or client name

client_nifstring nullable

Filter by client NIF(s) (Faturas.A) — CSV (#695 multi)

Filter by client NIF(s) (Faturas.A) — CSV (#695 multi)

adquirente_nifstring nullable

Filter by acquirer/customer NIF(s) (Faturas.B) — CSV

Filter by acquirer/customer NIF(s) (Faturas.B) — CSV

emitidostring nullable

Flow filter: 'vendas' (own PV NIF/NIPC) or 'compras'

Flow filter: 'vendas' (own PV NIF/NIPC) or 'compras'

justification_statusstring nullable

CSV of justified|partially_justified|unjustified|over_justified (#695 multi)

CSV of justified|partially_justified|unjustified|over_justified (#695 multi)

payment_statusstring nullable

CSV of paid|partially_paid|unpaid|over_paid (#695 multi)

CSV of paid|partially_paid|unpaid|over_paid (#695 multi)

archive_statusstring nullable

CSV of TOConline archive states: enviada|arquivada|erro_arquivo|sem_confirmacao|sem_feedback (#695 multi)

CSV of TOConline archive states: enviada|arquivada|erro_arquivo|sem_confirmacao|sem_feedback (#695 multi)

pvstring nullable

Filter by PV the invoice belongs to (uploaded OR cost-center split) — CSV of PontosDeVenda.ID

Filter by PV the invoice belongs to (uploaded OR cost-center split) — CSV of PontosDeVenda.ID

has_cost_centerboolean nullable

Filter by presence of a cost-center split (true=has one, false=has none)

Filter by presence of a cost-center split (true=has one, false=has none)

start_datestring nullable

Filter by dataentrada >= this date (YYYY-MM-DD)

Filter by dataentrada >= this date (YYYY-MM-DD)

end_datestring nullable

Filter by dataentrada <= this date, inclusive (YYYY-MM-DD)

Filter by dataentrada <= this date, inclusive (YYYY-MM-DD)

pageinteger
page_sizeinteger

Headers

x-api-tokenstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.