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]":
де ХХХХХ - код токена
Відповідь:{ "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]":
де ХХХХХ - код токена
Відповідь:{ "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 рр.
где ХХХХХ - код токена
Відповідь:{"data":[{"docdate":"05\/01\/2017","docid":1,"docsum":1070.0,"doccurrencyname":"ГРН","docdescr":"Не сплачено | 3 СТО Авто-Cвіт","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 рр.
где ХХХХХ - код токена
Відповідь:{"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}
