Журнал документів¶

Базова адреса для функцій роботи з документами /documents/.

Едо статуси
Групи документів
Типи документів
Швидкий вибір дат
Список документів з товарами (спрощений response)
Перетворення даних штрихкоду документа в uuid цього документа.
Журнал документів згрупований по датам
Список документів
Зберегти рахунок про оплату
Отримати реалізації товарів по замовленню покупця
Стан рекламації
Зберегти документ
Отримати статус підписання документу
Отримати документ за посиланням

Едо статуси ¶

GET /documents/filters/edo_statuses¶

{
    "edo_statuses": [
        {
            "key": "all",
            "name": "Всі"
        },
        {
            "key": "signed",
            "name": "Підписані"
        },
        {
            "key": "unsigned",
            "name": "Непідписані"
        }
    ]
}

Групи документів ¶

GET /documents/filters/groups¶

{
    "groups": [
        {   
          "code": "00003A4D",
          "name": "ТТН",
          "types": ["0000013C"],
          "edo_filter": true
        },
        {
          "code": "00000133",
          "name": "Оплаты",
          "types": ["00000133"],
          "edo_filter": false
        }
    ]
}

Типи документів ¶

GET /documents/filters/types¶

{
    "types": [
        {   
          "description": "Товарно-транспортная накладная",
          "code": "00003A4D",
          "name": "ТТН"
        },
        {
          "description": "Приходный кассовый ордер",
          "code": "00000133",
          "name": "Оплаты"
        }
    ]
}

Швидкий вибір дат ¶

GET /documents/filters/dates¶

{
  "dates": {
    "today": {
      "name": "Сегодня",
      "start": "2018-07-26T00:00:01Z",
      "end": "2018-07-26T23:59:59Z"
    },
    "yesterday": {
      "name": "Вчера",
      "start": "2018-07-25T00:00:01Z",
      "end": "2018-07-25T23:59:59Z"
    },
    "week": {
      "name": "Неделя",
      "start": "2018-07-23T00:00:01Z",
      "end": "2018-07-29T23:59:59Z"
    },
    "month": {
      "name": "Месяц",
      "start": "2018-07-01T00:00:01Z",
      "end": "2018-07-31T23:59:59Z"
    },
    "quarter": {
      "name": "Квартал",
      "start": "2018-07-01T00:00:01Z",
      "end": "2018-09-30T23:59:59Z"
    },
    "year": {
      "name": "Год",
      "start": "2018-01-01T00:00:01Z",
      "end": "2018-12-31T23:59:59Z"
    }
  }
}

Список документів з товарами (спрощений response)¶

GET /documents/sales_with_products¶

Query Parameters:
	direction – Напрям сортування. Може бути `asc` або `desc`. По замочуванню: `desc` period – Період вибірки. По замочуванню: `month` q – Фільтр по номеру документу page – Номер сторінки per_page – Кількість об’єктів на сторінці

Приклад відповіді:

{
    "documents": [
        {
            "carrier_warehouse": null,
            "document_uuid": "81D2005056BA39E811EF4366A6A343F1",
            "currency": {
                "name": "ГРН"
            },
            "carrier": null,
            "total": 173.22,
            "number": "ДГ001780924",
            "created_at": "2024-07-16T14:29:24Z",
            "products": [
                {
                    "product": {
                        "article": "9970",
                        "uuid": "B0B67F56058B506D4C416E005B5175F5",
                        "name": "Засіб для очищення карбюраторів/дросельних заслінок Carburetor Cleaner (400ml)",
                        "brand": {
                            "name": "MANNOL",
                            "uuid": "B6B4005056BA86AD11EC4C5C272BB7B7"
                        },
                        "default_image": ""
                    },
                    "price": 106.8,
                    "quantity": 1.000,
                    "total": 106.8
                },
                {
                    "product": {
                        "article": "V6435-XL",
                        "uuid": "B5F698682E8236904C9EC4F8FC9C01B0",
                        "name": "Рукавиці з поліуретановим покриттям долонь (T.10)",
                        "brand": {
                            "name": "VIGOR",
                            "uuid": "81D4005056AC66D611E9038F6B10FB4E"
                        },
                        "default_image": ""
                    },
                    "price": 47.82,
                    "quantity": 1.000,
                    "total": 47.82
                }
            ]
        }
    ]
}

Перетворення даних штрихкоду документа в uuid цього документа.¶

POST /documents/decode_barcode¶

Query Parameters:
	barcode – Дані штрихкоду документа

Приклад відповіді:

{
    "uuid": "81FF005056AC66D611EB02F8056A4423",
    "result": true,
    "message": "Штрихкод успешно преобразован"
}

Журнал документів згрупований по датам ¶

GET /documents/grouped¶

Query Parameters:

direction – Напрямок сортування. Може бути asc або desc. За замовчуванням:
period – Період вибірки. За замовчуванням: month
type – Фільтр по типу документа. За замовчуванням: всі документи. Див. Типи документів
q – Фільтр по номеру документа
group – Фільтр по групі документів
edo_signed – Фільтр по статусу підписанню документа signed, unsigned або all
page – Номер сторінки
per_page – Кількість об’єктів на сторінці

