API

Gauti sąskaitų faktūrų sąrašą

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

Autorizacija

api-token + language + role

Užklausos parametrai

page_numberinteger

Pavyzdys: 1

date_creation_fromstring

Pavyzdys: 25/04/2024

date_creation_tostring

Pavyzdys: 26/04/2024

statusstring

Reikšmės:annullednot_paidpaid

invoice_numberinteger

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

statusobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string
modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

invoice_numberobject (FilterId)
valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of object
idintegerprivalomas

Pavyzdys: 1

statusstringprivalomas

Reikšmės:paidnot_paidannulled

Pavyzdys: paid

invoice_numberintegerprivalomas

Pavyzdys: 583200011

amount_due_foreignnumberprivalomas

Pavyzdys: 10000

date_creationstring (DataTimeFormatSQL) privalomas

Pavyzdys: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Pavyzdys: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Valiutos kodas

Reikšmės:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Pavyzdys: RUB

namestring

Pavyzdys: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringprivalomas

Pavyzdys: Europe/Moscow

cao_emailstring

Pavyzdys: examople@example.com

cao_phone_format_idinteger

Pavyzdys: 1

cao_phone_numberstring

Pavyzdys: 9999999999

entity_name_shortstringprivalomas

Pavyzdys: LLC Green Basket

invoice_urlstring

Pavyzdys: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false