Интеграция c внешними системами>API. Функции по работе с документами

API. Функции по работе с документами

ИМПОРТ ДОКУМЕНТОВ В СИСТЕМУ ОБЛИК SAAS

Все ссылки на запросы к API включают обязательный основной URL:
https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API

1. Создание документа с помощью функции «createDoc».

Используются параметры:

token    - токен для доступа и выполнения функций API.

recalc   - автоматический пересчет и сохранение документа (логическое значение)

modify - включение автоматического пересчета полей (логическое значение)

putOn - включение автоматического проведения документа (логическое значение), 

если putOn=false - соданный документ отложен

data     - json объект формата:

{

 typeDoc - число, код типа документа в Облік SaaS

 idDoc  -  код документа во внешней системе (текстовое значение)

 fields   - json массив полей документа, формата:

 [

            {

            FieldName - поле документа в Облік SaaS (текстовое значение)

            TabRow -  номер строки в таблице (целое значение)

            FieldValue -  значение поля документа (текстовое значение)

            },

            ...

 ]

}

Пример. Запрос на создание документа "Счет покупателю[141]":

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/createDoc?token=XXXX&recalc=true&modify=true&putOn=false&data={"typeDoc":141,"idDoc":"A01","fields":[{"FieldName":"1:1","TabRow":1,"FieldValue":"07.06.2018"},{"FieldName":"1:2","TabRow":1,"FieldValue":"35"},{"FieldName":"1:4","TabRow":1,"FieldValue":"1"},{"FieldName":"1:7","TabRow":1,"FieldValue":"4"},{"FieldName":"1:8","TabRow":1,"FieldValue":"0"},{"FieldName":"2:1","TabRow":1,"FieldValue":"1"},{"FieldName":"2:2","TabRow":1,"FieldValue":"2801001"},{"FieldName":"2:3","TabRow":1,"FieldValue":"100"},{"FieldName":"2:4","TabRow":1,"FieldValue":"5"}]}

где ХХХХХ - код точена

Ответ:

{"status":0} – документ создан успешно  в системе Облик SaaS

{"status":7,"detail":"","total":0,"rows":[]} – документ не создан

 

2. Получение структуры документа с помощью функции «getDocStruct».

Используются параметры:

token    - токен для доступа и выполнения функций API.

typeDoc – номер вида документа

fullMode - режим отображения расширенных настроек документа

без fullMode - упрощенный вариант отображения настроек документа (вывод основных полей)

Пример.  Запрос на получение упрощенной структуры документа "Счет покупателю[141]":

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/getDocStruct?token=XXXX &typeDoc=141

где ХХХХХ - код токена

