Carga

Usamos a autenticação básica para manter a comunicação segura. Para realizar uma requisição, você precisará do token no cabeçalho da solicitação. Para obter o token entre em contato através do link na página de credenciais de acesso e procure o formulário para os produtos restritos via API.

Carga

Criar

https://conciliacao.vert-capital.app/api/v1/carga/criar

post

Cria uma carga para que seja possível enviar registros para as tabelas temporárias.

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Corpo

{ 'IdCarga': integer, 'NumeroRemessa': integer, 'Origem': 'string 15 bytes', 'TipoArquivo': integer, 'TipoSequencial': integer, 'nmArquivo': 'string 500 bytes'}stringOpcional

Respostas

post

HTTPcURLJavaScriptPython

POST /api/v1/carga/criar HTTP/1.1
Host: conciliacao.vert-capital.app
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 171

"{ 'IdCarga': integer, 'NumeroRemessa': integer, 'Origem': 'string 15 bytes', 'TipoArquivo': integer, 'TipoSequencial': integer, 'nmArquivo': 'string 500 bytes'}='text'"

200

Successful response

Sem conteúdo

Enviar registro

https://conciliacao.vert-capital.app/api/v1/carga/enviarregistro

post

Enviar registros para uma carga."

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Corpo

{ 'carga':{ 'IdCarga':integer, 'Origem':'string', 'NumeroRemessa':integer, 'TipoSequencial':integer, 'nmArquivo':'string', 'TipoArquivo':integer }, 'Clientes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmNome':'string', 'NuCpfCnpj':long, 'NmRg':'string', 'DtNascimento':'date', 'TpSexo':integer, 'TpEstadoCivil':integer, 'NmConjuge':'string', 'NmMae':'string', 'NmPai':'string', 'NmEmpresa':'string', 'NmCargo':'string', 'VlRenda':double, 'TpPessoa':integer } ], 'Contratos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NuPlano':integer, 'DtExpiracao':null } ], 'Dividas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'VlDivida':double, 'DtVencimento':'date', 'NuPrestacao':integer } ], 'Telefones':[ { 'TpEvento':integer, 'TpCelular':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'NmContato':'string', 'TpTelefone':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmTelefoneCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' }, { 'TpEvento':integer, 'TpCelular':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'NmContato':'string', 'TpTelefone':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmTelefoneCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' } ], 'Enderecos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'TpEndereco':integer, 'TpOrigem':integer, 'NmEndereco':'string', 'NmNumero':'string', 'NmComplemento':'string', 'NmBairro':'string', 'NmCidade':'string', 'NmUf':'string', 'NuCep':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmEnderecoCedente':'string', 'CampoLivre':'string', 'NmOrigem':'string' } ], 'ContratoDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'ClienteDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'DividaDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'Emails':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmEmail':'string', 'NmContato':'string', 'TpEmail':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmEmailCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' } ], 'ContratoAvalistas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmAvalistaCedente':'string', 'NmNome':'string', 'NuCPF':long, 'NmRG':'string', 'DtNascimento':'date', 'NmNomePai':'string', 'NmNomeMae':'string', 'NmEndereco':'string', 'NmNumero':'string', 'NmComplemento':'string', 'NmBairro':'string', 'NmCidade':'string', 'NmUF':'string', 'NuCep':integer, 'DsObs':'string', 'NmNomeConjuge':'string' } ], 'ContratoAvalistaTelefones':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmAvalistaCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'TpTelefone':integer } ], 'Garantias':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmGarantiaCedente':'string', 'NmGarantia':'string', 'DsGarantia':'string', 'VlGarantia':double } ], 'DividasPagamentos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ], 'AcordosCancelar':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmAcordoCedente':'string' } ], 'Taxas':[ { 'TpEvento':integer, 'NmTaxa':'string', 'DtTaxa':'date', 'VlTaxa':double } ], 'Acordos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmAcordoCedente':'string', 'DtAcordo':'date', 'DtCalculo':'date', 'NuPlano':integer, 'IdUsuarioAcordo':integer, 'AcordoParcelas':[ { 'NossoNumeroCedente':long, 'NuParcela':integer, 'DtParcela':'date', 'VlParcela':double } ], 'AcordoDividas':[ { 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ], 'AcordoDetalhes':[ { 'NmDetalhe':'string', 'NmDetalheValor':'string' } ] } ], 'Acoes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'IdAcao':integer, 'NmAcao':'string', 'IdUsuario':integer, 'DtAcao':'datetime', 'NuDdd':integer, 'NuTelefone':long, 'DsAcao':'string' } ], 'Veiculos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmVeiculoCedente':'string', 'NmModelo':'string', 'NuAnoFabricacao':integer, 'NuAnoModelo':integer, 'NuRenavam':long, 'NmCor':'string', 'NuFipe':integer, 'NuFipeDv':integer, 'NmChassis':'string', 'NmBeneficiario':'string', 'NmPlaca':'string', 'NmMarca':'string', 'VlVeiculo':double, 'DtApreensao':'date', 'DtVenda':'date', 'DtSentenca':'date', 'VlVenda':double, 'TpCombustivel':integer, 'TpCobranca':integer, 'TpGarantia':integer } ], 'AcordosLiquidacao':[ { 'IdCliente':integer, 'IdAcordo':integer, 'DtPagamento':'date' } ], 'ClientesArquivo':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmArquivo':'string', 'NmTipo':'string', 'DsArquivo':'stringBase64', 'IdUsuario':integer } ]}stringOpcional

