API платежи (Payment)

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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')	Направление платежа (по умолчанию определяется по сумме платежа)	Не обязательное поле.

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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	Получен ли платеж	Не обязательное поле.

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	paymentid	string	Id платежа	Обязательное поле.	Или id или code1c платежа обязательно для удаления
4	paymentcode1c	string	Code1c платежа	Обязательное поле.	Или id или code1c платежа обязательно для удаления

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	paymentid	integer	Id платежа	Обязательное поле.	id ожидаемого платежа обязательно для удаления
4	nomessage	1 / 0	Не создавать уведомление об удалении	Не обязательное поле.

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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	Комментарий к платежу	Не обязательное поле.

Параметры получения одного ожидаемого платежа:

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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 - имя создавшего платеж,

Параметры получения всех ожидаемых платежей:

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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 - имя создавшего платеж,

Параметры получения одного платежа:

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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 - дополнительные поля продукта заказа, которые состоят из: key - ключ_дополнительного_поля name - название дополнительного поля value - значение дополнительного поля

Параметры получения всех платежей:

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
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 - дополнительные поля продукта заказа, которые состоят из: key - ключ_дополнительного_поля name - название дополнительного поля value - значение дополнительного поля

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
3	contractortype	string	Тип юридического лица	Не обязательное поле.	Допустимые значения: all - виртуальные и не виртуальные юридические лица standard или параметр contractortype не передан - только не виртуальные virtual - виртуальные
4	accountid	integer	id счета	Не обязательное поле.	Если нужно получить баланс только по 1 счету, необходимо указать этот параметр
					Значения возвращаемых полей id - id финансового аккаунта, name - название финансового аккаунта, active - статус активности, contractorid - id юридического лица, currencyid - ID валюты аккаунта, currencyname - название валюты аккаунта, overdraft - сумма овердрафта, balancestart - стартовый баланс, managerid - ID менеджера аккаунта, balance - баланс финансового аккаунта, balanceIn - сумма входящих платежей аккаунта, balanceOut - сумма исходящих платежей аккаунта, balancedate - дата и время получения баланса

Пример:

№	Поле	Тип	Описание	Обязательное или нет	Коментарий
1	login	string	Логин в системе BOX	Обязательное поле.
2	password	string	Пароль в формате md5	Обязательное поле.	Напишите в техподдержку и мы выдадим вам hash для API
					Значения возвращаемых полей id - id бюджета, name - название бюджета, active - статус активности, currencyid - ID валюты бюджета, currencyname - название валюты бюджета, stabilizationfund - сумма стабилизационного фонда в базовой валюте, sumamount - сумма операций в валюте бюджета, sumamountbase - сумма операций в базовой валюте, balance - баланс бюджета в валюте бюджета, balancebase - баланс бюджета в базовой валюте, balancedate - дата и время получения баланса

№	Статус	Сообщение	Описание сообщения
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, с помощью которого браузер осуществляет запрос веб-страницы