Sauri - технические документы
Войти Создать аккаунт

API Sauri

Данное API позволяет взаимодействовать с ключевыми объектами конфигурации 1С:Бухгалтерии 3.0, опубликованной в сервисе 42Clouds. Может использоваться для разработки интеграций с внешними конфигурациями.

Service

GetDocumentsList

Возвращает список документов по типу документа

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Service/GetDocumentsList?DocumentType={Type}

Параметры запроса:

Параметр Тип параметра Описание параметра
DocumentType String Тип документа

Пример ответа на запрос:

<Result>
<GetDocumentsList Type="Table">
<Row>
<ID>5575977c-5813-11e7-80bc-951294d50957</ID>
<Type>СчетНаОплатуПокупателю</Type>
<Number>0000-000008</Number>
<Date>2017-06-23T00:00:00+03:00</Date>
<ClientName>Бел-Рет</ClientName>
<Sum>1200</Sum>
</Row>
</GetDocumentsList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор документа
Type String Тип документа
Number String Номер документа
Date Date Дата документа
ClientName String Имя контрагента
Sum double Сумма документа

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Документы по данному типу не найдены

DeleteDocument

Помечает документ на удаление

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Service/DeleteDocument?ID={ID}&DocumentType={Type}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор документа
DocumentType* String Тип документа

Пример ответа запроса:

<Result>
<DeleteDocument>true</DeleteDocument>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
DeleteDocument boolean Результат удаления

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Organizations

GetList

Возвращает список организаций

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/GetList

Пример ответа на запрос:

<Result>
<GetDocumentsList Type="Table">
<Row>
<OrganizationType>ЮридическоеЛицо</OrganizationType>
<Name>ООО "АГРОПАК"</Name>
<FullName>ООО "АГРОПАК">/FullName>
<LastNameIE/>
<FirstNameIE/>
<MiddleNameIE/>
<INN>0273095097</INN>
<KPP>027301001</KPP>
<BankAccountName/>
<OGRN>1140280008329</OGRN>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
<BankAccountID/>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор организации
OrganizationType String Тип организации
FullName String Полное имя организаци
Name String Имя организации
FirstNameIE String Имя ИП
LastNameIE String Фамилия ИП
MiddleNameIE String Отчество ИП
INN String ИНН
KPP String КПП
OGRN String ОГРН
BankAccountID Guid Идентификатор банковского счета
BankAccountName String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Список организаций пуст

GetMain

Возвращает главную организацию

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/GetMain

Пример ответа на запрос:

<Result>
<OrganizationType>ЮридическоеЛицо</OrganizationType>
<Name>ООО "АГРОПАК"</Name>
<FullName>ООО "АГРОПАК"</FullName>
<LastNameIE/>
<FirstNameIE/>
<MiddleNameIE/>
<INN>0273095097</INN>
<KPP>027301001</KPP>
<BankAccountName/>
<OGRN>1140280008329</OGRN>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
<BankAccountID/>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор организации
OrganizationType String Тип организации
FullName String Полное имя организаци
Name String Имя организации
FirstNameIE String Имя ИП
LastNameIE String Фамилия ИП
MiddleNameIE String Отчество ИП
INN String ИНН
KPP String КПП
OGRN String ОГРН
BankAccountID Guid Идентификатор банковского счета
BankAccountName String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Список организаций пуст

GetProperties

Возвращает свойства организации по ID

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/GetProperties?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
OrganizationID* Guid Идентификатор организации

Пример ответа на запрос:

<Result>
<OrganizationType>ЮридическоеЛицо</OrganizationType>
<Name>ООО "АГРОПАК"</Name>
<FullName>ООО "АГРОПАК"</FullName>
<LastNameIE/>
<FirstNameIE/>
<MiddleNameIE/>
<INN>0273095097</INN>
<KPP>027301001</KPP>
<BankAccountName/>
<OGRN>1140280008329</OGRN>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
<BankAccountID/>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор организации
OrganizationType String Тип организации
FullName String Полное имя организаци
Name String Имя организации
FirstNameIE String Имя ИП
LastNameIE String Фамилия ИП
MiddleNameIE String Отчество ИП
INN String ИНН
KPP String КПП
OGRN String ОГРН
BankAccountID Guid Идентификатор банковского счета
BankAccountName String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Документы по данному типу не найдены
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

GetTaxSystem

Возвращает налоговую систему организации по ID

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/GetTaxSystem?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор организации

Пример ответа на запрос:

<Result>
<GetTaxSystem/>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
GetTaxSystem String Система налогообложения организации

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Delete

Помечает организацию на удаление

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/ Delete?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор организации

Пример ответа на запрос:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Delete boolean Результат удаления

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Create

Создает новую организацию

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/Create

Параметры запроса:

Параметр Тип параметра Описание параметра
OrganizationType* String Тип организации
Name* String Имя
INN* String ИНН
KPP String КПП
OGRN String ОГРН
FullName String Полное имя
FirstNameIE String Имя ИП
LastNameIE String Фамилия ИП
MiddleNameIE String Отчество ИП

Пример ответа запроса:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

Clients

GetList

Возвращает список контрагентов

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Clients/GetList

Пример ответа на запрос:

<Result>
<GetList Type="Table">
<Row>
<ID>5a899748-6c55-11e7-80be-f65d39b0c912</ID>
<Name>ООО мечта</Name>
<ClientType>ЮридическоеЛицо</ClientType>
<INN>4656789045</INN>
<KPP>467890456</KPP>
<GovAgency>false</GovAgency>
<OGRN>78965478965</OGRN>
<BankAccountID/>
<BankAccountName/>
<Address>г.Ставрополь, ул.Жемчужная, д.45</Address>
<Email/>
<PhoneNumber/>
<FullName>ООО мечта</FullName>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор контрагента
ClientType String Тип контрагента
FullName String Полное имя контрагента
Name String Имя контрагента
PhoneNumber String Телефонный номер
Email String Электронная почта
Address String Адрес
INN String ИНН
KPP String КПП
OGRN String ОГРН
GovAgency boolean Государственный орган
BankAccountID Guid Идентификатор банковского счета
BankAccountName String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Список контрагентов пуст

GetProperties

Возвращает свойства контрагента по ID

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/GetProperties?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор контрагента

Пример ответа на запрос:

<Result>
<ID>5a899748-6c55-11e7-80be-f65d39b0c912</ID>
<Name>ООО мечта</Name>
<ClientType>ЮридическоеЛицо</ClientType>
<INN>4656789045</INN>
<KPP>467890456</KPP>
<GovAgency>false</GovAgency>
<OGRN>78965478965</OGRN>
<BankAccountID/>
<BankAccountName/>
<Address>г.Ставрополь, ул.Жемчужная, д.45</Address>
<Email/>
<PhoneNumber/>
<FullName>ООО мечта</FullName>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор контрагента
ClientType String Тип контрагента
FullName String Полное имя контрагента
Name String Имя контрагента
PhoneNumber String Телефонный номер
Email String Электронная почта
Address String Адрес
INN String ИНН
KPP String КПП
OGRN String ОГРН
GovAgency boolean Государственный орган
BankAccountID Guid Идентификатор банковского счета
BankAccountName String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Delete

Помечает контрагента на удаление

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Organizations/delete?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор контрагента

Пример ответа на запрос:

<Result>
<Delete>True</Delete>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Delete boolean Результат удаления

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Create

Создает нового контрагента

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Clients/Create

Параметры запроса:

Параметр Тип параметра Описание параметра
ClientType* String Тип контрагента
Name* String Имя
INN* String ИНН
KPP String КПП
OGRN String ОГРН
FullName String Полное имя
GovAgency boolean Государственный орган
PhoneNumber String Телефон
Email String Электронная почта
Address String Адрес

