Suppliers

list

request
DELETE /api/v2/supplies-delete/1000000146 HTTP/1.1
Table 333. /api/v2/supplies-delete/{supplyId}
Parameter Description

supplyId

ID поставки
response
HTTP/1.1 200 OK

create

request
POST /api/v2/suppliers HTTP/1.1

{
  "name" : "Тестовый поставщик для теста",
  "fullName" : "Тестовый поставщик для теста",
  "inn" : "1234567890",
  "ogrn" : "1234567890123",
  "kpp" : "123456789",
  "supplierInfo" : "Информация о поставщике",
  "address" : "Адрес поставщика",
  "phone" : "123-456-7890",
  "paymentAccount" : "40802810100000010001",
  "bankName" : "Название банка",
  "bankIdentificationCode" : "041123456",
  "bankCorrespondentAccount" : "30101810400000000225",
  "currency" : "RUB",
  "taxScheme" : "SIMPLE",
  "vatType" : "NON_TAXABLE",
  "expectedGoodsEmail" : "supplier@example.com"
}
Table 334. request description
Path Type Description Constraints

name

String

Наименование

Length must be between 0 and 50 inclusive.
Must not be null

fullName

String

Полное наименование

Length must be between 0 and 150 inclusive

inn

String

ИНН

Length must be between 0 and 20 inclusive

ogrn

String

ОГРН

Length must be between 0 and 50 inclusive

kpp

String

КПП

Length must be between 0 and 50 inclusive

supplierInfo

String

Доп. информация

address

String

Адрес

Length must be between 0 and 280 inclusive

phone

String

Телефон

Length must be between 0 and 50 inclusive

paymentAccount

String

Расчетный счет

Length must be between 0 and 50 inclusive

bankName

String

Наименование банка

Length must be between 0 and 50 inclusive

bankIdentificationCode

String

БИК

Length must be between 0 and 50 inclusive

bankCorrespondentAccount

String

Корреспондентский счет

Length must be between 0 and 50 inclusive

currency

String

Валюта

Length must be between 0 and 3 inclusive

taxScheme

String

Тип налогообложения

Must not be null

vatType

String

Ставка НДС

Must not be null

expectedGoodsEmail

String

Электронная почта

Length must be between 0 and 50 inclusive
response
HTTP/1.1 200 OK

{
  "name" : "Тестовый поставщик для теста",
  "fullName" : "Тестовый поставщик для теста",
  "inn" : "1234567890",
  "ogrn" : "1234567890123",
  "kpp" : "123456789",
  "supplierInfo" : "Информация о поставщике",
  "address" : "Адрес поставщика",
  "phone" : "123-456-7890",
  "paymentAccount" : "40802810100000010001",
  "bankName" : "Название банка",
  "bankIdentificationCode" : "041123456",
  "bankCorrespondentAccount" : "30101810400000000225",
  "currency" : "RUB",
  "taxScheme" : "SIMPLE",
  "vatType" : "NON_TAXABLE",
  "expectedGoodsEmail" : "supplier@example.com",
  "deleted" : false
}
Table 335. response description
Path Type Description

name

String

Наименование

fullName

String

Полное наименование

inn

String

ИНН

ogrn

String

ОГРН

kpp

String

КПП

supplierInfo

String

Доп. информация

address

String

Адрес

deleted

Boolean

Признак активности, true - активный, false - удаленный

phone

String

Телефон

paymentAccount

String

Расчетный счет

bankName

String

Наименование банка

bankIdentificationCode

String

БИК

bankCorrespondentAccount

String

Корреспондентский счет

currency

String

Валюта

taxScheme

String

Тип налогообложения

vatType

String

Ставка НДС

expectedGoodsEmail

String

Электронная почта

update

request
PUT /api/v2/suppliers HTTP/1.1

{
  "newName" : "Очки и линзы",
  "previousName" : "Очки и линзы",
  "fullName" : null,
  "inn" : "1234567890",
  "ogrn" : "1234567890123",
  "kpp" : "123456789",
  "supplierInfo" : null,
  "address" : null,
  "phone" : null,
  "paymentAccount" : null,
  "bankName" : null,
  "bankIdentificationCode" : null,
  "bankCorrespondentAccount" : null,
  "currency" : null,
  "taxScheme" : "SIMPLE",
  "vatType" : "NON_TAXABLE",
  "expectedGoodsEmail" : null
}
Table 336. request description
Path Type Description Constraints

name

String

Наименование

Length must be between 0 and 50 inclusive.
Must not be null

fullName

String

Полное наименование

Length must be between 0 and 150 inclusive

inn

String

ИНН

Length must be between 0 and 20 inclusive

ogrn

String

ОГРН

Length must be between 0 and 50 inclusive

kpp

String

КПП

Length must be between 0 and 50 inclusive

supplierInfo

String

Доп. информация

address

String

Адрес

Length must be between 0 and 280 inclusive

phone

String

Телефон

Length must be between 0 and 50 inclusive

paymentAccount

String

Расчетный счет

Length must be between 0 and 50 inclusive

bankName

String

Наименование банка

Length must be between 0 and 50 inclusive

bankIdentificationCode

String

БИК

