Faturação & pagamentos

Faturas, linhas, pagamentos, lembretes e faturação eletrónica (KSeF) — automatize a faturação de ponta a ponta.

Fatura

Endpoints

POST	/e-invoices/send	Cria um recurso Invoice.
GET	/invoices	Recupera a coleção de recursos Invoice.
POST	/invoices	Cria um recurso Invoice.
GET	/invoices/{id}	Recupera um recurso Invoice.
PATCH	/invoices/{id}	Atualiza o recurso Invoice.
DELETE	/invoices/{id}	Remove o recurso Invoice.
GET	/invoices/{id}/send	Recupera um recurso Invoice.
POST	/invoices/{id}/send	Cria um recurso Invoice.
GET	/invoices/draft	Recupera a coleção de recursos Invoice.
POST	/invoices/import	Cria um recurso Invoice.
GET	/invoices/name/{date}	Recupera a coleção de recursos Invoice.
POST	/invoices/send	Cria um recurso Invoice.

Linha da Fatura

Endpoints

GET	/invoice-rows	Recupera a coleção de recursos InvoiceRow.
POST	/invoice-rows	Cria um recurso InvoiceRow.
GET	/invoice-rows/{id}	Recupera um recurso InvoiceRow.
PATCH	/invoice-rows/{id}	Atualiza o recurso InvoiceRow.

Campos de schema

Campo	Tipo	Descrição
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	string
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array
product	string,null (iri-reference)	The catalog product this row sold, when it sold one. NULL on every row that exists today and on every row written by a non-POS screen — and a NULL product means this row moves no stock at all, which is exactly today's behaviour.
priceBasis	string
grossPrice	stringnull	The tax-INCLUSIVE unit price — the number on the price tag. Set only on a 'gross' row, where it is the authority; NULL on every 'net' row.

Transação da Fatura

Endpoints

GET	/invoice-transactions	Recupera a coleção de recursos InvoiceTransaction.
POST	/invoice-transactions	Cria um recurso InvoiceTransaction.
GET	/invoice-transactions/{id}	Recupera um recurso InvoiceTransaction.
PATCH	/invoice-transactions/{id}	Atualiza o recurso InvoiceTransaction.
DELETE	/invoice-transactions/{id}	Remove o recurso InvoiceTransaction.

Campos de schema

Campo	Tipo	Descrição
id	integer
invoice*	string (iri-reference)
transaction	string,null (iri-reference)
amount	numbernull
date*	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)

Método de Pagamento

Endpoints

GET	/payment-methods	Recupera a coleção de recursos PaymentMethod.
GET	/payment-methods/{id}	Recupera um recurso PaymentMethod.
PATCH	/payment-methods/{id}	Atualiza o recurso PaymentMethod.
DELETE	/payment-methods/{id}	Remove o recurso PaymentMethod.
POST	/payment-methods/create-setup-intent	Cria um recurso PaymentMethod.

Campos de schema

Campo	Tipo	Descrição
id	string
organization	string,null (iri-reference)
type	string
ccBrand	string
ccLastDigits	string
ccExpMonth*	integer
ccExpYear*	integer
externalId	string
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.

Transferência de Fatura

Endpoints

GET	/e-invoicing/invoices/{id}/download/pdf	Recupera um recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Recupera um recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/upo	Recupera um recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/xml	Recupera um recurso InvoiceDownload.
GET	/e-invoicing/invoices/download/xml	Recupera a coleção de recursos InvoiceDownload.

Lembrete de Fatura

Endpoints

GET	/invoice-reminders	Recupera a coleção de recursos InvoiceReminder.
POST	/invoice-reminders/{id}/approve	Cria um recurso InvoiceReminder.
POST	/invoice-reminders/{id}/dismiss	Cria um recurso InvoiceReminder.
GET	/invoice-reminders/{id}/send	Recupera um recurso InvoiceReminder.
POST	/invoice-reminders/{id}/send	Cria um recurso InvoiceReminder.

Campos de schema

Campo	Tipo	Descrição
id	integer
invoice	string (iri-reference)
level	integer
status	string
dueAt	string (date-time)
createdAt	string (date-time)
sentAt	string,null (date-time)
dismissedAt	string,null (date-time)
failedAt	string,null (date-time)
recipientEmail	stringnull
failureReason	stringnull
sentBody	stringnull
sentCcs	arraynull
pending	boolean
failed	boolean
sendable	boolean	A reminder can be (re-)sent while it is still awaiting its first send or its last attempt failed. Sent/dismissed reminders are terminal.
invoiceId	integernull
invoiceName	stringnull
clientName	stringnull
amountDue	numbernull
currencyCode	stringnull
invoiceDueDate	string (date-time)
daysOverdue	integer

Registo de Fatura

Endpoints

GET	/invoice-logs	Recupera a coleção de recursos InvoiceLog.
GET	/invoice-logs/{id}	Recupera um recurso InvoiceLog.

Campos de schema

Campo	Tipo	Descrição
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Envio de Fatura

Endpoints

POST

/e-invoicing/invoices/{id}/send

Envio de Correção de Fatura

Endpoints

POST

/e-invoicing/invoices/{id}/correction

Pagamento

Endpoints

GET

/payments

Campos de schema

Campo	Tipo	Descrição
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Transferência de Fatura Recebida

Endpoints

GET	/e-invoicing/invoices/inbound/{id}/download/upo	Recupera um recurso InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Recupera um recurso InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/download/xml	Recupera a coleção de recursos InboundInvoiceDownload.

Fila de Faturas Recebidas

Endpoints

POST

/e-invoicing/invoices/inbound/queue

Sincronização de Faturas Recebidas

Endpoints

POST

/e-invoicing/invoices/inbound/sync

Fila de Importação de Faturas Emitidas

Endpoints

POST

/v1/pl/invoices/outbound/import/queue

Sincronização de Importação de Faturas Emitidas

Endpoints

POST

/v1/pl/invoices/outbound/import/sync

Sessão KSeF

Endpoints

POST

/e-invoicing/ksef/session