Jeffit Integration API (1.0.0)

Download OpenAPI specification:Download

Создание дел на основании событий во внешней системе учета контрактов.

Взаимодействие.

Во внешней учетной системе происходит событие, по которому необходимо возбудить дело (например, истек срок погашения задолженности по контракту). Внешняя учетная система вызывает методы webservice Jeffit и передает необходимые данные для создания нового дела. Jeffit возвращает URL на созданное дело, внешняя система в карточке договора сохраняет этот URL.

Опционально.

Cправочник контрагентов может быть синхронизирован между Jeffit и учетной системой полностью. Тогда в Jeffit он становится readonly и при создании нового дела по контракту, передается только id контрагента. В противном случае передается полная информация о контрагенте при создании дела - и запись о контрагенте создается в момент создания дела.

Допущения.

Cчитаем, что справочники сотрудников учетной системы и Jeffit-а синхронизированы с ActiveDirectory или другим LDAP и уникальным userid является CN в LDAP.

Текстовые поля не могут быть пустыми строками или содержать только пробельные символы. На данный момент мы ограничиваем длину всех текстовых полей в 4000 символов.

На данный момент мы не специфицируем формат ответа при следующих ошибках, кроме того, что в результатах ошибочных запросов возвращается код состояния HTTP:

Указан неверный URL при запросе (404, Not Found)
Неверный метод запроса (405, Method Not Allowed)

В случае возникновения других ошибок будет возвращен JSON с кодом 400.

  {
    "success": false,
    "error": "error message"
  }

Webhook: Передача данных по делам из Jeffit во внешнюю систему

Описание процесса.

Jeffit при создании или изменения дела вызывает webservice внешней системы, указанный в настройках Jeffit и передает необходимые данные. При получении данных внешняя система должна вернуть успешный http response code (от 200 до 299). В случае неуспешной передачи данных Jeffit выполнит еще две попытки отправки данных с периодичностью 1 час.

Передаваемые данные.

Все параметры передаются в формате JSON и ответы возвращаются в формате JSON. Все передаваемые запросы должны содержать ключ авторизации в виде параметра token, который должен быть указан в настройках Jeffit.

Настройки в Jeffit

URL webservice внешней системы и Token для безопасности задаются в Jeffit: Настройки -> Настройки WebHook

Передача данных по делу.

Webhook - это POST запрос на URL указанный в настройке. В Jeffit предусмотрено два способа защиты взаимодействия:

BASIC: авторизация с помощью логина и пароля по протоколу Basic Authentication. Логин и пароль задаются в настройках. Basic Authentication
TOKEN: Запрос со стороны Jeffit и ответ со стороны сторонней системы должены содержать заголовок X-Webhook-Signature. Значение заголовка вычисляется следующим образом: который получается следующим образом: хэшируется тело запроса алгоритмом HmacSHA256, и результат хэширования кодируетс в hexadecimal. Token для хэширования указывается в настройках.

Integration API

Авторизация

Получение ключа авторизации пользователя, который необходимо передавать в дальнейших запросах в виде заголовка X-Jeffit-Session. Становится недействительным через 30 минут неактивности, необходимо получать перед серией запросов

Request Body schema: application/json

login required	string Логин пользователя
password required	string Пароль пользователя

Responses

Request samples

Payload

Content type

application/json

{"login": "string",
"password": "string"
}

Создание контрагента-организации

Создание контрагента-организации для юридических фирм и департаментов

header Parameters

X-Jeffit-Session

required

string

Ключ авторизации

Request Body schema: application/json

customerId required	string Уникальный ID контрагента во внешней учетной системе
name required	string Название контрагента-организации
ignoreIllFormedPhones	boolean Default: true Игнорировать неверный формат телефонов и не добавлять некорректные данные в систему
tryConvert8ToPlus7	boolean Default: true Менять автоматически на “+7” если первый символ “8”
ignoreIllFormedEmails	boolean Default: true Игнорировать неверный формат адресов электронной почты и не добавлять некорректные в систему
	Array of objects (Phone) Список телефонов контрагента. Только один из представленных телефонов может иметь флаг main = true
	Array of objects (Email) Список адресов электронной почты контрагента. Только один из представленных адресов может иметь тип PRIMARY
