API

Liste der Rechnungen abrufen

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

Autorisierung

api-token + language + role

Abfrageparameter

page_numberinteger

Beispiel: 1

date_creation_fromstring

Beispiel: 25/04/2024

date_creation_tostring

Beispiel: 26/04/2024

statusstring

Werte:annullednot_paidpaid

invoice_numberinteger

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

statusobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string
modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

invoice_numberobject (FilterId)
valueany

Beispiel: 0

typestringerforderlich

Beispiel: integer

placeholderstring

Beispiel: integer

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object
idintegererforderlich

Beispiel: 1

statusstringerforderlich

Werte:paidnot_paidannulled

Beispiel: paid

invoice_numberintegererforderlich

Beispiel: 583200011

amount_due_foreignnumbererforderlich

Beispiel: 10000

date_creationstring (DataTimeFormatSQL) erforderlich

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

date_paymentstring (DataTimeFormatSQL)

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

currency_code_foreignstring (CurrencyCode)

Währungscode

Werte:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Beispiel: RUB

namestring

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

timezonestringerforderlich

Beispiel: Europe/Moscow

cao_emailstring

Beispiel: examople@example.com

cao_phone_format_idinteger

Beispiel: 1

cao_phone_numberstring

Beispiel: 9999999999

entity_name_shortstringerforderlich

Beispiel: LLC Green Basket

invoice_urlstring

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

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false