Contact Invoices API
- Oleksandr Serdiuk
- Dmytro Lytvyn
С помощью данного API вы можете просматривать, создавать, находить и создавать счета выбранного клиента.
Чтение.
Позволяет просматривать созданные счета выбранного контакта в проекте.
GET https://api.smartsender.com/v1/contacts/{contactId}/invoices
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
{
"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.