API

Pobierz listę faktur

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

Autoryzacja

api-token + language + role

Parametry zapytania

page_numberinteger

Przykład: 1

date_creation_fromstring

Przykład: 25/04/2024

date_creation_tostring

Przykład: 26/04/2024

statusstring

Wartości:annullednot_paidpaid

invoice_numberinteger

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

statusobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string
modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

invoice_numberobject (FilterId)
valueany

Przykład: 0

typestringwymagane

Przykład: integer

placeholderstring

Przykład: integer

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

listarray of object
idintegerwymagane

Przykład: 1

statusstringwymagane

Wartości:paidnot_paidannulled

Przykład: paid

invoice_numberintegerwymagane

Przykład: 583200011

amount_due_foreignnumberwymagane

Przykład: 10000

date_creationstring (DataTimeFormatSQL) wymagane

Przykład: 2024-05-02 08:31:16

date_paymentstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

currency_code_foreignstring (CurrencyCode)

Kod waluty

Wartości:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Przykład: RUB

namestring

Przykład: Green Basket (LLC Green Basket, 1235416253, Green Basket | IikoTransportFS, Khabarovsk)

timezonestringwymagane

Przykład: Europe/Moscow

cao_emailstring

Przykład: examople@example.com

cao_phone_format_idinteger

Przykład: 1

cao_phone_numberstring

Przykład: 9999999999

entity_name_shortstringwymagane

Przykład: LLC Green Basket

invoice_urlstring

Przykład: https://ru.example.example/invoice/show/cf5371b7-ec6e-110b-110b-d59fce2e11af

paginationobject (Pagination)
max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false