{GET} /api/v1/settings
Результат:
Объект типа Settings
Пример:
{
"token": "00000000-0000-0000-0000-000000000000",
"fsrar_id": "000000000000",
"inn": "0000000000",
"kpp": "000000000",
"state": "INITIALIZED",
"statement_on_balance_last_no": 2,
"db_version": 2,
"cheque_last_no": 2,
"return_last_no": 8,
"transfer_last_no": 4,
"write_off_last_no": 3,
"shipment_last_no": 1,
"id": 1
}
{GET} /api/v1/server/status
Результат:
строка
Пример:
“INITIALIZED”
{GET}/api/v1/server/setup
Параметры:
token - строка
{POST} /api/v1/registration
Параметры:
version - версия клиента
{GET} /api/v1/products/{id}
Параметры:
id - числоРезультат:
Объект типа Product
Пример:
{
"full_name": "Настойка горькая \"Царь Кедр",
"alc_code": "0116125000001357760",
"capacity": "0.5",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ0",
"id": "17"
},
"id": "17"
},
"product_v_code": "212",
"price": "0.0",
"quantity": "0.0",
"id": "42"
}
{GET} /api/v1/products
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
criteria - строка (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов ChequeItem
{GET} /api/v1/products?count
Параметры:
criteria - строкаРезультат: Число
{PUT} /api/v1/products/{id}
Параметры:
id - число
Тело запроса - объект типа ProductРезультат: Объект типа Product
{GET} /api/v1/products
Параметры:
ean - строкаРезультат:
Массив типов Product
{GET} /api/v1/products
Параметры:
alc_code - строкаРезультат:
Массив типов Product
{GET} /api/v1/products?from_egais
Параметры:
inn - строка
{GET} /api/v1/products?rests
{GET} /api/v1/products/{product_id}/stock_items/id
Параметры:
product_id - число
id - числоРезультат:
Объект типа StockItem
Пример:
{
"product": {
"full_name": "Аперитив СТЕПНОЙ ВЕТЕР",
"alc_code": "0116116000002200583",
"capacity": 0.375,
"alc_volume": 18.0,
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "17"
},
"id": "17"
},
"product_v_code": "211",
"price": 0.0,
"quantity": 0.0,
"id": 8
},
"quantity": 2647.0,
"inform_a_reg_id": "00000000000000",
"inform_b_reg_id": "000000000000000",
"id": 10
}
{GET} /api/v1/products/{product_id}/stock_items
Параметры:
product_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов StockItem
{GET} /api/v1/products/{product_id}/stock_items?count
Параметры:
product_id - числоРезультат: Число
{GET} /api/v1/organizations/{id}
Параметры:
id - числоРезультат:
Объект типа Organization
Пример:
{
"client_reg_id": "000000000000",
"full_name": "ЗАКРЫТОЕ АКЦИОНЕРНОЕ ОБЩЕСТВО \"ТЕСТ",
"short_name": "ЗАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "643",
"id": "21"
},
"id": "21"
}
{GET} /api/v1/organizations
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
self - логический тип (true/false) (необходим для получения только своих подразделений)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов Organization
{GET} /api/v1/organizations?count
Параметры:
self - логический тип (true/false) (необходим для получения только своих подразделений)Результат: Число
{GET} /api/v1/organizations?from_egais
Параметры:
inn - строка
{PUT} /api/v1/acts/{id}?accept
Параметры:
id - число
{PUT} /api/v1/acts/{id}?reject
Параметры:
id - число
{GET} /api/v1/receipts/{id}
Параметры:
id - числоРезультат:
Объект типа WayBill
Пример:
{
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"unit_type": "PACKED",
"number": "ТЕСТ-0001",
"date": "2016-04-12 00:00:00.000",
"shipping_date": "2016-04-12 00:00:00.000",
"transport": {
"type": "",
"company": "",
"car": "",
"trailer": "",
"customer": "",
"driver": "",
"load_point": "",
"unloadpoint": "",
"redirect": "",
"forwarder": "",
"id": "104"
},
"shipper": {
"client_reg_id": "000000000000",
"full_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "Россия",
"id": "11"
},
"id": "11"
},
"consignee": {
"client_reg_id": "000000000000",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "2"
},
"id": "2"
},
"note": "",
"act": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"type": "ACCEPTED",
"date": "2016-04-12 21:37:57.352",
"way_bill_reg_id": "TEST-TTN-0000000000",
"note": "\r\nДокумент успешно принят.",
"status": "ACCEPTED",
"action": "PARTIAL_ACCEPT",
"utm_transport_id": "f24075d8-c8fd-4f78-abc9-d0c1226967c4",
"uuid": "b3b202b9-0173-408d-a885-a00b7e849ac1",
"id": "5"
},
"informBReg": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"wbRegId": "TEST-TTN-0000000000",
"egaisFixNumber": "TEST-WBF-201600000000000",
"egaisFixDate": "2016-04-12 00:00:00.000",
"wbnumber": "ТЕСТ-0001",
"wbDate": "2016-04-12 00:00:00.000",
"shipper": {
"client_reg_id": "000000000000",
"full_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "Россия",
"id": "11"
},
"id": "11"
},
"consignee": {
"client_reg_id": "000000000000",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "2"
},
"id": "2"
},
"uuid": "294954ad-8035-4a41-b6fb-7c1459169fa0",
"id": "36"
},
"status": "REJECTED",
"type": "RECEIPT",
"uuid": "ddef874b-0a71-4dab-a568-096ab7472996",
"id": "104"
}
{GET} /api/v1/receipts
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов WayBill
{GET} /api/v1/receipts?count
Результат: Число
{POST} {Multipart} /api/v1/receipts/{id}?accept
Параметры:
id - число
Тело запроса - note - заметки
Тело запроса - differences -объект типа Map {{1,5}, {2,10}, {3,0}}, где каждый элемент - сопоставление идентификатора строки - принимаемое количество (если накладная принимается полностью, параметр не передаётся)
{POST} {Multipart} /api/v1/receipts/{id}?reject
Параметры:
id - число
Тело запроса - note - заметки
{GET} /api/v1/receipts/{id}?ab_forms_request
Параметры:
id - число
{GET} /api/v1/receipts/{receipt_id}/items/{id}
Параметры:
receipt_id - число
id - числоРезультат:
Объект типа WayBillItem
Пример:
{
"product": {
"full_name": "Водка \"Татарстан",
"alc_code": "0000000000000000000",
"capacity": "0.75",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"region_code": "16",
"description": "РОССИЯ",
"id": "16"
},
"id": "16"
},
"product_v_code": "200",
"price": "0.0",
"quantity": "0.0",
"id": "5"
},
"quantity": "2.0",
"price": "0.0",
"identity": "2",
"inform_a_reg": "TEST-FA-000000000000000",
"inform_b_reg": "TEST-FB-000000000000000",
"way_bill_act_item_id": {
"realQuantity": "0.0",
"way_bill_act_id": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"type": "ACCEPTED",
"date": "2016-04-12 21:37:57.352",
"way_bill_reg_id": "TEST-TTN-0000000000",
"note": "\r\nДокумент успешно принят.",
"status": "ACCEPTED",
"action": "PARTIAL_ACCEPT",
"utm_transport_id": "f24075d8-c8fd-4f78-abc9-d0c1226967c4",
"uuid": "b3b202b9-0173-408d-a885-a00b7e849ac1",
"id": "5"
},
"id": "6"
},
"way_bill_id": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"unit_type": "PACKED",
"number": "ТЕСТ-0001",
"date": "2016-04-12 00:00:00.000",
"shipping_date": "2016-04-12 00:00:00.000",
"transport": {
"type": "",
"company": "",
"car": "",
"trailer": "",
"customer": "",
"driver": "",
"load_point": "",
"unloadpoint": "",
"redirect": "",
"forwarder": "",
"id": "104"
},
"shipper": {
"client_reg_id": "000000000000",
"full_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"АЛКОТОРГ",
"short_name": "ООО \"АЛКОТОРГ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"id": "11"
},
"id": "11"
},
"consignee": {
"client_reg_id": "000000000000",
"full_name": "Общество с ограниченной ответственностью \"АЛКОТОРГ",
"short_name": "ООО \"АЛКОТОРГ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"id": "2"
},
"id": "2"
},
"note": "",
"act": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"type": "ACCEPTED",
"date": "2016-04-12 21:37:57.352",
"way_bill_reg_id": "TEST-TTN-0000000000",
"note": "\r\nДокумент успешно принят.",
"status": "ACCEPTED",
"action": "PARTIAL_ACCEPT",
"utm_transport_id": "f24075d8-c8fd-4f78-abc9-d0c1226967c4",
"uuid": "b3b202b9-0173-408d-a885-a00b7e849ac1",
"id": "5"
},
"informBReg": {
"identity": "8219f735-e2d7-478d-aea2-9a804a836418",
"wbRegId": "TEST-TTN-0002272030",
"egaisFixNumber": "TEST-WBF-000000000000000",
"egaisFixDate": "2016-04-12 00:00:00.000",
"wbnumber": "ТЕСТ-0001",
"wbDate": "2016-04-12 00:00:00.000",
"shipper": {
"id": "11"
},
"consignee": {
"id": "2"
},
"uuid": "294954ad-8035-4a41-b6fb-7c1459169fa0",
"id": "36"
},
"status": "REJECTED",
"type": "RECEIPT",
"uuid": "ddef874b-0a71-4dab-a568-096ab7472996",
"id": "104"
},
"id": "108"
}
{GET} /api/v1/receipts/{receipt_id}/items/{id}
Параметры:
receipt_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов WayBillItem
{GET} /api/v1/receipts/{receipt_id}/items?count
Параметры:
receipt_id - числоРезультат: Число
{GET} /api/v1/returns/{id}
Параметры:
id - числоРезультат:
Объект типа WayBill
{GET} /api/v1/returns
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов WayBill
{GET} /api/v1/returns?count
Результат: Число
{GET} /api/v1/returns?new
Результат:
Объект типа WayBill
{GET} /api/v1/returns?new_from_receipt
Параметры:
receipt_id - числоРезультат:
Объект типа WayBill
{PUT} /api/v1/returns/{id}
Параметры:
id - число
Тело запроса - объект типа WayBillРезультат: Объект типа WayBill
{DELETE} /api/v1/returns/{id}
Параметры:
id - число
{DELETE} /api/v1/returns/{id}?to_egais
Параметры:
id - число
{GET} /api/v1/returns/{return_id}/items/{id}
Параметры:
return_id - число
id - числоРезультат:
Объект типа WayBillItem
{GET} /api/v1/returns/{return_id}/items
Параметры:
return_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов WayBillItem
{GET} /api/v1/returns/{return_id}/items?count
Параметры:
return_id - числоРезультат: Число
{POST} /api/v1/returns/{return_id}/items
Параметры:
return_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{PUT} /api/v1/returns/{return_id}/items/{id}
Параметры:
id - число
return_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{DELETE} /api/v1/returns/{return_id}/items/{id}
Параметры:
id - число
return_id - число
{GET} /api/v1/transfers/{id}
Параметры:
id - числоРезультат:
Объект типа WayBill
{GET} /api/v1/transfers
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов WayBill
{GET} /api/v1/transfers?count
Результат: Число
{GET} /api/v1/transfers?new
Результат:
Объект типа WayBill
{PUT} /api/v1/transfers/{id}
Параметры:
id - число
Тело запроса - объект типа WayBillРезультат: Объект типа WayBill
{DELETE} /api/v1/transfers/{id}
Параметры:
id - число
{DELETE} /api/v1/transfers/{id}?to_egais
Параметры:
id - число
{GET} /api/v1/transfers/{transfer_id}/items/{id}
Параметры:
transfer_id - число
id - числоРезультат:
Объект типа WayBillItem
{GET} /api/v1/transfers/{transfer_id}/items
Параметры:
transfer_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов WayBillItem
{GET} /api/v1/transfers/{transfer_id}/items?count
Параметры:
transfer_id - числоРезультат: Число
{POST} /api/v1/transfers/{transfer_id}/items
Параметры:
transfer_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{PUT} /api/v1/transfers/{transfer_id}/items/{id}
Параметры:
id - число
transfer_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{DELETE} /api/v1/transfers/{transfer_id}/items/{id}
Параметры:
id - число
transfer_id - число
{GET} /api/v1/statements_on_balance/{id}
Параметры:
id - числоРезультат:
Объект типа StatementOnBalance
Пример:
{
"number": "ПНБ-00002",
"date": "2016-04-12 00:00:00.000",
"status": "NEW",
"uuid": "bef20f33-eba0-4542-933a-75e6575349e8",
"id": "2"
}
{GET} /api/v1/statements_on_balance
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов StatementOnBalance
{GET} /api/v1/statements_on_balance?count
Результат: Число
{GET} /api/v1/statements_on_balance?new
Результат:
Объект типа StatementOnBalance
{PUT} /api/v1/statements_on_balance/{id}
Параметры:
id - число
Тело запроса - объект типа StatementOnBalanceРезультат: Объект типа StatementOnBalance
{DELETE} /api/v1/statements_on_balance/{id}
Параметры:
id - число
{DELETE} /api/v1/statements_on_balance/{id}?to_egais
Параметры:
id - число
{GET} /api/v1/statements_on_balance/{statement_on_balance_id}/items/{id}
Параметры:
statement_on_balance_id - число
id - числоРезультат:
Объект типа StatementOnBalanceItem
Пример:
{
"identity": "1",
"product": {
"full_name": "Водка\"WISE STYLE\" PLATINUM (\"МУДРЫЙ СТИЛЬ\" ПЛАТИНОВАЯ)",
"alc_code": "0116118000002174970",
"capacity": "0.5",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"region_code": "16",
"description": "РОССИЯ",
"id": "14"
},
"id": "14"
},
"product_v_code": "200",
"price": "0.0",
"quantity": "0.0",
"id": "83"
},
"quantity": "1.0",
"receipt_quantity": "1000.0",
"receipt_bottling_date": "2016-04-13 00:00:00.000",
"receipt_number": "1234",
"receipt_date": "2016-04-11 00:00:00.000",
"receipt_egais_fix_number": "",
"barcodes": "21N00000VRCE8S3DOFU2HLI404...;",
"statement_on_balance_id": {
"number": "ПНБ-00002",
"date": "2016-04-12 00:00:00.000",
"status": "NEW",
"uuid": "bef20f33-eba0-4542-933a-75e6575349e8",
"id": "2"
},
"id": "2"
}
{GET} /api/v1/statements_on_balance/{statement_on_balance_id}/items
Параметры:
statement_on_balance_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов StatementOnBalanceItem
{GET} /api/v1/statements_on_balance/{statement_on_balance_id}/items?count
Параметры:
statement_on_balance_id - числоРезультат: Число
{POST} /api/v1/statements_on_balance/{statement_on_balance_id}/items
Параметры:
statement_on_balance_id - число
Тело запроса - объект типа StatementOnBalanceItemРезультат: Объект типа StatementOnBalanceItem
{PUT} /api/v1/statements_on_balance/{statement_on_balance_id}/items/{id}
Параметры:
id - число
statement_on_balance_id - число
Тело запроса - объект типа StatementOnBalanceItemРезультат: Объект типа StatementOnBalanceItem
{DELETE} /api/v1/statements_on_balance/{statement_on_balance_id}/items/{id}
Параметры:
id - число
statement_on_balance_id - число
{GET} /api/v1/write_offs/{id}
Параметры:
id - числоРезультат:
Объект типа WriteOff
Пример:
{
"number": "С-00004",
"date": "2016-04-13 00:00:00.000",
"status": "NEW",
"type": "DAMAGE",
"uuid": "c71c6e33-14d3-4d5a-a256-ffe359d71de2",
"id": "34"
}
{GET} /api/v1/write_offs
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов WriteOff
{GET} /api/v1/write_offs?count
Результат: Число
{GET} /api/v1/write_offs?new
Результат:
Объект типа WriteOff
{PUT} /api/v1/write_offs/{id}
Параметры:
id - число
Тело запроса - объект типа WriteOffРезультат: Объект типа WriteOff
{DELETE} /api/v1/write_offs/{id}
Параметры:
id - число
{DELETE} /api/v1/write_offs/{id}?to_egais
Параметры:
id - число
{GET} /api/v1/write_offs/{write_off_id}/items/{id}
Параметры:
write_off_id - число
id - числоРезультат:
Объект типа WriteOffItem
Пример:
{
"identity": "1",
"product": {
"full_name": "Вино столовое полусладкое красное \"VIGROSSO (ВИГРОССО) МЕРЛО",
"alc_code": "0116116000002221406",
"capacity": "0.7",
"alc_volume": "12.0",
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "17"
},
"id": "17"
},
"product_v_code": "403",
"price": "0.0",
"quantity": "0.0",
"id": "89"
},
"quantity": "2.0",
"write_off_id": {
"number": "С-00004",
"date": "2016-04-13 00:00:00.000",
"status": "NEW",
"type": "DAMAGE",
"uuid": "c71c6e33-14d3-4d5a-a256-ffe359d71de2",
"id": "34"
},
"inform_b_reg": "TEST-FB-00000000000000",
"id": "66"
}
{GET} /api/v1/write_offs/{write_off_id}/items
Параметры:
write_off_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов WriteOffItem
{GET} /api/v1/write_offs/{write_off_id}/items?count
Параметры:
write_off_id - числоРезультат: Число
{POST} /api/v1/write_offs/{write_off_id}/items
Параметры:
write_off_id - число
Тело запроса - объект типа WriteOffItemРезультат: Объект типа WriteOffItem
{PUT} /api/v1/write_offs/{write_off_id}/items/{id}
Параметры:
id - число
write_off_id - число
Тело запроса - объект типа WriteOffItemРезультат: Объект типа WriteOffItem
{DELETE} /api/v1/write_offs/{write_off_id}/items/{id}
Параметры:
id - число
write_off_id - число
{GET} /api/v1/shipments/{id}
Параметры:
id - числоРезультат:
Объект типа WayBill
{GET} /api/v1/shipments
Параметры:
page_no - число (не обязательный)
page_size - число (не обязательный)
order_by - строка (не обязательный)
order_direction - строка (asc/desc) (не обязательный)Результат:
Массив типов WayBill
{GET} /api/v1/shipments?count
Результат: Число
{GET} /api/v1/shipments?new
Результат:
Объект типа WayBill
{PUT} /api/v1/shipments/{id}
Параметры:
id - число
Тело запроса - объект типа WayBillРезультат: Объект типа WayBill
{DELETE} /api/v1/shipments/{id}
Параметры:
id - число
{DELETE} /api/v1/shipments/{id}?to_egais
Параметры:
id - число
{GET} /api/v1/shipments/{shipment_id}/items/{id}
Параметры:
shipment_id - число
id - числоРезультат:
Объект типа WayBillItem
{GET} /api/v1/shipments/{shipment_id}/items
Параметры:
shipment_id - число
page_no - число (не обязательный)
page_size - число (не обязательный)Результат:
Массив типов WayBillItem
{GET} /api/v1/shipments/{shipment_id}/items?count
Параметры:
shipment_id - числоРезультат: Число
{POST} /api/v1/shipments/{shipment_id}/items
Параметры:
shipment_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{PUT} /api/v1/shipments/{shipment_id}/items/{id}
Параметры:
id - число
shipment_id - число
Тело запроса - объект типа WayBillItemРезультат: Объект типа WayBillItem
{DELETE} /api/v1/shipments/{shipment_id}/items/{id}
Параметры:
id - число
shipment_id - число
{GET} /api/v1/cheques/{id}
Параметры:
id - числоРезультат:
Объект типа Cheque
Пример:
{
"seller": {
"client_reg_id": "000000000001",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000001",
"kpp": "000000001",
"address": {
"country": "643",
"region_code": "77",
"description": "РОССИЯ",
"id": "2"
},
"id": "2"
},
"cash": "КАССА",
"shift": "2",
"number": "15265",
"timestamp": "2016-03-01 16:55:16.000",
"status": "COMMITED",
"uuid": "870a775a-49e4-477f-b0d8-ccfd944006a5",
"amount": "0.0",
"id": "1"
}
{GET} /api/v1/cheques?new
Результат:
Объект типа Cheque
{PUT} /api/v1/cheques/{id}
Параметры:
id - число
Тело запроса - объект типа ChequeРезультат: Объект типа Cheque
{DELETE} /api/v1/cheques/{id}
Параметры:
id - число
{POST} /api/v1/cheques/{id}?accept
Параметры: id - число
{GET} /api/v1/cheques/{cheque_id}/items/{id}
Параметры:
cheque_id - число
id - числоРезультат:
Объект типа ChequeItem
Пример:
{
"barcodes": "BARCODE1;BARCODE2;BARCODE3",
"count": "3.0",
"price": "215.99",
"product": {
"full_name": "Настойка горькая \"Царь Кедр",
"alc_code": "0116125000001357760",
"capacity": "0.5",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"Татспиртпром",
"short_name": "ОАО \"Татспиртпром\" филиал \"Чистопольский ликероводочный завод",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ0",
"id": "17"
},
"id": "17"
},
"product_v_code": "212",
"price": "0.0",
"quantity": "0.0",
"id": "42"
},
"cheque": {
"seller": {
"client_reg_id": "000000000000",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"id": "2"
},
"id": "2"
},
"cash": "КАССА",
"shift": "2",
"number": "15265",
"timestamp": "2016-03-01 16:55:16.000",
"status": "COMMITED",
"uuid": "870a775a-49e4-477f-b0d8-ccfd944006a5",
"amount": "0.0",
"id": "1"
},
"id": "2"
}
{GET} /api/v1/cheques/{cheque_id}/items/{id}
Параметры:
cheque_id - число
page_no - число
page_size - числоРезультат:
Массив типов ChequeItem
{GET} /api/v1/cheques/{cheque_id}/items?count
Параметры: cheque_id - число
Результат: Число
{POST} /api/v1/cheques/{cheque_id}/items
Параметры:
cheque_id - число
Тело запроса - объект типа ChequeItemРезультат: Объект типа ChequeItem
{PUT} /api/v1/cheques/{cheque_id}/items/{id}
Параметры:
id - число
cheque_id - число
Тело запроса - объект типа ChequeItemРезультат: Объект типа ChequeItem
{DELETE} /api/v1/cheques/{cheque_id}/items/{id}
Параметры:
id - число
cheque_id - число
{GET} /api/v1/a_forms/{id}
Параметры:
id - числоРезультат:
Объект типа FormA
Пример:
{
"inform_a_reg_id": "000000000000000",
"ttn_number": "000001/1",
"ttn_date": "2015-11-09 00:00:00.000",
"shipper": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "15"
},
"id": "15"
},
"consignee": {
"client_reg_id": "000000000000000",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "2"
},
"id": "2"
},
"shipping_date": "2015-11-09 00:00:00.000",
"product": {
"full_name": "Водка \"УСАДСКАЯ ХЛЕБНАЯ",
"alc_code": "0116125000001955505",
"capacity": "0.25",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "15"
},
"id": "15"
},
"product_v_code": "200",
"price": "0.0",
"quantity": "0.0",
"id": "17"
},
"bottling_date": "2015-11-06 00:00:00.000",
"quantity": "15840.0",
"egais_number": "00000000000000",
"egais_date": "2015-11-09 00:00:00.000",
"id": "1"
}
{GET} /api/v1/a_forms
Параметры:
regIds - массив идентификаторов справок АРезультат:
Массив типов FormA
{GET} /api/v1/a_forms?count
Параметры:
regId - идентификатор справки АРезультат:
Объект типа FormA
{GET} /api/v1/b_forms/{id}
Параметры:
id - числоРезультат:
Объект типа FormB
Пример:
{
"inform_b_reg_id": "000000000000000",
"ttn_number": "000000/1",
"ttn_date": "2015-11-05 00:00:00.000",
"shipper": {
"client_reg_id": "000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "15"
},
"id": "15"
},
"consignee": {
"client_reg_id": "000000000000000",
"full_name": "Общество с ограниченной ответственностью \"ТЕСТ",
"short_name": "ООО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "2"
},
"id": "2"
},
"product": {
"full_name": "Водка \"ХЛЕБНАЯ МЯГКАЯ",
"alc_code": "0116125000002245636",
"capacity": "0.5",
"alc_volume": "40.0",
"producer": {
"client_reg_id": "000000000000000",
"full_name": "Открытое акционерное общество \"ТЕСТ",
"short_name": "ОАО \"ТЕСТ",
"inn": "0000000000",
"kpp": "000000000",
"address": {
"country": "643",
"description": "РОССИЯ",
"id": "15"
},
"id": "15"
},
"product_v_code": "200",
"price": "0.0",
"quantity": "0.0",
"id": "54"
},
"quantity": "2107.0",
"id": "1"
}
{GET} /api/v1/b_forms
Параметры:
regIds - массив идентификаторов справок БРезультат:
Массив типов FormB
{GET} /api/v1/b_forms?count
Параметры:
regId - идентификатор справки БРезультат:
Объект типа FormB
{GET} /api/v1/reports/alc_journal.xls
Параметры:
start - дата с которой формируется журнал
finish - дата до которой формируется журналФормат дат yyyy-MM-dd’T’HH:mm:ss
{POST} /api/v1/imports/transfer
Параметры:
Тело запроса - xml файл
Пример xml файла:
<?xml version="1.0" encoding="UTF-8"?>
<Transfer>
<!-- Номер документа -->
<Number>№000006</Number>
<!-- Дата документа (Формат зависит от формата даты системы) -->
<Date>01.03.2016</Date>
<!-- Дата отгрузки (Формат зависит от формата даты системы) -->
<ShippingDate>18.03.2016</ShippingDate>
<!-- Реквизиты обособленного
подразделения получателя -->
<Consignee>
<INN>1659091192</INN>
<KPP>165145002</KPP>
</Consignee>
<!-- Транспортная информация
(Тег Transport, а так же его внутренние теги - опциональны) -->
<Transport>
<Type>Тип</Type>
<Company>Компания</Company>
<Customer>Клиент</Customer>
<Car>Транспортное средство</Car>
<Driver>Водитель</Driver>
<Trailer>Трейлер</Trailer>
<LoadPoint>Точка загрузки</LoadPoint>
<UnloadPoint>Точка разгрузки</UnloadPoint>
<Forwarder>Экспедитор</Forwarder>
<Redirect>Перенаправление</Redirect>
</Transport>
<!-- Заметки (Опциональный тег) -->
<Note>Заметки</Note>
<!-- Фасовка (возможные значения - PACKED/UNPACKED) -->
<UnitType>PACKED</UnitType>
<!-- Список перемещаемых позиций -->
<Items>
<Item>
<!-- Алко код -->
<AlcCode>0116125000001955511</AlcCode>
<!-- Номер поступления -->
<TtnNumber>002555/5</TtnNumber>
<!-- Дата поступления (Формат зависит от формата даты системы) -->
<TtnDate>26.10.2015</TtnDate>
<!-- Дата розлива (Формат зависит от формата даты системы) -->
<BottlingDate>23.10.2015</BottlingDate>
<!-- Количество -->
<Quantity>26</Quantity>
</Item>
<Item>
<AlcCode>0116125000001357760</AlcCode>
<TtnNumber>002617/5</TtnNumber>
<TtnDate>29.10.2015</TtnDate>
<BottlingDate>27.10.2015</BottlingDate>
<Quantity>16</Quantity>
</Item>
</Items>
</Transfer>
Схема xml файла:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified">
<xs:element name="Transfer">
<xs:complexType>
<xs:sequence>
<xs:element name="Number">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Date">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(((((0[1-9]|[1-2][0-9]|3[0-1])\.(0[1-9]|1[0-2])))\.\d{4}))" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="ShippingDate">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(((((0[1-9]|[1-2][0-9]|3[0-1])\.(0[1-9]|1[0-2])))\.\d{4}))" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Consignee">
<xs:complexType>
<xs:sequence>
<xs:element name="INN">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{10,12}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="KPP">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{9}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Transport">
<xs:complexType>
<xs:sequence>
<xs:element name="Type">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Company">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Customer">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Car">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Driver">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Trailer">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="LoadPoint">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="UnloadPoint">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Forwarder">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Redirect">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Note">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="UnitType">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="PACKED"/>
<xs:enumeration value="UNPACKED"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Items">
<xs:complexType>
<xs:sequence>
<xs:element name="Item" maxOccurs="unbounded" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="AlcCode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="TtnNumber">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="TtnDate">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(((((0[1-9]|[1-2][0-9]|3[0-1])\.(0[1-9]|1[0-2])))\.\d{4}))" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="BottlingDate">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="(((((0[1-9]|[1-2][0-9]|3[0-1])\.(0[1-9]|1[0-2])))\.\d{4}))" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Quantity">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
{POST} /api/v1/imports/cheque
Параметры:
Тело запроса - xml файл
Пример xml файла:
<?xml version="1.0" encoding="UTF-8"?>
<Cheque>
<!-- Касса -->
<Cash>КАССА_1</Cash>
<!-- Номер смены -->
<Shift>2</Shift>
<!-- Номер чека -->
<Number>15265</Number>
<!-- Дата и время чека -->
<Timestamp>01.03.2016 16:55:16</Timestamp>
<!-- Список позиций в чеке -->
<Items>
<Item>
<!-- Алко код -->
<AlcCode>0116125000001955511</AlcCode>
<!-- Количество -->
<Quantity>15</Quantity>
<!-- Цена -->
<Price>215.99</Price>
</Item>
<Item>
<AlcCode>0116125000001357760</AlcCode>
<Quantity>3</Quantity>
<Price>215.99</Price>
<!-- Штрихкоды (Тег должен присутствовать если продаётся крепко алкогольная продукция) -->
<Barcodes>BARCODE1;BARCODE2;BARCODE3</Barcodes>
</Item>
</Items>
</Cheque>
Схема xml файла:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified">
<xs:element name="Cheque">
<xs:complexType>
<xs:sequence>
<xs:element name="Cash">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Shift" type="xs:int"/>
<xs:element name="Number" type="xs:int"/>
<xs:element name="Timestamp">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="((((((0[1-9]|[1-2][0-9]|3[0-1])\.(0[1-9]|1[0-2])))\.\d{4})) (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]|6[0]):([0-5][0-9]|6[0]))" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Items">
<xs:complexType>
<xs:sequence>
<xs:element name="Item" maxOccurs="unbounded" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="AlcCode">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Quantity">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Price" type="xs:float"/>
<xs:element name="Barcodes" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>