Fatturazione e pagamenti
Fatture, righe, pagamenti, promemoria e fatturazione elettronica (KSeF) — automatizza la fatturazione end-to-end.
Fattura
Endpoint
| POST | /e-invoices/send | Crea una risorsa Invoice. |
| GET | /invoices | Recupera la raccolta di risorse Invoice. |
| POST | /invoices | Crea una risorsa Invoice. |
| GET | /invoices/{id} | Recupera una risorsa Invoice. |
| PATCH | /invoices/{id} | Aggiorna la risorsa Invoice. |
| DELETE | /invoices/{id} | Rimuove la risorsa Invoice. |
| GET | /invoices/{id}/send | Recupera una risorsa Invoice. |
| POST | /invoices/{id}/send | Crea una risorsa Invoice. |
| GET | /invoices/draft | Recupera la raccolta di risorse Invoice. |
| POST | /invoices/import | Crea una risorsa Invoice. |
| GET | /invoices/name/{date} | Recupera la raccolta di risorse Invoice. |
| POST | /invoices/send | Crea una risorsa Invoice. |
Riga fattura
Endpoint
| GET | /invoice-rows | Recupera la raccolta di risorse InvoiceRow. |
| POST | /invoice-rows | Crea una risorsa InvoiceRow. |
| GET | /invoice-rows/{id} | Recupera una risorsa InvoiceRow. |
| PATCH | /invoice-rows/{id} | Aggiorna la risorsa InvoiceRow. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| 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. |
Transazione fattura
Endpoint
| GET | /invoice-transactions | Recupera la raccolta di risorse InvoiceTransaction. |
| POST | /invoice-transactions | Crea una risorsa InvoiceTransaction. |
| GET | /invoice-transactions/{id} | Recupera una risorsa InvoiceTransaction. |
| PATCH | /invoice-transactions/{id} | Aggiorna la risorsa InvoiceTransaction. |
| DELETE | /invoice-transactions/{id} | Rimuove la risorsa InvoiceTransaction. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| 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) |
Metodo di pagamento
Endpoint
| GET | /payment-methods | Recupera la raccolta di risorse PaymentMethod. |
| GET | /payment-methods/{id} | Recupera una risorsa PaymentMethod. |
| PATCH | /payment-methods/{id} | Aggiorna la risorsa PaymentMethod. |
| DELETE | /payment-methods/{id} | Rimuove la risorsa PaymentMethod. |
| POST | /payment-methods/create-setup-intent | Crea una risorsa PaymentMethod. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| 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. |
Download fattura
Endpoint
| GET | /e-invoicing/invoices/{id}/download/pdf | Recupera una risorsa InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/preview/pdf | Recupera una risorsa InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/upo | Recupera una risorsa InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/xml | Recupera una risorsa InvoiceDownload. |
| GET | /e-invoicing/invoices/download/xml | Recupera la raccolta di risorse InvoiceDownload. |
Promemoria fattura
Endpoint
| GET | /invoice-reminders | Recupera la raccolta di risorse InvoiceReminder. |
| POST | /invoice-reminders/{id}/approve | Crea una risorsa InvoiceReminder. |
| POST | /invoice-reminders/{id}/dismiss | Crea una risorsa InvoiceReminder. |
| GET | /invoice-reminders/{id}/send | Recupera una risorsa InvoiceReminder. |
| POST | /invoice-reminders/{id}/send | Crea una risorsa InvoiceReminder. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| 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 fattura
Endpoint
| GET | /invoice-logs | Recupera la raccolta di risorse InvoiceLog. |
| GET | /invoice-logs/{id} | Recupera una risorsa InvoiceLog. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| id | integer | |
| invoice | string (iri-reference) | |
| employee | string (iri-reference) | |
| statusName | string | |
| description | stringnull |
Invio fattura
Endpoint
| POST | /e-invoicing/invoices/{id}/send | Crea una risorsa InvoiceSend. |
Invio correzione fattura
Endpoint
| POST | /e-invoicing/invoices/{id}/correction | Crea una risorsa InvoiceCorrectionSend. |
Pagamento
Endpoint
| GET | /payments | Recupera la raccolta di risorse Payment. |
Campi schema
| Campo | Tipo | Descrizione |
|---|---|---|
| id | string | |
| paymentMethod | string,null (iri-reference) | |
| type | string | |
| currency | string | |
| status | string |
Download fattura in entrata
Endpoint
| GET | /e-invoicing/invoices/inbound/{id}/download/upo | Recupera una risorsa InboundInvoiceDownload. |
| GET | /e-invoicing/invoices/inbound/{id}/download/xml | Recupera una risorsa InboundInvoiceDownload. |
| GET | /e-invoicing/invoices/inbound/download/xml | Recupera la raccolta di risorse InboundInvoiceDownload. |
Coda fatture in entrata
Endpoint
| POST | /e-invoicing/invoices/inbound/queue | Crea una risorsa InboundInvoiceQueue. |
Sincronizzazione fatture in entrata
Endpoint
| POST | /e-invoicing/invoices/inbound/sync | Crea una risorsa InboundInvoiceSync. |
Coda importazione fatture in uscita
Endpoint
| POST | /v1/pl/invoices/outbound/import/queue | Crea una risorsa OutboundInvoiceImportQueue. |
Sincronizzazione importazione fatture in uscita
Endpoint
| POST | /v1/pl/invoices/outbound/import/sync | Crea una risorsa OutboundInvoiceImportSync. |
Sessione KSeF
Endpoint
| POST | /e-invoicing/ksef/session | Crea una risorsa KsefSession. |