Ответ: {"data":[{"name":"Дата","field":"1:1","type":"Дата"},{"name":"№","field":"1:2","type":"Целое число"},{"name":"ЦФО","field":"1:3","type":"Филиал"},{"name":"Склад","field":"1:4","type":"Склад"},{"name":"НДС","field":"1:6","type":"Число с плавающей точкой"},{"name":"Контрагент","field":"1:7","type":"Клиент"},{"name":"Валюта","field":"1:8","type":"Валюта"},{"name":"Договор","field":"1:9","type":"Договор клиента"},{"name":"Сумма","field":"1:12","type":"Число с плавающей точкой"},{"name":"Примечание","field":"1:14","type":"Текст"},{"name":"Адрес","field":"1:15","type":"Текст"},{"name":"Терр. структура","field":"1:17","type":"Территориальная структура"},{"name":"Тип цены","field":"1:21","type":"Типы цен"},{"name":"Выбор из списка","field":"1:25","type":"Кнопка"},{"name":"Заказ N","field":"1:27","type":"Ссылка на документ"},{"name":"Менеджер","field":"1:28","type":"Сотрудник"},{"name":"Точка","field":"1:33","type":"Точка клиента"},{"name":"Тип отгрузки","field":"1:34","type":"Списки констант"},{"name":"Действителен до","field":"1:35","type":"Дата"},{"name":"Цена действительна от","field":"1:39","type":"Дата"},{"name":"Стоимость доставки","field":"1:44","type":"Число с плавающей точкой"},{"name":"Док.осн.","field":"1:46","type":"Ссылка на документ"},{"name":"Юридическое лицо","field":"1:47","type":"Логический"},{"name":"Не создавать акт","field":"1:48","type":"Логический"},{"name":"Р\/c","field":"1:49","type":"Расчетный счет предприятия"},{"name":"Оплачен","field":"1:50","type":"Логический"},{"name":"№","field":"2:1","type":"Целое число"},{"name":"Номенклатура","field":"2:2","type":"Товар"},{"name":"Цена","field":"2:3","type":"Число с плавающей точкой"},{"name":"Количество","field":"2:4","type":"Число с плавающей точкой"},{"name":"Сумма","field":"2:5","type":"Число с плавающей точкой"},{"name":"НДС","field":"2:6","type":"Число с плавающей точкой"},{"name":"Ед. изм.","field":"2:8","type":"Единицы измерения товара"},{"name":"К-во (доп)","field":"2:9","type":"Число с плавающей точкой"},{"name":"Цена без НДС","field":"2:10","type":"Число с плавающей точкой"},{"name":"Ставка НДС","field":"2:16","type":"Списки констант"},{"name":"Дата","field":"3:1","type":"Дата"},{"name":"Сумма","field":"3:2","type":"Число с плавающей точкой"}],"status":0}

Пример. Запрос на получение расширенной структуры документа "Счет покупателю[141]":

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/getDocStruct?token=XXXX &typeDoc=141&fullMode=true

где ХХХХХ - код токена

