API платежі (Payment)
- API бренди (Brand)
- API групи контактів (User group)
- API документів (Document)
- API замовлення (Orders)
- API категорії (Category)
- API відправки SMS або Email
- API платежі (Payment)
- API отримання Бізнес процесів і статусів
- API отримання користувача за номером телефону
- API користувачі (User)
- API склади (Storage)
- API створення дзвінків
- API довідники
- API товари (Product)
- API ціни товарів (Product price)
- Інструкція створення користувача і пароля API
- Пісочниця (Sandbox) REST API
Додавання платежу, метод: /api/payment/add/
Параметри
Приклад:
http://myboxurl/api/payment/add/?login=LOGIN&password=PASSWORD&sum=322¤cyname=UAH&accountid=1&clientid=1&clientemail=test@test.ru&clientname=Vasya Pupkin&orderid=2&comment=Test Payment
http://myboxurl/api/payment/add/?login=LOGIN&password=PASSWORD&sum=233¤cyname=UAH&accountid=1&clientemail=test@test.ru&ordercode1c=777
http://myboxurl/api/payment/add/?login=LOGIN&password=PASSWORD&sum=233¤cyname=UAH&accountid=1&clientemail=test@test.ru&ordercode1c=777
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | cdate | datetime | Дата створення платежу | Не обов'язкове поле. | Якщо не вказати, то поставиться поточна дата |
| 4 | pdate | datetime | Дата проведення (коли платіж став активний) | Не обов'язкове поле. | |
| 5 | rdate | datetime | Дата відмови від платежу | Не обов'язкове поле. | |
| 6 | sum | float | Сума платежу | Обов'язкове поле. | Повинна бути не рівною 0 |
| 7 | sumbase | float | Сума платежу в базовій валюті | Не обов'язкове поле. | Це сума в базовій валюті системи OneBox (якщо не вказувати система автоматично його заповніть на основі суми платежу |
| 8 | currencyid | integer | ID валюти платежу | Не обов'язкове поле. | |
| 9 | currencyname | string | Ім'я валюти платежу | Не обов'язкове поле. | |
| 10 | currencyrate | float | Курс валюти платежу щодо базової валюти системи | Не обов'язкове поле. | |
| 11 | accountid | integer | ID Рахунки на який проводити платіж в системі | Не обов'язкове поле. | |
| 12 | accountname | string | Ім'я рахунку на який проводити платіж в системі | Не обов'язкове поле. | |
| 13 | accountcode1c | string | Зовнішній ID рахунку на який проводити платіж в системі | Не обов'язкове поле. | |
| 14 | clientid | integer | id клієнта на якого створювати платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по id і привязать платіж до нього |
| 15 | clientcode1c | string | code1c клієнта на якого створювати платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по code1c і привязать платіж до нього |
| 16 | clientemail | string | Email клієнта на якого створювати платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по email і привязать платіж до нього |
| 17 | clientphone | string | Телефон клієнта на якого створювати платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по телефону і привязать платіж до нього |
| 18 | codepayment | string | Код платежу | Не обов'язкове поле. | |
| 19 | clientname | string | Ім'я клієнта на якого створювати платіж | Не обов'язкове поле. | |
| 20 | managerid | integer | id користувача який буде проводити платіж | Не обов'язкове поле. | Якщо не вказати то візьметься користувача від якого буде создаватся платіж |
| 21 | categoryid | interger | Id категорії платежу | Не обов'язкове поле. | |
| 22 | categoryname | string | Ім'я категорії платежу | Не обов'язкове поле. | |
| 23 | orderid | integer | Id замовлення до якого привязивать платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти замовлення по id і привязать платіж до нього |
| 24 | ordercode1c | integer | code1c замовлення до якого привязивать платіж | Не обов'язкове поле. | Якщо вказати то система спробує знайти замовлення по code1c і привязать платіж до нього |
| 25 | linkkey | string | Унікальний ключ платежу | Не обов'язкове поле. | |
| 26 | comment | string | Коментар до платежу | Не обов'язкове поле. | |
| 27 | invoiceid | integer | ID cподружжя платежу | Не обов'язкове поле. | |
| 28 | nobalance | 1 / 0 | Чи враховувати в загальному балансі цей платіж | Не обов'язкове поле. | |
| 29 | code1c | string | Code1c платежу (id платежу з вашої системи) | Не обов'язкове поле. | |
| 30 | direction | enum('fromclient','toclient') | Напрямок платежу (за замовчуванням визначається за сумою платежу) | Не обов'язкове поле. |
Додавання очікуваного платежу, метод: /api/payment/probation/add/
Параметри
Приклад:
http://myboxurl/api/payment/probation/add/?login=LOGIN&password=PASSWORD&sum=322¤cyname=UAH&accountid=1&orderid=2&comment=Test Payment
http://myboxurl/api/payment/probation/add/?login=LOGIN&password=PASSWORD&sum=233¤cyname=UAH&accountid=1&ordercode1c=777&received=1
http://myboxurl/api/payment/probation/add/?login=LOGIN&password=PASSWORD&sum=233¤cyname=UAH&accountid=1&ordercode1c=777&received=1
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | pdate | date | Дата очікуваного отримання платежу | Обов'язкове поле. | |
| 4 | sum | float | Сума платежу | Обов'язкове поле. | Повинна бути не рівною 0 |
| 5 | currencyid | integer | ID валюти платежу | Не обов'язкове поле. | |
| 6 | currencyname | string | Ім'я валюти платежу | Не обов'язкове поле. | |
| 7 | accountid | integer | ID Рахунки на який проводити платіж в системі | Не обов'язкове поле. | |
| 8 | accountname | string | Ім'я рахунку на який проводити платіж в системі | Не обов'язкове поле. | |
| 9 | managerid | integer | id користувача який буде проводити платіж | Не обов'язкове поле. | Якщо не вказати то візьметься користувача від якого буде создаватся платіж |
| 10 | categoryid | interger | Id категорії платежу | Не обов'язкове поле. | |
| 11 | categoryname | string | Ім'я категорії платежу | Не обов'язкове поле. | |
| 12 | orderid | integer | Id замовлення до якого привязивать платіж | Не обов'язкове поле. | Або id або code1c замовлення необхідні для створення очікуваного платежу |
| 13 | ordercode1c | string | code1c замовлення до якого привязивать платіж | Не обов'язкове поле. | Або id або code1c замовлення необхідні для створення очікуваного платежу |
| 14 | comment | string | Коментар до платежу | Не обов'язкове поле. | |
| 15 | received | 1 / 0 | Отримано платіж | Не обов'язкове поле. |
Видалення платежу, метод: /api/payment/delete/
Параметри
Приклад:
http://myboxurl/api/payment/delete/?login=LOGIN&password=PASSWORD&paymentid=3
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | paymentid | string | Id платежу | Обов'язкове поле. | Або id або code1c платежу обов'язково для видалення |
| 4 | paymentcode1c | string | Code1c платежу | Обов'язкове поле. | Або id або code1c платежу обов'язково для видалення |
Видалення очікуваного платежу, метод: /api/payment/probation/delete/
Параметри
Приклад:
http://myboxurl/api/payment/probation/delete/?login=LOGIN&password=PASSWORD&paymentid=3
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | paymentid | integer | Id платежу | Обов'язкове поле. | id очікуваного платежу обов'язково для видалення |
| 4 | nomessage | 1 / 0 | Не создавать уведомление об удалении | Не обов'язкове поле. |
Редагування платежу, метод: /api/payment/update/
Параметри
Приклад:
http://myboxurl/api/payment/update/?login=LOGIN&password=PASSWORD&paymentid=2&orderid=660&&comment=Міняю платіж&sum=3333
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
|---|---|---|---|---|---|
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | paymentid | string | Id платежу | Обов'язкове поле. | Або id або code1c платежу обов'язково для редагування |
| 4 | paymentcode1c | string | Code1c платежу | Обов'язкове поле. | Або id або code1c платежу обов'язково для редагування |
| 5 | cdate | datetime | Дата створення платежу | Не обов'язкове поле. | |
| 6 | pdate | datetime | Дата проведення платежу | Не обов'язкове поле. | |
| 7 | rdate | datetime | Дата відмови платежу | Не обов'язкове поле. | |
| 8 | sum | float | Сума платежу | Не обов'язкове поле. | |
| 9 | sumbase | float | Сума платежу в базовій валюті | Не обов'язкове поле. | |
| 10 | currencyid | integer | ID валюти платежу | Не обов'язкове поле. | |
| 11 | currencyname | string | Ім'я валюти платежу | Не обов'язкове поле. | |
| 12 | accountid | integer | ID Рахунки на який проводити платіж в системі | Не обов'язкове поле. | |
| 13 | accountname | string | Ім'я рахунку на який проводити платіж в системі | Не обов'язкове поле. | |
| 14 | clientid | integer | id клієнта | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по id і привязать платіж до нього |
| 15 | clientcode1c | string | code1c клієнта | Не обов'язкове поле. | Якщо вказати то система спробує знайти клієнта по code1c і привязать платіж до нього |
| 16 | orderid | integer | Id замовлення до якого привязивать платіж | Не обов'язкове поле. | |
| 17 | ordercode1c | string | Code1c замовлення до якого привязать платіж | Не обов'язкове поле. | |
| 18 | comment | string | Коментар до платежу | Не обов'язкове поле. |
Отримання одного очікуваного платежу і отримання всіх очікуваних платежів, метод: /api/payment/probation/get/
Параметри
Параметри отримання одного очікуваного платежу:
Приклад:
http://myboxurl/api/payment/probation/get/?login=LOGIN&password=PASSWORD&paymentid=7927
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | paymentid | integer | id очікуваного платежу | Обов'язкове поле. | Якщо вам потрібен конкретний очікуваний платіж то ви в це поле передаєте id очікуваного платежу яке повернуло вам наше API при його створенні. Значення повертаються полів id - id платежу cdate - дата створення, amount - сума платежу, amountbase - сума платежу в базовій валюті системи, orderid - id замовлення платежу, ordercode1c - зовнішній код процесу платежу, ordername - назва процесу платежу, currencyid - id валюти платежу, currencyname - назва валюти платежу, accountid - id акаунта платежу, accountname - назва акаунта платежу, categoryid - id категорії платежу, categoryname - назва категорії платежу, direction - направненіе платежу, received - отримано чи платіж, managerid - id співробітника створив платіж, managerName - ім'я який створив платіж, |
Параметри отримання всіх очікуваних платежів:
Приклад:
http://myboxurl/api/payment/probation/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/payment/probation/get/?login=LOGIN&password=PASSWORD&part=2
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | cdatefrom | date | Дата створення платежу від | Не обов'язкове поле. | |
| 4 | cdateto | date | Дата створення платежу до | Не обов'язкове поле. | |
| 5 | pdatefrom | date | Дата отримання платежу від | Не обов'язкове поле. | |
| 6 | pdateto | date | Дата отримання платежу до | Не обов'язкове поле. | |
| 7 | accountid | integer | id акаунта очікуваного платежу | Не обов'язкове поле. | |
| 8 | accountname | string | Назва акаунта очікуваного платежу | Не обов'язкове поле. | |
| 9 | categoryid | integer | id категорії платежу | Не обов'язкове поле. | |
| 10 | categoryname | string | Назва категорії платежу | Не обов'язкове поле. | |
| 11 | orderid | integer | id процесу платежів | Не обов'язкове поле. | |
| 12 | ordercode1c | string | Зовнішній код процесу платежів | Не обов'язкове поле. | |
| 13 | received | 1 / 0 | Отримано платіж | Не обов'язкове поле. | 1 - тільки отримані платежі 0 - тільки не отримані платежі |
| 10 | part | integer | Частина замовлень | Обов'язкове поле. | API видає в 1й частини до 1000 очікуваних платежів, щоб отримати такі 1000 замовлень передайте туди 2 (виходить частина 2) і тд. Значення повертаються полів id - id платежу cdate - дата створення, amount - сума платежу, amountbase - сума платежу в базовій валюті системи, orderid - id замовлення платежу, ordercode1c - зовнішній код процесу платежу, ordername - назва процесу платежу, currencyid - id валюти платежу, currencyname - назва валюти платежу, accountid - id акаунта платежу, accountname - назва акаунта платежу, categoryid - id категорії платежу, categoryname - назва категорії платежу, direction - направненіе платежу, received - отримано чи платіж, managerid - id співробітника створив платіж, managerName - ім'я який створив платіж, |
Отримання одного фактичного платежу і отримання всіх фактичних платежів, метод: /api/payment/get/
Параметри
Параметри отримання одного платежу:
Приклад:
http://myboxurl/api/payment/get/?login=LOGIN&password=PASSWORD&paymentid=7927
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | paymentid | integer | id платежу | Обов'язкове поле. | Якщо вам потрібен конкретний платіж то ви в це поле передаєте id платежу яке повернуло вам наше API при його створенні. Значення повертаються полів id - id платежу code1c - code1c платежу cdate - Дата створення amount- Сума currencyid - валюта платежу currencyname - назва валюти платежу currencyrate - курс amountbase - платіж в базовій валюті accountid - id аккаунта платежу accountname - назва акаунта categoryid - id категорії платежу categoryname - назва категорії virtual - віртуальний платіж чи платіж direction - напрямок платежу clientid - id клієнта clientName - ім'я клієнта clientCode1c - code1c клієнта userid - id хто проводив платіж userName - ім'я проводив userCode1c - code1c проводив documentid - id документа, який відноситься до платежу comment - Коментар referenscode - референс код bankdetail - банківські реквізити customfields - додаткові поля продукту замовлення, які складаються з:
|
Параметри отримання всіх платежів:
Приклад:
http://myboxurl/api/payment/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/payment/get/?login=LOGIN&password=PASSWORD&part=2
http://myboxurl/api/payment/get/?login=LOGIN&password=PASSWORD&part=2
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | cdatefrom | date | Дата створення платежу від | Не обов'язкове поле. | |
| 4 | cdateto | date | Дата створення платежу до | Не обов'язкове поле. | |
| 5 | pdatefrom | date | Дата отримання платежу від | Не обов'язкове поле. | |
| 6 | pdateto | date | Дата отримання платежу до | Не обов'язкове поле. | |
| 7 | accountid | integer | id акаунта платежу | Не обов'язкове поле. | |
| 8 | accountname | string | Назва акаунта платежу | Не обов'язкове поле. | |
| 9 | categoryid | integer | id категорії платежу | Не обов'язкове поле. | |
| 10 | categoryname | string | Назва категорії платежу | Не обов'язкове поле. | |
| 11 | orderid | integer | id процесу платежів | Не обов'язкове поле. | |
| 12 | ordercode1c | string | Зовнішній код процесу платежів | Не обов'язкове поле. | |
| 13 | part | integer | Частина платежів | Обов'язкове поле. | API видає в 1й частини до 1000 платежів, щоб отримати такі 1000 замовлень передайте туди 2 (виходить частина 2) і тд. Значення повертаються полів id - id платежу code1c - code1c платежу cdate - Дата створення amount- Сума currencyid - валюта платежу currencyname - назва валюти платежу currencyrate - курс amountbase - платіж в базовій валюті accountid - id аккаунта платежу accountname - назва акаунта categoryid - id категорії платежу categoryname - назва категорії virtual - віртуальний платіж чи платіж direction - напрямок платежу clientid - id клієнта clientName - ім'я клієнта clientCode1c - code1c клієнта userid - id хто проводив платіж userName - ім'я проводив userCode1c - code1c проводив documentid - id документа, який відноситься до платежу comment - Коментар referenscode - референс код bankdetail - банківські реквізити customfields - додаткові поля продукту замовлення, які складаються з:
|
Отримання балансів всіх фінансових акаунтів, метод: /api/payment/balance/get/
Параметри
Приклад:
http://myboxurl/api/payment/balance/get/?login=LOGIN&password=PASSWORD
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
| 3 | contractortype | string | Тип юридического лица | Не обязательное поле. |
Допустимые значения:
|
| 4 | accountid | integer | id счета | Не обязательное поле. | Если нужно получить баланс только по 1 счету, необходимо указать этот параметр |
|
Значення повертаються полів |
Отримання балансів всіх бюджетів, метод: /api/budget/balance/get/
Параметри
Приклад:
http://myboxurl/api/budget/balance/get/?login=LOGIN&password=PASSWORD
| № | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
| 1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
| 2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
|
Значення повертаються полів |
Можливі варіанти відповіді на запит
Детальніше
Також можуть виникати помилки:
502 Bad Gateway - Якщо виникла ця помилка необхідно:
1. Перевірити, чи є доступ до Інтернету (зайти на будь-який інший сайт).
2. Якщо проблем з доступом немає — можна видалити файли cookies.
Якщо вказане вище не допомогло — проблема на стороні сервера. Слід звернутися до системного адміністратора сайту.
503 (Service Temporarily Unavailable) - дана помилка може виникати в результаті занадто великої кількості запитів до сервера. Якщо ви побачили таку помилку, варто почекати пару хвилин і спробувати знову.
504 Gateway Timeout - cкорее за все справа в зрослої навантаженні на сайт, при якій Apache не встигає віддавати HTTP-відповіді, і нові запити встають в чергу. Щоб вирішити проблему, можна додати ресурсів сервера, зокрема оперативної пам'яті, і збільшити кількість процесів httpd (Apache).
Інша можлива причина виникнення помилки 504 - виконуваний скрипт не вкладається у відведений ліміт часу. Це буває, коли запит занадто важкий. Спробуйте розбити свій запит на кілька більш маленьких.
Помилка 505 HTTP Version not supported означає, що веб-сайт не підтримує версію протоколу HTTP, за допомогою якого браузер здійснює запит веб-сторінки
| № | Статус | Повідомлення | Опис повідомлення |
| 1 | ok | paymentid | id доданого / відредагованого платежу |
| 2 | fail | login_empty | Відсутня логін |
| 3 | fail | password_empty | Відсутня пароль |
| 4 | fail | Login or password not correct! | Невірний логін або пароль |
| 5 | fail | Bad user level! | Низький рівень користувача, для виконання даної дії (потрібен level 2 і вище) |
| 6 | fail | PaymentCode1c exists | Платіж з таким кодом вже існує |
| 7 | fail | FinanceAccount not found | Фінансовий аккаунт не знайдено |
| 8 | fail | Payment by id or code1c not found | Платіж з таким id або кодом вже існує |
| 9 | fail | Payment accounts not found | Фінансові акаунти не знайдені |
Також можуть виникати помилки:
502 Bad Gateway - Якщо виникла ця помилка необхідно:
1. Перевірити, чи є доступ до Інтернету (зайти на будь-який інший сайт).
2. Якщо проблем з доступом немає — можна видалити файли cookies.
Якщо вказане вище не допомогло — проблема на стороні сервера. Слід звернутися до системного адміністратора сайту.
503 (Service Temporarily Unavailable) - дана помилка може виникати в результаті занадто великої кількості запитів до сервера. Якщо ви побачили таку помилку, варто почекати пару хвилин і спробувати знову.
504 Gateway Timeout - cкорее за все справа в зрослої навантаженні на сайт, при якій Apache не встигає віддавати HTTP-відповіді, і нові запити встають в чергу. Щоб вирішити проблему, можна додати ресурсів сервера, зокрема оперативної пам'яті, і збільшити кількість процесів httpd (Apache).
Інша можлива причина виникнення помилки 504 - виконуваний скрипт не вкладається у відведений ліміт часу. Це буває, коли запит занадто важкий. Спробуйте розбити свій запит на кілька більш маленьких.
Помилка 505 HTTP Version not supported означає, що веб-сайт не підтримує версію протоколу HTTP, за допомогою якого браузер здійснює запит веб-сторінки
Copyright © OneBox 2024
