API

Získat seznam faktur k úhradě

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

Autorizace

api-token + language + role

Parametry dotazu

page_numberinteger

Příklad: 1

date_creation_fromstring

Příklad: 25/04/2024

date_creation_tostring

Příklad: 26/04/2024

statusstring

Hodnoty:annullednot_paidpaid

invoice_numberinteger

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmůže být null

Příklad: 2026-08-01 00:00:00

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_toobject (FilterDateTo)
valuestringmůže být null

Příklad: 2026-08-31 23:59:59

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

statusobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string
modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

invoice_numberobject (FilterId)
valueany

Příklad: 0

typestringpovinné

Příklad: integer

placeholderstring

Příklad: integer

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object
idintegerpovinné

Příklad: 1

statusstringpovinné

Hodnoty:paidnot_paidannulled

Příklad: paid

invoice_numberintegerpovinné

Příklad: 583200011

amount_due_foreignnumberpovinné

Příklad: 10000

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Kód měny

Hodnoty:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Příklad: RUB

namestring

Příklad: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringpovinné

Příklad: Europe/Moscow

cao_emailstring

Příklad: examople@example.com

cao_phone_format_idinteger

Příklad: 1

cao_phone_numberstring

Příklad: 9999999999

entity_name_shortstringpovinné

Příklad: LLC Green Basket

invoice_urlstring

Příklad: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false