Ответ:{"data":[{"idFrame":300132687,"frameNumber":1,"frameOrder":1,"frameName":"Счет покупателю","countElement":50,"maxOrder":25,"isFixSize":false,"isCollapsed":false,"openObject":0,"idOpenObject":0,"isRowSelect":false,"controlType":"groupbox","frameHeight":"280","fields":[{"idField":300132688,"fieldNumber":1,"fieldOrder":1,"fieldName":"Дата","fieldTooltip":"Дата документа","controlType":"datepicker","idFrameNew":300132687,"FrameNewName":"Frame №1","idDataType":31340,"DataTypeName":"Дата","isEditable":false,"fieldWidth":"100","fieldHeight":"auto","fieldX":131,"fieldY":5,"isMandatory":true,"isReadonly":false,"isAutoselect":true,"isHidden":false,"fieldAlias":"Дата документа","fieldFormat":"99\/99\/9999","isCalc":false,"isAudit":false,"isAuditContext":false,"isModify":true,"useType":1,"cls":"","refField":"","isShowMobile":true,"align":"left"},

{"idField":300132689,"fieldNumber":2,"fieldOrder":2,"fieldName":"№","fieldTooltip":"Номер документа","controlType":"textBox","idFrameNew":300132687,"FrameNewName":"Frame №1","idDataType":31212,"DataTypeName":"Целое число","isEditable":false,"fieldWidth":"50","fieldHeight":"auto","fieldX":331,"fieldY":5,"isMandatory":true,"isReadonly":false,"isAutoselect":true,"isHidden":false,"fieldAlias":"Номер документа","fieldFormat":">>>>>9","isCalc":false,"isAudit":false,"isAuditContext":false,"isModify":true,"useType":2,"cls":"","refField":"","isShowMobile":true,"align":"right"},

…… множество параметров «"idField:N"»

 

ЭКСПОРТ ДОКУМЕНТОВ ИЗ СИСТЕМЫ ОБЛИК SAAS

1. Получение списка документов с помощью функции «getListDoc».

Используются параметры:

token    - токен для доступа и выполнения функций API.

typeDoc – номер вида документа

dateFrom, dateTo - период, за который формируется список документов

cond - список полей, по которым выполняется поиск (например, для счета cond=1:1,1:50 // номер документа, признак «оплачен»)

value - значения поиска (например, для счета value=1,no // номер документа, признак «не оплачен»)

sort – поля, по которым выполнить сортировку (например, sort=1:2)

Пример 1.1. Запрос на получение  данных  счетов под № 1 за период с 01.01.2017 по 31.12.2018 гг.

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/getListDoc?token=ХХХХХ&typeDoc=141&dateFrom=01.01.2017&dateTo=31.12.2018&cond=1:2&value=1

где ХХХХХ - код токена

Ответ:{"data":[{"docdate":"05\/01\/2017","docid":1,"docsum":1070.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 3 СТО Авто-Мир","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":false,"isOriginal":false,"riddoc":14750},{"docdate":"20\/02\/2018","docid":1,"docsum":1200.0,"doccurrencyname":"ГРН","docdescr":"Оплачен | 4 ВАТ Канцтовари","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":false,"docdelayed":true,"isOriginal":false,"riddoc":213939}],"status":0}

….. и данные других счетов под № 1

Пример 1.2.  Запрос на получение списка неоплаченных счетов за период с 01.01.2017 по 31.12.2018 гг.

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/getListDoc?token=ХХХХХ&typeDoc=141&dateFrom=01.01.2017&dateTo=31.12.2018&cond=1:50&value=no

где ХХХХХ - код токена

Ответ:{"data":[{"docdate":"05\/01\/2017","docid":1,"docsum":1070.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 3 СТО Авто-Мир","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":false,"isOriginal":false,"riddoc":14750},{"docdate":"22\/05\/2017","docid":6,"docsum":33.99,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 4 ВАТ Канцтовари | 1234","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":false,"isOriginal":false,"riddoc":16366},{"docdate":"22\/05\/2017","docid":7,"docsum":1550.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 4 ВАТ Канцтовари","isError":false,"errorText":"","isKeep":true,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":false,"isOriginal":false,"riddoc":16367},{"docdate":"17\/09\/2017","docid":8,"docsum":17750.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 1 ВАТ Демо-Банк","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":true,"isOriginal":false,"riddoc":212222},{"docdate":"07\/06\/2018","docid":34,"docsum":500.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 4 ВАТ Канцтовари","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":true,"isOriginal":false,"riddoc":214066},{"docdate":"16\/06\/2018","docid":35,"docsum":500.0,"doccurrencyname":"ГРН","docdescr":"Неоплачен | 4 ВАТ Канцтовари","isError":false,"errorText":"","isKeep":false,"isRecalc":false,"isComplete":false,"isFill":true,"docdelayed":false,"isOriginal":false,"riddoc":214065}],"status":0}

 

2. Получение данных документа с помощью функции «getDocs».

Используются параметры:

token    - токен для доступа и выполнения функций API.

rid     - внутренний номер документа в системе

Пример. Запрос на получение  данных  счета под внутренним № 212222

https://ioblik.com/cgi-bin/wspd_cgi.sh/WService=wsoblik/iOblik/API/getDocs?token= ХХХХХ &rid=212222

где ХХХХХ - код токена

Ответ:{"data":[{"RIDDOC":212222,"DOCDATE":"17\/09\/2015","DOCID":8,"DOCSUM":17750.0,"DOCCURRENCY":0,"DOCCURRENCYNAME":"ГРН","DOCDESCR":"Неоплачен | 1 ВАТ Демо-Банк","DOCDELAYED":true,"FIELDS":[{"NAMEFIELD":"1:47","BASETYPE":"LOGICAL","LINE":1,"SCRVALUE":"yes","VALUE":"yes","IDVALUE":"yes"},{"NAMEFIELD":"1:48","BASETYPE":"LOGICAL","LINE":1,"SCRVALUE":"no","VALUE":"no","IDVALUE":"no"},{"NAMEFIELD":"1:49","BASETYPE":"BANKACC","LINE":1,"SCRVALUE":"1 Основной счет предприятия","VALUE":"300092154","IDVALUE":"1"},{"NAMEFIELD":"2:16","BASETYPE":"DIRCONST","LINE":1,"SCRVALUE":"20%","VALUE":"300096528","IDVALUE":"1"},{"NAMEFIELD":"1:50","BASETYPE":"LOGICAL","LINE":1,"SCRVALUE":"No","VALUE":"No","IDVALUE":"No"},{"NAMEFIELD":"1:1","BASETYPE":"DATE","LINE":1,"SCRVALUE":"17\/09\/2015","VALUE":"17\/09\/2015","IDVALUE":"17\/09\/2015"},{"NAMEFIELD":"1:2","BASETYPE":"INTEGER","LINE":1,"SCRVALUE":"8","VALUE":"8","IDVALUE":"8"},{"NAMEFIELD":"1:3","BASETYPE":"FILIAL","LINE":1,"SCRVALUE":"Управление","VALUE":"31268","IDVALUE":"1"},{"NAMEFIELD":"1:4","BASETYPE":"WAREHOUSE","LINE":1,"SCRVALUE":"1 Основной склад","VALUE":"35716","IDVALUE":"1"},{"NAMEFIELD":"1:6","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"2958.33","VALUE":"2958.33","IDVALUE":"2958.33"},{"NAMEFIELD":"1:7","BASETYPE":"CLIENTS","LINE":1,"SCRVALUE":"1 ВАТ Демо-Банк","VALUE":"200482800","IDVALUE":"1"},{"NAMEFIELD":"1:8","BASETYPE":"CURRENCY","LINE":1,"SCRVALUE":"ГРН Гривня","VALUE":"34056","IDVALUE":"0"},{"NAMEFIELD":"1:12","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"17750","VALUE":"17750","IDVALUE":"17750"},{"NAMEFIELD":"1:21","BASETYPE":"PRICETYPE","LINE":1,"SCRVALUE":"1 Розничная базовая","VALUE":"60672","IDVALUE":"1"},{"NAMEFIELD":"1:28","BASETYPE":"EMPLOYEER","LINE":1,"SCRVALUE":"3 Іванов Іван Іванович","VALUE":"200482766","IDVALUE":"3"},{"NAMEFIELD":"1:33","BASETYPE":"T-CLNPOINT","LINE":1,"SCRVALUE":"0","VALUE":"0","IDVALUE":"0"},{"NAMEFIELD":"2:1","BASETYPE":"INTEGER","LINE":1,"SCRVALUE":"1","VALUE":"1","IDVALUE":"1"},{"NAMEFIELD":"2:2","BASETYPE":"WARE","LINE":1,"SCRVALUE":"104002 Монiтор FSC 462V FA","VALUE":"200671396","IDVALUE":"104002"},{"NAMEFIELD":"2:3","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"3550","VALUE":"3550","IDVALUE":"3550"},{"NAMEFIELD":"2:4","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"5","VALUE":"5","IDVALUE":"5"},{"NAMEFIELD":"2:5","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"17750","VALUE":"17750","IDVALUE":"17750"},{"NAMEFIELD":"2:6","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"2958.33","VALUE":"2958.33","IDVALUE":"2958.33"},{"NAMEFIELD":"2:8","BASETYPE":"WRUNITS","LINE":1,"SCRVALUE":"Штука","VALUE":"шт","IDVALUE":"шт"},{"NAMEFIELD":"2:9","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"5","VALUE":"5","IDVALUE":"5"},{"NAMEFIELD":"2:10","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"2958.3333333333","VALUE":"2958.3333333333","IDVALUE":"2958.3333333333"},{"NAMEFIELD":"3:1","BASETYPE":"DATE","LINE":1,"SCRVALUE":"17\/09\/2015","VALUE":"17\/09\/2015","IDVALUE":"17\/09\/2015"},{"NAMEFIELD":"3:2","BASETYPE":"DECIMAL","LINE":1,"SCRVALUE":"17750","VALUE":"17750","IDVALUE":"17750"}]}],"status":0}