address	string Deprecated Адрес контрагента. Устарело, вместо этого поля используйте поле physicalAddress
fullName	string Официальное название организации. В случае отсутствия значеия официальное название организации будет взято из поля name
businessAddress	string Юридический адрес
physicalAddress	string Физический адрес
inn	string Идентификационный номер налогоплательщика
innLabel	string Enum: "INN" "UNP" Тип идентификационного номера налогоплательщика. "INN" - российский ИНН, "UNP" - беларуский УНП.
kpp	string Код причины постановки на налоговый учёт
ogrn	string Основной государственный регистрационный номер
requisitesName	string Наименование банковского счета. Игнорируется для юридических департаментов.
currency	string Код валюты в формате ISO 4217. Игнорируется для юридических департаментов.
zipCode	string Почтовый индекс. Игнорируется для юридических департаментов.
accountNumber	string Номер счета. Игнорируется для юридических департаментов.
bankAccountInfo	string Информация о счете. Игнорируется для юридических департаментов.
bank	string Наименование банка получателя. Игнорируется для юридических департаментов.
bik	string Банковский идентификационный код. Игнорируется для юридических департаментов.
bankCity	string Юридический адрес банка получателя. Игнорируется для юридических департаментов.
correspondentAccount	string Номер корреспондентского счета. Игнорируется для юридических департаментов.
intermediaryBank	string Транзитный банк. Игнорируется для юридических департаментов.
intermediaryBankSwift	string SWIFT транзитного банка. Игнорируется для юридических департаментов.
swift	string SWIFT. Игнорируется для юридических департаментов.

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
}

Response samples

default

Content type

application/json

{"success": true,
"error": "string"
}

Создание контрагента-персоны

Создание контрагента-персоны для юридических фирм и департаментов

header Parameters

X-Jeffit-Session

required

string

Ключ авторизации

Request Body schema: application/json

customerId required	string Идентификатор контрагента во внешней системе
firstName required	string Имя контрагента
lastName required	string Фамилия контрагента
middleName	string Отчество контрагента
ignoreIllFormedPhones	boolean Default: true Игнорировать неверный формат телефонов и не добавлять некорректные данные в систему
tryConvert8ToPlus7	boolean Default: true Менять автоматически на “+7” если первый символ “8”
ignoreIllFormedEmails	boolean Default: true Игнорировать неверный формат адресов электронной почты и не добавлять некорректные в систему
	Array of objects (Phone) Список телефонов контрагента. Только один из представленных телефонов может иметь флаг main = true
	Array of objects (Email) Список адресов электронной почты контрагента. Только один из представленных адресов может иметь тип PRIMARY
address	string Адрес контрагента.
position	string Должность контрагента
birthday	string Дата рождения. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
inn	string Идентификационный номер налогоплательщика
innLabel	string Enum: "INN" "UNP" Тип идентификационного номера налогоплательщика. "INN" - российский ИНН, "UNP" - беларуский УНП.
passportCodeOfState	string Код страны, в которой выдан документ удостоверяющий личность. Передается в формате ISO 3166-1 alpha-3
passportNumber	string Номер документа удостоверяющего личность
passportIssueDate	string Дата выдачи документа удостоверяющего личность. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
passportIssuer	string Кем выдан документ удостоверяющий личность

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"position": "string",
"birthday": "string",
"inn": "string",
"innLabel": "INN",
"passportCodeOfState": "string",
"passportNumber": "string",
"passportIssueDate": "string",
"passportIssuer": "string"
}

Response samples

default

Content type

application/json

{"success": true,
"error": "string"
}

Создание дела с договором и контрагентом

Создание дела с договором и контрагентом для юридических департаментов

header Parameters

X-Jeffit-Session

required

string

Ключ авторизации

Request Body schema: application/json

