MUmultigest
invoices

List invoices

Changed on

List invoices (faturas) with filters and pagination.

Translates VBA: PTQ_Financeiro_list

get/api/invoices

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/invoices
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Query parameters

yearinteger nullable

Filter by year

monthstring nullable

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

tipo_documentostring nullable

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

enviado_contabilidadeboolean nullable

Filter by sent to accountant

searchstring nullable

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

client_nifstring nullable

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

adquirente_nifstring nullable

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

emitidostring nullable

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

justification_statusstring nullable

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

payment_statusstring nullable

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)

pvstring nullable

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)

start_datestring nullable

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

end_datestring nullable

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

pageinteger
page_sizeinteger
sort_bystring nullable

Order by: data (document date) | entrada (upload date) | valor | numero

sort_orderstring nullable

asc | desc (default desc)

date_fieldstring nullable

Period filters read: entrada (upload date, default) | documento (document date)

Headers

x-api-tokenstring nullable

Response

Successful Response

object required

Changes

  • 46a612f27fbfRevision changes
    • info

      added the new optional query request parameter date_field

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order