API

Iegūt rēķinu sarakstu

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

Autorizācija

api-token + language + role

Vaicājuma parametri

page_numberinteger

Piemērs: 1

date_creation_fromstring

Piemērs: 25/04/2024

date_creation_tostring

Piemērs: 26/04/2024

statusstring

Vērtības:annullednot_paidpaid

invoice_numberinteger

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

invoice_numberobject (FilterId)
valueany

Piemērs: 0

typestringobligāts

Piemērs: integer

placeholderstring

Piemērs: integer

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

listarray of object
idintegerobligāts

Piemērs: 1

statusstringobligāts

Vērtības:paidnot_paidannulled

Piemērs: paid

invoice_numberintegerobligāts

Piemērs: 583200011

amount_due_foreignnumberobligāts

Piemērs: 10000

date_creationstring (DataTimeFormatSQL) obligāts

Piemērs: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Valūtas kods

Vērtības:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Piemērs: RUB

namestring

Piemērs: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringobligāts

Piemērs: Europe/Moscow

cao_emailstring

Piemērs: examople@example.com

cao_phone_format_idinteger

Piemērs: 1

cao_phone_numberstring

Piemērs: 9999999999

entity_name_shortstringobligāts

Piemērs: LLC Green Basket

invoice_urlstring

Piemērs: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false