contractId	string Внешний идентификатор договора
contractNumber	string Номер договора
customerId required	string Внешний идентификатор контрагента
contractCreationDate	string Дата заключения договора. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
customerType	string Enum: "ORGANIZATION" "PERSON" Тип контрагента
contractResponsibleLawyerId	string Внешний идентификатор ответственного юриста по договору
contractAssigneeId	string Внешний идентификатор ответственного исполнителя по договору
customerFirstName	string Имя коннтагента, обязательно если тип контрагента PERSON
customerLastName	string Фамилия коннтагента, обязательно если тип контрагента PERSON
ignoreIllFormedPhones	boolean Default: true Игнорировать неверный формат телефонов и не добавлять некорректные данные в систему
tryConvert8ToPlus7	boolean Default: true Менять автоматически на “+7” если первый символ “8”
ignoreIllFormedEmails	boolean Default: true Игнорировать неверный формат адресов электронной почты и не добавлять некорректные в систему
	Array of objects Файлы договоров
contractSubject	string Предмет договора
contractAmount	string Сумма договора
contractTaxPercent	number Процент налога по договору
contractTaxAmount	number Сумма налога по договору
contractCurrency	string Код валюты в формате ISO 4217.
contractPenaltyAmount	number Сумма штрафа по договору
contractDate	string Дата заключения договора. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
contractSignedBy	string Подписант
contractTypeExternalId	string Внешний идентификатор типа договора
contractTypeName	string Наименование типа договора
contractCompanyExternalId	string Внешний идентификатор компании
	Array of objects Внешние ссылки в договоре
contractNote	string Коментарий к договору
externalRespPersonFirstName	string Имя контактоного лица
externalRespPersonLastName	string Фаилия контактного лица
externalRespPersonEmail	string Адрес электронной почты контактного лица
externalRespPersonPhone	string Телефон контактного лица
	Array of objects (Phone) Список телефонов контрагента
	Array of objects (Email) Список электроннных почт контрагента
customerFax	string Факс контрагента
customerAddress	string Адрес контрагента
customerMiddleName	string Отчество контрагента
customerFullName	string Полное имя контрагента
customerBusinessAddress	string Юридический адрес контрагента
customerZipCode	string Почтовый индекс контрагента
customerPhysicalAddress	string Физический адрес контрагента
customerCurrency	string Код валюты контрагента в формате ISO 4217.
customerInn	string ИНН контрагента
customerInnLabel	string Enum: "INN" "UNP" Тип идентификационного номера налогоплательщика. "INN" - российский ИНН, "UNP" - беларуский УНП.
customerKpp	string КПП контрагента
customerOgrn	string ОГРН контарагента
customerAccountNumber	string Номер банковского счета контрагента
customerBank	string Наименование банка контрагента
customerBik	string БИК контрагента
customerBankCity	string Юридический адрес банка получателя контрагента.
customerCorrespondentAccount	string Номер корреспондентского счета контрагента.
customerIntermediaryBank	string Транзитный банк контрагента.
customerIntermediaryBankSwift	string SWIFT транзитного банка контрагента.
customerSwift	string SWIFT контрагента.
customerPosition	string Должность контрагента
customerBirthday	string Дата рождения контрагента. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
customerPassportCodeOfState	string Код страны, в которой выдан документ удостоверяющий личность. Передается в формате ISO 3166-1 alpha-3
customerPassportNumber	string Номер паспорта контрагента
customerPassportIssueDate	string Дата выдачи паспорта контрагента. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
customerPassportIssuer	string Орган выдавший паспорт контрагента
customerPassportExpiryDate	string Дата истечения паспорта контрагента. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
	Array of objects Список реквизитов. Только один элемент может иметь аттрибут main = true
issueId	integer Внутренний идентификатор дела
serviceId	integer Внутренний идентификатор категории дела
issueSubject	string Наименование дела
issueDescription	string Описание дела
customerName	string Имя контрагента
assigneeLdapCn	string Логин исполнителя в LDAP
assigneeCandidates	Array of strings список значений внешних ключей пользователей для автоматического распределения создаваемого дела. ВАЖНО: можно использовать либо это свойство, либо assigneeLdapCn Вместе использовать их нельзя.
declarantLdapCn	string Логин заявителя в LDAP
	Array of objects Внешние ссылки

