API

Obter a lista de faturas

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

Autorização

api-token + language + role

Parâmetros de consulta

page_numberinteger

Exemplo: 1

date_creation_fromstring

Exemplo: 25/04/2024

date_creation_tostring

Exemplo: 26/04/2024

statusstring

Valores:annullednot_paidpaid

invoice_numberinteger

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

invoice_numberobject (FilterId)
valueany

Exemplo: 0

typestringobrigatório

Exemplo: integer

placeholderstring

Exemplo: integer

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object
idintegerobrigatório

Exemplo: 1

statusstringobrigatório

Valores:paidnot_paidannulled

Exemplo: paid

invoice_numberintegerobrigatório

Exemplo: 583200011

amount_due_foreignnumberobrigatório

Exemplo: 10000

date_creationstring (DataTimeFormatSQL) obrigatório

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

date_paymentstring (DataTimeFormatSQL)

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

currency_code_foreignstring (CurrencyCode)

Código da moeda

Valores:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Exemplo: RUB

namestring

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

timezonestringobrigatório

Exemplo: Europe/Moscow

cao_emailstring

Exemplo: examople@example.com

cao_phone_format_idinteger

Exemplo: 1

cao_phone_numberstring

Exemplo: 9999999999

entity_name_shortstringobrigatório

Exemplo: LLC Green Basket

invoice_urlstring

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

paginationobject (Pagination)
max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false