Рахунки та платежі

Рахунки, позиції, платежі, нагадування та електронне фактурування (KSeF) — автоматизуйте виставлення рахунків від початку до кінця.

Цей довідник згенеровано зі схеми API. Описи полів і будь-який текст, який ще не перекладено, показано англійською.

Рахунок

Endpoints

Рахунок: Endpoints
Метод	Шлях	Опис
POST	/e-invoices/send	Створює ресурс Invoice.
GET	/invoices	Отримує колекцію ресурсів Invoice.
POST	/invoices	Створює ресурс Invoice.
GET	/invoices/{id}	Отримує ресурс Invoice.
PATCH	/invoices/{id}	Оновлює ресурс Invoice.
DELETE	/invoices/{id}	Видаляє ресурс Invoice.
GET	/invoices/{id}/send	Отримує ресурс Invoice.
POST	/invoices/{id}/send	Створює ресурс Invoice.
GET	/invoices/draft	Отримує колекцію ресурсів Invoice.
POST	/invoices/import	Створює ресурс Invoice.
GET	/invoices/name/{date}	Отримує колекцію ресурсів Invoice.
POST	/invoices/send	Створює ресурс Invoice.

Рядок рахунку

Endpoints

Рядок рахунку: Endpoints
Метод	Шлях	Опис
GET	/invoice-rows	Отримує колекцію ресурсів InvoiceRow.
POST	/invoice-rows	Створює ресурс InvoiceRow.
GET	/invoice-rows/{id}	Отримує ресурс InvoiceRow.
PATCH	/invoice-rows/{id}	Оновлює ресурс InvoiceRow.

Поля схеми

Рядок рахунку: Поля схеми
Поле	Тип	Опис
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	stringnull
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.

Транзакція рахунку

Endpoints

Транзакція рахунку: Endpoints
Метод	Шлях	Опис
GET	/invoice-transactions	Отримує колекцію ресурсів InvoiceTransaction.
POST	/invoice-transactions	Створює ресурс InvoiceTransaction.
GET	/invoice-transactions/{id}	Отримує ресурс InvoiceTransaction.
PATCH	/invoice-transactions/{id}	Оновлює ресурс InvoiceTransaction.
DELETE	/invoice-transactions/{id}	Видаляє ресурс InvoiceTransaction.

Поля схеми

Транзакція рахунку: Поля схеми
Поле	Тип	Опис
id	integer
invoice*	string (iri-reference)
transaction	string,null (iri-reference)
amount	number	MINOR units (grosze/cents) — 2 606,74 is 260674, NOT 2606.74. This differs from every neighbouring money field on this API: Invoice.amount, Invoice.amountNet and Transaction.amount are all MAJOR units, so a caller copying a transaction amount straight into this field stores 100x too little and the invoice renders as 1% paid.
date*	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)
amountFromMajor	numbernull	Store a payment whose source value is in MAJOR units.

Спосіб оплати

Endpoints

Спосіб оплати: Endpoints
Метод	Шлях	Опис
GET	/payment-methods	Отримує колекцію ресурсів PaymentMethod.
GET	/payment-methods/{id}	Отримує ресурс PaymentMethod.
PATCH	/payment-methods/{id}	Оновлює ресурс PaymentMethod.
DELETE	/payment-methods/{id}	Видаляє ресурс PaymentMethod.
POST	/payment-methods/create-setup-intent	Створює ресурс PaymentMethod.

Поля схеми

Спосіб оплати: Поля схеми
Поле	Тип	Опис
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.

Завантаження рахунку

Endpoints

Завантаження рахунку: Endpoints
Метод	Шлях	Опис
GET	/e-invoicing/invoices/{id}/download/pdf	Отримує ресурс InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Отримує ресурс InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/upo	Отримує ресурс InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/xml	Отримує ресурс InvoiceDownload.
GET	/e-invoicing/invoices/download/xml	Отримує колекцію ресурсів InvoiceDownload.

Нагадування про рахунок

Endpoints

Нагадування про рахунок: Endpoints
Метод	Шлях	Опис
GET	/invoice-reminders	Отримує колекцію ресурсів InvoiceReminder.
POST	/invoice-reminders/{id}/approve	Створює ресурс InvoiceReminder.
POST	/invoice-reminders/{id}/dismiss	Створює ресурс InvoiceReminder.
GET	/invoice-reminders/{id}/send	Отримує ресурс InvoiceReminder.
POST	/invoice-reminders/{id}/send	Створює ресурс InvoiceReminder.

Поля схеми

Нагадування про рахунок: Поля схеми
Поле	Тип	Опис
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

Журнал рахунку

Endpoints

Журнал рахунку: Endpoints
Метод	Шлях	Опис
GET	/invoice-logs	Отримує колекцію ресурсів InvoiceLog.
GET	/invoice-logs/{id}	Отримує ресурс InvoiceLog.

Поля схеми

Журнал рахунку: Поля схеми
Поле	Тип	Опис
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Надсилання рахунку

Endpoints

Надсилання рахунку: Endpoints
Метод	Шлях	Опис
POST	/e-invoicing/invoices/{id}/send	Створює ресурс InvoiceSend.

Надсилання коригування рахунку

Endpoints

Надсилання коригування рахунку: Endpoints
Метод	Шлях	Опис
POST	/e-invoicing/invoices/{id}/correction	Створює ресурс InvoiceCorrectionSend.

Платіж

Endpoints

Платіж: Endpoints
Метод	Шлях	Опис
GET	/payments	Отримує колекцію ресурсів Payment.

Поля схеми

Платіж: Поля схеми
Поле	Тип	Опис
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Завантаження вхідного рахунку

Endpoints

Завантаження вхідного рахунку: Endpoints
Метод	Шлях	Опис
GET	/e-invoicing/invoices/inbound/{id}/download/upo	Отримує ресурс InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Отримує ресурс InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/download/xml	Отримує колекцію ресурсів InboundInvoiceDownload.

Черга вхідних рахунків

Endpoints

Черга вхідних рахунків: Endpoints
Метод	Шлях	Опис
POST	/e-invoicing/invoices/inbound/queue	Створює ресурс InboundInvoiceQueue.

Синхронізація вхідних рахунків

Endpoints

Синхронізація вхідних рахунків: Endpoints
Метод	Шлях	Опис
POST	/e-invoicing/invoices/inbound/sync	Створює ресурс InboundInvoiceSync.

Черга імпорту вихідних рахунків

Endpoints

Черга імпорту вихідних рахунків: Endpoints
Метод	Шлях	Опис
POST	/v1/pl/invoices/outbound/import/queue	Створює ресурс OutboundInvoiceImportQueue.

Синхронізація імпорту вихідних рахунків

Endpoints

Синхронізація імпорту вихідних рахунків: Endpoints
Метод	Шлях	Опис
POST	/v1/pl/invoices/outbound/import/sync	Створює ресурс OutboundInvoiceImportSync.

Сеанс KSeF

Endpoints

Сеанс KSeF: Endpoints
Метод	Шлях	Опис
POST	/e-invoicing/ksef/session	Створює ресурс KsefSession.