{
    "documents": {
        "2021-06-02": [
            {
                "city": null,
                "total": 17533.32,
                "address": "",
                "places": 0,
                "number": "ПП000229181",
                "carrier": null,
                "document_type": "0000013C",
                "carrier_warehouse": null,
                "carrier_number": "",
                "currency": {
                    "name": "ГРН"
                },
                "warehouse": {
                    "name": "Луцк"
                },
                "client": "81EB005056AC66D611EA2AF9E6FFC44D",
                "document_uuid": "8190005056BA39E811EBB7BC95863266",
                "created_at": "2021-06-02T00:00:00+00:00",
                "owner": {
                    "uuid": "81EB005056AC66D611EA2AF9E6FFC44D",
                    "name": "Иванов Иван Иванович",
                    "f": 2
                },
                "document_url": "https://api.bm.parts/documents/0000013C/8190005056BA39E811EBB7BC95863266",
                "weight": 2.05,
                "document_name": "Реализация товаров и услуг",
                "comment": "",
                "edo_signed": false
            }
        ],
        "2021-06-01": [
            {
                "city": null,
                "total": 315.36,
                "address": "",
                "places": 0,
                "number": "ПП000229175",
                "carrier": null,
                "document_type": "0000013C",
                "carrier_warehouse": null,
                "carrier_number": "",
                "currency": {
                    "name": "ГРН"
                },
                "warehouse": {
                    "name": "Луцк"
                },
                "client": "81EB005056AC66D611EA2AF9E6FFC44D",
                "document_uuid": "8190005056BA39E811EBB7AB7C96B4E0",
                "created_at": "2021-06-01T00:00:00+00:00",
                "owner": {
                    "uuid": "81EB005056AC66D611EA2AF9E6FFC44D",
                    "name": "Иванов Иван Иванович",
                    "f": 2
                },
                "document_url": "https://api.bm.parts/documents/0000013C/8190005056BA39E811EBB7AB7C96B4E0",
                "weight": 1.08,
                "document_name": "Реализация товаров и услуг",
                "comment": "",
                "edo_signed": true
            }
        ]
    }
}

Приклад використання:

Примітка

Допускается фильтрация документов по типу и по номеру. Для документа ТТН фильтрация происходит также по номеру перевозчика.

Список документів ¶

GET /documents/list¶

Query Parameters:

direction – Напрямок сортування. Може бути asc або desc. За замовчуванням:
period – Період вибірки. За замовчуванням: month
type – Фільтр по типу документа, за замовчуванням вертаються всі документи
q – Фільтр по номеру документа
group – Фільтр по групі документів
edo_signed – Фільтр по статусу підписанню документа signed, unsigned або all
page – Номер сторінки
per_page – Кількість об’єктів на сторінці

{
    "documents": [
        {
            "number": "ПП000229181",
            "carrier": null,
            "currency": {
                "name": "ГРН"
            },
            "total": 17533.32,
            "warehouse": {
                "name": "Луцк"
            },
            "document_name": "Реализация товаров и услуг",
            "document_url": "https://api.bm.parts/documents/0000013C/8190005056BA39E811EBB7BC95863266",
            "carrier_number": "",
            "client": "81EB005056AC66D611EA2AF9E6FFC44D",
            "document_uuid": "8190005056BA39E811EBB7BC95863266",
            "carrier_warehouse": null,
            "city": null,
            "owner": {
                "name": "Иванов Иван Иванович",
                "uuid": "81EB005056AC66D611EA2AF9E6FFC44D",
                "f": 2
            },
            "weight": 2.05,
            "comment": "",
            "address": "",
            "created_at": "2021-06-02T00:00:00+00:00",
            "places": 0,
            "document_type": "0000013C",
            "edo_signed": true
        }
    ]
}

Зберегти рахунок про оплату ¶

GET /documents/download_invoice/(string: uuid)¶

query uuid:	ID документу реалізації

Отримати реалізації товарів по замовленню покупця ¶

GET /documents/sales_by_order/(string: uuid)¶

Query Parameters:
	uuid – ID документа Замовлення покупця

Приклад відповіді:

{
  "order": {
    "uuid": "AABBCC112233445566778899AABBCC00",
    "number": "ДГ001234567",
    "status": "Собран",
    "processed": true
  },
  "sales": [
    {
      "uuid": "AABBCC112233445566778899AABBCC00",
      "number": "ДГ000000020"
    }
  ]
}

Примітка

Ключ order.processed вказує на завершення формування документа(ів) реалізації

Стан рекламації ¶

GET /documents/reclamation/(string: act_uuid)¶

query act_uuid:	ID документа рекламації

Зберегти документ ¶

GET /documents/download/(string: type_)/(string: uuid)/(string: file_type)¶

Query Parameters:
	type – Тип документа uuid – ID документа file_type – Тип файлу. Можливі варіанти: pdf, xlsx, csv.

Примітка