Responses

Request samples

Payload

Content type

application/json

{"contractId": "string",
"contractNumber": "string",
"customerId": "string",
"contractCreationDate": "string",
"customerType": "ORGANIZATION",
"contractResponsibleLawyerId": "string",
"contractAssigneeId": "string",
"customerFirstName": "string",
"customerLastName": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"contractFiles": [{"name": "string",
"filebase64": "string"
}
],
"contractSubject": "string",
"contractAmount": "string",
"contractTaxPercent": 0,
"contractTaxAmount": 0,
"contractCurrency": "string",
"contractPenaltyAmount": 0,
"contractDate": "string",
"contractSignedBy": "string",
"contractTypeExternalId": "string",
"contractTypeName": "string",
"contractCompanyExternalId": "string",
"contractHyperlinks": [{"id": 0,
"name": "string",
"link": "string"
}
],
"contractNote": "string",
"externalRespPersonFirstName": "string",
"externalRespPersonLastName": "string",
"externalRespPersonEmail": "string",
"externalRespPersonPhone": "string",
"customerPhones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"customerEmails": [{"type": "PRIMARY",
"email": "string"
}
],
"customerFax": "string",
"customerAddress": "string",
"customerMiddleName": "string",
"customerFullName": "string",
"customerBusinessAddress": "string",
"customerZipCode": "string",
"customerPhysicalAddress": "string",
"customerCurrency": "string",
"customerInn": "string",
"customerInnLabel": "INN",
"customerKpp": "string",
"customerOgrn": "string",
"customerAccountNumber": "string",
"customerBank": "string",
"customerBik": "string",
"customerBankCity": "string",
"customerCorrespondentAccount": "string",
"customerIntermediaryBank": "string",
"customerIntermediaryBankSwift": "string",
"customerSwift": "string",
"customerPosition": "string",
"customerBirthday": "string",
"customerPassportCodeOfState": "string",
"customerPassportNumber": "string",
"customerPassportIssueDate": "string",
"customerPassportIssuer": "string",
"customerPassportExpiryDate": "string",
"requisitesList": [{"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string",
"name": "string",
"fullName": "string",
"main": true,
"businessAddress": "string"
}
],
"issueId": 0,
"serviceId": 0,
"issueSubject": "string",
"issueDescription": "string",
"customerName": "string",
"assigneeLdapCn": "string",
"assigneeCandidates": ["string"
],
"declarantLdapCn": "string",
"hyperlinks": [{"id": 0,
"name": "string",
"link": "string"
}
]
}

Response samples

Content type

application/json

{"success": true,
"error": "string",
"result": {"id": 0
}
}

Создание или обновление дела с динамическими полями

Создание или обновление дела с динамическими полями для юридических фирм и департаментов

header Parameters

X-Jeffit-Session

required

string

Ключ авторизации

Request Body schema: application/json

name required	string Наименование дела
serviceId required	string Внешний идентификатор категории дела, задается в UI Jeffit
id	integer Внутренний идентификатор дела, используется для обновления параметров дела, имеет приоритет над externalId
externalId	string Внешний идентификатор дела, используется для обновления параметров дела, игнорируется, если задан параметр id
parentId	integer Внутренний идентификатор родительского дела, имеет приоритет над externalParentId
externalParentId	string Внешний идентификатор родительского дела, игнорируется если задан параметр parentId
deadline	string Дата крайнего срока закрытия дела. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
	object (ExtraJudicialProceeding) Секция для передачи данных внесудебного разбирательства
	object (FirstJudicialProceeding) Секция для передачи данных суда первой инстанции
	object (Contract) Deprecated договор для версии Jeffit для юридических подразделений
	Array of objects (Contract) Договоры
description	string Описание
declarantId	string Идентификатор заявителя
assigneeId	string Идентификатор исполнителя
	Array of objects (Link) Ссылки
	object Пара - ключ externalID поля и значение для этого поля