Respostas

post

HTTPcURLJavaScriptPython

POST /api/v1/carga/enviarregistro HTTP/1.1
Host: conciliacao.vert-capital.app
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 6052

"{ 'carga':{ 'IdCarga':integer, 'Origem':'string', 'NumeroRemessa':integer, 'TipoSequencial':integer, 'nmArquivo':'string', 'TipoArquivo':integer }, 'Clientes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmNome':'string', 'NuCpfCnpj':long, 'NmRg':'string', 'DtNascimento':'date', 'TpSexo':integer, 'TpEstadoCivil':integer, 'NmConjuge':'string', 'NmMae':'string', 'NmPai':'string', 'NmEmpresa':'string', 'NmCargo':'string', 'VlRenda':double, 'TpPessoa':integer } ], 'Contratos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NuPlano':integer, 'DtExpiracao':null } ], 'Dividas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'VlDivida':double, 'DtVencimento':'date', 'NuPrestacao':integer } ], 'Telefones':[ { 'TpEvento':integer, 'TpCelular':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'NmContato':'string', 'TpTelefone':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmTelefoneCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' }, { 'TpEvento':integer, 'TpCelular':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'NmContato':'string', 'TpTelefone':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmTelefoneCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' } ], 'Enderecos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'TpEndereco':integer, 'TpOrigem':integer, 'NmEndereco':'string', 'NmNumero':'string', 'NmComplemento':'string', 'NmBairro':'string', 'NmCidade':'string', 'NmUf':'string', 'NuCep':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmEnderecoCedente':'string', 'CampoLivre':'string', 'NmOrigem':'string' } ], 'ContratoDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'ClienteDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'DividaDetalhes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string', 'NmDetalhe':'string', 'NmDetalheValor':'string' } ], 'Emails':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmEmail':'string', 'NmContato':'string', 'TpEmail':integer, 'TpHabilitado':integer, 'TpPreferencial':integer, 'NmEmailCedente':'string', 'CampoLivre':'string', 'IdQualificacao':integer, 'NmOrigem':'string' } ], 'ContratoAvalistas':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmAvalistaCedente':'string', 'NmNome':'string', 'NuCPF':long, 'NmRG':'string', 'DtNascimento':'date', 'NmNomePai':'string', 'NmNomeMae':'string', 'NmEndereco':'string', 'NmNumero':'string', 'NmComplemento':'string', 'NmBairro':'string', 'NmCidade':'string', 'NmUF':'string', 'NuCep':integer, 'DsObs':'string', 'NmNomeConjuge':'string' } ], 'ContratoAvalistaTelefones':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmAvalistaCedente':'string', 'NuDdd':integer, 'NuTelefone':long, 'NuRamal':integer, 'TpTelefone':integer } ], 'Garantias':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmGarantiaCedente':'string', 'NmGarantia':'string', 'DsGarantia':'string', 'VlGarantia':double } ], 'DividasPagamentos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ], 'AcordosCancelar':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmAcordoCedente':'string' } ], 'Taxas':[ { 'TpEvento':integer, 'NmTaxa':'string', 'DtTaxa':'date', 'VlTaxa':double } ], 'Acordos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmAcordoCedente':'string', 'DtAcordo':'date', 'DtCalculo':'date', 'NuPlano':integer, 'IdUsuarioAcordo':integer, 'AcordoParcelas':[ { 'NossoNumeroCedente':long, 'NuParcela':integer, 'DtParcela':'date', 'VlParcela':double } ], 'AcordoDividas':[ { 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmDividaCedente':'string' } ], 'AcordoDetalhes':[ { 'NmDetalhe':'string', 'NmDetalheValor':'string' } ] } ], 'Acoes':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'IdAcao':integer, 'NmAcao':'string', 'IdUsuario':integer, 'DtAcao':'datetime', 'NuDdd':integer, 'NuTelefone':long, 'DsAcao':'string' } ], 'Veiculos':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmContratoCedente':'string', 'NmProdutoCedente':'string', 'NmVeiculoCedente':'string', 'NmModelo':'string', 'NuAnoFabricacao':integer, 'NuAnoModelo':integer, 'NuRenavam':long, 'NmCor':'string', 'NuFipe':integer, 'NuFipeDv':integer, 'NmChassis':'string', 'NmBeneficiario':'string', 'NmPlaca':'string', 'NmMarca':'string', 'VlVeiculo':double, 'DtApreensao':'date', 'DtVenda':'date', 'DtSentenca':'date', 'VlVenda':double, 'TpCombustivel':integer, 'TpCobranca':integer, 'TpGarantia':integer } ], 'AcordosLiquidacao':[ { 'IdCliente':integer, 'IdAcordo':integer, 'DtPagamento':'date' } ], 'ClientesArquivo':[ { 'TpEvento':integer, 'NmClienteCedente':'string', 'NmCedenteCedente':'string', 'NmArquivo':'string', 'NmTipo':'string', 'DsArquivo':'stringBase64', 'IdUsuario':integer } ]}='text'"