Зверніть увагу, що не всі документи можуть бути збережені як pdf` або xlsx.

Отримати статус підписання документу ¶

GET /documents/(string: uuid)/check_sign¶

Query Parameters:
	uuid – ID документа

Приклад відповіді:

{
    "edo_signed": false
}

Отримати документ за посиланням ¶

GET /documents/(string: type_)/(string: uuid)¶

Query Parameters:
	type – Тип документа uuid – ID документа

Приклад відповіді для документа - Товарно-транспортна накладна:

{
    "document": {
        "carrier_number": "",
        "return_money_total": 0,
        "pdf": false,
        "receiver": {
            "uuid": "812D000C2999A7E611E57EECEFA73268",
            "full_name": "Иванов Иван Иванович"
        },
        "comment": "",
        "number": "00001020698",
        "uuid": "81C9005056AC66D611E86956DF4E37A1",
        "type": "00003A4D",
        "return_money": false,
        "owner": {
            "uuid": "831C005056BAF70311EB92D4AC9B5F1F",
            "name": "Иванов Иван Иванович",
            "f": 1
        },
        "city": {
            "region": {
                "name": "Сумська область"
            },
            "name": "Суми 1"
        },
        "sale_documents": [
            {
                "currency": {
                    "name": "ГРН"
                },
                "type": "0000013C",
                "document_name": "Реализация товаров и услуг",
                "uuid": "B67E005056BAE4A011EBA68A0280B282",
                "shipped_at": "2021-04-27T06:00:00+00:00",
                "document_url": "https://api.bm.parts/documents/0000013C/B67E005056BAE4A011EBA68A0280B282",
                "number": "ДГ000365978",
                "warehouse": {
                    "uuid": "816D000C2999A7E611E6EC6B4A1915AF",
                    "name": "Киев"
                }
            }
        ],
        "pdf": false,
        "total": 0.00,
        "carrier_warehouse": null,
        "created_at": "2021-04-26T15:22:06+00:00",
        "places": 1,
        "weight": 1.000,
        "carrier_number": "",
        "address": "вул.Білопільський шлях,, буд. № 11",
        "excel": false,
        "csv": false,
        "type": "00003A4D",
        "document_name": "Товарно-транспортная накладная",
        "uuid": "B67E005056BAE4A011EBA68A0280B283",
        "receiver": {
            "full_name": "Иванов Иван Иванович",
            "uuid": "831C005056BAF70311EB92D4AC9B5F26"
        },
        "return_money_total": 0.00,
        "warehouse": {
            "uuid": "816D000C2999A7E611E6EC6B4A1915AF",
            "name": "Киев"
        },
        "comment": "",
        "number": "00004365987",
        "carrier": {
            "uuid": "A38B158FEBD71FDF44901B05CFDE8A32",
            "name": "Доставка"
        },
        "expense_document_type": "0000013C",
        "edo_signed": null
    }
}

Приклад відповіді для документа - Реалізація товарів і послуг:

{
    "documents": [
        {
            "total": 17533.32,
            "carrier": null,
            "city": null,
            "created_at": "2021-06-02T00:00:00+00:00",
            "document_name": "Реализация товаров и услуг",
            "comment": "",
            "document_uuid": "8190005056BA39E811EBB7BC95863266",
            "carrier_warehouse": null,
            "currency": {
                "name": "ГРН"
            },
            "document_url": "https://api.bm.parts/documents/0000013C/8190005056BA39E811EBB7BC95863266",
            "client": "81EB005056AC66D611EA2AF9E6FFC44D",
            "carrier_number": "",
            "address": "",
            "warehouse": {
                "name": "Луцк"
            },
            "places": 0,
            "document_type": "0000013C",
            "weight": 2.05,
            "owner": {
                "uuid": "81EB005056AC66D611EA2AF9E6FFC44D",
                "name": "Иванов Иван Иванович",
                "f": 2
            },
            "number": "ПП000229181",
            "edo_signed": true
        },
        {
            "total": 315.36,
            "carrier": null,
            "city": null,
            "created_at": "2021-06-01T00:00:00+00:00",
            "document_name": "Реализация товаров и услуг",
            "comment": "",
            "document_uuid": "8190005056BA39E811EBB7AB7C96B4E0",
            "carrier_warehouse": null,
            "currency": {
                "name": "ГРН"
            },
            "document_url": "https://api.bm.parts/documents/0000013C/8190005056BA39E811EBB7AB7C96B4E0",
            "client": "81EB005056AC66D611EA2AF9E6FFC44D",
            "carrier_number": "",
            "address": "",
            "warehouse": {
                "name": "Луцк"
            },
            "places": 0,
            "document_type": "0000013C",
            "weight": 1.08,
            "owner": {
                "uuid": "81EB005056AC66D611EA2AF9E6FFC44D",
                "name": "Иванов Иван Иванович",
                "f": 2
            },
            "number": "ПП000229175",
            "edo_signed": false
        }
    ]
}

Примітка

У випадку якщо документ не знайдено, буде повернута відповідь 404 NOT FOUND.

Rest Client

Журнал документів¶