disputeDirection	string Enum: "INCOMING" "OUTGOING" "THIRDPARTY" Направление спора
judicialStatus	string Enum: "NOT_COMPLETED" "POSSIBLE_APPEAL" "COMPLETED" Статус судебной работы
judicialResult	string Результат судебной работы

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"serviceId": "string",
"id": 0,
"externalId": "string",
"parentId": 0,
"externalParentId": "string",
"deadline": "string",
"extraJudicialProceeding": {"active": false,
"recipient": {"externalId": "string",
"name": "string"
},
"applicant": {"externalId": "string",
"name": "string"
},
"claimNumber": "string",
"dateOfSendClaim": "string",
"dateOfReceivedClaim": "string",
"dateOfResponseClaim": "string",
"requirementsDescription": "string",
"position": "string",
"debt": {"value": 0,
"currency": "string"
},
"fine": {"value": 0,
"currency": "string"
},
"paidOut": {"value": 0,
"currency": "string"
},
"financialReservesEnabled": true,
"financialReserves": {"sum": {"value": 0,
"currency": "string"
},
"claimRequirementId": 0
},
"result": "string",
"amountOfAgreement": {"value": 0,
"currency": "string"
}
},
"firstJudicialProceeding": {"claimants": [{"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
}
],
"defendants": [{"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
}
],
"thirdParties": [{"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
}
],
"claimDescription": "string",
"claimDate": "string",
"proceedingCommencementDate": "string",
"courtId": "string",
"judgeId": "string",
"claims": {"detailed": true,
"sum": {"value": 0,
"currency": "string"
},
"details": [{"description": "string",
"sum": {"value": 0,
"currency": "string"
},
"claimRequirementId": "string"
}
]
},
"governmentTax": {"value": 0,
"currency": "string"
},
"financialReservesEnabled": true,
"financialReserves": [{"sum": {"value": 0,
"currency": "string"
},
"claimRequirementId": "string"
}
],
"decisionTypeId": "string",
"courtDecision": "string",
"satisfiedClaims": {"detailed": true,
"sum": {"value": 0,
"currency": "string"
},
"details": [{"description": "string",
"sum": {"value": 0,
"currency": "string"
},
"claimRequirementId": "string"
}
]
},
"decisionDate": "string",
"entryIntoForceDate": "string",
"termOfAppeal": "string",
"executiveListRequisites": "string",
"executiveListDate": "string",
"simplified": true,
"active": true,
"proceedingCode": "string",
"initiator": {"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
}
},
"contract": {"amount": 0,
"penaltyAmount": 0,
"contractor": {"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
},
"creationDate": "string",
"date": "string",
"id": "string",
"currency": "string",
"number": "string",
"signerBy": "string",
"subject": "string",
"responsibleLawyerId": "string",
"contractTypeId": "string",
"companyId": "string",
"links": [{"name": "string",
"link": "string"
}
],
"note": "string"
},
"contracts": [{"amount": 0,
"penaltyAmount": 0,
"contractor": {"externalId": "string",
"type": "ORGANIZATION",
"name": "string",
"ignoreIllFormedPhones": true,
"tryConvert8ToPlus7": true,
"ignoreIllFormedEmails": true,
"phones": [{"type": "WORK",
"phone": "string",
"main": true
}
],
"emails": [{"type": "PRIMARY",
"email": "string"
}
],
"address": "string",
"fullName": "string",
"businessAddress": "string",
"physicalAddress": "string",
"inn": "string",
"innLabel": "INN",
"kpp": "string",
"ogrn": "string",
"requisitesName": "string",
"currency": "string",
"zipCode": "string",
"accountNumber": "string",
"bankAccountInfo": "string",
"bank": "string",
"bik": "string",
"bankCity": "string",
"correspondentAccount": "string",
"intermediaryBank": "string",
"intermediaryBankSwift": "string",
"swift": "string"
},
"creationDate": "string",
"date": "string",
"id": "string",
"currency": "string",
"number": "string",
"signerBy": "string",
"subject": "string",
"responsibleLawyerId": "string",
"contractTypeId": "string",
"companyId": "string",
"links": [{"name": "string",
"link": "string"
}
],
"note": "string"
}
],
"description": "string",
"declarantId": "string",
"assigneeId": "string",
"links": [{"name": "string",
"link": "string"
}
],
"fields": {"property1": "string",
"property2": "string"
},
"disputeDirection": "INCOMING",
"judicialStatus": "NOT_COMPLETED",
"judicialResult": "string"
}