Пример ответа на запрос:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Delete boolean Результат удаления

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

SetProperties

Изменяет свойства контрагента

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Clients/SetProperties

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор контрагента
ClientType* String Тип контрагента
Name* String Имя
INN* String ИНН
KPP String КПП
OGRN String ОГРН
FullName String Полное имя
GovAgency boolean Государственный орган
PhoneNumber String Телефон
Email String Электронная почта
Address String Адрес
BankAccountID String Идентификатор банковского счета

Пример ответа на запрос:

<Result>
<SetProperties>true</SetProperties>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
SetProperties boolean Результат изменения

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Invoices

GetList

Возвращает список счет-фактур

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Invoices/GetList

Пример ответа на запрос:

<Result>
<GetList Type="Table">
<Row>
<ID>c92e7ee1-077a-11e9-a208-00155d091210</ID>
<Number>00БП-000018</Number>
<Date>2018-12-24T15:52:35+03:00</Date>
<ClientName>0 0 0 0 0</ClientName>
<OrganizationName>1 1 1 1 1</OrganizationName>
<Sum>200</Sum>
<CurrencyName>USD</CurrencyName>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор счет-фактуры
Number String Номер счет-фактуры
Date String Дата
Name String Имя
ClientName String Имя контрагента
OrganizationName String Имя организации
Sum Double Сумма документа
CurrencyName String Имя валюты документа
CurrencyName String Имя валюты документа

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Список счет-фактур пуст

GetProperties

Возвращает свойства счет-фактуры по ID

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Invoices/GetProperties?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор счет-фактуры

Пример ответа на запрос:

<Result>
<ID>c92e7ee1-077a-11e9-a208-00155d091210</ID>
<Number>00БП-000018</Number>
<Date>2018-12-24T15:52:35+03:00</Date>
<Name>00БП-000018 от 2018-12-24</Name>
<ClientName>0 0 0 0 0</ClientName>
<OrganizationName>1 1 1 1 1</OrganizationName>
<Sum>200</Sum>
<CurrencyName>USD</CurrencyName>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор счет-фактуры
Number String Номер счет-фактуры
Date String Дата
Name String Имя
ClientName String Имя контрагента
OrganizationName String Имя организации
Sum Double Сумма документа
CurrencyName String Имя валюты документа

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Delete

Помечает счет-фактуру на удаление

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Invoices/Delete?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор счет-фактуры

Пример ответа на запрос:

<Result>
<Delete>True</Delete>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Delete boolean Результат удаления

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Create

Создает новые счет-фактуры

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Invoices/Create

Параметры запроса:

Параметр Тип параметра Описание параметра
OrganizationID* Guid Идентификатор организации
ClientID* Guid Идентификатор контрагента
BankAccountID* Guid Идентификатор банковского счета
CurrencyID Guid Идентификатор типа валют
Discount String Скидка
VAT boolean НДС
Date Date Дата
NomenclatureTable:
<NomID
NomPrice
NomQuantity
NomSum> 		Table:
Guid
Double
Double
Double 		Таблица номенклатуры документа:
ID номенклатуры
Цена номенклатуры
Количество
Сумма

Пример ответа на запрос:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Create Guid Идентификатор счет-фактуры

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

SetProperties

Изменение свойств счет-фактуры

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Invoices/SetProperties

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор счет-фактуры
OrganizationID Guid Идентификатор организации
ClientID Guid Идентификатор контрагента
BankAccountID Guid Идентификатор банковского счета
CurrencyID Guid Идентификатор типа валют
Discount Double Скидка
VAT boolean НДС
Date Date Дата
NomenclatureTable:
<NomID
NomPrice
NomQuantity
NomSum>		 Table:
Guid
Double
Double
Double		 Таблица номенклатуры документа:
ID номенклатуры
Цена номенклатуры
Количество
Суммы

