Gerar Método K. - KLEVER SASS REST CLIENT API

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Bodyapplication/json

Os dados para solicitar o método k.

cnpj

string

requerido

As perguntas da empresa respondidas no momento do registro.

newAnalysis

boolean

opcional

Indica se você deseja gerar uma nova análise ou retornar a última executada, se a variável é falsa uma nova análise é executada.

Exemplo

{
    "cnpj": "string",
    "newAnalysis": true
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.klever.tec.br/api/external_resource/methodk' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cnpj": "string",
    "newAnalysis": true
}'

Respostas

🟢200OK

application/json

Body

analysis

array[object (MethodKScoreAnalysisDto) {3}]

opcional

operations

object

opcional

As operações.

total

number <double>

opcional

O valor total.

type

enum<string>

opcional

O tipo de score.

Valores permitidos:

STRENGTHREGISTERHABITUALITYALLBALANCEDEMOSTRATION

balances

array[object (MethodKBalanceDto) {3}]

opcional

description

enum<string>

opcional

Valores permitidos:

AVAILABILITYCP_CUSTOMERSSTOCKOTHER_ASSETSCURRENT_ASSETSLP_CUSTOMERSNON_CURRENT_ASSETSPERMANENTTOTAL_ASSETSCP_SUPPLIERSCP_BANKSOTHER_PASSIVESCURRENT_PASSIVESLP_BANKSNON_CURRENT_PASSIVESREFPLTOTAL_PASSIVESCCLNCGNET_DEBTGENERAL_INDEBTEDNESSNET_REVENUECMVOPERATIONAL_EXPENSESEBITDADEPRECIATION_AMORTIZATION_EXPENSESOPERATING_PROFITFINANCIAL_RESULTTAXESLIQUID_PROFITDL_EBITDAEBITDA_PERCENTLL_PERCENT

endDate

string <date>

opcional

endValue

number <double>

opcional

cnae

string

opcional

cnpj

string

opcional

created

string <date-time>

opcional

demonstrations

array[object (MethodKBalanceDto) {3}]

opcional

description

enum<string>

opcional

Valores permitidos:

AVAILABILITYCP_CUSTOMERSSTOCKOTHER_ASSETSCURRENT_ASSETSLP_CUSTOMERSNON_CURRENT_ASSETSPERMANENTTOTAL_ASSETSCP_SUPPLIERSCP_BANKSOTHER_PASSIVESCURRENT_PASSIVESLP_BANKSNON_CURRENT_PASSIVESREFPLTOTAL_PASSIVESCCLNCGNET_DEBTGENERAL_INDEBTEDNESSNET_REVENUECMVOPERATIONAL_EXPENSESEBITDADEPRECIATION_AMORTIZATION_EXPENSESOPERATING_PROFITFINANCIAL_RESULTTAXESLIQUID_PROFITDL_EBITDAEBITDA_PERCENTLL_PERCENT

endDate

string <date>

opcional

endValue

number <double>

opcional

fantasyName

string

opcional

habituality

integer <int32>

opcional

habitualityWeight

integer <int32>

opcional

indicativeOperation

object (IndicativeOperationDto)

opcional

A operação indicativa do método K.

gracePeriod

integer <int32>

opcional

The grace period.

grossBreakeven

number <double>

opcional

The gross breakeven. Value expressed in %.

liquidBreakeven

number <double>

opcional

The liquid breakeven. Value expressed in %.

operations

object

opcional

The history of operations.

requestedVolume

number <double>

opcional

The requested volume.

term

integer <int32>

opcional

The term.

typeOfGuarantee

enum<string>

opcional

The type of guarantee.

Valores permitidos:

NONEAVALDISCOUNTRECEITAREPROVED

volume

string

opcional

The total volume. If the company has restrictions, its value is RESTRICTIVE.

municipality

string

opcional

O município.

openingDate

string <date-time>

opcional

organizationId

string

opcional

quantityEmployee

integer <int32>

opcional

register

integer <int32>

opcional

registerWeight

integer <int32>

opcional

robustnessWeight

integer <int32>

opcional

scale

object (MethodKScaleDto)

opcional

operationAction

string

opcional

rating

string

opcional

scale

integer <int32>

opcional

strength

integer <int32>

opcional

total

integer <int32>

opcional

uf

string

opcional

Exemplo

{
    "analysis": [
        {
            "operations": {
                "property1": {},
                "property2": {}
            },
            "total": 0,
            "type": "STRENGTH"
        }
    ],
    "balances": [
        {
            "description": "AVAILABILITY",
            "endDate": "2019-08-24",
            "endValue": 0
        }
    ],
    "cnae": "string",
    "cnpj": "string",
    "created": "2019-08-24T14:15:22Z",
    "demonstrations": [
        {
            "description": "AVAILABILITY",
            "endDate": "2019-08-24",
            "endValue": 0
        }
    ],
    "fantasyName": "string",
    "habituality": 0,
    "habitualityWeight": 0,
    "indicativeOperation": {
        "gracePeriod": 0,
        "grossBreakeven": 0,
        "liquidBreakeven": 0,
        "operations": {
            "property1": {},
            "property2": {}
        },
        "requestedVolume": 0,
        "term": 0,
        "typeOfGuarantee": "NONE",
        "volume": "string"
    },
    "municipality": "string",
    "openingDate": "2019-08-24T14:15:22Z",
    "organizationId": "string",
    "quantityEmployee": 0,
    "register": 0,
    "registerWeight": 0,
    "robustnessWeight": 0,
    "scale": {
        "operationAction": "string",
        "rating": "string",
        "scale": 0
    },
    "strength": 0,
    "total": 0,
    "uf": "string"
}

🟠404CNPJ não encontrado

🟠422Erro inesperado