Response samples

Content type

application/json

{"success": true,
"error": "string",
"result": {"id": 0
}
}

Webhook

Передача данных дела из Jeffit во внешнюю систему

Request Body schema: application/json

id	integer Внутренний индентификатор дела
externalId	string Внешний идентификатор дела
issueSubject	string Тема
issueDescription	string Описание
state	string Статус
deadline	string Крайний срок завершения дела по SLA. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
claimNumber	string Номер претензии
dateOfClaim	string Дата регистрации претензии. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
dateOfSendClaim	string Дата отправки претенции. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
dateOfReceivedClaim	string Дата получения претенции. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
	Array of objects Ссылки на внешние ресурсы
ctime	string Дата создания дела. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
decision	string Решение
dueDate	string Крайний срок завершения дела. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
	Array of objects Договоры
	Array of objects Список производств по делу
	object Данные по внесудебному разбирательству
serviceId	string Внешний идентификатор категориии дела
	object Исполнитель
	object Заявитель
	object Заявитель претензии
	object Ответчик по претензии
	Array of objects Список решений по делу
	object Текущий статус дела
	Array of objects (StateInfo) История статусов дела
linkToCase	string Ссылка на дело
externalParentId	string Внешний идентификатор родительского дела
	object Пара - ключ externalID поля и значение для этого поля
decisionType	string Тип решения по делу

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"externalId": "string",
"issueSubject": "string",
"issueDescription": "string",
"state": "string",
"deadline": "string",
"claimNumber": "string",
"dateOfClaim": "string",
"dateOfSendClaim": "string",
"dateOfReceivedClaim": "string",
"links": [{"link": "string",
"name": "string"
}
],
"ctime": "string",
"decision": "string",
"dueDate": "string",
"contracts": [{"id": 0,
"contractNumber": "string",
"contractDate": "string",
"sum": 0
}
],
"proceedings": [{"id": 0,
"claimants": [{"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
}
],
"defendants": [{"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
}
],
"thirdparties": [{"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
}
],
"court": {"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
},
"caseNumber": "string",
"startingDate": "string",
"finishingDate": "string",
"decisionDate": "string",
"decisionEffectiveDate": "string",
"sum": 0,
"decision": "string",
"type": "FIRST"
}
],
"executiveProceeding": {"active": true,
"debtor": "string",
"applicant": "string",
"dateOfExecutiveDocument": "string",
"debt": 0
},
"serviceId": "string",
"assignee": {"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
},
"client": {"type": "ORGANIZATION",
"representative": {"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
}
},
"claimApplicant": {"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
},
"claimRecipient": {"id": "string",
"externalId": "string",
"name": "string",
"email": "string"
},
"decisions": [{"message": "string",
"decisionDate": "string"
}
],
"stateInfoCurrent": {"date": "string",
"reason": "string",
"author": "string",
"state": "string"
},
"stateInfoHistory": [{"date": "string",
"reason": "string",
"author": "string",
"state": "string"
}
],
"linkToCase": "string",
"externalParentId": "string",
"fields": {"property1": "string",
"property2": "string"
},
"decisionType": "string"
}

Передача файлов дел во внешнюю систему

Request Body schema: application/json

relativePath	Array of strings Путь файла
name	string Имя файла
version	integer Версия файла
contentType	string Тип файла
contentInBase64	string Содержимое файла в кодировке Base64
uploadedDate	string Дата создания файла. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
issueId	integer Внутренний идентификатор дела
issueExternalId	string Внешний идентификатор дела
initiatorExternalId	string Внешний идентификатор пользователя загрузившего файл
initiatorName	string Имя пользователя загрузившего файл

Responses

Request samples

Payload

Content type

application/json

