Facturation et paiements
Factures, lignes, paiements, relances et facturation électronique (KSeF) — automatisez la facturation de bout en bout.
Facture
Points de terminaison
| POST | /e-invoices/send | Crée une ressource Invoice. |
| GET | /invoices | Récupère la collection de ressources Invoice. |
| POST | /invoices | Crée une ressource Invoice. |
| GET | /invoices/{id} | Récupère une ressource Invoice. |
| PATCH | /invoices/{id} | Met à jour la ressource Invoice. |
| DELETE | /invoices/{id} | Supprime la ressource Invoice. |
| GET | /invoices/{id}/send | Récupère une ressource Invoice. |
| POST | /invoices/{id}/send | Crée une ressource Invoice. |
| GET | /invoices/draft | Récupère la collection de ressources Invoice. |
| POST | /invoices/import | Crée une ressource Invoice. |
| GET | /invoices/name/{date} | Récupère la collection de ressources Invoice. |
| POST | /invoices/send | Crée une ressource Invoice. |
Ligne de facture
Points de terminaison
| GET | /invoice-rows | Récupère la collection de ressources InvoiceRow. |
| POST | /invoice-rows | Crée une ressource InvoiceRow. |
| GET | /invoice-rows/{id} | Récupère une ressource InvoiceRow. |
| PATCH | /invoice-rows/{id} | Met à jour la ressource InvoiceRow. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| 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. |
Transaction de facture
Points de terminaison
| GET | /invoice-transactions | Récupère la collection de ressources InvoiceTransaction. |
| POST | /invoice-transactions | Crée une ressource InvoiceTransaction. |
| GET | /invoice-transactions/{id} | Récupère une ressource InvoiceTransaction. |
| PATCH | /invoice-transactions/{id} | Met à jour la ressource InvoiceTransaction. |
| DELETE | /invoice-transactions/{id} | Supprime la ressource InvoiceTransaction. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| 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éthode de paiement
Points de terminaison
| GET | /payment-methods | Récupère la collection de ressources PaymentMethod. |
| GET | /payment-methods/{id} | Récupère une ressource PaymentMethod. |
| PATCH | /payment-methods/{id} | Met à jour la ressource PaymentMethod. |
| DELETE | /payment-methods/{id} | Supprime la ressource PaymentMethod. |
| POST | /payment-methods/create-setup-intent | Crée une ressource PaymentMethod. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| 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. |
Téléchargement de facture
Points de terminaison
| GET | /e-invoicing/invoices/{id}/download/pdf | Récupère une ressource InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/preview/pdf | Récupère une ressource InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/upo | Récupère une ressource InvoiceDownload. |
| GET | /e-invoicing/invoices/{id}/download/xml | Récupère une ressource InvoiceDownload. |
| GET | /e-invoicing/invoices/download/xml | Récupère la collection de ressources InvoiceDownload. |
Relance de facture
Points de terminaison
| GET | /invoice-reminders | Récupère la collection de ressources InvoiceReminder. |
| POST | /invoice-reminders/{id}/approve | Crée une ressource InvoiceReminder. |
| POST | /invoice-reminders/{id}/dismiss | Crée une ressource InvoiceReminder. |
| GET | /invoice-reminders/{id}/send | Récupère une ressource InvoiceReminder. |
| POST | /invoice-reminders/{id}/send | Crée une ressource InvoiceReminder. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| 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 |
Journal de facture
Points de terminaison
| GET | /invoice-logs | Récupère la collection de ressources InvoiceLog. |
| GET | /invoice-logs/{id} | Récupère une ressource InvoiceLog. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | integer | |
| invoice | string (iri-reference) | |
| employee | string (iri-reference) | |
| statusName | string | |
| description | stringnull |
Envoi de facture
Points de terminaison
| POST | /e-invoicing/invoices/{id}/send | Crée une ressource InvoiceSend. |
Envoi de facture rectificative
Points de terminaison
| POST | /e-invoicing/invoices/{id}/correction | Crée une ressource InvoiceCorrectionSend. |
Paiement
Points de terminaison
| GET | /payments | Récupère la collection de ressources Payment. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| id | string | |
| paymentMethod | string,null (iri-reference) | |
| type | string | |
| currency | string | |
| status | string |
Téléchargement de facture entrante
Points de terminaison
| GET | /e-invoicing/invoices/inbound/{id}/download/upo | Récupère une ressource InboundInvoiceDownload. |
| GET | /e-invoicing/invoices/inbound/{id}/download/xml | Récupère une ressource InboundInvoiceDownload. |
| GET | /e-invoicing/invoices/inbound/download/xml | Récupère la collection de ressources InboundInvoiceDownload. |
File d'attente des factures entrantes
Points de terminaison
| POST | /e-invoicing/invoices/inbound/queue | Crée une ressource InboundInvoiceQueue. |
Synchronisation des factures entrantes
Points de terminaison
| POST | /e-invoicing/invoices/inbound/sync | Crée une ressource InboundInvoiceSync. |
File d'attente d'import des factures sortantes
Points de terminaison
| POST | /v1/pl/invoices/outbound/import/queue | Crée une ressource OutboundInvoiceImportQueue. |
Synchronisation d'import des factures sortantes
Points de terminaison
| POST | /v1/pl/invoices/outbound/import/sync | Crée une ressource OutboundInvoiceImportSync. |
Session KSeF
Points de terminaison
| POST | /e-invoicing/ksef/session | Crée une ressource KsefSession. |