API

Ödəniş üçün hesabların siyahısını əldə et

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

Avtorizasiya

api-token + language + role

Sorğu parametrləri

page_numberinteger

Nümunə: 1

date_creation_fromstring

Nümunə: 25/04/2024

date_creation_tostring

Nümunə: 26/04/2024

statusstring

Dəyərlər:annullednot_paidpaid

invoice_numberinteger

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_creation_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

statusobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

invoice_numberobject (FilterId)
valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

listarray of object
idintegermütləq

Nümunə: 1

statusstringmütləq

Dəyərlər:paidnot_paidannulled

Nümunə: paid

invoice_numberintegermütləq

Nümunə: 583200011

amount_due_foreignnumbermütləq

Nümunə: 10000

date_creationstring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Valyuta kodu

Dəyərlər:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Nümunə: RUB

namestring

Nümunə: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringmütləq

Nümunə: Europe/Moscow

cao_emailstring

Nümunə: examople@example.com

cao_phone_format_idinteger

Nümunə: 1

cao_phone_numberstring

Nümunə: 9999999999

entity_name_shortstringmütləq

Nümunə: LLC Green Basket

invoice_urlstring

Nümunə: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false