Список финансовых операций (начисления и списания)

POST /v1/finance/transaction/list

POST/v1/finance/transaction/list

Тело запроса

filter
object

Параметры фильтрации.

Показать свойства
date_from
string

Начало периода (RFC3339).

date_to
string

Окончание периода (RFC3339).

operation_type
array

Фильтр по типам.

Допустимые значения
SALECOMMISSIONLOGISTICSLAST_MILESTORAGEACCEPTANCERETURNCOMPENSATIONADJUSTMENT
merchant_order_id
array

Фильтр по заказам.

shipment_id
array

Фильтр по отгрузкам.

cursor
string

Курсор постраничной выборки.

limit
integer

Размер страницы. min = 1; max = 300; default = 100.

Успешный ответ

200A successful response.
application/json
object
transactions
array

Список операций.

financeFboTransaction

Показать свойства

financeFboTransaction

operation_id
string

Идентификатор операции.

operation_type
string

Тип операции.

Допустимые значения
SALECOMMISSIONLOGISTICSLAST_MILESTORAGEACCEPTANCERETURNCOMPENSATIONADJUSTMENT
operation_date
string

Дата операции (RFC3339).

amount
integer

Сумма, умноженная на 100.

currency
string

Валюта.

Допустимые значения
RUBBYNKZTEURUSDCNY
merchant_order_id
string

Идентификатор заказа продавца.

shipment_id
string

Идентификатор отгрузки.

offer_id
string

Артикул товара.

product_id
string

Идентификатор товара.

description
string

Описание операции.

services
array

Разбивка по услугам.

financeFboTransactionService

Показать свойства

financeFboTransactionService

name
string

Наименование услуги.

amount
integer

Сумма по услуге, умноженная на 100.

next_cursor
string

Курсор следующей страницы.

Ошибки

400Некорректный запрос
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
401Ошибка авторизации
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
429Превышен лимит запросов
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
POST/v1/finance/transaction/list
1curl https://api.omninet.ru/v1/finance/transaction/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "date_from": "string",7    "date_to": "string",8    "operation_type": [9      "string"10    ],11    "merchant_order_id": [12      "string"13    ],14    "shipment_id": [15      "string"16    ]17  },18  "cursor": "string",19  "limit": 020}'
{
  "transactions": [
    {
      "operation_id": "string",
      "operation_type": "string",
      "operation_date": "string",
      "amount": 0,
      "currency": "RUB",
      "merchant_order_id": "string",
      "shipment_id": "string",
      "offer_id": "string",
      "product_id": "string",
      "description": "string",
      "services": [
        {
          "name": "string",
          "amount": 0
        }
      ]
    }
  ],
  "next_cursor": "string"
}

A successful response.