Obter os dados de faturamento da empresa pelo CNPJ.

Prod Env

https://api.klever.tec.br/api

GET

/external_resource/document_ocr/billing_statements/{cnpj}

External Resource

Obter os dados de faturamento da empresa pelo CNPJ.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

cnpj

string

requerido

O cnpj da empresa

Exemplo:

12456606000115, 15021849000119

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.klever.tec.br/api/external_resource/document_ocr/billing_statements/12456606000115, 15021849000119'

Respostas

🟢200OK

application/json

Body

Os dados do extrato de faturamento.

created

string <date-time>

opcional

A data de criação.

string

opcional

O id.

monthValues

array[object (MonthValueDto) {11}]

opcional

Os valores por mês.

approved

boolean

opcional

Indica se o valor foi aprovado.

date

string <date>

requerido

A data de término mensal pertencente ao valor. AAAA-MM-DD.

nfValue

number <double>

opcional

O valor da Nota Fiscal.

nfValueLastModifiedDate

string <date>

opcional

Última data em que o valor da nota fiscal foi modificado.

ocrValue

number <double>

opcional

O valor OCR.

ocrValueLastModifiedDate

string <date>

opcional

Última data em que o valor do OCR foi modificado.

pgdasValue

number <double>

opcional

O valor do PGDAS.

pgdasValueLastModifiedDate

string <date>

opcional

Última data em que o valor do PGDAS foi modificado.

spedValue

number <double>

opcional

O valor do Sped.

spedValueLastModifiedDate

string <date>

opcional

Última data em que o valor do sped foi modificado.

variation

number <double>

opcional

A variação do faturamento

Exemplo

{
    "created": "2019-08-24T14:15:22Z",
    "id": "string",
    "monthValues": [
        {
            "approved": true,
            "date": "2019-08-24",
            "nfValue": 0,
            "nfValueLastModifiedDate": "2019-08-24",
            "ocrValue": 0,
            "ocrValueLastModifiedDate": "2019-08-24",
            "pgdasValue": 0,
            "pgdasValueLastModifiedDate": "2019-08-24",
            "spedValue": 0,
            "spedValueLastModifiedDate": "2019-08-24",
            "variation": 0
        }
    ]
}

🟠404CNPJ não encontrado

🟠422Erro inesperado

Página anterior

Obter os dados de endividamento da empresa pelo CNPJ.

Próxima página

Obter análise vertical das notas fiscais.