{"swagger":"2.0","info":{"title":"1C-sync protocol","version":"1.0.0","description":"Cитуации, которые должны быть покрыты API:\n1. Любая информация, отправленная клиентом в 1С, должа быть либо полностью записана, либо полностью отвергнута (наш бэк не должен коммитить транзакцию, пока не получит ответ от 1С).\n 2. Клиент может заполнять не все поля, предусмотренные 1С, а только часть.\n 3. Взаимодействие с 1С должно быть не по интервалу, а в момент обращения.\n 4. Если 1С не смогла доставить информацию до нашей системы, то эта информация ставится в очередь. А через некоторый интервал наша система опрашивает наличие несинхронизированных изменений. Это должно работать только для изменений, которые внесены напрямую в 1С (например, бухгалтерами), не через нашу программу.\n 5. Нужно отделять измения, совершенные через наш АПИ, от всех других изменений, чтобы не допускать циклической синхронизации.\n 6. Для первичной синхронизации нужно будет использовать endpoint, реализованный на шаге (4). Таким образом, через этот endpoint будут получены все данные, содержащиеся в 1С, т.к. эти данные будут считаться недоставлеными.\n 7. Протокол должен поддерживать синхронизацию физического удаление объекта из 1С\n 8. При синхронизации «пометка на удаление» также должна быть отправлена на бэк.\n 9. Данные должны передаваться в JSON.\n 10. Необходимо проработать механизм установки таймзоны для сеанса в котором выполняется синхронизация.\n"},"tags":[{"name":"basic features","description":"Необходимо реализовать в первую очередь"},{"name":"additional features","description":"Фичи которые нужно реализовать в перспективе"}],"schemes":["https"],"produces":["application/json"],"securityDefinitions":{"basicAuth":{"type":"basic"}},"definitions":{"PaymentStatus":{"description":"Перечисления.СтатусОплатыСчета","type":"string","enum":["PAID","PARTIALLY_PAID","NOT_PAID"]},"VatType":{"description":"Перечисления.СтавкиНДС","type":"string","enum":["NONE","VAT_0","VAT_10","VAT_18","VAT_20","VAT_10_110","VAT_18_118","VAT_20_120"]},"ContragentType":{"description":"Перечисления.ЮридическоеФизическоеЛицо","type":"string","enum":["LEGAL","INDIVIDUAL"]},"Abstract1CEntity":{"description":"В 1С не представлен. Общий предок для всех сущностей имеющих поле \"Ссылка\"","type":"object","properties":{"guid":{"type":"string","format":"uuid","description":"Ссылка"}}},"MeasurementUnit":{"description":"Справочник.КлассификаторЕдиницИзмерения","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"Код единицы"},"shortName":{"type":"string","description":"Условное обозначение"},"fullName":{"type":"string","description":"Наименование"}}}]},"Nomenclature":{"description":"Справочник.Номенклатура","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"name":{"type":"string","description":"Наименование полное"},"unit":{"$ref":"#/definitions/MeasurementUnit","description":"Единица измерения"}}}]},"Currency":{"description":"Справочник.Валюты","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"shortName":{"type":"string","description":"Символьный код"},"code":{"type":"integer","format":"int32","description":"Цифровой код валюты"},"parent":{"$ref":"#/definitions/Currency"}}}]},"Bank":{"description":"Справочник.Банки","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"bic":{"type":"string","description":"БИК"},"corporateAccount":{"type":"string","description":"КоррСчет"},"name":{"type":"string","description":"Наименование банка"}}}]},"BankAccount":{"description":"Справочник.БанковскиеСчета","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"number":{"type":"string","description":"Номер Счета"},"bank":{"$ref":"#/definitions/Bank","description":"Банк"},"owner":{"type":"string","format":"uuid","description":"GUID владельца счета. Может быть организацией или контрагентом, физические лица пока не поддерживаются, но их идентификатор все равно может быть указан."},"currency":{"$ref":"#/definitions/Currency","description":"Валюта"}}}]},"Contract":{"description":"Справочник.ДоговорыКонтрагентов","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"code":{"type":"string","description":"Код договора"},"description":{"type":"string","description":"Наименование договора"},"number":{"type":"string","description":"Номер договора"},"contragent":{"$ref":"#/definitions/Contragent","description":"Контрагент"},"organization":{"$ref":"#/definitions/Contragent","description":"Организация"},"contractTime":{"type":"string","format":"datetime","description":"Срок действия договора"},"currency":{"$ref":"#/definitions/Currency","description":"Валюта договора"},"documentDate":{"type":"string","format":"date","description":"Дата создания договора"},"paymentsDueDays":{"type":"integer","format":"int32","description":"Количество дней на оплату счетов по договору"}}}]},"Contragent":{"description":"Справочник.Контрагенты","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"isOurOrganization":{"type":"boolean","description":"Флаг показывает, является ли этот контрагент нашей организацией"},"fullName":{"type":"string","description":"Полное наименование"},"shortName":{"type":"string","description":"Короткое наименование"},"inn":{"type":"string","description":"ИНН"},"kpp":{"type":"string","description":"КПП"},"ogrn":{"type":"string","description":"ОГРН"},"registrationDate":{"type":"string","format":"date","description":"Дата регистрации компании"},"contragentType":{"$ref":"#/definitions/ContragentType","description":"Тип контрагента. Физическое или юридическое лицо"},"address":{"type":"string","description":"Адрес"},"mainBankAccount":{"description":"Основной банковский счет","$ref":"#/definitions/BankAccount"}}}]},"BillPart":{"description":"ТабличнаяЧасть.Товары","type":"object","properties":{"lineNumber":{"type":"integer","description":"Порядковый номер записи"},"target":{"type":"string","description":"Наименование товара или услуги"},"price":{"type":"number","description":"Цена товара или услуги"},"amount":{"type":"number","description":"Сумма"},"amountVat":{"type":"number","description":"Сумма НДС"},"count":{"type":"integer","description":"Количество товаров или услуг"},"nomenclature":{"$ref":"#/definitions/Nomenclature","description":"Номенклатура"},"vatType":{"$ref":"#/definitions/VatType","description":"Ставка НДС"}}},"AbstractBill":{"description":"В 1С не представлен является единым предком всех счетов и реализует их общие свойства.","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"amount":{"type":"number","description":"Сумма Документа"},"number":{"type":"string","description":"Номер счета"},"isVatIncluded":{"type":"boolean","description":"Сумма Включает НДС"},"isWithoutVat":{"type":"boolean","description":"Документ Без НДС"},"target":{"type":"string","description":"Строковое представление товаров в счете (нужно для акта сверки)"},"parts":{"type":"array","description":"Товары","items":{"$ref":"#/definitions/BillPart"}},"contract":{"$ref":"#/definitions/Contract","description":"Договор Контрагента"},"comment":{"type":"string","description":"Комментарий"},"documentDate":{"type":"string","format":"date","description":"Дата документа"},"rate":{"type":"number","description":"Курс валюты (если счет рублевый, то = 1)"},"currency":{"$ref":"#/definitions/Currency","description":"Валюта документа"},"payUntil":{"type":"string","format":"date","description":"Оплатить до"},"billStatus":{"$ref":"#/definitions/PaymentStatus","description":"Статус оплаты"},"bankAccount":{"$ref":"#/definitions/BankAccount","description":"Банковский счет"},"recipient":{"$ref":"#/definitions/Contragent","description":"Получатель счета (не денег)"},"sender":{"$ref":"#/definitions/Contragent","description":"Отправитель счета (не денег)"}}}]},"IncomingBill":{"description":"Документ.СчетНаОплатуПоставщика","allOf":[{"$ref":"#/definitions/AbstractBill"},{"type":"object","properties":{"incomingDocumentNumber":{"type":"string","description":"Номер счета от поставщика"},"incomingDocumentDate":{"type":"string","format":"date","description":"Дата счета от поставщика"}}}]},"OutgoingBill":{"description":"Документ.СчетНаОплатуПокупателю","allOf":[{"$ref":"#/definitions/AbstractBill"},{"type":"object","properties":{"organization":{"$ref":"#/definitions/Contragent","description":"Организация-Получатель"},"deliveryAddress":{"type":"string","description":"Адрес Доставки"}}}]},"TransferPart":{"description":"ТабличнаяЧасть.РасшифровкаПлатежа","type":"object","properties":{"lineNumber":{"type":"integer","format":"int32","description":"Порядковый номер записи"},"billGuid":{"type":"string","format":"uuid","description":"Ссылка на оплачиваемый счет"},"amount":{"type":"number","description":"Сумма платежа"},"rate":{"type":"number","description":"Курс платежа"}}},"AbstractTransfer":{"description":"В 1С не представлен. является единым предком для всех движений средств (списаний, поступлений) по расчетному счету","allOf":[{"$ref":"#/definitions/Abstract1CEntity"},{"type":"object","properties":{"documentDate":{"type":"string","format":"datetime","description":"Дата платежа"},"number":{"type":"string","description":"Номер Входящего Документа"},"amount":{"type":"number","description":"Сумма Документа"},"target":{"type":"string","description":"Назначение Платежа"},"comment":{"type":"string","description":"Комментарий"},"currency":{"$ref":"#/definitions/Currency","description":"Валюта платежа"},"transferParts":{"type":"array","items":{"$ref":"#/definitions/TransferPart","description":"Части платежа"}},"sender":{"$ref":"#/definitions/Contragent","description":"Отправитель платежа (денег)"},"recipient":{"$ref":"#/definitions/Contragent","description":"Получатель платежа (денег)"}}}]},"IncomingTransfer":{"description":"Документ.ПоступлениеНаРасчетныйСчет","allOf":[{"$ref":"#/definitions/AbstractTransfer"},{"type":"object"}]},"OutgoingTransfer":{"description":"Документ.СписаниеСРасчетногоСчета","allOf":[{"$ref":"#/definitions/AbstractTransfer"},{"type":"object"}]}},"paths":{"/updates/{versionNumber}/page/{page}":{"get":{"tags":["basic features"],"security":[{"basicAuth":[]}],"parameters":[{"name":"versionNumber","required":true,"in":"path","description":"Последний выгруженный номер","type":"integer","format":"int64"},{"name":"page","in":"path","required":true,"description":"Номер страницы данных начиная с 0","type":"integer","format":"int32","default":0}],"responses":{"200":{"description":"Успешный ответ","schema":{"type":"object","properties":{"versionNumber":{"type":"integer","format":"int64","description":"Номер новой выгрузки, если изменений не было, то возвращается запрошенный versionNumber, если изменения были, то номер увеличивается на 1"},"nextPage":{"type":"integer","format":"int32","description":"Номер следующей страницы с данными. Если следующих данных нет, он совпадает с номером текущей страницы"},"content":{"type":"object","properties":{"banks":{"type":"array","items":{"$ref":"#/definitions/Bank"}},"deletedBanks":{"type":"array","items":{"type":"string","format":"uuid"}},"incomingBills":{"type":"array","items":{"$ref":"#/definitions/IncomingBill"}},"deletedIncomingBills":{"type":"array","items":{"type":"string","format":"uuid"}},"outgoingBills":{"type":"array","items":{"$ref":"#/definitions/OutgoingBill"}},"deletedOutgoingBills":{"type":"array","items":{"type":"string","format":"uuid"}},"incomingTransfers":{"type":"array","items":{"$ref":"#/definitions/IncomingTransfer"}},"deletedIncomingTransfers":{"type":"array","items":{"type":"string","format":"uuid"}},"outgoingTransfers":{"type":"array","items":{"$ref":"#/definitions/OutgoingTransfer"}},"deletedOutgoingTransfers":{"type":"array","items":{"type":"string","format":"uuid"}},"bankAccounts":{"type":"array","items":{"$ref":"#/definitions/BankAccount"}},"deletedBankAccounts":{"type":"array","items":{"type":"string","format":"uuid"}},"contrgents":{"type":"array","items":{"$ref":"#/definitions/Contragent"}},"deletedContrgents":{"type":"array","items":{"type":"string","format":"uuid"}},"nomenclature":{"type":"array","items":{"$ref":"#/definitions/Nomenclature"}},"deletedNomenclature":{"type":"array","items":{"type":"string","format":"uuid"}},"currencies":{"type":"array","items":{"$ref":"#/definitions/Currency"}},"deletedCurrencies":{"type":"array","items":{"type":"string","format":"uuid"}},"measurementUnits":{"type":"array","items":{"$ref":"#/definitions/MeasurementUnit"}},"deletedMeasurementUnits":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}},"403":{"description":"Отсутвует доступ"}}}},"/updates/{versionNumber}/commit":{"patch":{"tags":["basic features"],"description":"Подтверждение полной загрузки изменений","security":[{"basicAuth":[]}],"parameters":[{"name":"versionNumber","required":true,"in":"path","description":"Последний выгруженный номер","type":"integer","format":"int64"}],"responses":{"200":{"description":"Успешный коммит"},"403":{"description":"Отсутвует доступ"},"400":{"description":"Коммит не произошел","schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}},"/entities/incomingBills":{"post":{"tags":["basic features"],"description":"Добавление или изменение счета от поставщика. Выгружается вся иерархия объектов для того, чтобы восстановить битую ссылку (если вдруг guid не обнаружен, нужно заново создать объект по переданным данным).","security":[{"basicAuth":[]}],"parameters":[{"in":"body","name":"bill","schema":{"$ref":"#/definitions/IncomingBill"}}],"responses":{"200":{"description":"Успешное добавление счета. Возвращает все данные счета, чтобы обновить их в случае заполнения в 1С. Например, guid.","schema":{"$ref":"#/definitions/IncomingBill"}},"403":{"description":"Отсутвует доступ"},"400":{"description":"Произошла ошибка","schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}},"/entities/outgoingBills":{"post":{"tags":["basic features"],"description":"Добавление или изменение счета для клиента. Выгружается вся иерархия объектов для того, чтобы восстановить битую ссылку (если вдруг guid не обнаружен, нужно заново создать объект по переданным данным).","security":[{"basicAuth":[]}],"parameters":[{"in":"body","name":"bill","schema":{"$ref":"#/definitions/OutgoingBill"}}],"responses":{"200":{"description":"Успешное добавление счета. Возвращает все данные счета, чтобы обновить их в случае заполнения в 1С. Например, guid.","schema":{"$ref":"#/definitions/OutgoingBill"}},"403":{"description":"Отсутвует доступ"},"400":{"description":"Произошла ошибка","schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}}},"host":"virtserver.swaggerhub.com","basePath":"/paulseiziger9/1C-sync/1.0.0"}