Length must be between 0 and 50 inclusive

bankCorrespondentAccount

String

Корреспондентский счет

Length must be between 0 and 50 inclusive

currency

String

Валюта

Length must be between 0 and 3 inclusive

taxScheme

String

Тип налогообложения

Must not be null

vatType

String

Ставка НДС

Must not be null

expectedGoodsEmail

String

Электронная почта

Length must be between 0 and 50 inclusive
response
HTTP/1.1 200 OK

{
  "name" : "Очки и линзы",
  "fullName" : null,
  "inn" : "1234567890",
  "ogrn" : "1234567890123",
  "kpp" : "123456789",
  "supplierInfo" : null,
  "address" : null,
  "phone" : null,
  "paymentAccount" : null,
  "bankName" : null,
  "bankIdentificationCode" : null,
  "bankCorrespondentAccount" : null,
  "currency" : null,
  "taxScheme" : "SIMPLE",
  "vatType" : "NON_TAXABLE",
  "expectedGoodsEmail" : null,
  "deleted" : false
}
Table 337. response description
Path Type Description

name

String

Наименование

fullName

String

Полное наименование

inn

String

ИНН

ogrn

String

ОГРН

kpp

String

КПП

supplierInfo

String

Доп. информация

address

String

Адрес

deleted

Boolean

Признак активности, true - активный, false - удаленный

phone

String

Телефон

paymentAccount

String

Расчетный счет

bankName

String

Наименование банка

bankIdentificationCode

String

БИК

bankCorrespondentAccount

String

Корреспондентский счет

currency

String

Валюта

taxScheme

String

Тип налогообложения

vatType

String

Ставка НДС

expectedGoodsEmail

String

Электронная почта

get info

request
GET /api/v2/suppliers/info?supplierName=%D0%9E%D0%BF%D1%82%D0%B8%D0%BA%20%D0%BF%D0%BB%D1%8E%D1%81 HTTP/1.1
Table 338. request description
Parameter Description

supplierName

supplierName
response
HTTP/1.1 200 OK

{
  "name" : "Оптик плюс",
  "fullName" : null,
  "inn" : "111",
  "ogrn" : "222",
  "kpp" : "333",
  "supplierInfo" : null,
  "address" : null,
  "phone" : null,
  "paymentAccount" : null,
  "bankName" : null,
  "bankIdentificationCode" : null,
  "bankCorrespondentAccount" : null,
  "currency" : null,
  "taxScheme" : "FULL",
  "vatType" : "NORMAL",
  "expectedGoodsEmail" : null,
  "deleted" : false
}
Table 339. response description
Path Type Description

name

String

Наименование

fullName

String

Полное наименование

inn

String

ИНН

ogrn

String

ОГРН

kpp

String

КПП

supplierInfo

String

Доп. информация

address

String

Адрес

deleted

Boolean

Признак активности, true - активный, false - удаленный

phone

String

Телефон

paymentAccount

String

Расчетный счет

bankName

String

Наименование банка

bankIdentificationCode

String

БИК

bankCorrespondentAccount

String

Корреспондентский счет

currency

String

Валюта

taxScheme

String

Тип налогообложения

vatType

String

Ставка НДС

expectedGoodsEmail

String

Электронная почта

delete

request
DELETE /api/v2/suppliers?supplierName=%D0%9C%D0%B0%D1%81%D1%82%D0%B5%D1%80%20%D0%BE%D1%87%D0%BA%D0%BE%D0%B2 HTTP/1.1
Table 340. request description
Parameter Description

supplierName

supplierName

restore

request
POST /api/v2/suppliers/restore?supplierName=%D0%9B%D0%B8%D0%BD%D0%B7%D1%8B%20%D0%B8%20%D0%BE%D0%BF%D1%80%D0%B0%D0%B2%D1%8B%20%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Table 341. request description
Parameter Description

supplierName

supplierName
response
HTTP/1.1 200 OK

{
  "name" : "Линзы и оправы удаленный",
  "fullName" : null,
  "inn" : null,
  "ogrn" : null,
  "kpp" : null,
  "supplierInfo" : null,
  "address" : null,
  "phone" : null,
  "paymentAccount" : null,
  "bankName" : null,
  "bankIdentificationCode" : null,
  "bankCorrespondentAccount" : null,
  "currency" : null,
  "taxScheme" : "FULL",
  "vatType" : "NORMAL",
  "expectedGoodsEmail" : null,
  "deleted" : false
}
Table 342. response description
Path Type Description

name

String

Наименование

fullName

String

Полное наименование

inn

String

ИНН

ogrn

String

ОГРН

kpp

String

КПП

supplierInfo

String

Доп. информация

address

String

Адрес

deleted

Boolean

Признак активности, true - активный, false - удаленный

phone

String

Телефон

paymentAccount

String

Расчетный счет

bankName

String

Наименование банка

bankIdentificationCode

String

БИК

bankCorrespondentAccount

String

Корреспондентский счет

currency

String

Валюта

taxScheme

String

Тип налогообложения

vatType

String

Ставка НДС

expectedGoodsEmail

String

Электронная почта

← Previous: Supply register | ↑ Up: Optima2 API v.2 REST | Next: Time zone →