/paydocument ​

Кінцева точка /paydocument відповідає за роботу з платіжними документами (банківські платежі та касові операції).

Методи ​

• /paydocument/index - завантажити перелік платіжних документів
• /paydocument/load - завантажити платіжний документ
• /paydocument/update - створити або оновити платіжний документ

GET /paydocument/index/?{from}&{to}&{pageSize=100}&{offset=0} ​

Завантажує перелік платіжних документів за період.

Параметри запиту:

• from - початок періоду (дата документа), формат 2026-01-01. Обов'язковий.
• to - кінець періоду. Обов'язковий.
• pageSize - розмір сторінки (1-100).
• offset - зміщення ( > 0)
• dateModified - необов'язковий фільтр: тільки документи, змінені починаючи з вказаної дати/часу. Зручно для інкрементальної синхронізації.
• agent - необов'язковий фільтр: UID контрагента. Повертаються тільки платіжні документи цього контрагента. Якщо контрагента з таким UID немає - повертається пустий перелік.

Приклад: /paydocument/index?from=2026-09-01&to=2026-09-30&agent=d362cdfd-72d5-4906-889c-44152121c8b4

Повертає стандартну відповідь для індексу об'єктів PayDocument.

{
   "success" : true, 
   "totalCount": 10,
   "data": [ /* PayDocument */
		{ "uid": "...." }
	]
};

{
   "success" : true, 
   "totalCount": 10,
   "data": [ /* PayDocument */
		{ "uid": "...." }
	]
};

Зверніть увагу, що поле totalCount поверне загальну кількість платіжних документів за період (з урахуванням фільтрів dateModified та agent).

GET /paydocument/load/{uid} ​

Завантажує платіжний документ по його UID.

Параметри запиту:

• uid - UID документа (в URL)

Повертає стандартну відповідь з об'єктом PayDocument.

{
   "success" : true, 
   "data": { /* PayDocument */
		"uid": "...."
	}
};

{
   "success" : true, 
   "data": { /* PayDocument */
		"uid": "...."
	}
};

POST /paydocument/update ​

Створює або оновлює властивості платіжного документа.

Тіло запита має бути обєктом PayDocument:

{
    "uid":"C259B17B-BFC8-48B9-A6A7-CEB1FD054413",
    "date":"2023-02-23",
    "type": "payFromCustomer",
    "no":"string",
    "sum": 100,
    "memo": "string",
    "agent": {
        "uid": "d362cdfd-72d5-4906-889c-44152121c8b4",
        "name": "string",
    }
}

{
    "uid":"C259B17B-BFC8-48B9-A6A7-CEB1FD054413",
    "date":"2023-02-23",
    "type": "payFromCustomer",
    "no":"string",
    "sum": 100,
    "memo": "string",
    "agent": {
        "uid": "d362cdfd-72d5-4906-889c-44152121c8b4",
        "name": "string",
    }
}

Зверніть увагу:

• Непередані властивості не змінюються (див. Особливості оновлення).
• Проведений документ не можна оновлювати.

Повертає стандартну відповідь з об'єктом PayDocument.

Платіжний документ можна пов'язати зі звичайним документом (наприклад, оплату з рахунком) методом /document/linkto, а перевірити проведеність - методом /document/getdone.