API

Отримати список рахунків на оплату

GET/api/crm/v2/invoicesv2
operationId: invoices.default

Авторизація

api-token + language + role

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

page_numberinteger

Приклад: 1

date_creation_fromstring

Приклад: 25/04/2024

date_creation_tostring

Приклад: 26/04/2024

statusstring

Значення:annullednot_paidpaid

invoice_numberinteger

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

invoice_numberobject (FilterId)
valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

listarray of object
idintegerобов’язковий

Приклад: 1

statusstringобов’язковий

Значення:paidnot_paidannulled

Приклад: paid

invoice_numberintegerобов’язковий

Приклад: 583200011

amount_due_foreignnumberобов’язковий

Приклад: 10000

date_creationstring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Код валюти

Значення:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Приклад: RUB

namestring

Приклад: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringобов’язковий

Приклад: Europe/Moscow

cao_emailstring

Приклад: examople@example.com

cao_phone_format_idinteger

Приклад: 1

cao_phone_numberstring

Приклад: 9999999999

entity_name_shortstringобов’язковий

Приклад: LLC Green Basket

invoice_urlstring

Приклад: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false