Backend API Docs
Backend API Docs
- Enum реестры
- Источники лидов - НазначениеGET
- Типы почтыGET
- Типы сообщенияGET
- Способы оплатыGET
- Варианты оплатыGET
- Типы получателейGET
- Темы делGET
- Статусы лидовGET
- Статусы товарных позиций в запросахGET
- Статусы запросовGET
- Статусы платежаGET
- Статусы грузовGET
- Статусы заявок на оплатуGET
- Типы Российских ДоговоровGET
- Способы отправкиGET
- Типы счетчиковGET
- Login
- Users
- UserGroups
- UserPositions
- UserCodes
- Получение заголовков раздела "Сотрудники"GET
- Получение списка сотрудниковGET
- Создание нового сотрудникаPOST
- Удаление списка записей раздела "Сотрудники"DELETE
- Информация об авторизованном пользователеGET
- Список доступных авторизованному пользователю секцийGET
- Получение списка подчиненных пользователейGET
- Получение сотрудника по IDGET
- Изменение данных сотрудникаPATCH
- Генерация токена для пользователяPOST
- Получение токенов пользователяGET
- Roles
- Services
- DepartmentCodes
- TechDealStatuses
- TechDealTypes
- CauseFailures
- PaymentOptions
- Materials
- UnitOfMeasures
- PackingTypes
- PackingContents
- Agents
- RuCompanies
- Currencies
- Contracts
- Countries
- Cities
- UtmMarks
- RuContracts
- Accounts
- Payers
- Recipients
- IssuanceMethods
- ProductItems
- Requests
- RequestItems
- Получение списка записей раздела "Товарные позиции в запросах на расчет ТС"
- Добавление новой Товарной позиции в запросах на расчет ТС
- Удаление списка записей раздела "Товарные позиции в запросах на расчет ТС"
- Получение Товарной позиции в запросах на расчет ТС по ID
- Редактирование Товарной позиции в запросах на расчет ТС
- Загрузка товарных позиций
- Проставить признак Поиск разрешительных документов по нескольким товарным позициям запросов
- Получение заголовков раздела "Запросы на расчет ТС"
- Получение списка записей раздела "Запросы на расчет ТС"
- Добавление нового Запроса на расчет ТС
- Удаление списка записей раздела "Запросы на расчет ТС"
- Получение Запроса на расчет ТС по ID
- Редактирование Запроса на расчет ТС
- Загрузка товарных позиций
- RequestItems
- Customers
- CustomerEmails
- CustomerPhones
- Получение заголовков раздела "Клиенты"
- Получение списка записей раздела "Клиенты"
- Добавление нового Клиента
- Удаление списка записей раздела "Клиенты"
- Получение Клиента по ID
- Редактирование Клиента
- Получение списка звонков по ID Клиента
- Получение списка писем по ID Клиента
- Получение списка комментариев по ID Клиента
- Создание нового комментария по ID Клиента
- Получение истории по ID Клиента
- Закрепление элемента истории по ID Клиента
- Открепление элемента истории по ID Клиента
- Leads
- LeadSources
- LeadDistribution
- Получение заголовков раздела "Лиды"
- Получение списка записей раздела "Лиды"
- Добавление нового Лида
- Удаление списка записей раздела "Лиды"
- Загрузка Excel файла в раздел "Лиды"
- Смена статуса списку лидов
- Получение Лида по ID
- Редактирование Лида
- Получение списка звонков по ID Лида
- Получение списка писем по ID Лида
- Получение списка комментариев по ID Лида
- Создание нового комментария по ID Лида
- Получение истории по ID Лида
- Закрепление элемента истории по ID Лида
- Открепление элемента истории по ID Лида
- Смена менеджера списку лидов
- Webhook Tilda
- Webhook Custom Service
- Factories
- FactoryBanks
- FactoryAccounts
- PreliminaryCostings
- PreliminaryCostingItems
- Получение заголовков раздела "Предварительный расчет стоимости"
- Получение списка записей раздела "Предварительный расчет стоимости"
- Добавление нового Предварительного расчета стоимости
- Удаление списка записей раздела "Предварительный расчет стоимости"
- Получение Предварительного расчета стоимости по ID
- Редактирование Предварительного расчета стоимости
- ToDos
- Payments
- PaymentRequests
- Warehouses
- Cargos
- CargoItems
- Получение списка записей раздела "Товарные позиции в Грузе для к лиента"
- Добавление новой товарной позиции в Грузе для клиента
- Удаление списка записей раздела "Товарные позиции в грузе для клиента"
- Загрузка товарных позиций в Грузе для клиента
- Редактирование товарной позиции в Грузе для клиента
- Получение товарной позиции в Грузе для клиента по ID
- Tracks
- Places
- Specifications
- Batches
- SpecificationTypes
- Получение списка записей раздела "Груз для клиента"
- Добавление нового Груза для клиента
- Удаление списка записей раздела "Груз для клиента"
- Редактирование Груза для клиента
- Получение Груза для клиента по ID
- Перемещение треков в груз
- Сформировать Счет за транспорт
- Снятие запрета на выдачу по заданному массиву грузов
- Применение запрета на выдачу по заданному массиву грузов
- Скачивание ставок по товарным позициям груза
- Загрузка ставок по товарным позициям груза
- Получение общих данных о Грузах
- Скачать Расчетку
- Передать в бухгалтерию
- Выставить запрет на отправку
- CargoItems
- CommercialOffers
- CargoDirections
- HistoryChanges
- Reports
- Files
- Images
- Notifications
- WishesTypes
- Checkpoints
- DeliveryBasis
- Contacts
- Exceptions
- КурсыGET
- Поиск лидов и клиентовGET
- Счетчики по разделамGET
- Untitled EndpointPOST
Получение списка записей раздела "Договора"
Cloud Mock
https://mock.apidog.com/m1/463678-0-default
Cloud Mock
https://mock.apidog.com/m1/463678-0-default
GET
https://mock.apidog.com/m1/463678-0-default
RuContracts
Last modified:2024-06-06 05:51:58
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
page
integer
optional
pagination
boolean
optional
exists[deletedAt]
boolean
optional
fields[]
string
optional
Example:
fields[]=id
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://mock.apidog.com/m1/463678-0-default/ru-contracts?page&pagination&exists[deletedAt]&fields[]=fields[]=id'Responses
🟢200OK
application/json
Body
data
array[object (Договора) {10}]
optional
deletedAt
string <date-time> | null
required
id
integer
required
>= 1
payer
object
Плательщики
company
object
Компании РФ
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.
number
string
required
date
string <date>
required
file
object
File
scanFiles
array[object (File) {11}]
optional
techDealType
object
Типы сделок
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.
type
object
Типы договоров
pagination
object (Pagination)
optional
first
integer
optional
>= 1
current
integer
optional
>= 1
last
integer
optional
>= 1
previous
integer
optional
>= 1
next
integer
optional
>= 1
total
integer
optional
>= 0
Example
{
"data": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"payer": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"code": "string",
"paymentMethod": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"paymentOption": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"paymentMethod": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"title": "string"
},
"title": "string",
"titleShort": "string",
"accountingPhone": "string",
"customer": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"code": "string",
"firstname": "string",
"surname": "string",
"middlename": "string",
"birthdate": "2019-08-24",
"company": "string",
"companyUrl": "http://example.com",
"comment": "string",
"serviceAssigned": [
{
"service": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"departureCountry": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"departureCity": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"country": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
},
"isForwarding": false
},
"assigned": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"departmentCode": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"code": "string"
},
"position": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"group": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"codes": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"code": "string"
}
],
"roles": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"allServices": true,
"services": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"departureCity": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"country": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
},
"isForwarding": false
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"parent": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"isAdmin": false
}
}
],
"isSeason": true,
"isManagement": true,
"isBonus": true,
"bonus": 0,
"payers": [
null
],
"recipients": [
{
"code": "string",
"isBlocked": false,
"isPayRuDelivery": false,
"type": {
"id": 1,
"title": "string"
},
"title": "string",
"titleShort": "string",
"inn": "string",
"kpp": "string",
"ogrn": "string",
"legalAddress": "string",
"email": "user@example.com",
"contacts": "string",
"shippingMethod": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"code": "string"
},
"city": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"country": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
},
"issuanceMethod": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"deliveryBases": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
]
},
"addressDelivery": "string",
"fio": "string",
"passport": "string",
"addressReg": "string"
}
],
"leads": [
{
"leadSource": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"purpose": {
"id": 1,
"title": "string"
},
"utmMarks": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"user": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": [],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"parent": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"isAdmin": false
},
"type": "string",
"value": "string"
}
]
},
"name": "string",
"surname": "string",
"company": "string",
"campaign": "string",
"phone": "string",
"email": "user@example.com",
"city": "string",
"leadStatus": {
"id": 1,
"title": "string"
},
"additionalInformation": "string",
"manager": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": [],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"parent": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"isAdmin": false
},
"service": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"departureCity": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"country": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
},
"isForwarding": false
},
"labelUtm": "string",
"causeFailure": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
},
"id": 1,
"lastTodo": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"topic": "Перезвон",
"description": "string",
"expires": "2019-08-24T14:15:22Z",
"lead": {},
"phone": "string",
"techDeal": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"marking": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"marking": "string",
"departmentCode": "string",
"managerCode": "string",
"clientCode": "string",
"payerCode": "string",
"techDealTypeCode": "string",
"shippingMethodCode": "string",
"dateArrival": "2019-08-24",
"countPlaces": 0,
"countPlacesTotal": 0,
"isTakenBorder": false
},
"techDealType": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"code": "string",
"ruContractTypes": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
]
},
"techDealStatus": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"dealTypes": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"code": "string",
"ruContractTypes": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
]
}
]
}
},
"isCompleted": false,
"assigned": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": [],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"parent": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"isAdmin": false
},
"dateCompleted": "2019-08-24T14:15:22Z"
},
"additionalPhone": "string"
}
],
"lastTodo": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"topic": "Перезвон",
"description": "string",
"expires": "2019-08-24T14:15:22Z",
"lead": {},
"phone": "string",
"isCompleted": false,
"dateCompleted": "2019-08-24T14:15:22Z"
},
"phone": "string",
"email": "user@example.com",
"additionalPhone": "string",
"irs": true
},
"inn": "string",
"kpp": "string",
"ogrn": "string",
"bankTitle": "string",
"rs": "string",
"ks": "string",
"bik": "string",
"isEdo": false,
"director": "string",
"directorRp": "string",
"basisRp": "string",
"legalAddress": "string",
"mailingAddress": "string",
"email": "user@example.com",
"contacts": "string",
"assortment": "string",
"requisites": {
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"path": "string",
"size": 0,
"mimeType": "string",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"deletedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pathPreview": "string"
},
"statement": {},
"organizationForm": {
"id": 0,
"label": "string"
}
},
"company": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"code": "string",
"isMainCarrier": false
},
"number": "string",
"date": "2019-08-24",
"file": {
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"path": "string",
"size": 0,
"mimeType": "string",
"createdBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"updatedBy": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"codes": [],
"roles": []
},
"deletedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pathPreview": "string"
},
"scanFiles": [
{}
],
"techDealType": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string",
"code": "string",
"ruContractTypes": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
]
},
"type": {
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"title": "string"
}
}
],
"pagination": {
"first": 1,
"current": 1,
"last": 1,
"previous": 1,
"next": 1,
"total": 0
}
}🟠400Ошибки 4XX
🔴500Ошибки 5XX