Facturación y pagos

Facturas, líneas, pagos, recordatorios y facturación electrónica (KSeF) — automatiza la facturación de principio a fin.

Factura

Endpoints

POST	/e-invoices/send	Crea un recurso Invoice.
GET	/invoices	Recupera la colección de recursos Invoice.
POST	/invoices	Crea un recurso Invoice.
GET	/invoices/{id}	Recupera un recurso Invoice.
PATCH	/invoices/{id}	Actualiza el recurso Invoice.
DELETE	/invoices/{id}	Elimina el recurso Invoice.
GET	/invoices/{id}/send	Recupera un recurso Invoice.
POST	/invoices/{id}/send	Crea un recurso Invoice.
GET	/invoices/draft	Recupera la colección de recursos Invoice.
GET	/invoices/name/{date}	Recupera la colección de recursos Invoice.
POST	/invoices/send	Crea un recurso Invoice.

Línea de Factura

Endpoints

GET	/invoice-rows	Recupera la colección de recursos InvoiceRow.
POST	/invoice-rows	Crea un recurso InvoiceRow.
GET	/invoice-rows/{id}	Recupera un recurso InvoiceRow.
PATCH	/invoice-rows/{id}	Actualiza el recurso InvoiceRow.

Campos de schema

Campo	Tipo	Descripción
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	string
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array

Transacción de Factura

Endpoints

GET	/invoice-transactions	Recupera la colección de recursos InvoiceTransaction.
POST	/invoice-transactions	Crea un recurso InvoiceTransaction.
GET	/invoice-transactions/{id}	Recupera un recurso InvoiceTransaction.
PATCH	/invoice-transactions/{id}	Actualiza el recurso InvoiceTransaction.
DELETE	/invoice-transactions/{id}	Elimina el recurso InvoiceTransaction.

Campos de schema

Campo	Tipo	Descripción
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 Pago

Endpoints

GET	/payment-methods	Recupera la colección de recursos PaymentMethod.
GET	/payment-methods/{id}	Recupera un recurso PaymentMethod.
PATCH	/payment-methods/{id}	Actualiza el recurso PaymentMethod.
DELETE	/payment-methods/{id}	Elimina el recurso PaymentMethod.
POST	/payment-methods/create-setup-intent	Crea un recurso PaymentMethod.

Campos de schema

Campo	Tipo	Descripción
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.

Descarga de Factura

Endpoints

GET	/e-invoicing/invoices/{id}/download/pdf	Recupera un recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Recupera un recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/upo	Recupera un recurso InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/xml	Recupera un recurso InvoiceDownload.
GET	/e-invoicing/invoices/download/xml	Recupera la colección de recursos InvoiceDownload.

Recordatorio de Factura

Endpoints

GET	/invoice-reminders	Recupera la colección de recursos InvoiceReminder.
POST	/invoice-reminders/{id}/approve	Crea un recurso InvoiceReminder.
POST	/invoice-reminders/{id}/dismiss	Crea un recurso InvoiceReminder.
GET	/invoice-reminders/{id}/send	Recupera un recurso InvoiceReminder.
POST	/invoice-reminders/{id}/send	Crea un recurso InvoiceReminder.

Campos de schema

Campo	Tipo	Descripción
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

Registro de Factura

Endpoints

GET	/invoice-logs	Recupera la colección de recursos InvoiceLog.
GET	/invoice-logs/{id}	Recupera un recurso InvoiceLog.

Campos de schema

Campo	Tipo	Descripción
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Envío de Factura

Endpoints

POST

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

Envío de Corrección de Factura

Endpoints

POST

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

Pago

Endpoints

GET

/payments

Campos de schema

Campo	Tipo	Descripción
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Descarga de Factura Entrante

Endpoints

GET	/e-invoicing/invoices/inbound/{id}/download/upo	Recupera un recurso InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Recupera un recurso InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/download/xml	Recupera la colección de recursos InboundInvoiceDownload.

Cola de Facturas Entrantes

Endpoints

POST

/e-invoicing/invoices/inbound/queue

Sincronización de Facturas Entrantes

Endpoints

POST

/e-invoicing/invoices/inbound/sync

Cola de Importación de Facturas Salientes

Endpoints

POST

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

Sincronización de Importación de Facturas Salientes

Endpoints

POST

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

Sesión KSeF

Endpoints

POST

/e-invoicing/ksef/session