Contact Invoices API - ua

За допомогою цього API ви можете переглядати, створювати, знаходити та створювати рахунки вибраного клієнта.

Читання.

Дозволяє переглядати створені рахунки вибраного контакту у проекті.

GET https://api.smartsender.com/v1/contacts/{contactId}/invoices

Основні параметри:

Назва	Опис	Валідація

Назва	Опис	Валідація
page	Запрошувана сторінка	Мінімальне значення 1
limitation	Кількість даних для виводу на сторінці	Мінімальне значення 1, максимальне 20

У разі успішної відповіді отримаєте таке:

{
    "cursor": Cursor,
    "collection": Invoice[]
}

Опис відповіді:

Назва	Опис

Назва	Опис
cursor	Об'єкт типу Cursor
collection	Масив об'єктів типу Invoice

Отримання номера рахунку.

Отримання рахунку контакту за номером (orderId).

GET https://api.smartsender.com/v1/contacts/{contactId}/invoices/{orderId}

У разі успішної відповіді отримайте об'єкт типу Invoice

Створення рахунку.

Створення нового рахунку для контакту.

Основні параметри:

Назва	Опис

Назва	Опис
essenceId	Ідентифікатор товару
paymentSystemId	Ідентифікатор платіжної системи

У разі успішної відповіді отримайте об'єкт типу Invoice

Оплата за рахунок (ручний платіж).

Оплачує зазначений рахунок (або створює якщо раніше його не існувало) для зазначеного контакту. Якщо сума оплати менша ніж реальна на виставленому рахунку, рахунок все одно буде успішно сплачено.

Основні параметри:

Назва	Опис

Назва	Опис
date	Дата оплати, формат Y-m-d H:i:s
amount	Сума платежу
currency	Валюта платежу (lowecase)
orderId	ID замовлення
essenceId	Ідентифікатор товару
paymentSystemId	Ідентифікатор платіжної системи

У разі успішної відповіді отримайте об'єкт типу Invoice