200

Successful response

Sem conteúdo

Anular

https://conciliacao.vert-capital.app/api/v1/carga/anular/{idCarga}

get

Anula a carga caso a mesma esteja no status de ImportacaoConcluida ou ErroNaCarga. Uma vez que a carga é anulada ela não será mais importada para as tabelas oficiais do sistema.

Parâmetros de rota

idCargastringObrigatório

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Respostas

get

HTTPcURLJavaScriptPython

GET /api/v1/carga/anular/{idCarga} HTTP/1.1
Host: conciliacao.vert-capital.app
Accept: */*

200

Successful response

Sem conteúdo

Finalizar

https://conciliacao.vert-capital.app/api/v1/carga/finalizar/{idCarga}

get

Finaliza a carga das tabelas temporárias. É necessário executar este endpoint para que o sistema saiba que a carga das tabelas temporárias foi finalizada, e que está tudo pronto para importar os registros para as tabelas oficiais do sistema.

Parâmetros de rota

idCargastringObrigatório

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Respostas

get

HTTPcURLJavaScriptPython

GET /api/v1/carga/finalizar/{idCarga} HTTP/1.1
Host: conciliacao.vert-capital.app
Accept: */*

200

Successful response

Sem conteúdo

Executar

https://conciliacao.vert-capital.app/api/v1/carga/executar

