API

Hankige arvete nimekiri

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

Autoriseerimine

api-token + language + role

Päringu parameetrid

page_numberinteger

Näide: 1

date_creation_fromstring

Näide: 25/04/2024

date_creation_tostring

Näide: 26/04/2024

statusstring

Väärtused:annullednot_paidpaid

invoice_numberinteger

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

invoice_numberobject (FilterId)
valueany

Näide: 0

typestringkohustuslik

Näide: integer

placeholderstring

Näide: integer

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

listarray of object
idintegerkohustuslik

Näide: 1

statusstringkohustuslik

Väärtused:paidnot_paidannulled

Näide: paid

invoice_numberintegerkohustuslik

Näide: 583200011

amount_due_foreignnumberkohustuslik

Näide: 10000

date_creationstring (DataTimeFormatSQL) kohustuslik

Näide: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Valuuta kood

Väärtused:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Näide: RUB

namestring

Näide: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringkohustuslik

Näide: Europe/Moscow

cao_emailstring

Näide: examople@example.com

cao_phone_format_idinteger

Näide: 1

cao_phone_numberstring

Näide: 9999999999

entity_name_shortstringkohustuslik

Näide: LLC Green Basket

invoice_urlstring

Näide: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false