Звіти

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

Продажі по брендам

GET /reports/brands_turnover
Query Parameters:
 
  • period – Період вибірки. За замовчуванням: month

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

{
  "grid": [
    {
      "row": ["Бренд", "Всего", "Август, 2018"],
      "meta": {"header": true, "important": false}
    },
    {
      "row": ["NRF", 326.1, 326.1],
      "meta": {"header": false, "important": true}
    },
    {
      "row": ["INA", 88.75, 88.75],
      "meta": {"header": false, "important": false}
    }
  ]
}

Звірка взаєморозрахунків

GET /reports/reconciliation
Query Parameters:
 

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

{
    "result": true,
    "error": null,
    "contract": "Название договора (EUR)",
    "balance_before": 102.13,
    "xls_url": "https://api.bm.parts/reports/download/reconciliation/2018-03-01/2018-03-31%2023:59:59/xls",
    "pdf_url": "https://api.bm.parts/reports/download/reconciliation/2018-03-01/2018-03-31%2023:59:59/pdf",
    "pdf_url": "https://api.bm.parts/reports/download/reconciliation/2018-03-01/2018-03-31%2023:59:59/xlsx",
    "in_balance": 36.74,
    "out_balance": 138.87,
    "balance_after": 0,
    "currency_name": "ГРН",
    "documents": [
        {
            "uuid": "816F000C2999A7E611E6FF5EB2E74C1F",
            "created_at": "2017-03-02T17:56:21Z",
            "number": "ВХ000018633",
            "description": "Приходный кассовый ордер",
            "type": "000000C1",
            "document_url": "https://api.bm.parts/documents/0000013C/8115005056AC1EA911E82871B13F7F7A",
            "comment": "",
            "total": 3040.71,
            "currency_name": "ГРН",
            "in_balance": 0,
            "out_balance": 105.21,
            "after_transaction": -3.08,
            "flag": 0
        }
    ]
}

Звіт по оплатах

GET /reports/payment_report
Query Parameters:
 

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

{
    "report": {
        "result": true,
        "error": "",
        "data": {
            "excel_url": "http://127.0.0.1:5000/reports/download/reconciliation/xlsx",
            "currency_name": "ГРН",
            "balance": 153.42,
            "balance_plan": 0,
            "statuses": [
                {
                    "name": "Оплачено",
                    "balance": 153.42,
                    "balance_plan": 0,
                    "data": [
                        {
                            "name": "Контрагент [000047662]",
                            "uuid": "68e5edbf-b719-11ec-92e2-005056baa486",
                            "balance": 153.42,
                            "balance_plan": 0,
                            "documents": [
                                {
                                    "uuid": "d8b3c028-9a54-11ee-81c9-005056ba39e8",
                                    "created_at": "2023-12-14T09:46:10Z",
                                    "currency_name": "ГРН",
                                    "description": "Прибутковий касовий ордер",
                                    "number": "ДГ001354799",
                                    "balance": 153.42,
                                    "balance_plan": 0
                                }
                            ]
                        }
                    ]
                }
            ]
        },
    }
}

Заборгованість по термінах боргу

GET /reports/terms
Query Parameters:
 
  • at_date – Дата для розрахунку днів платежу. За замовчуванням, поточна дата.

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

{
    "terms": {
        "contracts": [
            "Название договора (EUR)",
            "Договор 2"
        ],
        "debts": [
            1533.8,
            1884.4
        ],
        "databefore": {
            "headerbefore": [
                "Остальные (не менее 4 дней)",
                "От 3 до 3 дней",
                "От 2 до 2 дней",
                "От 1 до 1 дней",
                "Не более 0 дней"
            ],
            "blockbefore": [
                [0, 1884.4],
                [0, 0],
                [0, 0],
                [1385.9, 0],
                [147.9, 0]
            ]
        },
        "dataafter": {
            "headerafter": [
                "Не более 1 дней",
                "От 2 до 2 дней",
                "От 3 до 3 дней",
                "От 4 до 8 дней",
                "Остальные (не менее 9 дней)"
            ],
            "blockafter": [
                [0, 0],
                [0, 0],
                [0, 0],
                [0, 0],
                [0, 0]
            ]
        },
        "error": null,
        "result": true
    }
}

Попередження

Формат поверненого значення може змінитися!

Зберегти звірку взаєморозрахунків як файл

GET /reports/download/reconciliation/(file_type)
Query Parameters:
 
  • period – Період вибірки. За замовчуванням: month
  • file_type – Тип файлу. Можливі варіанти: pdf, xlsx, xls.

Метод дозволяє завантажити з сервера звіт в вигляді файлу.

Завантажити звіт по оплатах у вигляді файлу

GET /reports/download/payment_report/(file_type)
query period:Період вибірки. За замовчуванням: month
query file_type:
 Тип файлу. Можливі варіанти: xlsx, xls.