Отримання списку транзакцій

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/transactions

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

trans_status - статус транзакції; можливі значення: «1» - вхідна; «2»- вихідна; «3»- тарифікуєма

date_from - дата початку періоду отримання транзакцій; дата в форматі timeStamp

date_to - дата закінчення періоду отримання транзакцій; дата в форматі timeStamp

Опціональні url-параметри:

trans_type - тип транзакції; можливі значення: «1» - відправка документу; «2» - довкладення отримувача

company_id - ID компанії, по якій необхідно отримати інформацію

limit - ліміт вибірки (за умовчуванням 30; максимальне значення вибірки 50)

offset - зміщення відносно верхньої межі вибірки (за умовчуванням 0)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається об’єкт BillingData зі списком транзакцій.

Таблиця 1 - Опис параметрів об’єкта BillingData

Параметр

Формат

Опис

.._BillingData:

Об’єкт BillingData

chargeableTransCount

long

тарифіковані транзакції

remainsTransCount

int

залишок оплачених транзакцій (базові + регулярні)

baseTransCount

int

кількість оплачених транзакцій за поточний період по базовому тарифному пакету

regularTransCount

int

кількість оплачених транзакцій за поточний період по регулярному тарифному пакету

transCount

long

кількість використаних транзакцій

transactions

List<Transaction_>

список транзакцій

Таблиця 2 - Опис параметрів об’єкта Transaction

Параметр

Формат

Опис

.._Transaction:

Об’єкт Transaction

transId

long

ідентифікатор транзакції

senderId

long

ідентифікатор відправника

recipientId

long

ідентифікатор отримувача

payerId

long

ідентифікатор платника

packageId

long

ідентифікатор комплекту (пакета)

documentId

long

ідентифікатор документу

transDate

long

дата транзакції (в форматі UNIX-timestamp)

transType

int

тип транзакції (1 - відправлений документ; 2 - довкладення отримувача)

transDirection

int

статус транзакції (trans_status); можливі значення: «1» - вхідні; «2» - вихідні; «3» — тарифіковані

isChargeAble

boolean

відмітка Тарифіковані транзакції

senderCompany

Company_

дані компанії відправника

recipientCompany

Company_

дані компанії отримувача

payerCompany

Company_

дані компанії платника (може бути як відправник так і отримувач)


Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)


Приклад тіла відповіді в json форматі

  {
  "chargeableTransCount": 2,
  "transCount": 2,
  "transactions": [
    {
      "transId": 18,
      "packageId": 2114,
      "documentId": 2114,
      "transDate": 1541429099,
      "transType": 1,
      "senderCompany": {
        "companyId": 6,
        "accountId": 10,
        "type": 2,
        "name": "ФІЗИЧНА ОСОБА",
        "inn": "0987654321",
        "code": "3366905914",
        "phone": "432532",
        "info": "выфвфы565",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 0,
        "atCode": "2432423",
        "certNum": "21321321312",
        "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      },
      "recipientCompany": {
        "companyId": 4,
        "accountId": 8,
        "type": 1,
        "name": "ПрАТ \"Літак\"",
        "inn": "123456789012",
        "code": "34554355",
        "phone": "4234234324",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 4,
        "addCode": "121212",
        "atCode": "12363",
        "prsNum": "43242352",
        "certNum": "456",
        "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      },
      "payerCompany": {
        "companyId": 4,
        "accountId": 8,
        "type": 1,
        "name": "ПрАТ \"Літак\"",
        "inn": "123456789012",
        "code": "34554355",
        "phone": "4234234324",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 4,
        "addCode": "121212",
        "atCode": "12363",
        "prsNum": "43242352",
        "certNum": "456",
        "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      }
    }
  ]
}