{"relativePath": ["string"
],
"name": "string",
"version": 0,
"contentType": "string",
"contentInBase64": "string",
"uploadedDate": "string",
"issueId": 0,
"issueExternalId": "string",
"initiatorExternalId": "string",
"initiatorName": "string"
}

Передача информации счета

Передача информации счета при его переводе в статусы:

Утвержден
Аннулирован

Request Body schema: application/json

One of

pdfInBase64	string Содержимое pdf файла в формате строки Base64
number	string Номер
date	string Дата создания. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
currency	string Код валюты в формате ISO 4217.
sum	number Сумма
	object Налог
	object Выбранный реквизит клиента
	object Реквизиты поставщика
	Array of objects Включенные расходы
	Array of objects Включенные услуги
contractNumber	string Номер договора
dueDate	string Крайний срок оплаты. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z

Responses

Request samples

Payload

Content type

application/json

Example

Bill_APPROVED

{"pdfInBase64": "string",
"number": "string",
"date": "string",
"currency": "string",
"sum": 0,
"tax": {"name": "string",
"value": 0
},
"client": {"name": "string",
"address": "string",
"inn": "string"
},
"provider": {"name": "string",
"address": "string",
"inn": "string",
"kpp": "string",
"bankAccount": {"name": "string",
"correspondentAccount": "string",
"accountNum": "string",
"bic": "string",
"currency": "string"
}
},
"expenses": [{"title": "string",
"sum": 0
}
],
"providedServices": [{"title": "string",
"sum": 0,
"quantity": 0,
"price": 0
}
],
"contractNumber": "string",
"dueDate": "string"
}

Передача информации акта

Передача информации акта при его переводе в статус Утвержден

Request Body schema: application/json

pdfInBase64	string Содержимое pdf файла в формате строки Base64
number	string Номер
date	string Дата создания. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
currency	string Код валюты в формате ISO 4217.
sum	number Сумма
	object Налог
	object Выбранный реквизит клиента
	object Реквизиты поставщика
	Array of objects Включенные расходы
	Array of objects Включенные услуги
contractNumber	string Номер договора

Responses

Request samples

Payload

Content type

application/json

{"pdfInBase64": "string",
"number": "string",
"date": "string",
"currency": "string",
"sum": 0,
"tax": {"name": "string",
"value": 0
},
"client": {"name": "string",
"address": "string",
"inn": "string"
},
"provider": {"name": "string",
"address": "string",
"inn": "string",
"kpp": "string",
"bankAccount": {"name": "string",
"correspondentAccount": "string",
"accountNum": "string",
"bic": "string",
"currency": "string"
}
},
"expenses": [{"title": "string",
"sum": 0
}
],
"providedServices": [{"title": "string",
"sum": 0,
"quantity": 0,
"price": 0
}
],
"contractNumber": "string"
}

Передача информации отчета

Передача информации отчета при его переводе в статусы:

Утвержден
Аннулирован

Request Body schema: application/json

One of

pdfInBase64	string Содержимое pdf файла в формате строки Base64
number	string Номер
date	string Дата создания. Передается в формате ISO 8601 Например: 2015-12-30 или 2017-10-03T07:00:14.095Z
currency	string Код валюты в формате ISO 4217.
sum	number Сумма
	object Налог
	object Выбранный реквизит клиента
	object Реквизиты поставщика
	Array of objects Включенные расходы
	Array of objects Включенные услуги
contractNumber	string Номер договора

Responses

Request samples

Payload

Content type

application/json

Example

REPORT_APPROVED

{"pdfInBase64": "string",
"number": "string",
"date": "string",
"currency": "string",
"sum": 0,
"tax": {"name": "string",
"value": 0
},
"client": {"name": "string",
"address": "string",
"inn": "string"
},
"provider": {"name": "string",
"address": "string",
"inn": "string",
"kpp": "string",
"bankAccount": {"name": "string",
"correspondentAccount": "string",
"accountNum": "string",
"bic": "string",
"currency": "string"
}
},
"expenses": [{"title": "string",
"sum": 0
}
],
"providedServices": [{"title": "string",
"sum": 0,
"quantity": 0,
"price": 0
}
],
"contractNumber": "string"
}