Пример ответа на запрос:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

BankAccounts

GetList

Возвращает список банковских счетов

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/BankAccounts/GetList?OwnerID={OwnerID}&OwnerType={OwnerType}

Параметры запроса:

Параметр Тип параметра Описание параметра
OwnerID Guid Идентификатор владельца счета
OwnerType String Тип владельца

Пример ответа на запрос:

<Result>
<GetList Type="Table">
<Row>
<ID>b27be9b9-6c66-11e7-80be-f65d39b0c912</ID>
<Name>40703810070010000381, МОСКОВСКИЙ ФИЛИАЛ АО КБ "МОДУЛЬБАНК";</Name>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор банковского счета
Name String Имя банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Банковские счета не найдены

GetProperties

Возвращает свойства банковского счета

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/BankAccounts/GetProperties?ID={ID}

Параметры запроса:

Параметр Тип параметра Описание параметра
ID* Guid Идентификатор банковского счета

Пример ответа на запрос:

<Result>
<ID>19b1dce1-3f3a-11e9-a205-00155d39c025</ID>
<Name/>
<Number>32132546432133</Number>
<BankID>ce6e3251-a526-11e8-80d7-00155d09cb0a</BankID>
<BankName>044552105</BankName>
<OwnerID>892088b9-67cb-11e7-80be-f65d39b0c912</OwnerID>
<OwnerType>Контрагенты</OwnerType>
<OwnerName>ООО Тестовый контрагент</OwnerName>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор банковского счета
Name String Имя банковского счета
Number String Номер счета
BankID Guid Идентификатор банка
BankName String Имя банка
OwnerID Guid Идентификатор владельца
OwnerType String Тип владельца
OwnerName String Имя владельца

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Метод объекта не найден
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Create

Создает банковский счет

POST

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/BankAccounts/Create

Параметры запроса:

Параметр Тип параметра Описание параметра
BankID Guid Идентификатор банка
OwnerID Guid Идентификатор владельца
OwnerType String Тип владельца
Number String Номер счета
Name String Имя счета

Пример ответа на запрос:

<Result>
<ID>49492a7a-6b2d-11e8-80cf-00155d09cb0a</ID>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
Create Guid Идентификатор банковского счета

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Документы по данному типу не найдены
406 Неверные параметры в запросе
400 Не найдены параметры в запросе

Banks

GetList

Возвращает список банков

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Banks/GetList

Пример ответа на запрос:

<Result>
<GetList Type="Table">
<Row>
<ID>ce6e3251-a526-11e8-80d7-00155d09cb0a</ID>
<Name>044552105</Name>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор банка
Name String Имя банка

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Банки не найдены

Currencies

GetList

Возвращает список валют

GET

Пример ответа на запрос:

<Result>
<GetList Type="Table">
<Row>
<ID>de80b7ca-aa22-11dc-a0f4-0011d85708ff</ID>
<Name>USD</Name>
</Row>
</GetList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор валюты
Name String Имя валюты

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Валюты не найдены

Nomenclature

GetList

Возвращает список номенклатуры

GET

Запрос:

https://beta-bp.42clouds.com/bp_base1/104/hs/SauriAPI/Nomenclature/GetList

Пример ответа на запрос:

<Result>
<GetDocumentsList Type="Table">
<Row>
<ID>5575977c-5813-11e7-80bc-951294d50957</ID>
<Type>СчетНаОплатуПокупателю</Type>
<Number>0000-000008</Number>
<Date>2017-06-23T00:00:00+03:00</Date>
<ClientName>Бел-Рет</ClientName>
<Sum>1200</Sum>
</Row>
</GetDocumentsList>
</Result>

Структура ответа:

Параметр Тип параметра Описание параметра
ID Guid Идентификатор номенклатуры
Name String Имя номенклатуры

Возможные ошибки метода:

Код ошибки Описание ошибки
404 Номенклатура не найдена
Вверх