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
POST
https://mock.apidog.com/m1/463678-0-default
Payers
Last modified:2024-02-27 07:08:03
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
code
string
required
Match pattern:
^[A-Z0-9]+
paymentMethod
string <iri-reference>
required
Example:
/payment-methods/1
paymentOption
string <iri-reference>
optional
Example:
/payment-options/1
title
string
required
titleShort
string
required
accountingPhone
string <phone>
optional
customer
string <iri-reference>
required
Example:
/customers/1
inn
string
optional
kpp
string
optional
ogrn
string
optional
bankTitle
string
optional
rs
string
optional
ks
string
optional
bik
string
optional
isEdo
boolean
optional
Default:
false
director
string
optional
directorRp
string
optional
basisRp
string
optional
legalAddress
string
optional
mailingAddress
string
optional
email
string <email>
optional
contacts
string
optional
assortment
string
optional
requisites
string <iri-reference>
optional
Example:
/files/3fa85f64-5717-4562-b3fc-2c963f66afa6
statement
string <iri-reference>
optional
Example:
/files/3fa85f64-5717-4562-b3fc-2c963f66afa6
organizationForm
string <iri-reference> | null
optional
Example:
/organization-forms/1
Example
{
"code": "string",
"paymentMethod": "/payment-methods/1",
"paymentOption": "/payment-options/1",
"title": "string",
"titleShort": "string",
"accountingPhone": "string",
"customer": "/customers/1",
"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": "/files/3fa85f64-5717-4562-b3fc-2c963f66afa6",
"statement": "/files/3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationForm": "/organization-forms/1"
}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 --request POST 'https://mock.apidog.com/m1/463678-0-default/payers' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "string",
"paymentMethod": "/payment-methods/1",
"paymentOption": "/payment-options/1",
"title": "string",
"titleShort": "string",
"accountingPhone": "string",
"customer": "/customers/1",
"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": "/files/3fa85f64-5717-4562-b3fc-2c963f66afa6",
"statement": "/files/3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationForm": "/organization-forms/1"
}'Responses
🟢201Created
application/json
Body
deletedAt
string <date-time> | null
required
id
integer
required
>= 1
code
string
required
Match pattern:
^[A-Z0-9]+
paymentMethod
object
Способы оплаты
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.
deletedAt
string <date-time> | null
required
id
integer
required
>= 1
title
string
required
paymentOption
object
Формы оплаты
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.
deletedAt
string <date-time> | null
required
id
integer
required
>= 1
paymentMethod
object
Способы оплаты
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.
title
string
required
title
string
required
titleShort
string
required
accountingPhone
string <phone>
optional
customer
allOf {2}
Клиенты
object (BaseFieldsModel)
optional
object
optional
inn
string
optional
kpp
string
optional
ogrn
string
optional
bankTitle
string
optional
rs
string
optional
ks
string
optional
bik
string
optional
isEdo
boolean
optional
Default:
false
director
string
optional
directorRp
string
optional
basisRp
string
optional
legalAddress
string
optional
mailingAddress
string
optional
email
string <email>
optional
contacts
string
optional
assortment
string
optional
requisites
object
File
uuid
string <uuid>
optional
name
string
optional
path
string
optional
size
integer
optional
>= 0
mimeType
string
optional
createdBy
object
Пользователи (base)
updatedBy
object
Пользователи (base)
deletedAt
string <date-time> | null
optional
createdAt
string <date-time>
optional
updatedAt
string <date-time>
optional
pathPreview
string
optional
statement
object
File
uuid
string <uuid>
optional
name
string
optional
path
string
optional
size
integer
optional
>= 0
mimeType
string
optional
createdBy
object
Пользователи (base)
updatedBy
object
Пользователи (base)
deletedAt
string <date-time> | null
optional
createdAt
string <date-time>
optional
updatedAt
string <date-time>
optional
pathPreview
string
optional
organizationForm
object
required
id
integer
required
label
string
required
Example
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": 1,
"code": "string",
"paymentMethod": {
"title": "string"
},
"paymentOption": {
"paymentMethod": {
"title": "string"
},
"title": "string"
},
"title": "string",
"titleShort": "string",
"accountingPhone": "string",
"customer": {
"code": "string",
"firstname": "string",
"surname": "string",
"middlename": "string",
"birthdate": "2019-08-24",
"company": "string",
"companyUrl": "http://example.com",
"comment": "string",
"serviceAssigned": [
{
"service": {
"title": "string",
"departureCountry": {
"title": "string"
},
"departureCity": {
"title": "string",
"country": {
"title": "string"
}
},
"isForwarding": false
},
"assigned": {
"id": 1,
"firstname": "string",
"surname": "string",
"phone": "string",
"email": "user@example.com",
"departmentCode": {
"code": "string"
},
"position": {
"title": "string"
},
"group": {
"title": "string"
},
"codes": [
{
"code": "string"
}
],
"roles": [
{
"title": "string",
"allServices": true,
"services": [
{
"title": "string",
"departureCity": {
"title": "string",
"country": {
"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": {
"title": "string",
"code": "string"
},
"city": {
"title": "string",
"country": {
"title": "string"
}
},
"issuanceMethod": {
"title": "string",
"deliveryBases": [
{
"title": "string"
}
]
},
"addressDelivery": "string",
"fio": "string",
"passport": "string",
"addressReg": "string"
}
],
"leads": [
{
"leadSource": {
"title": "string",
"purpose": {
"id": 1,
"title": "string"
},
"utmMarks": [
{
"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": {
"title": "string",
"departureCity": {
"title": "string",
"country": {
"title": "string"
}
},
"isForwarding": false
},
"labelUtm": "string",
"causeFailure": {
"title": "string"
},
"id": 1,
"lastTodo": {
"topic": "Перезвон",
"description": "string",
"expires": "2019-08-24T14:15:22Z",
"lead": {},
"phone": "string",
"techDeal": {
"marking": {
"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": {
"title": "string",
"code": "string",
"ruContractTypes": [
{
"title": "string"
}
]
},
"techDealStatus": {
"title": "string",
"dealTypes": [
{
"title": "string",
"code": "string",
"ruContractTypes": [
{
"title": "string"
}
]
}
]
},
"ruContract": {
"company": {
"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": {
"title": "string",
"code": "string",
"ruContractTypes": [
{
"title": "string"
}
]
},
"type": {
"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": {
"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"
}
}🟠400Ошибки 4XX
🔴500Ошибки 5XX