post

Carrega as tabelas oficiais do sistema importando os registros das tabelas temporárias.Antes de executar este endpoint deve ter sido executado o endpoint /v1/carga/finalizar/{idCarga} para que a carga fique no status de ImportacaoConcluida. Somente serão carregados os registros que estiverem na temporária e pertecerem as cargas com a Origem informada no JSON e que estejam no status de ImportacaoConcluida ou ErroNaCarga.

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Corpo

{ 'CargaExecucao':{ 'TamanhoBloco':integer, 'ContratoNovo':'string', 'BaixarFaturaEspecial':'string', 'IncluirDividaQuitada':'string', 'InserirEventoCliente':'string', 'InserirEventoContrato':'string', 'InserirEventoDivida':'string', 'InserirEventoDividaPagamento':'string', 'Origem':'string', 'InserirPreferencial':'string', 'AlterarDataAtualizacaoContrato':'string', 'BaixarParcelaAcordoValorPago':'string', 'DiasLimiteParaBaixaDeProposta':integer, 'IdUsuarioNoAcordo':integer, 'ValidarTelefone':'string', 'HabilitarTelefone':'string', 'HabilitarEndereco':'string', 'ValidarEmail':'string', 'IgnorarTipoTelefone':'string', 'ProcessarEmParalelo':'string', 'HabilitarEmail':'string', 'RetornarErroExecucaoSimultanea':'string', 'CargaRapidaAcao':'string', 'DesabilitarTelefone':'string', 'IgnorarOrigemTelefone':'string', 'ValidarAmortizacaoAcordo':'string' }, 'Tarefa':{ 'DescricaoTarefa':'string' }}stringOpcional

Respostas

post

HTTPcURLJavaScriptPython

POST /api/v1/carga/executar HTTP/1.1
Host: conciliacao.vert-capital.app
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 911

"{ 'CargaExecucao':{ 'TamanhoBloco':integer, 'ContratoNovo':'string', 'BaixarFaturaEspecial':'string', 'IncluirDividaQuitada':'string', 'InserirEventoCliente':'string', 'InserirEventoContrato':'string', 'InserirEventoDivida':'string', 'InserirEventoDividaPagamento':'string', 'Origem':'string', 'InserirPreferencial':'string', 'AlterarDataAtualizacaoContrato':'string', 'BaixarParcelaAcordoValorPago':'string', 'DiasLimiteParaBaixaDeProposta':integer, 'IdUsuarioNoAcordo':integer, 'ValidarTelefone':'string', 'HabilitarTelefone':'string', 'HabilitarEndereco':'string', 'ValidarEmail':'string', 'IgnorarTipoTelefone':'string', 'ProcessarEmParalelo':'string', 'HabilitarEmail':'string', 'RetornarErroExecucaoSimultanea':'string', 'CargaRapidaAcao':'string', 'DesabilitarTelefone':'string', 'IgnorarOrigemTelefone':'string', 'ValidarAmortizacaoAcordo':'string' }, 'Tarefa':{ 'DescricaoTarefa':'string' }}='text'"

200

Successful response

Sem conteúdo

Consulta de movimento

https://conciliacao.vert-capital.app/api/v1/carga/movimento/{idCarga}

get

Retorna o movimento da carga.

Parâmetros de rota

idCargastringObrigatório

Parâmetros de cabeçalho

AcceptstringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Basic

Respostas

get

HTTPcURLJavaScriptPython

GET /api/v1/carga/movimento/{idCarga} HTTP/1.1
Host: conciliacao.vert-capital.app
Accept: */*

200

Successful response

Sem conteúdo

Para realizar o processo via troca de arquivos, consulte a página:

Troca de dados via arquivo