logo
API docs by Redocly

Bimer Core API (11.02.03.01)

Download OpenAPI specification:

Introdução

Bimer API é uma plataforma que permite aos clientes da Alterdata, integrar diversos recursos de sistemas de terceiros ao Bimer através de funcionalidades disponibilizadas por um conjunto de APIs RestFul/JSON.

Antes de iniciar o desenvolvimento, leia sobre os padrões de modelagem das APIs no tópico APIs.
Depois, navegue pela documentação para conhecer as funcionalidades disponíveis.

APIs

Todos os serviços disponibilizados através da API utilizam a tecnologia REST (Representational State Transfer), uma arquitetura que permite interações com serviços web RestFul que disponibiliza recursos através de sistemas distribuídos, popularmente utilizados via HTTP.

Onde:

  • Hostname: Endereço principal do serviço
  • Versão da API: Versão do serviço que está sendo consumido
  • Recurso Raiz: Nome do serviço

Por exemplo: https://seuservidordaAPI.com.br/api/clientes

No Recurso Raiz, podemos acessar as principais operações do serviço (CRUD), através dos métodos do padrão HTTP, conforme tabela abaixo:

CRUD Métodos HTTP
Create POST
Read GET
Update PUT
Delete DELETE

Ou seja, no serviço /clientes, do exemplo acima, se fizermos uma operação POST, salvaremos um novo cliente.

A tabela abaixo mostra algumas das operações que conseguimos executar sobre determinados serviços:

Recurso GET POST
/clientes * Cria um novo cliente
/produtos Lista com todos os produtos cadastrados *
/produtos/00A0000001 Lista detalhes do produto com identificador 00A0000001 *
  • O '*' representa que o método não está disponível, então espera-se o retorno com ERRO 405 - method not allowed


HTTP 1.1

O protocolo padrão para comunicação com as APIs é o HTTP versão 1.1.
Para mais informações sobre esse protocolo, consulte:
http://www.w3.org/Protocols/rfc2616/rfc2616.html
http://www.ietf.org/rfc/rfc2616.txt



UTF-8

O Charset padrão para chamadas às APIs é o UTF-8. Para mais informações sobre essa codificação, consulte:

https://tools.ietf.org/html/rfc3629



JSON

JSON (JavaScript Object Notation) é um padrão para descrição de dados para intercâmbio entre sistemas e é mais simples e mais leve que o XML.

Por padrão, toda a API trafega JSON, tanto para receber informações (métodos POST e PUT) quanto no retorno (método GET)

Devido a essa padronização, para as chamadas POST e PUT é necessário informar o HTTP Header content-type:application/json. Do contrário, você receberá um erro HTTP 415: Unsupported Media Type

Requisitos

Para poder utilizar a api é necessário se atentar aos seguintes requisitos:

  • Verificar se a api atende suas necessidades através de uma exploração maior da documentação a fim de verificar se as funcionalidades disponibilizadas irão atender às pretendidas.
  • IIS 7.5 ou superior instalado no servidor;
  • Net Framework 4.7.2 ou superior instalado no servidor;
  • Acesso ao banco de dados SQL onde está a base do Bimer;
    • Para a criação de um login para ser utilizado pelo Bimer
  • APIVersão corrente da documentação ou superior do Alterdata Bimer ERP
    • Caso não esteja na versão informada, solicite a atualização via suporte
  • Acesso ao módulo Cadastro de Usuário do Bimer.
  • Versão do Windows em período de suporte da Microsoft (A instalação pode ser realizada em uma versão fora do suporte, mas não há garantia de funcionamento)
  • Base de homologação do Bimer (Não é um requisito, mas é altamente recomendado)
    • Base de dados que é uma cópia da base de produção voltada para os testes.

Dúvidas e Sugestões

Gostaria de sugerir um novo recurso? Acesse a Central do cliente em https://www.alterdata.com.br e crie um registro em Minhas sugestões.

Caso continue com problemas você também pode entrar em contato com nosso time de suporte, estamos sempre felizes em ajudar!

Atenção: A BimerAPI pode funcionar tanto em HTTP quanto em HTTPs e irá depender da infraestrutura onde a mesma foi instalada.

Erros comuns

Existem alguns erros comuns que podem acontecer ao utilizar a api, dentre eles estão:

  • Erro 405 - The requested resource does not support http method '...'.
    1. Pode ser causado pela utilização de uma versão mais antiga da api.
  • Erro 400 - Não foi possível hidratar a entidade '...' com identificador 00000.
    1. Pode ser causado por um identificador incorreto. Lembre-se que os identificadores do Bimer são compostos de 10 caracteres alfanuméricos.
    2. Pode ser causado pelo identificador não existir no banco de dados. Isso pode ser causado pela remoção indevida do registro do banco. Por favor entre em contato com o suporte.
  • Erro 401 - Authorization has been denied for this request.
    1. O token de autenticação utilizado expirou ou é inválido
  • Erro 403 - Forbidden
    1. O usuário atual não possui acesso a essa rota. Libere o acesso no módulo cadastro de usuários.

Autenticação

Teste de disponibilidade da API

Verificar se a API está disponível.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
"string"

Requisição do token de acesso

Obtém o token de acesso à API.

Authorizations:
Bearer
Request Body schema: multipart/form-data
username
required
string

O login do usuário
Login

password
required
string

A senha do usuário
123456

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "tokenType": "string"
}

Verificação da validade do token de acesso

Verifica se o token de acesso ainda é válido.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "mensagem": "string"
}

Logout do usuário

Efetua a desconexão do usuário.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "mensagem": "string"
}

Atualização do Token de acesso

Atualiza o token de acesso à API.

Authorizations:
Bearer
Request Body schema: multipart/form-data
username
required
string

O login do usuário
Login

token
required
string

O token de acesso (sem 'bearer' no início)
b493d48364afe44d11c0165cf470a4164d1e26

refreshToken
required
string

O refresh token (sem 'bearer' no início)
bcd06ce364251e1c451fae6f9cd26cc8867cab

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string",
  • "expiresIn": 0,
  • "tokenType": "string"
}

Atendimento

Cadastrar um atendimento

Cadastra um novo atendimento que pode ser visualizado no CRM.

Authorizations:
Bearer
Request Body schema:

O atendimento que será adicionado.

agrupamento
string or null

O agrupamento ao que o atendimento pertence.
A

assunto
string or null

O assunto do atendimento.
A

codigoExterno
string or null

Código externo do atendimento.

dataAbertura
string <date-time>

A data de abertura.
2020-06-10T12:32:15.992Z

dataContatoInterno
string <date-time>

A data de contato interno.
2020-06-10T12:32:15.992Z

dataEntrega
string <date-time>

A data de entrega.
2020-06-10T12:32:15.992Z

dataPrevista
string <date-time>

A data prevista.
2020-06-10T12:32:15.992Z

destinatariosSpySystem
Array of strings or null

Obtém ou define a lista de destinatários de spy.
["funcionario1@email.com", "colaborado2@email.com"]

identificadorPessoa
required
string

Identificador da pessoa do atendimento.
00A0000001

identificadorProduto
string or null

Identificador do produto do atendimento.
00A0000001

identificadorTipoAtendimento
required
string

O identificador do tipo de atendimento.
00A0000001

identificadorUsuarioContatoInterno
string or null

O identificador do usuário de contato interno.
00A0000001

identificadorVersaoProduto
string or null

O identificador da versão do produto.
00A0000001

object (AtendimentoParecerCadastroContrato)

Contrato cadastro de parecer de atendimento.

prioridade
integer <int32>

O valor da prioridade do atendimento.
0

tag
string or null

Uma tag para o atendimento.
A

prioritario
boolean

Define se o atendimento é prioritário.

identificadorEntidadeOrigem
string or null

O identificador da entidade origem.
00A0000001

nomeEntidadeOrigem
string or null

O nome da entidade origem.
ContatoVenda

Responses

Request samples

Content type
{
  • "agrupamento": "string",
  • "assunto": "string",
  • "codigoExterno": "string",
  • "dataAbertura": "2019-08-24T14:15:22Z",
  • "dataContatoInterno": "2019-08-24T14:15:22Z",
  • "dataEntrega": "2019-08-24T14:15:22Z",
  • "dataPrevista": "2019-08-24T14:15:22Z",
  • "destinatariosSpySystem": [
    ],
  • "identificadorPessoa": "string",
  • "identificadorProduto": "string",
  • "identificadorTipoAtendimento": "string",
  • "identificadorUsuarioContatoInterno": "string",
  • "identificadorVersaoProduto": "string",
  • "parecerAbertura": {
    },
  • "prioridade": 0,
  • "tag": "string",
  • "prioritario": true,
  • "identificadorEntidadeOrigem": "string",
  • "nomeEntidadeOrigem": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adicionar um parecer em um atendimento

Adiciona um parecer em um atendimento

Authorizations:
Bearer
path Parameters
identificador
required
string
Request Body schema:
dataFinalParecer
string <date-time>

A data do fim do parecer.
2020-06-10T12:32:15.992Z

dataInicialParecer
string <date-time>

A data de início do parecer.
2020-06-10T12:32:15.992Z

dataProximoContato
string <date-time>

A data de próximo contato.
2020-06-10T12:32:15.992Z

descricao
string or null

A descrição do parecer.
Texto do parecer

identificadorTipoContato
string or null

O identificador do tipo de contato.
00A0000001

identificadorUsuarioProximoContato
string or null

O identificador do usuário de próximo contato.
00A0000001

identificadorWorkFlowDestino
string or null

O identificador do WorkFlow de destino.
00A0000001

identificadorWorkFlowItemDestino
string or null

O identificador do item do WorkFlow de destino.
00A0000001

nomePessoaContato
string or null

O nome da pessoa de contato do atendimento.
Cliente

Responses

Request samples

Content type
{
  • "dataFinalParecer": "2019-08-24T14:15:22Z",
  • "dataInicialParecer": "2019-08-24T14:15:22Z",
  • "dataProximoContato": "2019-08-24T14:15:22Z",
  • "descricao": "string",
  • "identificadorTipoContato": "string",
  • "identificadorUsuarioProximoContato": "string",
  • "identificadorWorkFlowDestino": "string",
  • "identificadorWorkFlowItemDestino": "string",
  • "nomePessoaContato": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar permissão de encerramento

Consultar se derterminado usuário possui permissão para encerrar um atendimento, conforme a configuração do tipo de atendimento.

Authorizations:
Bearer
query Parameters
identificadorUsuario
required
string

O identificador do usuário.
Exemplo: 00A0000001

identificadorAtendimento
string

O identificador do atendimento.
Exemplo: 454612
*Obs.: É necessário preencher o parâmetro 'IdentificadorAtendimento' ou 'IdentificadorTipoAtendimento'.

identificadorTipoAtendimento
string

O identificador do tipo de atendimento.
Exemplo: 00A0000001
*Obs.: É necessário preencher o parâmetro 'IdentificadorAtendimento' ou 'IdentificadorTipoAtendimento'.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta um tipo de atendimento.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do tipo de atendimento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Retorna um workflowitem.

Authorizations:
Bearer
path Parameters
identificadorWorkFlow
required
string
identificadorWorkFlowItem
required
string

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Contato de venda

Cria um contato de venda.

Authorizations:
Bearer
Request Body schema:

O contrato do contato de venda que será criado.

assuntoAtual
string or null

Assunto atual

descricaoContato
string or null

Decrição do Contato de Venda

contatoPrioritario
boolean

Indica se é um contato prioritário

dataAbertura
string or null <date-time>

Data de abertura

dataContatoInterno
string or null <date-time>

Data de contato interno

dataProximoContato
string or null <date-time>

Data de próximo contato

dataEncerramento
string or null <date-time>

Data de Encerramento do contato

dataPrevistaFechamento
string or null <date-time>

Data de previsão de fechamento do contato de venda

dataFechamentoCobranca
string or null <date-time>

Data de fechamento da cobrança

dataFechamentoPedido
string or null <date-time>

Data de pfechamento do pedido

descricaoMeioDeContato
string or null

Descrição do Meio de contato de venda

descricaoSistemaAtual
string or null

Descrição do sistema atual

destinatariosSpySystem
Array of strings or null

Destinatários para envio de Spy System

encerrado
boolean

Define se o contato já está encerrado.

identificadorMeioContato
string or null

Identificador meio de contato

identificadorSistemaAtual
string or null

Identificador sistema atual

identificadorPrazo
string or null

Identificador do prazo.

identificadorFormaPagamentoContrato
string or null

Identificador da forma de pagamento da cobrança do contrato que será gerado após o fechamento do contato de venda.

identificadorCentroResponsabilidade
string or null

Identificador centro de responsabilidade

identificadorOperacaoNotaFiscal
string or null

Identificador operação nota fiscal

Array of objects or null (ContatoVendaItemCadastroContrato)

Produtos

Array of objects or null (ContatoVendaParecerCadastroContrato)

Pareceres de abertura de contato de venda

Array of objects or null (ContatoVendaConcorrenteCadastroContrato)

Concorrentes do contato de venda

Array of objects or null (ContatoVendaRepasseCadastroContrato)

Repasses do contato de venda

percentualFechamento
number or null <double>

Percentual da probabilidade de fechamento do contato

restrito
boolean

Indica que o conteúdo do contato é restrito

object (ContatoVendaPessoaContrato)

Contrato pessoa contato de venda.

identificadorTipoAtendimento
string or null

Identificador tipo de atendimento

identificadorUsuarioContatoInterno
string or null

Usuário de contato interno do contato

identificadorUsuarioProximoContato
string or null

Identificador usuário próximo contato

identificadorUsuarioSolicitanteAbertura
string or null

Identificador usuário do que solicitou a abertura do contato de venda

identificadorUsuarioAbertura
string or null

Identificador usuário de abertura

valorAproximado
number or null <double>

Valor aproximado do contato de venda

identificadorClienteResponsavelFinanceiro
string or null

O identificador do cliente responsável financeiro

gerarPedidoPessoaFinanceiro
boolean

Informação se o contato vai gerar pedido para o responsável financeiro.

observacaoDocumento
string or null

A observação do documento

nomeEntidadeOrigem
string or null

Nome da entidade de origem do documento de venda.

identificadorEntidadeOrigem
string or null

Identificador da entidade de origem do documento de venda.

Array of objects or null (ContatoVendaPagamentoCadastroContrato)

Os pagamentos do contato de venda.

Responses

Request samples

Content type
{
  • "assuntoAtual": "string",
  • "descricaoContato": "string",
  • "contatoPrioritario": true,
  • "dataAbertura": "2019-08-24T14:15:22Z",
  • "dataContatoInterno": "2019-08-24T14:15:22Z",
  • "dataProximoContato": "2019-08-24T14:15:22Z",
  • "dataEncerramento": "2019-08-24T14:15:22Z",
  • "dataPrevistaFechamento": "2019-08-24T14:15:22Z",
  • "dataFechamentoCobranca": "2019-08-24T14:15:22Z",
  • "dataFechamentoPedido": "2019-08-24T14:15:22Z",
  • "descricaoMeioDeContato": "string",
  • "descricaoSistemaAtual": "string",
  • "destinatariosSpySystem": [
    ],
  • "encerrado": true,
  • "identificadorMeioContato": "string",
  • "identificadorSistemaAtual": "string",
  • "identificadorPrazo": "string",
  • "identificadorFormaPagamentoContrato": "string",
  • "identificadorCentroResponsabilidade": "string",
  • "identificadorOperacaoNotaFiscal": "string",
  • "itens": [
    ],
  • "pareceres": [
    ],
  • "concorrentes": [
    ],
  • "repasses": [
    ],
  • "percentualFechamento": 0.1,
  • "restrito": true,
  • "pessoa": {
    },
  • "identificadorTipoAtendimento": "string",
  • "identificadorUsuarioContatoInterno": "string",
  • "identificadorUsuarioProximoContato": "string",
  • "identificadorUsuarioSolicitanteAbertura": "string",
  • "identificadorUsuarioAbertura": "string",
  • "valorAproximado": 0.1,
  • "identificadorClienteResponsavelFinanceiro": "string",
  • "gerarPedidoPessoaFinanceiro": true,
  • "observacaoDocumento": "string",
  • "nomeEntidadeOrigem": "string",
  • "identificadorEntidadeOrigem": "string",
  • "pagamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Inventário

Obtém um lote de inventário pelo identificador.

Authorizations:
Bearer
path Parameters
identificadorLoteInventario
required
string

O identificador do lote de inventário.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um lote de inventário pelo identificador.

Authorizations:
Bearer
path Parameters
identificadorLoteInventario
required
string

O identificador do lote de inventário.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cria um novo inventário.

Authorizations:
Bearer
Request Body schema:

O inventário a ser criado.

codigoEmpresa
string or null
identificadorUsuario
string or null
identificadorSetor
string or null
descricaoLoteInventario
string or null
descricaoMotivoContagem
string or null
dataLancamento
string <date-time>
dataInventario
string <date-time>
identificadorUsuarioDestinoContagem
string or null
Array of objects or null (InserirLoteInventarioItemRequestDTO)

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "identificadorUsuario": "string",
  • "identificadorSetor": "string",
  • "descricaoLoteInventario": "string",
  • "descricaoMotivoContagem": "string",
  • "dataLancamento": "2019-08-24T14:15:22Z",
  • "dataInventario": "2019-08-24T14:15:22Z",
  • "identificadorUsuarioDestinoContagem": "string",
  • "itens": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cria um novo inventário.

Authorizations:
Bearer
Request Body schema:

O inventário a ser criado.

codigoEmpresa
string or null
identificadorUsuario
string or null
identificadorSetor
string or null
descricaoLoteInventario
string or null
descricaoMotivoContagem
string or null
dataLancamento
string <date-time>
dataInventario
string <date-time>
identificadorUsuarioDestinoContagem
string or null
Array of objects or null (InserirLoteInventarioItemRequestDTO)

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "identificadorUsuario": "string",
  • "identificadorSetor": "string",
  • "descricaoLoteInventario": "string",
  • "descricaoMotivoContagem": "string",
  • "dataLancamento": "2019-08-24T14:15:22Z",
  • "dataInventario": "2019-08-24T14:15:22Z",
  • "identificadorUsuarioDestinoContagem": "string",
  • "itens": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Pedido de compra

Cadastrar um pedido de compra

Cadastrar um novo pedido de compra no sistema

Authorizations:
Bearer
Request Body schema:

O pedido de compra a ser adicionado.

cep
string or null

CEP.
Exemplo: 12345-678

codigo
string or null

Codigo do pedido de compra.
Exemplo: 00A0000001

complementoEndereco
string or null

Complemento do endereco.
Exemplo: Apto 101

dataEmissao
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2024-01-31T13:45:00

dataEmissaoACT
string <date-time>

Obtém ou define a data de emissao do aviso de conhecimento do transporte.
Exemplo: 2024-01-31T13:45:00

dataEntrega
string <date-time>

Obtém ou define a data da entrega.
Exemplo: 2024-01-31T13:45:00

descricao
string or null

Obtém ou define a descricao.
Exemplo: Descrição do pedido de compra

entregaParcial
boolean

Obtém ou define se o pedido de compra terá entrega parcial.
Exemplo: true

logradouro
string or null

Logradouro.
Exemplo: Rua das Flores

numeroEndereco
string or null

Numero do endereco.
Exemplo: 1234

numeroOrcamento
string or null

Numero de orçamento.
Exemplo: ORC-2024-001

observacao
string or null

Obtém ou define a observacao.
Exemplo: Observações adicionais sobre o pedido de compra

object (PrazoContrato)

Contrato do prazo.

tipoLogradouro
string or null

Tipo do logradouro.
Exemplo: Rua, Avenida

uf
string or null

Obtém ou define a UF.
Exemplo: SP

identificadorEntidadeOrigem
string or null

Identificador da entidade de origem.
Exemplo: 00A0000001

nomeEntidadeOrigem
string or null

Entidade de Origem.
Exemplo: Fornecedor XYZ

codigoEmpresa
string or null

Codigo da empresa.
Exemplo: 00A0000001

codigoEmpresaFinanceiro
string or null

Codigo da empresa financeiro.
Exemplo: 00A0000002

identificadorBairro
string or null

Identificador do bairro.
Exemplo: 00A0000003

identificadorCidade
string or null

Identificador da cidade.
Exemplo: 00A0000004

identificadorFornecedor
string or null

Identificador da pessoa fornecedora.
Exemplo: 00A0000005

identificadorIndexador
string or null

Identificador do indexador.
Exemplo: 00A0000006

identificadorNaturezaLancamento
string or null

Identificador da natureza de lancamento.
Exemplo: 00A0000007

identificadorTransportador
string or null

Identificador da pessoa transportadora.
Exemplo: 00A0000008

identificadorUsuarioLiberacao
string or null

Identificador do usuario responsavel pela liberacao.
Exemplo: 00A0000001

valorAcrescimo
number <double>

Valor do acrescimo.
Exemplo: 100.50

valorDesconto
number <double>

Valor do desconto.
Exemplo: 50.00

valorFrete
number <double>

Valor do frete.
Exemplo: 20.00

valorSeguro
number <double>

Valor do seguro.
Exemplo: 15.00

valorOutrasDespesas
number <double>

Valor de outras despesas.
Exemplo: 5.00

valorACT
number <double>

Valor do aviso de conhecimento de transporte.
Exemplo: 30.00

object (PedidoDeCompraPagamentoTransporteCadastroContratoPedidoDeCompraConhecimentoTransporteContrato)

Contrato do conhecimento de transporte.

tipoFrete
string or null

Tipo de frete do pedido de compra.
Exemplo: D: Frete por conta do destinatário, E: Frete por conta do emitente, T: Frete por conta de terceiros, N: Sem frete; Caso seja omitido, será considerado como Sem frete ("N").

status
string or null

Status do pedido de compra.
Exemplo: A: Aberto, G: Aguardando; Caso seja omitido, será considerado como Aberto ("A").

Responses

Request samples

Content type
{
  • "cep": "string",
  • "codigo": "string",
  • "complementoEndereco": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataEmissaoACT": "2019-08-24T14:15:22Z",
  • "dataEntrega": "2019-08-24T14:15:22Z",
  • "descricao": "string",
  • "entregaParcial": true,
  • "logradouro": "string",
  • "numeroEndereco": "string",
  • "numeroOrcamento": "string",
  • "observacao": "string",
  • "prazo": {
    },
  • "tipoLogradouro": "string",
  • "uf": "string",
  • "identificadorEntidadeOrigem": "string",
  • "nomeEntidadeOrigem": "string",
  • "codigoEmpresa": "string",
  • "codigoEmpresaFinanceiro": "string",
  • "identificadorBairro": "string",
  • "identificadorCidade": "string",
  • "identificadorFornecedor": "string",
  • "identificadorIndexador": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorTransportador": "string",
  • "identificadorUsuarioLiberacao": "string",
  • "valorAcrescimo": 0.1,
  • "valorDesconto": 0.1,
  • "valorFrete": 0.1,
  • "valorSeguro": 0.1,
  • "valorOutrasDespesas": 0.1,
  • "valorACT": 0.1,
  • "conhecimentoTransporte": {
    },
  • "tipoFrete": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar um pedido de compra por seu identificador

Realizar a busca de um pedido de compra pelo identificador informado

Authorizations:
Bearer
path Parameters
identificadorPedido
required
string

O identificador do pedido de compra.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Editar um pedido de compra por identificador, considerando para cada item o pagamento que foi informado no "TipoCadastro"

Editar um pedido de compra por identificador, considerando nos itens e pagamentos o que foi informado no campo "TipoCadastro"
Valores do Tipo Cadastro:
A - Alteração
E - Exclusão
I - Inclusão

Authorizations:
Bearer
path Parameters
identificadorPedido
required
string

O identificador do pedido a ser alterado.
Exemplo: 00A0000001

Request Body schema:

O contrato do pedido de compra a ser alterado.

cep
string or null

CEP.
Exemplo: 12345-678

codigo
string or null

Codigo do pedido de compra.
Exemplo: 00A0000001

complementoEndereco
string or null

Complemento do endereco.
Exemplo: Apto 101

dataEmissao
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2024-01-31T13:45:00

dataEmissaoACT
string <date-time>

Obtém ou define a data de emissao do aviso de conhecimento do transporte.
Exemplo: 2024-01-31T13:45:00

dataEntrega
string <date-time>

Obtém ou define a data da entrega.
Exemplo: 2024-01-31T13:45:00

descricao
string or null

Obtém ou define a descricao.
Exemplo: Descrição do pedido de compra

entregaParcial
boolean

Obtém ou define se o pedido de compra terá entrega parcial.
Exemplo: true

logradouro
string or null

Logradouro.
Exemplo: Rua das Flores

numeroEndereco
string or null

Numero do endereco.
Exemplo: 1234

numeroOrcamento
string or null

Numero de orçamento.
Exemplo: ORC-2024-001

observacao
string or null

Obtém ou define a observacao.
Exemplo: Observações adicionais sobre o pedido de compra

object (PrazoContrato)

Contrato do prazo.

tipoLogradouro
string or null

Tipo do logradouro.
Exemplo: Rua, Avenida

uf
string or null

Obtém ou define a UF.
Exemplo: SP

identificadorEntidadeOrigem
string or null

Identificador da entidade de origem.
Exemplo: 00A0000001

nomeEntidadeOrigem
string or null

Entidade de Origem.
Exemplo: Fornecedor XYZ

codigoEmpresa
string or null

Codigo da empresa.
Exemplo: 00A0000001

codigoEmpresaFinanceiro
string or null

Codigo da empresa financeiro.
Exemplo: 00A0000002

identificadorBairro
string or null

Identificador do bairro.
Exemplo: 00A0000003

identificadorCidade
string or null

Identificador da cidade.
Exemplo: 00A0000004

identificadorFornecedor
string or null

Identificador da pessoa fornecedora.
Exemplo: 00A0000005

identificadorIndexador
string or null

Identificador do indexador.
Exemplo: 00A0000006

identificadorNaturezaLancamento
string or null

Identificador da natureza de lancamento.
Exemplo: 00A0000007

identificadorTransportador
string or null

Identificador da pessoa transportadora.
Exemplo: 00A0000008

identificadorUsuarioLiberacao
string or null

Identificador do usuario responsavel pela liberacao.
Exemplo: 00A0000001

valorAcrescimo
number <double>

Valor do acrescimo.
Exemplo: 100.50

valorDesconto
number <double>

Valor do desconto.
Exemplo: 50.00

valorFrete
number <double>

Valor do frete.
Exemplo: 20.00

valorSeguro
number <double>

Valor do seguro.
Exemplo: 15.00

valorOutrasDespesas
number <double>

Valor de outras despesas.
Exemplo: 5.00

valorACT
number <double>

Valor do aviso de conhecimento de transporte.
Exemplo: 30.00

object (PedidoDeCompraPagamentoTransporteCadastroContratoPedidoDeCompraConhecimentoTransporteContrato)

Contrato do conhecimento de transporte.

tipoFrete
string or null

Tipo de frete do pedido de compra.
Exemplo: D: Frete por conta do destinatário, E: Frete por conta do emitente, T: Frete por conta de terceiros, N: Sem frete; Caso seja omitido, será considerado como Sem frete ("N").

status
string or null

Status do pedido de compra.
Exemplo: A: Aberto, G: Aguardando; Caso seja omitido, será considerado como Aberto ("A").

Responses

Request samples

Content type
{
  • "cep": "string",
  • "codigo": "string",
  • "complementoEndereco": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataEmissaoACT": "2019-08-24T14:15:22Z",
  • "dataEntrega": "2019-08-24T14:15:22Z",
  • "descricao": "string",
  • "entregaParcial": true,
  • "logradouro": "string",
  • "numeroEndereco": "string",
  • "numeroOrcamento": "string",
  • "observacao": "string",
  • "prazo": {
    },
  • "tipoLogradouro": "string",
  • "uf": "string",
  • "identificadorEntidadeOrigem": "string",
  • "nomeEntidadeOrigem": "string",
  • "codigoEmpresa": "string",
  • "codigoEmpresaFinanceiro": "string",
  • "identificadorBairro": "string",
  • "identificadorCidade": "string",
  • "identificadorFornecedor": "string",
  • "identificadorIndexador": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorTransportador": "string",
  • "identificadorUsuarioLiberacao": "string",
  • "valorAcrescimo": 0.1,
  • "valorDesconto": 0.1,
  • "valorFrete": 0.1,
  • "valorSeguro": 0.1,
  • "valorOutrasDespesas": 0.1,
  • "valorACT": 0.1,
  • "conhecimentoTransporte": {
    },
  • "tipoFrete": "string",
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Deletar um pedido de compra por identificador

Realizar a exclusão de um pedido de compra pelo identificador informado

Authorizations:
Bearer
path Parameters
identificadorPedido
required
string

Identificador do pedido de compra
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o(s) pedido(s) de compra de acordo com o STATUS informado

Consultar os pedidos de compra de acordo com o status, filtrar também o código da empresa, o identificador do fornecedor e a data de emissão

Authorizations:
Bearer
path Parameters
codigoEmpresa
required
string

O código da empresa cadastrada.
Exemplo: 01

query Parameters
identificadorFornecedor
string

O identificador do fornecedor.
Exemplo: 00A0000002

status
string

O status do pedido de compra.
Exemplos de status:
Aberto A
Em digitacao D
Aguardando G
Cancelado C
Atend. C/Corte X
Parcialmente atendido P
Atendido T
Confirmado F
Encerrado R

dataInicialEmissao
string <date-time>

A data inicial de emissão do pedido de compra.
Exemplo: 2023-01-01

dataFinalEmissao
string <date-time>

A data final de emissão do pedido de compra.
Exemplo: 2023-12-31

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Requisição de materiais

Cadastrar uma requisição de material

Realizar o cadastro de uma nova requisição de material no sistema.

Authorizations:
Bearer
Request Body schema:

A requisição de material que deverá ser adicionada.

codigoEmpresa
integer <int32>

Código da empresa.
Exemplo: 1

data
string <date-time>

Obtém ou define a data da requisição de materiais.
Exemplo: 2020-06-12T16:52:57.315Z

identificadorCentroDeCusto
string or null

Identificador do centro de custos.
Exemplo: 00A0000001

identificadorSetorRequisitado
string or null

Identificador do setor requisitante.
Exemplo: 00A0000002

identificadorSetorRequisitante
string or null

Identificador do setor requisitante.
Exemplo: 00A0000002

Array of objects or null (RequisicaoMaterialItemCadastroContrato)

Obtém ou define os itens da requisição.

numeroOrdemProducao
string or null

Número da ordem de produção.
Exemplo: 12345

observacao
string or null

Obtém ou define a observação.
Exemplo: Material necessário para o projeto X

prioridade
integer <int32>

Obtém ou define a prioridade.
Exemplo: 1

tipo
string or null

Tipo da requisição.
Exemplo:
Valores permitidos: R - Requisicao, C - RequisicaoConsumo, D - Devolucao, P - Perda, S - Reposicao, T - Transferencia

urgente
boolean

Obtém ou define um valor que indica se a requisição de material é urgente.
Exemplo: true

Responses

Request samples

Content type
{
  • "codigoEmpresa": 0,
  • "data": "2019-08-24T14:15:22Z",
  • "identificadorCentroDeCusto": "string",
  • "identificadorSetorRequisitado": "string",
  • "identificadorSetorRequisitante": "string",
  • "itens": [
    ],
  • "numeroOrdemProducao": "string",
  • "observacao": "string",
  • "prioridade": 0,
  • "tipo": "string",
  • "urgente": true
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os dados da requisição de materiais por identificador

Realizar a busca dos dados da requisição de materiais pelo identificador informado

Authorizations:
Bearer
path Parameters
identificadorRequisicao
required
string

O identificador da requisicao que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os itens da requisição de materiais por identificador

Realizar a busca dos itens da requisição de materiais pelo identificador informado

Authorizations:
Bearer
path Parameters
identificadorRequisicao
required
string

O identificador da requisicao que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todas as baixas efetuadas para a requisição de materiais por identificador

Realizar a busca de todas as baixas efetuadas para a requisição de materiais pelo identificador informado

Authorizations:
Bearer
path Parameters
identificadorRequisicao
required
string

O identificador da requisicao que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os dados da baixa de itens da requisição de materiais por identificador do item da requisição

Realizar a busca dos dados da baixa de itens da requisição de materiais pelo identificador do item da requisição informado

Authorizations:
Bearer
path Parameters
identificadorRequisicao
required
string

O identificador da requisicao que se deseja consultar.
Exemplo: 00A0000001

identificadorRequisicaoItem
required
string

O identificador do item da requisicao que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Setor

Consultar todos os setores

Realizar a busca de todos os setores cadastrados no sistema

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar por identificador

Realizar a busca do setor pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do setor.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Pedido de venda

Adicionar um pedido de venda

Adiciona um novo pedido de venda.

Authorizations:
Bearer
Request Body schema:

O pedido de venda que deve ser adicionado.

identificador
string or null

Identiificador do pedido. Em caso de uma inclusão de pedido este campo deve ser omitido.

codigo
string or null

Código único do pedido. Em caso de inclusão, se omitido, este valor será gerado automaticamente de acordo com as configurações do sistema.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

codigoEmpresa
required
integer <int32>

Código da empresa emitente do pedido.

codigoEmpresaEstoque
integer or null <int32>

Código da empresa para o estoque.

codigoEmpresaFinanceiro
integer or null <int32>

Código da empresa para o financeiro.

codigoEnderecoCobranca
string or null

Código do endereço de cobrança do pedido de venda. Este é o código do endereço dentro do cadastro do cliente. Caso seja omitido, será informado por padrão o endereço principal do cliente.

codigoEnderecoEntrega
string or null

Código do endereço de entrega do pedido de venda. Este é o código do endereço dentro do cadastro do cliente. Caso seja omitido, será informado por padrão o endereço principal do cliente.

codigoPedidoDeCompraCliente
string or null

Código do pedido de compra do cliente.

dataEmissao
required
string <date-time>

Data de emissão do pedido.

dataEntrada
string <date-time>

Data de entrada.

dataEntrega
string <date-time>

Data prevista de entrega do pedido.

dataCotacaoIndexador
string <date-time>

Data da cotação do indexador.

dataReferenciaPagamento
string <date-time>

Data de referência do pagamento.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

faturamentoParcial
boolean

O status do faturamento é parcial.

identificadorCliente
required
string or null

Identificador do cliente.

identificadoresMensagens
Array of strings or null <= 4 items

Lista de mensagens definidas para o pedido (No máximo 4 mensagens).

identificadorIndexador
string or null

Identificador do indexador.

identificadorMeioContato
string or null

Identificador do meio de contato que foi utilizado para a geração do pedido.

identificadorOperacao
required
string or null

Operação fiscal utilizada por este pedido.

identificadorOperacaoOE
required
string or null

Operação de ordem de entrega utilizada por este pedido.

identificadorSetor
string or null

Identificador setor de saída das mercadorias.

identificadorTransportador
string or null

Identificador do transportador.

identificadorPreco
string or null

Identificador do preço.

Array of objects or null (PedidoDeVendaItemCadastroContrato)

Lista de itens do pedido.

nomePessoaContato
string or null

Nome da pessoa de contato com a qual se realizou o pedido. No caso de uma empresa, o pedido é gerado com a empresa como cliente, mas o mesmo é negociado com uma pessoa de contato.

observacao
string or null

Observação para o pedido.

observacaoDocumento
string or null

Observação do documento para o pedido.

Array of objects or null (PedidoDeVendaPagamentoCadastroContrato)

Lista de pagamentos do pedido.

object (PrazoContrato)

Contrato do prazo.

status
string or null

Status do pedido de venda.
Valores aceitos:
"A": Aguardando liberação,
"L": Liberado,
"C": Cancelado,
"X": Atendido com corte,
"P": Parcialmente atendido,
"T": Atendido totalmente,
"D": Devolvido,
"R": Parcialmente devolvido; Caso seja omitido, será considerado como Aguardando liberação ("A").

tipoFrete
string or null

Tipo de frete do pedido de venda.
Valores aceitos:
"D": Frete por conta do destinatário,
"E": Frete por conta do emitente,
"T": Frete por conta de terceiros,
"N": Sem frete; Caso seja omitido, será considerado como Sem frete ("N").

indicadorAtendimentoPresencial
string or null

Informação de indicação de presença.
(1) - Operação presencial.
(2) - Operação não presencial, pela internet.
(3) - Operação não presencial, teleatendimento.
(5) - Operação presencial, fora do estabelecimento.
(9) - Operação não presencial, outros.

object (PedidoDeVendaTransportadoraContrato)

The transportadora contrato.

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "acrescimo": {
    },
  • "codigoEmpresa": 0,
  • "codigoEmpresaEstoque": 0,
  • "codigoEmpresaFinanceiro": 0,
  • "codigoEnderecoCobranca": "string",
  • "codigoEnderecoEntrega": "string",
  • "codigoPedidoDeCompraCliente": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataEntrada": "2019-08-24T14:15:22Z",
  • "dataEntrega": "2019-08-24T14:15:22Z",
  • "dataCotacaoIndexador": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "desconto": {
    },
  • "faturamentoParcial": true,
  • "identificadorCliente": "string",
  • "identificadoresMensagens": [
    ],
  • "identificadorIndexador": "string",
  • "identificadorMeioContato": "string",
  • "identificadorOperacao": "string",
  • "identificadorOperacaoOE": "string",
  • "identificadorSetor": "string",
  • "identificadorTransportador": "string",
  • "identificadorPreco": "string",
  • "itens": [
    ],
  • "nomePessoaContato": "string",
  • "observacao": "string",
  • "observacaoDocumento": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "status": "string",
  • "tipoFrete": "string",
  • "indicadorAtendimentoPresencial": "string",
  • "transportadora": {
    }
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Baixar um pedido de venda

Realiza a baixa de um pedido de venda totalmente ou parcialmente, gerando um documento no Faturamento.

Authorizations:
Bearer
path Parameters
identificadorPedidoDeVenda
required
string

O identificador do pedido de venda.

Request Body schema:

O contrato de baixa do pedido (os itens não são obrigatórios em caso de baixa total).

criaDocumentoProntoParaSerLiberado
boolean

Define se o documento deve ser criado pronto para ser liberado.

Array of objects or null (PedidoDeVendaBaixaItemContrato)

Itens a serem baixados

statusNotaFiscalEletronica
string or null

Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro

Responses

Request samples

Content type
{
  • "criaDocumentoProntoParaSerLiberado": true,
  • "itens": [
    ],
  • "statusNotaFiscalEletronica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todos os pedidos de venda usando o status

Realiza uma consulta paginada nos pedidos de venda pelo status. Permite filtrar por empresa, cliente, código do pedido de venda, código do pedido de compra do cliente e data de emissão.

Status do pedido de venda:
A - Aberto
L - Liberado
P - Parcialmente Atendimento
T - Totalmente Atendido
X - Atendido com Corte
C - Cancelado

Authorizations:
Bearer
query Parameters
empresa
integer <int32>

O código da empresa que será utilizado na consulta.

cliente
string

O identificador do cliente que será usado na consulta.

pedidoDeVenda
string

O código do pedido de venda.

pedidoDeCompraCliente
string

O código do pedido de compra do cliente.

status
required
string

O status do pedido de venda.

emissaoInicial
string <date-time>

A data de emissão inicial.

emissaoFinal
string <date-time>

A data de emissão final.

limite
required
integer <int32>

Define a quantidade de registros que serão apresentados.

pagina
required
integer <int32>

Define o índice da página que será apresentada.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ],
  • "paginacao": {
    }
}

Obter um pedido de venda pelo seu identificador

Obtém um pedido de venda pelo seu identificador.

Authorizations:
Bearer
path Parameters
identificadorPedidoDeVenda
required
string

O identificador do pedido de venda.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Agência

Consulta uma agência por seu identificador

Consultar uma agência cadastrada no Bimer por seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da agência.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta uma agência por seu banco e número

Consultar uma agência cadastrada no Bimer utilizando como parâmetros o número da agência e o identificador do banco.

Authorizations:
Bearer
query Parameters
identificadorBanco
string

O identificador do banco (Febraban).
Exemplo: 353

numeroAgencia
string

O número da agência.
Exemplo: 3334

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Banco

Obtém um banco através de seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do banco (Código Febraban).

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Boleto

Obtém um boleto bancário através do título a receber.

Authorizations:
Bearer
path Parameters
identificadorTitulo
required
string

O identificador do título a receber

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Centro de custo

Obtém todos os centros de custo cadastrados.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Deleta um lançamento de centro de custo.

Authorizations:
Bearer
path Parameters
identificador
required
string

Identificador do lançamento de centro de custo

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Conta bancária

Obtém todas as contas bancárias cadastradas.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma conta bancária por identificador.

Observação: O identificador é composto por 10 caracteres.
Exemplo de utilização:

http://localhost:8085/api/contas-bancarias/00100001F1
Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da conta bancária.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os saldos das contas bancárias por código da empresa

Authorizations:
Bearer
path Parameters
codigoEmpresa
required
integer <int32>

O código da empresa para consulta

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Conta corrente

Adiciona um novo lançamento no conta corrente.

Authorizations:
Bearer
Request Body schema:

O contrato com o lançamento no conta corrente.

aliquotaMovimento
number <double>

Obtém ou define a alíquota do movimento

dataLiberacao
string <date-time>

Obtém ou define a data de liberacao.

dataMovimento
string <date-time>

Obtém ou define a data do movimento

codigoEmpresa
integer <int32>

Obtém ou define a empresa.

historico
string or null

Histórico da conta corrente

lancamentoCompoeFatura
boolean

Obtém ou define se será lançamento compõe a fatura.

lancamentoCompoeIRRF
boolean

Obtém ou define se o lançamento compõe o IRRF.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lancamento.

identificadorPessoa
string or null

Identificador da pessoa da conta corrente

valorBaseMovimento
number <double>

Valor da Base do movimento

valorMovimento
number <double>

Valor do movimento

Responses

Request samples

Content type
{
  • "aliquotaMovimento": 0.1,
  • "dataLiberacao": "2019-08-24T14:15:22Z",
  • "dataMovimento": "2019-08-24T14:15:22Z",
  • "codigoEmpresa": 0,
  • "historico": "string",
  • "lancamentoCompoeFatura": true,
  • "lancamentoCompoeIRRF": true,
  • "identificadorNaturezaLancamento": "string",
  • "identificadorPessoa": "string",
  • "valorBaseMovimento": 0.1,
  • "valorMovimento": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Forma pagamento

Obtém todas as formas de pagamento cadastradas.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma forma de pagamento por seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da forma de pagamento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

HistoricoCarteira

Consulta o histórico de carteira por identificador do titulo a receber.

No campo BoletoBancario será retornado um link do boleto bancário em pdf. Possíveis causas para não gerar boleto bancário:

  • Título não possui histórico de carteira.
  • Histórico de carteira do título não possui conta bancária.
  • Banco não possui layout HTML de boleto.
Authorizations:
Bearer
path Parameters
identificadorAReceber
required
string = 10 characters

O identificador do titulo a receber.

query Parameters
historicoValido
boolean
Default: true

O histórico de carteira válido

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Modalidade pagamento

Consulta todas as modalidades de pagamento cadastradas.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta uma modalidade de pagamento por identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

Identificador da modalidade de pagamento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Movimento de cobrança

Obtém um movimento de cobrança por identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do movimento de cobrança.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um movimento de cobrança.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do movimento de cobrança a ser editado.

Request Body schema:

O movimento de cobrança a ser editado.

codigoContrato
string or null

Código do contrato.

identificador
string or null

Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido.

Array of objects or null (MovimentoCobrancaPagamentoContrato)

Obtém ou define os pagamentos do movimento de cobrança

aglutinaCobrancaEmTitulo
boolean

Obtém ou define um valor que indica se aglutina a cobrança em título.

cobraTaxaBancaria
boolean

Obtém ou define um valor que indica se deverá ser cobrada taxa bancária.

codigoEmpresa
string or null

Obtém ou define a empresa.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

codigoEnderecoEntrega
string or null

Endereço de entrega.

contratoLiberado
boolean

Obtém ou define um valor que indica se o contrato está liberado.

destino
string or null

Destino da cobrança. "N": Nota fiscal, "R": Títulos a receber.

diaVencimento
integer <int32>

Dia do vencimento.

dataVencimento
string or null <date-time>

Obtém ou define a data do vencimento.

identificadorFormaPagamento
string or null

Obtém ou define a forma de pagamento do movimento.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do movimento.

identificadorOperacaoNotaFiscal
string or null

Obtém ou define a operação da nota fiscal que poderá ser gerada pelo movimento caso o destino do mesmo seja nota fiscal.

identificadorTipoCobranca
string or null

Tipo de cobrança do movimento.

Array of objects or null (MovimentoCobrancaItemCadastroContrato)

Obtém ou define os itens do movimento.

numeroContrato
string or null

Número do contrato.

identificadorResponsavelFinanceiro
string or null

Identificador da responsável pelo financeiro.

dataFimVigenciaContrato
string or null <date-time>

Obtém ou define a data de fim de vigência do contrato.

dataInicialVigenciaContrato
string or null <date-time>

Obtém ou define a data de início de vigência do contrato.

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.

identificadorPrazo
string or null

Identificador do prazo.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

aliquotaRepasseRepresentantePrincipal
number <double>

Obtém ou define a aliquota de repasse para o representante principal

Responses

Request samples

Content type
{
  • "codigoContrato": "string",
  • "identificador": "string",
  • "pagamentos": [
    ],
  • "aglutinaCobrancaEmTitulo": true,
  • "cobraTaxaBancaria": true,
  • "codigoEmpresa": "string",
  • "codigoEnderecoCobranca": "string",
  • "codigoEnderecoEntrega": "string",
  • "contratoLiberado": true,
  • "destino": "string",
  • "diaVencimento": 0,
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "identificadorFormaPagamento": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorOperacaoNotaFiscal": "string",
  • "identificadorTipoCobranca": "string",
  • "itens": [
    ],
  • "numeroContrato": "string",
  • "identificadorResponsavelFinanceiro": "string",
  • "dataFimVigenciaContrato": "2019-08-24T14:15:22Z",
  • "dataInicialVigenciaContrato": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorPrazo": "string",
  • "acrescimo": {
    },
  • "desconto": {
    },
  • "aliquotaRepasseRepresentantePrincipal": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém a lista de movimentos de cobrança de uma pessoa com um determinado produto.

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

O identificador da pessoa.

identificadorProduto
string

O identificador do produto.

tipoMovimento
string

O tipo do movimento para filtro: "F" - Fixo; "V" - Variável; "P" - Prazo

considerarInativos
boolean

Valor que indica se os movimentos inativos devem ser considerados na consulta.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um movimento de cobrança.

Authorizations:
Bearer
query Parameters
incluirComposicaoPadrao
boolean
Default: false

Indica se os itens do movimento devem ter toda sua composição padrão inserida.

Request Body schema:

O movimento de cobrança que será adicionado.

codigoContrato
string or null

Código do contrato.

identificador
string or null

Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido.

Array of objects or null (MovimentoCobrancaPagamentoContrato)

Obtém ou define os pagamentos do movimento de cobrança

aglutinaCobrancaEmTitulo
boolean

Obtém ou define um valor que indica se aglutina a cobrança em título.

cobraTaxaBancaria
boolean

Obtém ou define um valor que indica se deverá ser cobrada taxa bancária.

codigoEmpresa
string or null

Obtém ou define a empresa.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

codigoEnderecoEntrega
string or null

Endereço de entrega.

contratoLiberado
boolean

Obtém ou define um valor que indica se o contrato está liberado.

destino
string or null

Destino da cobrança. "N": Nota fiscal, "R": Títulos a receber.

diaVencimento
integer <int32>

Dia do vencimento.

dataVencimento
string or null <date-time>

Obtém ou define a data do vencimento.

identificadorFormaPagamento
string or null

Obtém ou define a forma de pagamento do movimento.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do movimento.

identificadorOperacaoNotaFiscal
string or null

Obtém ou define a operação da nota fiscal que poderá ser gerada pelo movimento caso o destino do mesmo seja nota fiscal.

identificadorTipoCobranca
string or null

Tipo de cobrança do movimento.

Array of objects or null (MovimentoCobrancaItemCadastroContrato)

Obtém ou define os itens do movimento.

numeroContrato
string or null

Número do contrato.

identificadorResponsavelFinanceiro
string or null

Identificador da responsável pelo financeiro.

dataFimVigenciaContrato
string or null <date-time>

Obtém ou define a data de fim de vigência do contrato.

dataInicialVigenciaContrato
string or null <date-time>

Obtém ou define a data de início de vigência do contrato.

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.

identificadorPrazo
string or null

Identificador do prazo.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

object (AcrescimoDescontoContrato)

Contrato de desconto ou acréscimo.

aliquotaRepasseRepresentantePrincipal
number <double>

Obtém ou define a aliquota de repasse para o representante principal

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do movimento.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do movimento.

identificadorCliente
string or null

Define o cliente.

identificadorTipoMovimentoCobranca
string or null

Identificador do tipo de movimento de cobrança. Este movimento será utilizado para alimentar os itens do movimento de cobrança que não tenham o tipo de movimento de cobrança informado.

tipoMovimento
string or null

Tipo de movimento. "F": Fixo, "V": Variável, "P": Prazo;

Responses

Request samples

Content type
{
  • "codigoContrato": "string",
  • "identificador": "string",
  • "pagamentos": [
    ],
  • "aglutinaCobrancaEmTitulo": true,
  • "cobraTaxaBancaria": true,
  • "codigoEmpresa": "string",
  • "codigoEnderecoCobranca": "string",
  • "codigoEnderecoEntrega": "string",
  • "contratoLiberado": true,
  • "destino": "string",
  • "diaVencimento": 0,
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "identificadorFormaPagamento": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorOperacaoNotaFiscal": "string",
  • "identificadorTipoCobranca": "string",
  • "itens": [
    ],
  • "numeroContrato": "string",
  • "identificadorResponsavelFinanceiro": "string",
  • "dataFimVigenciaContrato": "2019-08-24T14:15:22Z",
  • "dataInicialVigenciaContrato": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorPrazo": "string",
  • "acrescimo": {
    },
  • "desconto": {
    },
  • "aliquotaRepasseRepresentantePrincipal": 0.1,
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "identificadorCliente": "string",
  • "identificadorTipoMovimentoCobranca": "string",
  • "tipoMovimento": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os contratos do cliente assim como seus respectivos vencimentos.

Exemplo de utilização do endpoint:

http://localhost:8085/api/financeiro/movimentoCobranca/outros-contratos/00100025C3

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador do cliente.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém a lista de movimentos de cobrança completa de uma pessoa com um determinado produto.

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

O identificador da pessoa.

identificadorProduto
string

O identificador do produto.

tipoMovimento
string

O tipo do movimento para filtro: "F" - Fixo; "V" - Variável; "P" - Prazo

considerarInativos
boolean

Valor que indica se os movimentos inativos devem ser considerados na consulta.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um item no movimento de cobrança

Authorizations:
Bearer
path Parameters
identificadorMovimentoCobranca
required
string
Request Body schema:
ativo
boolean

Valor que indica se o item está ativo.

dataInicioUtilizacao
string or null <date-time>

Obtém ou define a data do início da utilização.

dataFinalCarencia
string or null <date-time>

Obtém ou define a data final da carência.

dataInicialReajuste
string or null <date-time>

Obtém ou define a data inicial para reajuste.

dataUltimoReajuste
string or null <date-time>

Data em que o item foi reajustado pela última vez.

dataValidoAPartir
string or null <date-time>

Obtém ou define a data de validade a partir.

dataValidoAte
string or null <date-time>

Obtém ou define a data de validade.

doacao
boolean

Obtém ou define um valor que indica se o item do movimento é uma doação.

identificador
string or null

Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido.

mesesGeracaoDestinoMovimentoCobranca
Array of strings or null

Obtém ou define os meses de geração do destino de movimento de cobrança. Os meses devem ser informados com suas siglas;

motivoDoacao
string or null

Motivo da doação.

observacao
string or null

Obtém ou define a observação do item.

periodoReajusteMovimentoCobranca
string or null

Período de reajuste do item do movimento de cobrança. "ANO", "SEMESTRE", "TRIMESTRE", "BIMESTRE", "MES", "DIA";

valor
number <double>

Valor do item.

Array of objects or null (MovimentoCobrancaItemRepasseContrato)

Obtém ou define os repasses do item

Array of objects or null (MovimentoCobrancaItemComplementoContrato)

Informações complementares do item.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do item.

identificadorIndexador
string or null

Indexador do item do movimento de cobrança.

identificadorMotivoCancelamento
string or null

Identificador do motivo de cancelamento/devolução do item do movimento de cobrança.

identificadorProduto
string or null

Produto do item.

identificadorProdutoVinculado
string or null

Identificador do produto do item vinculado

identificadorStatusProduto
string or null

Status do produto.

identificadorTipoMovimentoCobranca
string or null

Tipo do movimento de cobrança.

Responses

Request samples

Content type
{
  • "ativo": true,
  • "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
  • "dataFinalCarencia": "2019-08-24T14:15:22Z",
  • "dataInicialReajuste": "2019-08-24T14:15:22Z",
  • "dataUltimoReajuste": "2019-08-24T14:15:22Z",
  • "dataValidoAPartir": "2019-08-24T14:15:22Z",
  • "dataValidoAte": "2019-08-24T14:15:22Z",
  • "doacao": true,
  • "identificador": "string",
  • "mesesGeracaoDestinoMovimentoCobranca": [
    ],
  • "motivoDoacao": "string",
  • "observacao": "string",
  • "periodoReajusteMovimentoCobranca": "string",
  • "valor": 0.1,
  • "repasses": [
    ],
  • "informacoesComplementares": [
    ],
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "identificadorIndexador": "string",
  • "identificadorMotivoCancelamento": "string",
  • "identificadorProduto": "string",
  • "identificadorProdutoVinculado": "string",
  • "identificadorStatusProduto": "string",
  • "identificadorTipoMovimentoCobranca": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um item de movimento de combrança

Authorizations:
Bearer
path Parameters
identificadorMovimentoCobranca
required
string
identificadorMovimentoItem
required
string
Request Body schema:
ativo
boolean

Valor que indica se o item está ativo.

dataInicioUtilizacao
string or null <date-time>

Obtém ou define a data do início da utilização.

dataFinalCarencia
string or null <date-time>

Obtém ou define a data final da carência.

dataInicialReajuste
string or null <date-time>

Obtém ou define a data inicial para reajuste.

dataUltimoReajuste
string or null <date-time>

Data em que o item foi reajustado pela última vez.

dataValidoAPartir
string or null <date-time>

Obtém ou define a data de validade a partir.

dataValidoAte
string or null <date-time>

Obtém ou define a data de validade.

doacao
boolean

Obtém ou define um valor que indica se o item do movimento é uma doação.

identificador
string or null

Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido.

mesesGeracaoDestinoMovimentoCobranca
Array of strings or null

Obtém ou define os meses de geração do destino de movimento de cobrança. Os meses devem ser informados com suas siglas;

motivoDoacao
string or null

Motivo da doação.

observacao
string or null

Obtém ou define a observação do item.

periodoReajusteMovimentoCobranca
string or null

Período de reajuste do item do movimento de cobrança. "ANO", "SEMESTRE", "TRIMESTRE", "BIMESTRE", "MES", "DIA";

valor
number <double>

Valor do item.

Array of objects or null (MovimentoCobrancaItemRepasseContrato)

Obtém ou define os repasses do item

Array of objects or null (MovimentoCobrancaItemComplementoContrato)

Informações complementares do item.

identificadorStatusProduto
string or null

Identificador do status do produto.

identificadorTipoMovimentoCobranca
string or null

Identificador do tipo do movimento de cobrança.

identificadorProdutoVinculado
string or null

Identificador do produto do item vinculado

identificadorIndexador
string or null

Identificador do indexador do item do movimento de cobrança.

identificadorMotivoCancelamento
string or null

Identificador do motivo de cancelamento/devolução do item do movimento de cobrança.

identificadorAtendimentoVinculadoCancelamento
string or null

Identificador do atendimento vinculado ao motivo de cancelamento/devolução do item do movimento de cobrança.

tipoProdutoMotivoCancelamento
string or null

Tipo de produto relacionado ao motivo de cancelamento/devolução do item do movimento de cobrança (Produto/Todos/NaoInformado).

identificadorProdutoMotivoCancelamento
string or null

Identificador do produto relacionaldo ao motivo de cancelamento/devolução do item do movimento de cobrança quando o tipo é Produto.

Responses

Request samples

Content type
{
  • "ativo": true,
  • "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
  • "dataFinalCarencia": "2019-08-24T14:15:22Z",
  • "dataInicialReajuste": "2019-08-24T14:15:22Z",
  • "dataUltimoReajuste": "2019-08-24T14:15:22Z",
  • "dataValidoAPartir": "2019-08-24T14:15:22Z",
  • "dataValidoAte": "2019-08-24T14:15:22Z",
  • "doacao": true,
  • "identificador": "string",
  • "mesesGeracaoDestinoMovimentoCobranca": [
    ],
  • "motivoDoacao": "string",
  • "observacao": "string",
  • "periodoReajusteMovimentoCobranca": "string",
  • "valor": 0.1,
  • "repasses": [
    ],
  • "informacoesComplementares": [
    ],
  • "identificadorStatusProduto": "string",
  • "identificadorTipoMovimentoCobranca": "string",
  • "identificadorProdutoVinculado": "string",
  • "identificadorIndexador": "string",
  • "identificadorMotivoCancelamento": "string",
  • "identificadorAtendimentoVinculadoCancelamento": "string",
  • "tipoProdutoMotivoCancelamento": "string",
  • "identificadorProdutoMotivoCancelamento": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Natureza de lançamento

Obtém uma natureza de lançamento por identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma natureza de lançamento por descrição.

Authorizations:
Bearer
query Parameters
descricao
string
Default: ""

A descrição.

porTrecho
boolean
Default: true

Valor que indica se a consulta será realizada por trecho.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Tipo de baixa

Obtém todos os tipos de baixas cadastrados.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um tipo de baixa cadastrado por seu identificador.

Observação: O identificador é composto por 10 caracteres.
Exemplo de utilização:

http://localhost:8085/api/tipo-baixas/0010000005

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do tipo de baixa.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Tipo de cobrança

Consulta todos os tipos de cobrança.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta por identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do tipo de cobrança.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Título a pagar

Obtém um titulo a pagar pelo identificador

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do titulo a pagar.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um título a pagar pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do titulo a pagar a ser alterado.

Request Body schema:

O titulo com as alterações.

codigoEmpresa
string or null

Código da empresa do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de Vencimento do título.

descricao
string or null

Obtém ou define a descrição (nome) do título.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

identificadorPessoa
string or null

Identificador da pessoa.

numero
string or null

Número do título.

numeroAgenciaBancaria
string or null

Número da agencia bancária de origem do título.

numeroCodigoBarra
string or null

Número do código de barra do título.

numeroContaBancaria
string or null

Número da conta bancária de origem do título.

numeroTituloBanco
string or null

Número do título no banco.

observacao
string or null

Obtém ou define a observação.

previsao
boolean

Valor que indica se este é um título de previsão.

tipoLiquidacao
string or null

Tipo de liquidacao. Valores aceitos: "B": Bloqueto, "C": Concessionária.

dataExclusao
string <date-time>

Obtém ou define a data de exclusao do título.

identificadorBanco
string or null

Identificador do banco.

identificadorCategoriaPessoa
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria fornecedor ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorModalidadePagamento
string or null

Identificador da modalidade de pagamento.

identificadorSituacaoAdministrativa
string or null

O identificador da situação administrativa do título.

versaoRegistro
integer or null <int64>

A versão do registro.

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "descricao": "string",
  • "desmembramentoCOFINS": {
    },
  • "desmembramentoCSLL": {
    },
  • "desmembramentoDesconto": {
    },
  • "desmembramentoINSS": {
    },
  • "desmembramentoIRRF": {
    },
  • "desmembramentoISS": {
    },
  • "desmembramentoJuros": {
    },
  • "desmembramentoMulta": {
    },
  • "desmembramentoOutros": {
    },
  • "desmembramentoPIS": {
    },
  • "desmembramentoPisCofinsCsll": {
    },
  • "identificadorPessoa": "string",
  • "numero": "string",
  • "numeroAgenciaBancaria": "string",
  • "numeroCodigoBarra": "string",
  • "numeroContaBancaria": "string",
  • "numeroTituloBanco": "string",
  • "observacao": "string",
  • "previsao": true,
  • "tipoLiquidacao": "string",
  • "dataExclusao": "2019-08-24T14:15:22Z",
  • "identificadorBanco": "string",
  • "identificadorCategoriaPessoa": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorModalidadePagamento": "string",
  • "identificadorSituacaoAdministrativa": "string",
  • "versaoRegistro": 0
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém ou define a quantidade de titulos a pagar.

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

Identificador da Pessoa.

titulosEmAberto
boolean

Obtém ou define os titulos em aberto.

dataInicialVencimento
string <date-time>

Obtém ou define a data inicial do vencimento.

dataFinalVencimento
string <date-time>

Obtém ou define a data final do vencimento.

dataInicialEmissao
string <date-time>

Obtém ou define a data inicial da emissão.

dataFinalEmissao
string <date-time>

Obtém ou define a data final da emissão.

dataInicialBaixa
string <date-time>

Obtém ou define a data inicial da baixa.

dataFinalBaixa
string <date-time>

Obtém ou define a data final da baixa.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém ou define os titulos a pagar encontrados por pessoa a partir de um filtro de datas.

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

Identificador da Pessoa.

titulosEmAberto
boolean
Default: false

Obtém ou define os titulos em aberto.

dataInicialVencimento
string <date-time>

Obtém ou define a data inicial do vencimento.

dataFinalVencimento
string <date-time>

Obtém ou define a data final do vencimento.

dataInicialEmissao
string <date-time>

Obtém ou define a data inicial da emissão.

dataFinalEmissao
string <date-time>

Obtém ou define a data final da emissão.

dataInicialBaixa
string <date-time>

Obtém ou define a data inicial da baixa.

dataFinalBaixa
string <date-time>

Obtém ou define a data final da baixa.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um novo título a pagar.

Authorizations:
Bearer
Request Body schema:

O título a pagar que deverá ser adicionado.

codigoEmpresa
string or null

Código da empresa do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de Vencimento do título.

descricao
string or null

Obtém ou define a descrição (nome) do título.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoValoresContrato)

The desmembramento valores.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

object (DesmembramentoImpostosContrato)

Contrato do desmembramento de impostos.

identificadorPessoa
string or null

Identificador da pessoa.

numero
string or null

Número do título.

numeroAgenciaBancaria
string or null

Número da agencia bancária de origem do título.

numeroCodigoBarra
string or null

Número do código de barra do título.

numeroContaBancaria
string or null

Número da conta bancária de origem do título.

numeroTituloBanco
string or null

Número do título no banco.

observacao
string or null

Obtém ou define a observação.

previsao
boolean

Valor que indica se este é um título de previsão.

tipoLiquidacao
string or null

Tipo de liquidacao. Valores aceitos: "B": Bloqueto, "C": Concessionária.

dataExclusao
string <date-time>

Obtém ou define a data de exclusao do título.

identificadorBanco
string or null

Identificador do banco.

identificadorCategoriaPessoa
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria fornecedor ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorModalidadePagamento
string or null

Identificador da modalidade de pagamento.

identificadorSituacaoAdministrativa
string or null

O identificador da situação administrativa do título.

versaoRegistro
integer or null <int64>

A versão do registro.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

identificadorNaturezaLancamento
string or null

Identificador da natureza de lançamento do título.

Array of objects or null (APagarItemInclusaoContrato)

Obtém ou define os itens do título a pagar.

valor
number <double>

Valor do título.

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "descricao": "string",
  • "desmembramentoCOFINS": {
    },
  • "desmembramentoCSLL": {
    },
  • "desmembramentoDesconto": {
    },
  • "desmembramentoINSS": {
    },
  • "desmembramentoIRRF": {
    },
  • "desmembramentoISS": {
    },
  • "desmembramentoJuros": {
    },
  • "desmembramentoMulta": {
    },
  • "desmembramentoOutros": {
    },
  • "desmembramentoPIS": {
    },
  • "desmembramentoPisCofinsCsll": {
    },
  • "identificadorPessoa": "string",
  • "numero": "string",
  • "numeroAgenciaBancaria": "string",
  • "numeroCodigoBarra": "string",
  • "numeroContaBancaria": "string",
  • "numeroTituloBanco": "string",
  • "observacao": "string",
  • "previsao": true,
  • "tipoLiquidacao": "string",
  • "dataExclusao": "2019-08-24T14:15:22Z",
  • "identificadorBanco": "string",
  • "identificadorCategoriaPessoa": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorModalidadePagamento": "string",
  • "identificadorSituacaoAdministrativa": "string",
  • "versaoRegistro": 0,
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "identificadorNaturezaLancamento": "string",
  • "itens": [
    ],
  • "valor": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os títulos a pagar por data de cadastro

Authorizations:
Bearer
query Parameters
limite
integer <int32>

Limite de títulos por consulta.

pagina
integer <int32>

Página.

dataCadastroInicial
string <date-time>

Data cadastro inicial.

dataCadastroFinal
string <date-time>

Data cadastro final.

identificadorPessoa
string

Obtém ou define o identificador da Pessoa.

codigoEmpresa
integer <int32>

Obtém ou define o código da empresa.

dataVencimentoInicial
string <date-time>

Data vencimento inicial.

dataVencimentoFinal
string <date-time>

Data vencimento final.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os títulos de uma empresa por status

Authorizations:
Bearer
path Parameters
codigoEmpresa
required
integer <int32>

O código da empresa.

query Parameters
status
integer <int32> (EStatusTitulosAPagar)
Enum: 0 1 2 3

O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos excluídos. 2 = Títulos de previsão.

dataEmissaoInicial
string <date-time>

A data inicial de emissão do filtro.

dataEmissaoFinal
string <date-time>

A data final de emissão do filtro.

limite
integer <int32>
Default: 25

A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25.

pagina
integer <int32>
Default: 1

A página que deseja consultar. Quando não informado, por pardrão será definido 1.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtem os títulos a pagar pelo Identificador Entidade Origem

Authorizations:
Bearer
query Parameters
idEntidadeOrigem
string
Default: ""

O identificador da entidade origem

nomeEntidadeOrigem
string
Default: ""

O nome da entidade origem

limite
integer <int32>
Default: 25

A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25.

pagina
integer <int32>
Default: 1

A página que deseja consultar. Quando não informado, por pardrão será definido 1.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os títulos a pagar por data de cadastro

Authorizations:
Bearer
query Parameters
limite
integer <int32>
Default: 25

Limite de títulos por consulta.

pagina
integer <int32>
Default: 1

Página.

dataCadastroInicial
string <date-time>

Data cadastro inicial.

dataCadastroFinal
string <date-time>

Data cadastro final.

identificadorPessoa
string

Obtém ou define o identificador da Pessoa.

codigoEmpresa
integer <int32>

Obtém ou define o código da empresa.

dataVencimentoInicial
string <date-time>

Data vencimento inicial.

dataVencimentoFinal
string <date-time>

Data vencimento final.

identificadorNaturezaLancamento
string

Identificador da Natureza de Lançamento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cria o lote a pagar e efetua a baixa do mesmo

Authorizations:
Bearer
Request Body schema:

O contrato de LoteAPagarBaixa

identificadorTituloAPagar
string or null

Identificador do título a pagar

identificadorTipoBaixa
string or null

Identificador do tipo de baixa

identificadorFormaPagamento
string or null

Identificador da forma de pagamento

identificadorContaBancaria
string or null

Identificador da conta bancária

valorBaixa
number <double>

Valor de baixa

descricao
string or null

Descrição do lote

observacao
string or null

Observação da baixa

liberacaoAutomatica
boolean

Define se o título será liberado via GE

Responses

Request samples

Content type
{
  • "identificadorTituloAPagar": "string",
  • "identificadorTipoBaixa": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorContaBancaria": "string",
  • "valorBaixa": 0.1,
  • "descricao": "string",
  • "observacao": "string",
  • "liberacaoAutomatica": true
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os títulos de uma empresa por status

Authorizations:
Bearer
query Parameters
versaoRegistro
integer <int64>

A versão do registro.

status
integer <int32> (EStatusTitulosAPagar)
Enum: 0 1 2 3

O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos excluídos. 2 = Títulos de previsão.

codigoEmpresa
integer <int32>
Default: 0

O código da empresa.

limite
integer <int32>
Default: 25

A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25.

pagina
integer <int32>
Default: 1

A página que deseja consultar. Quando não informado, por pardrão será definido 1.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Título a receber

Obtém um tiutlo pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do titulo a receber.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém a quantidade de títulos a receber da pessoa a partir de um filtro.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa.

Request Body schema:

Os parametros de consulta de títulos a receber.

dataFinalBaixa
string or null <date-time>

Obtém ou define a data final baixa.

dataFinalEmissao
string or null <date-time>

Obtém ou define a data final de emissão.

dataFinalVencimento
string or null <date-time>

Obtém ou define a data final de vencimento.

dataInicialBaixa
string or null <date-time>

Obtém ou define a data inicial de baixa.

dataInicialEmissao
string or null <date-time>

Obtém ou define a data inicial de emissão.

dataInicialVencimento
string or null <date-time>

Obtém ou define a data inicial de vencimento.

somenteTitulosEmAberto
boolean

Obtém ou define um valor que indica que os filtros deverão filtrar somente os títulos em aberto deverão consultados.

identificadoresTiposMovimentoCobranca
Array of strings or null

Obtém ou define os identificadores dos tipos de movimento de cobrança para filtro.

Responses

Request samples

Content type
{
  • "dataFinalBaixa": "2019-08-24T14:15:22Z",
  • "dataFinalEmissao": "2019-08-24T14:15:22Z",
  • "dataFinalVencimento": "2019-08-24T14:15:22Z",
  • "dataInicialBaixa": "2019-08-24T14:15:22Z",
  • "dataInicialEmissao": "2019-08-24T14:15:22Z",
  • "dataInicialVencimento": "2019-08-24T14:15:22Z",
  • "somenteTitulosEmAberto": true,
  • "identificadoresTiposMovimentoCobranca": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os títulos a receber da pessoa a partir de um filtro.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa.

Request Body schema:

Os parametros de consulta de títulos a receber.

dataFinalBaixa
string or null <date-time>

Obtém ou define a data final baixa.

dataFinalEmissao
string or null <date-time>

Obtém ou define a data final de emissão.

dataFinalVencimento
string or null <date-time>

Obtém ou define a data final de vencimento.

dataInicialBaixa
string or null <date-time>

Obtém ou define a data inicial de baixa.

dataInicialEmissao
string or null <date-time>

Obtém ou define a data inicial de emissão.

dataInicialVencimento
string or null <date-time>

Obtém ou define a data inicial de vencimento.

somenteTitulosEmAberto
boolean

Obtém ou define um valor que indica que os filtros deverão filtrar somente os títulos em aberto deverão consultados.

identificadoresTiposMovimentoCobranca
Array of strings or null

Obtém ou define os identificadores dos tipos de movimento de cobrança para filtro.

Responses

Request samples

Content type
{
  • "dataFinalBaixa": "2019-08-24T14:15:22Z",
  • "dataFinalEmissao": "2019-08-24T14:15:22Z",
  • "dataFinalVencimento": "2019-08-24T14:15:22Z",
  • "dataInicialBaixa": "2019-08-24T14:15:22Z",
  • "dataInicialEmissao": "2019-08-24T14:15:22Z",
  • "dataInicialVencimento": "2019-08-24T14:15:22Z",
  • "somenteTitulosEmAberto": true,
  • "identificadoresTiposMovimentoCobranca": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um novo título a receber. Deprecated

Authorizations:
Bearer
Request Body schema:

O título a ser adicionado.

agrupamento
string or null

Obtém ou define a descrição do agrupamento.

aliquotaConvenio
number <double>

Valor da aliquota do convênio.

Array of objects or null (LancamentoCentroCustoInclusaoContrato)

Obtém ou define os centros de custo do item.

object (AReceberCheque)

Contrato de cheque a receber.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de vencimento do título.

descricaoTitulo
string or null

Obtém ou define a descrição do título.

object (HistoricoCarteiraContrato)

Classe de contrato de histórico de carteira.

identificadorContaBancaria
string or null

Identificador da conta do banco de cobrança.

numeroParcela
integer <int32>

Número da parcela do título.

numeroTitulo
string or null

Número do título.

numeroTransacao
string or null

Numero da transação.

observacao
string or null

Obtém ou define a observação do título.

previsao
boolean

Obtém ou define um valor que indica se o título é de previsão.

valorTACConvenio
number <double>

Valor do TAC do convenio.

valorTACEmpresa
number <double>

Valor do TAC da empresa.

tituloConciliadoPeloFinConciliare
boolean

Obtém ou define se o título está conciliado no FinConciliare.

codigoEmpresa
string or null

Obtém ou define a empresa do título.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

identificadorAgenciaCobranca
string or null

Obtém ou define a agência do banco de cobrança.

identificadorBancoCobranca
string or null

Identificador do banco.

identificadorCategoria
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do título.

identificadorNaturezaLancamentoConvenio
string or null

Valor do identificador da natureza de lançamento do convênio.

identificadorNaturezaLancamentoTACConvenio
string or null

Valor do identificador da natureza de lançamento TAC do convênio.

identificadorNaturezaLancamentoTACEmpresa
string or null

Valor do identificador da natureza de lançamento TAC da empresa.

identificadorPessoa
string or null

Obtém ou define a pessoa do título.

identificadorSituacaoAdministrativa
string or null

Obtém ou define a situação administrativa do título.

identificadorMotivoExclusao
string or null

Motivo de exclusão do título. (Apenas Para exclusão de um a receber vinculado á documento) Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor"
Ou Para outros tipos de exclusão SELECT * FROM InformacaoGeral WHERE NmCombo 'MotivoExclusao'.
Para cancelar uma exclusão informe "" (vazio) ou omita o campo

object (AReceberConvenioContrato)

Contrato de convênio de títulos a receber.

Array of objects or null (AReceberItemContrato)

Obtém ou define os itens do título a receber.

valorTitulo
number <double>

Valor do título

identificadorContaBancariaBaixa
string or null

Identificador da conta bancária de baixa na inclusão.

Responses

Request samples

Content type
{
  • "agrupamento": "string",
  • "aliquotaConvenio": 0.1,
  • "centrosDeCusto": [
    ],
  • "cheque": {
    },
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "descricaoTitulo": "string",
  • "historicoCarteira": {
    },
  • "identificadorContaBancaria": "string",
  • "numeroParcela": 0,
  • "numeroTitulo": "string",
  • "numeroTransacao": "string",
  • "observacao": "string",
  • "previsao": true,
  • "valorTACConvenio": 0.1,
  • "valorTACEmpresa": 0.1,
  • "tituloConciliadoPeloFinConciliare": true,
  • "codigoEmpresa": "string",
  • "codigoEnderecoCobranca": "string",
  • "identificadorAgenciaCobranca": "string",
  • "identificadorBancoCobranca": "string",
  • "identificadorCategoria": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorNaturezaLancamentoConvenio": "string",
  • "identificadorNaturezaLancamentoTACConvenio": "string",
  • "identificadorNaturezaLancamentoTACEmpresa": "string",
  • "identificadorPessoa": "string",
  • "identificadorSituacaoAdministrativa": "string",
  • "identificadorMotivoExclusao": "string",
  • "convenio": {
    },
  • "itens": [
    ],
  • "valorTitulo": 0.1,
  • "identificadorContaBancariaBaixa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os títulos a receber por empresa, pessoa, data de cadastro e data de vencimento

Authorizations:
Bearer
query Parameters
limite
integer <int32>

Limite de títulos por consulta.

pagina
integer <int32>

Página.

dataCadastroInicial
string <date-time>

Data cadastro inicial.

dataCadastroFinal
string <date-time>

Data cadastro final.

identificadorPessoa
string

Obtém ou define o identificador da Pessoa.

codigoEmpresa
integer <int32>

Obtém ou define o código da empresa.

dataVencimentoInicial
string <date-time>

Data vencimento inicial.

dataVencimentoFinal
string <date-time>

Data vencimento final.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona uma lista de novos títulos a receber. Deprecated

Authorizations:
Bearer
Request Body schema:

Os títulos a serem adicionados.

Array
agrupamento
string or null

Obtém ou define a descrição do agrupamento.

aliquotaConvenio
number <double>

Valor da aliquota do convênio.

Array of objects or null (LancamentoCentroCustoInclusaoContrato)

Obtém ou define os centros de custo do item.

object (AReceberCheque)

Contrato de cheque a receber.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de vencimento do título.

descricaoTitulo
string or null

Obtém ou define a descrição do título.

object (HistoricoCarteiraContrato)

Classe de contrato de histórico de carteira.

identificadorContaBancaria
string or null

Identificador da conta do banco de cobrança.

numeroParcela
integer <int32>

Número da parcela do título.

numeroTitulo
string or null

Número do título.

numeroTransacao
string or null

Numero da transação.

observacao
string or null

Obtém ou define a observação do título.

previsao
boolean

Obtém ou define um valor que indica se o título é de previsão.

valorTACConvenio
number <double>

Valor do TAC do convenio.

valorTACEmpresa
number <double>

Valor do TAC da empresa.

tituloConciliadoPeloFinConciliare
boolean

Obtém ou define se o título está conciliado no FinConciliare.

codigoEmpresa
string or null

Obtém ou define a empresa do título.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

identificadorAgenciaCobranca
string or null

Obtém ou define a agência do banco de cobrança.

identificadorBancoCobranca
string or null

Identificador do banco.

identificadorCategoria
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do título.

identificadorNaturezaLancamentoConvenio
string or null

Valor do identificador da natureza de lançamento do convênio.

identificadorNaturezaLancamentoTACConvenio
string or null

Valor do identificador da natureza de lançamento TAC do convênio.

identificadorNaturezaLancamentoTACEmpresa
string or null

Valor do identificador da natureza de lançamento TAC da empresa.

identificadorPessoa
string or null

Obtém ou define a pessoa do título.

identificadorSituacaoAdministrativa
string or null

Obtém ou define a situação administrativa do título.

identificadorMotivoExclusao
string or null

Motivo de exclusão do título. (Apenas Para exclusão de um a receber vinculado á documento) Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor"
Ou Para outros tipos de exclusão SELECT * FROM InformacaoGeral WHERE NmCombo 'MotivoExclusao'.
Para cancelar uma exclusão informe "" (vazio) ou omita o campo

object (AReceberConvenioContrato)

Contrato de convênio de títulos a receber.

Array of objects or null (AReceberItemContrato)

Obtém ou define os itens do título a receber.

valorTitulo
number <double>

Valor do título

identificadorContaBancariaBaixa
string or null

Identificador da conta bancária de baixa na inclusão.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um novo título a receber.

Authorizations:
Bearer
Request Body schema:

O título a ser adicionado.

agrupamento
string or null

Obtém ou define a descrição do agrupamento.

aliquotaConvenio
number <double>

Valor da aliquota do convênio.

Array of objects or null (LancamentoCentroCustoInclusaoContrato)

Obtém ou define os centros de custo do item.

object (AReceberCheque)

Contrato de cheque a receber.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de vencimento do título.

descricaoTitulo
string or null

Obtém ou define a descrição do título.

object (HistoricoCarteiraContrato)

Classe de contrato de histórico de carteira.

identificadorContaBancaria
string or null

Identificador da conta do banco de cobrança.

numeroParcela
integer <int32>

Número da parcela do título.

numeroTitulo
string or null

Número do título.

numeroTransacao
string or null

Numero da transação.

observacao
string or null

Obtém ou define a observação do título.

previsao
boolean

Obtém ou define um valor que indica se o título é de previsão.

valorTACConvenio
number <double>

Valor do TAC do convenio.

valorTACEmpresa
number <double>

Valor do TAC da empresa.

tituloConciliadoPeloFinConciliare
boolean

Obtém ou define se o título está conciliado no FinConciliare.

codigoEmpresa
string or null

Obtém ou define a empresa do título.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

identificadorAgenciaCobranca
string or null

Obtém ou define a agência do banco de cobrança.

identificadorBancoCobranca
string or null

Identificador do banco.

identificadorCategoria
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do título.

identificadorNaturezaLancamentoConvenio
string or null

Valor do identificador da natureza de lançamento do convênio.

identificadorNaturezaLancamentoTACConvenio
string or null

Valor do identificador da natureza de lançamento TAC do convênio.

identificadorNaturezaLancamentoTACEmpresa
string or null

Valor do identificador da natureza de lançamento TAC da empresa.

identificadorPessoa
string or null

Obtém ou define a pessoa do título.

identificadorSituacaoAdministrativa
string or null

Obtém ou define a situação administrativa do título.

identificadorMotivoExclusao
string or null

Motivo de exclusão do título. (Apenas Para exclusão de um a receber vinculado á documento) Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor"
Ou Para outros tipos de exclusão SELECT * FROM InformacaoGeral WHERE NmCombo 'MotivoExclusao'.
Para cancelar uma exclusão informe "" (vazio) ou omita o campo

object (AReceberConvenioContrato)

Contrato de convênio de títulos a receber.

Array of objects or null (AReceberItemContrato)

Obtém ou define os itens do título a receber.

valorTitulo
number <double>

Valor do título

identificadorContaBancariaBaixa
string or null

Identificador da conta bancária de baixa na inclusão.

Responses

Request samples

Content type
{
  • "agrupamento": "string",
  • "aliquotaConvenio": 0.1,
  • "centrosDeCusto": [
    ],
  • "cheque": {
    },
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "descricaoTitulo": "string",
  • "historicoCarteira": {
    },
  • "identificadorContaBancaria": "string",
  • "numeroParcela": 0,
  • "numeroTitulo": "string",
  • "numeroTransacao": "string",
  • "observacao": "string",
  • "previsao": true,
  • "valorTACConvenio": 0.1,
  • "valorTACEmpresa": 0.1,
  • "tituloConciliadoPeloFinConciliare": true,
  • "codigoEmpresa": "string",
  • "codigoEnderecoCobranca": "string",
  • "identificadorAgenciaCobranca": "string",
  • "identificadorBancoCobranca": "string",
  • "identificadorCategoria": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorNaturezaLancamentoConvenio": "string",
  • "identificadorNaturezaLancamentoTACConvenio": "string",
  • "identificadorNaturezaLancamentoTACEmpresa": "string",
  • "identificadorPessoa": "string",
  • "identificadorSituacaoAdministrativa": "string",
  • "identificadorMotivoExclusao": "string",
  • "convenio": {
    },
  • "itens": [
    ],
  • "valorTitulo": 0.1,
  • "identificadorContaBancariaBaixa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona uma lista de novos títulos a receber.

Authorizations:
Bearer
Request Body schema:

Os títulos a serem adicionados.

Array
agrupamento
string or null

Obtém ou define a descrição do agrupamento.

aliquotaConvenio
number <double>

Valor da aliquota do convênio.

Array of objects or null (LancamentoCentroCustoInclusaoContrato)

Obtém ou define os centros de custo do item.

object (AReceberCheque)

Contrato de cheque a receber.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de vencimento do título.

descricaoTitulo
string or null

Obtém ou define a descrição do título.

object (HistoricoCarteiraContrato)

Classe de contrato de histórico de carteira.

identificadorContaBancaria
string or null

Identificador da conta do banco de cobrança.

numeroParcela
integer <int32>

Número da parcela do título.

numeroTitulo
string or null

Número do título.

numeroTransacao
string or null

Numero da transação.

observacao
string or null

Obtém ou define a observação do título.

previsao
boolean

Obtém ou define um valor que indica se o título é de previsão.

valorTACConvenio
number <double>

Valor do TAC do convenio.

valorTACEmpresa
number <double>

Valor do TAC da empresa.

tituloConciliadoPeloFinConciliare
boolean

Obtém ou define se o título está conciliado no FinConciliare.

codigoEmpresa
string or null

Obtém ou define a empresa do título.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

identificadorAgenciaCobranca
string or null

Obtém ou define a agência do banco de cobrança.

identificadorBancoCobranca
string or null

Identificador do banco.

identificadorCategoria
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do título.

identificadorNaturezaLancamentoConvenio
string or null

Valor do identificador da natureza de lançamento do convênio.

identificadorNaturezaLancamentoTACConvenio
string or null

Valor do identificador da natureza de lançamento TAC do convênio.

identificadorNaturezaLancamentoTACEmpresa
string or null

Valor do identificador da natureza de lançamento TAC da empresa.

identificadorPessoa
string or null

Obtém ou define a pessoa do título.

identificadorSituacaoAdministrativa
string or null

Obtém ou define a situação administrativa do título.

identificadorMotivoExclusao
string or null

Motivo de exclusão do título. (Apenas Para exclusão de um a receber vinculado á documento) Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor"
Ou Para outros tipos de exclusão SELECT * FROM InformacaoGeral WHERE NmCombo 'MotivoExclusao'.
Para cancelar uma exclusão informe "" (vazio) ou omita o campo

object (AReceberConvenioContrato)

Contrato de convênio de títulos a receber.

Array of objects or null (AReceberItemContrato)

Obtém ou define os itens do título a receber.

valorTitulo
number <double>

Valor do título

identificadorContaBancariaBaixa
string or null

Identificador da conta bancária de baixa na inclusão.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cria um lote de baixa a receber.

Authorizations:
Bearer
Request Body schema:

O contrato do lote a receber.

codigoEmpresa
integer <int32>

Código da empresa.

descricaoLote
string or null

Obtém ou define a descrição do lote.

Array of objects or null (LoteAReceberItemBaixaContrato)

Obtém ou define os itens que serão adicionados a baixa.

Responses

Request samples

Content type
{
  • "codigoEmpresa": 0,
  • "descricaoLote": "string",
  • "loteAReceberItemBaixa": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cria o lote receber e efetua a baixa do mesmo

Authorizations:
Bearer
Request Body schema:

O contrato de LoteAReceberBaixa

identificadorTituloAReceber
string or null

Identificador do título a receber

identificadorFormaPagamento
string or null

Identificador forma de pagamento

identificadorContaBancaria
string or null

Identificador da conta bancária

valorBaixa
number <double>

Valor de baixa

object (TipoBaixaConsultaContrato)

Contrato de consulta do tipo de baixa.

descricao
string or null

Descrição do lote

observacao
string or null

Observação da baixa

liberacaoAutomatica
boolean

Define se o título será liberado via GE

Responses

Request samples

Content type
{
  • "identificadorTituloAReceber": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorContaBancaria": "string",
  • "valorBaixa": 0.1,
  • "tipoBaixa": {
    },
  • "descricao": "string",
  • "observacao": "string",
  • "liberacaoAutomatica": true
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Adiciona um convênio a um título a receber.

Authorizations:
Bearer
path Parameters
identificadorTitulo
required
string

Identificador do título a receber.

Request Body schema:

O contrato do convênio.

nomeAdquirinte
string or null

Nome do adquirinte.

numeroAutorizacao
string or null

Número de autorização.

numeroSequencialUnico
string or null

Número sequencial único (NSU).

quantidadeParcelas
integer <int32>

Obtém ou define a quantidade de parcelas.

identificadorTransacao
string or null

Identificador da transação.

Responses

Request samples

Content type
{
  • "nomeAdquirinte": "string",
  • "numeroAutorizacao": "string",
  • "numeroSequencialUnico": "string",
  • "quantidadeParcelas": 0,
  • "identificadorTransacao": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um título a receber.

Authorizations:
Bearer
path Parameters
identificadorTitulo
required
string

Identificador Titulo.

Request Body schema:

Contrato do título a ser editado.

agrupamento
string or null

Obtém ou define a descrição do agrupamento.

aliquotaConvenio
number <double>

Valor da aliquota do convênio.

Array of objects or null (LancamentoCentroCustoInclusaoContrato)

Obtém ou define os centros de custo do item.

object (AReceberCheque)

Contrato de cheque a receber.

dataCadastro
string <date-time>

Obtém ou define a data de cadastro do título.

dataEmissao
string <date-time>

Obtém ou define a data de emissão do título.

dataReferencia
string <date-time>

Obtém ou define a data de referencia.

dataVencimento
string <date-time>

Obtém ou define a data de vencimento do título.

descricaoTitulo
string or null

Obtém ou define a descrição do título.

object (HistoricoCarteiraContrato)

Classe de contrato de histórico de carteira.

identificadorContaBancaria
string or null

Identificador da conta do banco de cobrança.

numeroParcela
integer <int32>

Número da parcela do título.

numeroTitulo
string or null

Número do título.

numeroTransacao
string or null

Numero da transação.

observacao
string or null

Obtém ou define a observação do título.

previsao
boolean

Obtém ou define um valor que indica se o título é de previsão.

valorTACConvenio
number <double>

Valor do TAC do convenio.

valorTACEmpresa
number <double>

Valor do TAC da empresa.

tituloConciliadoPeloFinConciliare
boolean

Obtém ou define se o título está conciliado no FinConciliare.

codigoEmpresa
string or null

Obtém ou define a empresa do título.

codigoEnderecoCobranca
string or null

Endereço de cobrança.

identificadorAgenciaCobranca
string or null

Obtém ou define a agência do banco de cobrança.

identificadorBancoCobranca
string or null

Identificador do banco.

identificadorCategoria
string or null

Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa.

identificadorFormaPagamento
string or null

Identificador da forma de pagamento do título.

identificadorNaturezaLancamento
string or null

Obtém ou define a natureza de lançamento do título.

identificadorNaturezaLancamentoConvenio
string or null

Valor do identificador da natureza de lançamento do convênio.

identificadorNaturezaLancamentoTACConvenio
string or null

Valor do identificador da natureza de lançamento TAC do convênio.

identificadorNaturezaLancamentoTACEmpresa
string or null

Valor do identificador da natureza de lançamento TAC da empresa.

identificadorPessoa
string or null

Obtém ou define a pessoa do título.

identificadorSituacaoAdministrativa
string or null

Obtém ou define a situação administrativa do título.

identificadorMotivoExclusao
string or null

Motivo de exclusão do título. (Apenas Para exclusão de um a receber vinculado á documento) Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor"
Ou Para outros tipos de exclusão SELECT * FROM InformacaoGeral WHERE NmCombo 'MotivoExclusao'.
Para cancelar uma exclusão informe "" (vazio) ou omita o campo

object (AReceberConvenioContrato)

Contrato de convênio de títulos a receber.

Array of objects or null (AReceberItemContrato)

Obtém ou define os itens do título a receber.

valorTitulo
number <double>

Valor do título

identificadorContaBancariaBaixa
string or null

Identificador da conta bancária de baixa na inclusão.

Responses

Request samples

Content type
{
  • "agrupamento": "string",
  • "aliquotaConvenio": 0.1,
  • "centrosDeCusto": [
    ],
  • "cheque": {
    },
  • "dataCadastro": "2019-08-24T14:15:22Z",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataVencimento": "2019-08-24T14:15:22Z",
  • "descricaoTitulo": "string",
  • "historicoCarteira": {
    },
  • "identificadorContaBancaria": "string",
  • "numeroParcela": 0,
  • "numeroTitulo": "string",
  • "numeroTransacao": "string",
  • "observacao": "string",
  • "previsao": true,
  • "valorTACConvenio": 0.1,
  • "valorTACEmpresa": 0.1,
  • "tituloConciliadoPeloFinConciliare": true,
  • "codigoEmpresa": "string",
  • "codigoEnderecoCobranca": "string",
  • "identificadorAgenciaCobranca": "string",
  • "identificadorBancoCobranca": "string",
  • "identificadorCategoria": "string",
  • "identificadorFormaPagamento": "string",
  • "identificadorNaturezaLancamento": "string",
  • "identificadorNaturezaLancamentoConvenio": "string",
  • "identificadorNaturezaLancamentoTACConvenio": "string",
  • "identificadorNaturezaLancamentoTACEmpresa": "string",
  • "identificadorPessoa": "string",
  • "identificadorSituacaoAdministrativa": "string",
  • "identificadorMotivoExclusao": "string",
  • "convenio": {
    },
  • "itens": [
    ],
  • "valorTitulo": 0.1,
  • "identificadorContaBancariaBaixa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os títulos de uma empresa por status

Authorizations:
Bearer
path Parameters
codigoEmpresa
required
integer <int32>

O código da empresa.

query Parameters
status
integer <int32> (EStatusTitulo)
Enum: 0 1 2 3 4

O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos baixados sem numerário. 2 = Títulos baixados com numerário. 3 = Títulos excluídos. 4 = Títulos de previsão.

dataEmissaoInicial
string <date-time>

A data inicial de emissão do filtro.

dataEmissaoFinal
string <date-time>

A data final de emissão do filtro.

dataBaixaInicial
string <date-time>

A data inicial de baixa do filtro.

dataBaixaFinal
string <date-time>

A data final de baixa do filtro.

limite
integer <int32>
Default: 25

A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25.

pagina
integer <int32>
Default: 1

A página que deseja consultar. Quando não informado, por pardrão será definido 1.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtem os títulos a receber pelo Identificador Entidade Origem

Authorizations:
Bearer
query Parameters
idEntidadeOrigem
string
Default: ""

O identificador da entidade origem

nomeEntidadeOrigem
string
Default: ""

O nome da entidade origem

limite
integer <int32>
Default: 25

A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25.

pagina
integer <int32>
Default: 1

A página que deseja consultar. Quando não informado, por pardrão será definido 1.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Simula renegociações um pra um de um título.

Authorizations:
Bearer
Request Body schema:

O contrato para as simulações.

identificador
string or null

O identificador do titulo a ser renegociado

datas
Array of strings or null <date-time> [ items <date-time > ]

Datas para as simulações

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "datas": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Gera um novo título e baixa o anterior sem numerário atravez de uma renegociação um pra um.

Authorizations:
Bearer
Request Body schema:

O contrato para a renegociação.

identificador
string or null

Identificador do título

novoVencimento
string <date-time>

O novo vencimento

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "novoVencimento": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém os títulos a receber por data de cadastro

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

Identificador da Pessoa.

titulosEmAberto
boolean
Default: false

Obtém ou define os titulos em aberto.

dataInicialVencimento
string <date-time>

Obtém ou define a data inicial do vencimento.

dataFinalVencimento
string <date-time>

Obtém ou define a data final do vencimento.

dataInicialEmissao
string <date-time>

Obtém ou define a data inicial da emissão.

dataFinalEmissao
string <date-time>

Obtém ou define a data final da emissão.

limite
integer <int32>
Default: 25

Limite de títulos

pagina
integer <int32>
Default: 1

Página

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Método responsável por retornar todos os títulos a receber e pode filtrar por empresa, data de cadastro, data de vencimento e natureza de lançamento

Authorizations:
Bearer
query Parameters
limite
integer <int32>
Default: 25

Limite de titulos.

pagina
integer <int32>
Default: 1

Pagina.

dataCadastroInicial
string <date-time>

A data de cadastro Inicial.

dataCadastroFinal
string <date-time>

A data de cadastro Final.

identificadorPessoa
string

O identificador da pessoa

codigoEmpresa
integer <int32>

O código da empresa.

dataVencimentoInicial
string <date-time>

A data de vencimento Inicial.

dataVencimentoFinal
string <date-time>

A data de vencimento Final.

identificadorNaturezaLancamento
string

Identificador da natureza de lançamento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta títulos a receber abertos com boleto gerado por pessoa

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string = 10 characters

O identificador da pessoa

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Agenda

Alterar um agendamento

Realiza a alteração parcial de um agendamento existente.

Authorizations:
Bearer
path Parameters
identificador
required
string
Request Body schema:
identificadorUsuario
string or null

Usuário ao qual se refere o agendamento alterado.

identificadorTipoAgendamento
string or null

Identificador do tipo de agendamento.

identificadorPessoa
string or null

Identificador da pessoa.

observacao
string or null

Observação do agendamento.

dataInicial
string or null <date-time>

Data inicial do agendamento.

dataFinal
string or null <date-time>

Data final do agendamento.

valorVisita
number or null <double>

Valor cobrado na visita.

aceiteFichaVisita
boolean or null

Informa se a ficha de visita foi aceita pelo cliente.

dataAutorizacaoFicha
string or null <date-time>

Informa a data em que o cliente autorizou a ficha.

emailClienteFichaVisita
string or null

Informa o e-mail do cliente que autorizou a ficha de visita.

Responses

Request samples

Content type
{
  • "identificadorUsuario": "string",
  • "identificadorTipoAgendamento": "string",
  • "identificadorPessoa": "string",
  • "observacao": "string",
  • "dataInicial": "2019-08-24T14:15:22Z",
  • "dataFinal": "2019-08-24T14:15:22Z",
  • "valorVisita": 0.1,
  • "aceiteFichaVisita": true,
  • "dataAutorizacaoFicha": "2019-08-24T14:15:22Z",
  • "emailClienteFichaVisita": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um novo agendamento

Cadastra um novo agendamento.

Authorizations:
Bearer
Request Body schema:
identificadorTipoAgendamento
string or null

O identificador do tipo de agendamento
Exemplo: 00A0000002

identificadorUsuarioCadastro
string or null

Identificador usuário que efetuou cadastro.
Exemplo: 00A0000010

Array of objects or null (AgendaDataContrato)

As datas do agendamento.

Array of objects or null (AgendaPessoaContrato)

As pessoas do contato.

identificadoresUsuarios
Array of strings or null

Os identificadores do usuário do agendamento.
Exemplo: ["00A0000003", "00A0000004"]

identificadorAtendimento
string or null

Identificador do atendimento vinculado.

identificadorProduto
string or null

Identificador produto.

identificadorLocalAgendamento
string or null

Identificador do local do agendamento.

identificadorTipoAtendimento
string or null

O identificador do tipo de atendimento.
Exemplo: 00A0000001

valorVisita
number <double>

Valor da visita.
Exemplo: 123.89

observacao
string or null

Observação do agendamento.
Exemplo: Observação detalhado do agendamento

Responses

Request samples

Content type
{
  • "identificadorTipoAgendamento": "string",
  • "identificadorUsuarioCadastro": "string",
  • "datasAgendamento": [
    ],
  • "pessoas": [
    ],
  • "identificadoresUsuarios": [
    ],
  • "identificadorAtendimento": "string",
  • "identificadorProduto": "string",
  • "identificadorLocalAgendamento": "string",
  • "identificadorTipoAtendimento": "string",
  • "valorVisita": 0.1,
  • "observacao": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Anexo

Cadastra anexo

Cadastrar um novo anexo no banco utilizando multipart/form-data.

Authorizations:
Bearer
path Parameters
nomeEntidade
required
string

O nome da entidade de origem.
Exemplo: PedidoDeVenda

identificadorEntidade
required
string

O identificador da entidade de origem.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Bairro

Cadastra um bairro

Cadastrar um bairro no Bimer, por ser um cadastro o identificador é desnecessário

Authorizations:
Bearer
Request Body schema:

O bairro que será adicionado.

codigo
required
string or null

Código de chamada.
Exemplo: 454612

identificador
string or null

Identificador do bairro.
Exemplo: 00A0000001

nome
string or null

Nome do bairro.
Exemplo: Várzea

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "identificador": "string",
  • "nome": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta bairros por nome

Consultar um bairro cadastrado no Bimer pelo nome, possibilita busca por trecho

Authorizations:
Bearer
query Parameters
nomeBairro
string

O nome do bairro a ser consultado.
Exemplo: Várzea

porTrecho
boolean

Valor que indica se a consulta deverá ser feita por trecho, ou seja, se haverá consulta com nome parcial do bairro.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um bairro por seu identificador

Consultar um bairro cadastrado no Bimer pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do bairro a ser consultado.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um bairro

Editar o cadastro de um bairro no Bimer.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do bairro a ser editado.
Exemplo: 00A0000001

Request Body schema:

O bairro a ser editado.

codigo
required
string or null

Código de chamada.
Exemplo: 454612

identificador
string or null

Identificador do bairro.
Exemplo: 00A0000001

nome
string or null

Nome do bairro.
Exemplo: Várzea

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "identificador": "string",
  • "nome": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Calculo de ICMS

Obtém cálculos de ICMS por descricao.

Authorizations:
Bearer
query Parameters
descricao
string

A descrição do cálculo de ICMS.

porTrecho
boolean
Default: false

Valor que indica se a consulta do nome será utilizada por trecho.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um cálculo de ICMS por seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do cálculo ICMS.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um cálculo de ICMS por seu código de chamada.

Authorizations:
Bearer
query Parameters
codigo
string

O código de chamada do cálculo de ICMS.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os cálculos de ICMS paginado

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

CEP

Cadastra um CEP

Cadastrar um CEP no Bimer.

Authorizations:
Bearer
Request Body schema:

O CEP que será adicionado

codigo
string or null

Código de chamada
Exemplo: 454612

identificadorBairro
string or null

O identificador do bairro
Exemplo: 00A0000001

identificadorCidade
string or null

O identificador da cidade
Exemplo: 00A0000001

identificadorUF
string or null

O identificador da UF
Exemplo: RJ

nomeLogradouro
string or null

O nome do logradouro
Exemplo: Prefeito Sebastião Teixeira

tipoLogradouro
string or null

O tipo do logradouro
Exemplo: Rua

identificadorTipoLogradouro
string or null

O identificador do tipo do logradouro
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "identificadorBairro": "string",
  • "identificadorCidade": "string",
  • "identificadorUF": "string",
  • "nomeLogradouro": "string",
  • "tipoLogradouro": "string",
  • "identificadorTipoLogradouro": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um CEP

Consultar um CEP pelo código.

Authorizations:
Bearer
path Parameters
codigo
required
string

O código do CEP a ser consultado
Exemplo: 25953-200

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém CEPs por cidade

Consultar os CEPs cadastrados para uma cidade.

Authorizations:
Bearer
path Parameters
identificadorCidade
required
string

O identificador do CEP a ser consultado
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém CEPs por logradouro

Consultar os CEPs pelo nome do logradouro.

Authorizations:
Bearer
path Parameters
nomeLogradouro
required
string

O nome do logradouro
Exemplo: Prefeito Sebastião Teixeira

query Parameters
porTrecho
boolean
Default: false

Habilita a pesquisa por trecho
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cidade

Cadastra uma cidade

Cadastrar uma cidade no Bimer.

Authorizations:
Bearer
Request Body schema:

A cidade a ser cadastrada.

codigoIBGE
required
string or null

O código IBGE
Exemplo: 2900306

codigo
string or null

O código da cidade no Bimer
Exemplo: 004223

codigoDDD
string or null

O código do DDD da cidade
Exemplo: 21

nome
string or null

O nome da cidade
Exemplo: Teresópolis

identificadorUF
required
string or null

O identificador da UF
Exemplo: RJ

Responses

Request samples

Content type
{
  • "codigoIBGE": "string",
  • "codigo": "string",
  • "codigoDDD": "string",
  • "nome": "string",
  • "identificadorUF": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita uma cidade

Editar uma cidade pelo identificador.

Authorizations:
Bearer
query Parameters
identificador
string

O identificador da cidade a ser editada.
Exemplo: 00A0000001

Request Body schema:

A cidade a ser editada.

codigoIBGE
required
string or null

O código IBGE
Exemplo: 2900306

codigo
string or null

O código da cidade no Bimer
Exemplo: 004223

codigoDDD
string or null

O código do DDD da cidade
Exemplo: 21

nome
string or null

O nome da cidade
Exemplo: Teresópolis

identificadorUF
required
string or null

O identificador da UF
Exemplo: RJ

Responses

Request samples

Content type
{
  • "codigoIBGE": "string",
  • "codigo": "string",
  • "codigoDDD": "string",
  • "nome": "string",
  • "identificadorUF": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém cidades por nome e UF

Consultar uma cidade pelo nome e pela UF.

Authorizations:
Bearer
path Parameters
siglaUF
required
string

A sigla do estado em que se esta buscando a cidade.
Exemplo: RJ

query Parameters
nomeCidade
string

O nome da cidade que está sendo consultada.
Exemplo: Teresópolis

nomeCidadePorTrecho
boolean

Valor que indica se o nome da cidade será consultado por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma cidade

Consultar uma cidade pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da cidade.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Classificação fiscal

Obtém classificações fiscais por descricao.

Authorizations:
Bearer
query Parameters
descricao
string

A descrição do classificação fiscal.

porTrecho
boolean
Default: false

Valor que indica se a consulta do nome será utilizada por trecho.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma classificação fiscal por seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da classificação fiscal.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um classificação fiscal por classificação.

Authorizations:
Bearer
query Parameters
classificacao
string

O código de chamada do classificação fiscal.

porTrecho
boolean
Default: false

Valor que indica se a consulta do nome será utilizada por trecho.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todas as classificações fiscais

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Configuração

Obtém configurações de uma seção por seu nome.

Authorizations:
Bearer
query Parameters
nomeSecao
string

O nome da seção que se deseja obter as configurações.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Documento

Consultar todos os documentos de venda por emitente

Consultar página por documentos de venda por emitente, permitindo filtrar por código da empresa, data inicial e final.

Authorizations:
Bearer
query Parameters
codigoEmpresa
required
integer <int32>

Codigo da empresa cadastrada no Bimer.

dataInicial
string <date-time>

Obtém ou define a data inicial de emissão do documento.

dataFinal
string <date-time>

Obtém ou define a data final de emissão do documento.

limite
required
integer <int32>

Determina o limite de registros que serão apresentados na consulta.

pagina
required
integer <int32>

Determina a página onde os registros apresentados estão localizados.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ],
  • "paginacao": {
    }
}

Consultar uma lista de documentos pelo identificador do pedido de venda

Consultar uma lista de documentos pelo identificador do pedido de venda. O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro.

Authorizations:
Bearer
path Parameters
identificadorPedido
required
string

O identificador documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar uma lista de documentos pelo código do pedido de venda

Consultar uma lista de documentos pelo código do pedido de venda. O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro.

Authorizations:
Bearer
path Parameters
codigoPedidoDeVenda
required
string

O código do pedido de venda documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar uma lista de documentos pelo código do pedido de compra com o Status do pedido T e X

Consultar os documentos com base no código do pedido de compra de origem

Authorizations:
Bearer
path Parameters
codigoPedidoDeCompra
required
string

Código do documento do pedido de compra a ser consultado.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o documento pelo identificador

Consultar o documento pelo identificador.

Authorizations:
Bearer
path Parameters
identificadorDocumento
required
string

O identificador documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar documentos por pessoa e por período de data de emissão (início e fim)

Consultar documentos por pessoa e por período de data de emissão (início e fim).

Authorizations:
Bearer
query Parameters
identificadorPessoa
required
string

Obtém o identificador de Pessoa.

tipoOperacao
required
string

Obtém tipo de Operacao.

dataInicial
required
string

Obtém data Inicial.

dataFinal
required
string

Obtém data Final.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o PDF do DANFE por identificador do documento

O retorno da consulta será um PDF em BASE64, necessitando apenas de ser convertido para PDF:
Exemplo:

GET: /00A000001C/DANFE/PDF
{
   JVBERi0xLjQNCiW17a77DQoyIDAgb2JqDQo8PCAvTGVuZ3RoIDMgMCBSDQogICAv
   VHlwZSAvWE9iamVjdA0KICAgL1N1YnR5cGUgL0Zvcm0NCiAgIC9CQm94IFsgMCAw
   IDIxNiA0MDQgXQ0KPj4NCnN0cmVhbQ0KMSAwIDAgLTEgMCA0MDQgY20NCnEgMzYg
   ...
   MjA5OSAwMDAwMCBuDQowMDAwMDIyMjI5IDAwMDAwIG4NCnRyYWlsZXINCjw8IC9T
   aXplIDEwDQogICAvUm9vdCA5IDAgUg0KICAgL0luZm8gOCAwIFINCj4+DQpzdGFy
   dHhyZWYNCjIyMjg2DQolJUVPRg0K
}
Authorizations:
Bearer
path Parameters
identificadorDocumento
required
string

O identificador documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar XMLs por período e tipo de operação

Consultar XMLs de documentos, permitindo filtrar por data inicial e final, tipo de operação e identificador da pessoa. Pode ser utilizado o limite para definir quantos XMLs serão exibidos e definir a página de consulta.

Authorizations:
Bearer
query Parameters
emissaoInicial
required
string <date-time>
emissaoFinal
required
string <date-time>
limite
integer <int32>
Default: 50
pagina
integer <int32>
Default: 1
identificadorPessoa
string
Default: ""
tipoOperacao
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ],
  • "paginacao": {
    }
}

Consultar o XML do DANFE por identificador do documento

Consultar o XML do DANFE com base no identificador do documento.

Authorizations:
Bearer
path Parameters
identificadorDocumento
required
string

O identificador documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o documento pela chave de acesso

Consultar o documento pela chave de acesso.

Authorizations:
Bearer
path Parameters
chaveAcesso
required
string

A chave de acesso.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o documento pela empresa e número

Consultar o documento pela empresa e número.

Authorizations:
Bearer
query Parameters
numero
required
string

O número.

codigoEmpresa
required
integer <int32>

O código da empresa.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um novo documento de saída

Cadastrar um novo documento de saída.

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do documento de saída. O Campo Identificador do contrato não é necessário e será ignorado, pois é gerado de forma automática.

codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.
Exemplo: 1234

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.
Exemplo: true

tipoDocumento
string or null

O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O":
Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações.
Exemplo: F

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.
Exemplo: 0

Array of objects or null (MensagemContrato)

A lista de mensagens definidas para o pedido (No máximo 4 mensagens).

valorDeducaoBaseISS
number <double>

Valor de dedução da base de ISS.
Exemplo: 100.00

statusNotaFiscalEletronica
required
string or null

Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "criaDocumentoProntoParaSerLiberado": true,
  • "tipoDocumento": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "valorDeducaoBaseISS": 0.1,
  • "statusNotaFiscalEletronica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Alterar um documento criado

Alterar um documento criado.

Authorizations:
Bearer
Request Body schema:
codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.
Exemplo: 1234

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.
Exemplo: true

tipoDocumento
string or null

O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O":
Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações.
Exemplo: F

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.
Exemplo: 0

Array of objects or null (MensagemContrato)

A lista de mensagens definidas para o pedido (No máximo 4 mensagens).

valorDeducaoBaseISS
number <double>

Valor de dedução da base de ISS.
Exemplo: 100.00

statusNotaFiscalEletronica
required
string or null

Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "criaDocumentoProntoParaSerLiberado": true,
  • "tipoDocumento": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "valorDeducaoBaseISS": 0.1,
  • "statusNotaFiscalEletronica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um documento de saída de forma assíncrona

Cadastrar de forma assíncrona os documentos de saída.

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do documento de saída.

codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.
Exemplo: 1234

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.
Exemplo: true

tipoDocumento
string or null

O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O":
Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações.
Exemplo: F

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.
Exemplo: 0

Array of objects or null (MensagemContrato)

A lista de mensagens definidas para o pedido (No máximo 4 mensagens).

valorDeducaoBaseISS
number <double>

Valor de dedução da base de ISS.
Exemplo: 100.00

statusNotaFiscalEletronica
required
string or null

Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "criaDocumentoProntoParaSerLiberado": true,
  • "tipoDocumento": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "valorDeducaoBaseISS": 0.1,
  • "statusNotaFiscalEletronica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um documento de entrada

Cadastrar um documento de entrada

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do documento de entrada.

codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.
Exemplo: 1234

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.
Exemplo: true

tipoDocumento
string or null

O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O":
Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações.
Exemplo: F

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.
Exemplo: 0

Array of objects or null (MensagemContrato)

A lista de mensagens definidas para o pedido (No máximo 4 mensagens).

valorDeducaoBaseISS
number <double>

Valor de dedução da base de ISS.
Exemplo: 100.00

chaveAcessoNotaFiscalEletronica
string or null

Obtém ou define a chave na nota fiscal eletrônica.
Exemplo: 12345678912345678912345689

object (DocumentoComplementoISSTomadorContrato)

Contrato de dados do ISS Tomador.

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "criaDocumentoProntoParaSerLiberado": true,
  • "tipoDocumento": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "valorDeducaoBaseISS": 0.1,
  • "chaveAcessoNotaFiscalEletronica": "string",
  • "issTomador": {
    }
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um documento de beneficiamento

Cadastrar um documento como beneficiamento.

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do controle de remessa e retorno para beneficiamento.

identificador
string or null

Identificador do documento a ser incluso como beneficiamento.

Responses

Request samples

Content type
{
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um documento de telecomunicações

Cadastrar um documento de telecomunicação.

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do documento de entrada.

codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.
Exemplo: 1234

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.
Exemplo: true

tipoDocumento
string or null

O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O":
Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações.
Exemplo: F

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.
Exemplo: 0

Array of objects or null (MensagemContrato)

A lista de mensagens definidas para o pedido (No máximo 4 mensagens).

valorDeducaoBaseISS
number <double>

Valor de dedução da base de ISS.
Exemplo: 100.00

tipoFinalidade
integer <int32> (ETipoFinalidade)
Enum: 0 1 2 3 4 5 6

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "criaDocumentoProntoParaSerLiberado": true,
  • "tipoDocumento": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "valorDeducaoBaseISS": 0.1,
  • "tipoFinalidade": 0
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar uma nova devolução de um documento

Cadastrar uma nova devolução de um documento.

Authorizations:
Bearer
path Parameters
identificadorDocumento
required
string

O identificador do documento a ser devolvido.

Request Body schema:

O contrato da devolução a ser cadastrada.

criaDocumentoProntoParaSerLiberado
boolean

Valor que indica se o documento deve ser criado pronto para ser liberado.

dataEmissao
string <date-time>

Obtém ou define a data de emissão.

dataReferencia
string <date-time>

Obtém ou definea data refêrencia.

identificadorOperacao
string or null

Identificador da operação. A operação deverá ser do tipo devolução.

Array of objects or null (DevolucaoItemCadastroContrato)

Obtém ou define os itens da devolução.

numero
string or null

Número da devolução.

observacao
string or null

Obtém ou define a observação da devolução.

statusNotaFiscalEletronica
string or null

Status da devolução : "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro

Responses

Request samples

Content type
{
  • "criaDocumentoProntoParaSerLiberado": true,
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "itens": [
    ],
  • "numero": "string",
  • "observacao": "string",
  • "statusNotaFiscalEletronica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar documentos inutilizados por filtros

Consultar uma lista de documentos inutilizados pelo identificador ou por filtros diversos como (empresa, data inicial, data final, série/subsérie e número do documento).

Authorizations:
Bearer
query Parameters
identificadorDocumento
string

O identificador do documento inutilizado.

identificadorEmpresa
string

O identificador da empresa.

dataInicial
string <date-time>

A data inicial.

dataFinal
string <date-time>

A data final.

codigoSerieSubSerie
string

O código de série e sub série.

numeroDocumento
string

O número do documento.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Gerar inutilizações de documentos

Gerar inutilizações de uma sequência de documentos.

Authorizations:
Bearer
Request Body schema:

O contrato de inutilização a ser cadastrado.

numeroDocumentoInicial
required
integer or null <int32>

Número do documento inicial.

numeroDocumentoFinal
required
integer or null <int32>

Número do documento final.

justificativaInutilizacao
required
string or null >= 15 characters

Obtém ou define a justificativa da inutilização.

codigoEmpresa
required
string or null

Código da empresa.

identificadorTipoDocumento
required
string or null

Identificador do tipo de documento.

Responses

Request samples

Content type
{
  • "numeroDocumentoInicial": 0,
  • "numeroDocumentoFinal": 0,
  • "justificativaInutilizacao": "stringstringstr",
  • "codigoEmpresa": "string",
  • "identificadorTipoDocumento": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um novo documento de saída sem recalculo

Cadastrar um novo documento de saída sem recalculo.

Authorizations:
Bearer
Request Body schema:

O contrato de cadastro do documento de saída. O Campo Identificador do contrato não é necessário e será ignorado, pois é gerado de forma automática.

codigoEmpresa
required
string or null

Código da empresa.
Exemplo: 00A0000001

dataEmissao
required
string <date-time>

Obtém ou define a data de emissão.
Exemplo: 2023-01-01T00:00:00

dataReferencia
string <date-time>

Obtém ou define a data de referência.
Exemplo: 2023-01-01T00:00:00

dataReferenciaPagamento
string <date-time>

Obtém ou define a data de referência do pagamento.
Exemplo: 2023-01-01T00:00:00

identificadorOperacao
required
string or null

Identificador da operação.
A operação indicará o tipo do documento como sendo de entrada ou saída.
Exemplo: 00A0000007

identificadorPessoa
required
string or null

Identificador da pessoa.
Exemplo: 00A0000008

required
Array of objects or null (DocumentoItemCadastroEmitidoContrato)

Os itens do documento.

nomeEntidadeOrigem
string or null

O nome entidade origem.
Exemplo: Nome da entidade

identificador
string or null

Identificador do documento.
Exemplo: 00A000002X

numero
string or null

Número do documento.
Exemplo: 12345

numeroNFSE
string or null

Número da nota fiscal de Serviço Eletrônico do documento.
Exemplo: 12345

observacao
string or null

A observação do documento.
Exemplo: Observação do documento

Array of objects or null (DocumentoPagamentoCadastroContrato)

Os pagamentos do documento.

object (PrazoContrato)

Contrato do prazo.

codigoContratoCompraCliente
string or null

Código do contrato de compra do cliente.

tipoPagamento
string or null

Tipo de pagamento: "0": ÀVista | "1": Parcelado.

Array of objects or null (MensagemContrato)

Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens).

identificadorPreco
string or null

Identificador da tabela de preço

tipoAcrescimo
string or null

Tipo de acréscimo (A = Alíquota; V = Valor)

tipoDesconto
string or null

Tipo de desconto (A = Alíquota; V = Valor)

identificadorPessoaTransportador
string or null

Identificador da pessoa que é o transportador

tipoFrete
string or null

Tipo de frete E = Frete por conta do emitente D = Frete por conta do destinatário T = Frete por conta de terceiros P = Próprio por conta do remetente Q = Próprio por conta do destinatário N = Sem frete

quantidadeVolumesTransporte
integer <int32>

Descrição de quantos volumes a carga possui

descricaoEspecie
string or null

Espécie do documento

descricaoMarca
string or null

Descrição da marca para transporte

numeroTransportadora
integer <int32>

Número para transporte

valorPesoBruto
number <double>

Peso bruto

valorPesoLiquido
number <double>

Peso liquido

identificadorPrazo
string or null

Identificador do prazo

descricaoViaTransporte
string or null

Via de transporte

valorAcrescimo
number <double>

Valor de acréscimo da capa

valorDesconto
number <double>

Valor desconto da capa

valorFrete
number <double>

Valor frete da capa

valorSeguro
number <double>

Valor seguro da capa

aliquotaAcrescimo
number <double>

Aliquota de acrescimo

valorOutrasDespesas
number <double>

Valor de outras despesas

aliquotaDesconto
number <double>

Aliquota de desconto

valorComplementoICMS
number <double>

Valor de complemento de ICMS

valorComplementoIPI
number <double>

Valor de complemento de IPI

aliquotaBaseINSS
number <double>

Aliquota de Base INSS

valorPISRetido
number <double>

Valor de PIS retido

valorCOFINSRetido
number <double>

Valor de COFINS retido

valorCSLLRetido
number <double>

Valor de CSLL retido

valorComplementoICMSST
number <double>

Valor de complemento de ICMS-ST

statusNotaFiscalEletronica
string or null

Status da NF-e

codigoChaveAcessoNFEletronica
string or null

Código da chave de acesso da NF-e

numeroProtocoloNFEletronica
string or null

Número do protocolo da NF-e

dataSaida
string <date-time>

Data de saída

tipoIndicacaoAtendimentoPresencial
integer <int32>

Tipo de indicação do atendimento presencial

identificadorUnidadeDeNegocio
integer <int32>

Identificador unidade de negocio

xmlRetorno
string or null

XML de envio

xmlAssinado
string or null

XML de retorno

Responses

Request samples

Content type
{
  • "codigoEmpresa": "string",
  • "dataEmissao": "2019-08-24T14:15:22Z",
  • "dataReferencia": "2019-08-24T14:15:22Z",
  • "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
  • "identificadorOperacao": "string",
  • "identificadorPessoa": "string",
  • "itens": [
    ],
  • "nomeEntidadeOrigem": "string",
  • "identificador": "string",
  • "numero": "string",
  • "numeroNFSE": "string",
  • "observacao": "string",
  • "pagamentos": [
    ],
  • "prazo": {
    },
  • "codigoContratoCompraCliente": "string",
  • "tipoPagamento": "string",
  • "mensagens": [
    ],
  • "identificadorPreco": "string",
  • "tipoAcrescimo": "string",
  • "tipoDesconto": "string",
  • "identificadorPessoaTransportador": "string",
  • "tipoFrete": "string",
  • "quantidadeVolumesTransporte": 0,
  • "descricaoEspecie": "string",
  • "descricaoMarca": "string",
  • "numeroTransportadora": 0,
  • "valorPesoBruto": 0.1,
  • "valorPesoLiquido": 0.1,
  • "identificadorPrazo": "string",
  • "descricaoViaTransporte": "string",
  • "valorAcrescimo": 0.1,
  • "valorDesconto": 0.1,
  • "valorFrete": 0.1,
  • "valorSeguro": 0.1,
  • "aliquotaAcrescimo": 0.1,
  • "valorOutrasDespesas": 0.1,
  • "aliquotaDesconto": 0.1,
  • "valorComplementoICMS": 0.1,
  • "valorComplementoIPI": 0.1,
  • "aliquotaBaseINSS": 0.1,
  • "valorPISRetido": 0.1,
  • "valorCOFINSRetido": 0.1,
  • "valorCSLLRetido": 0.1,
  • "valorComplementoICMSST": 0.1,
  • "statusNotaFiscalEletronica": "string",
  • "codigoChaveAcessoNFEletronica": "string",
  • "numeroProtocoloNFEletronica": "string",
  • "dataSaida": "2019-08-24T14:15:22Z",
  • "tipoIndicacaoAtendimentoPresencial": 0,
  • "identificadorUnidadeDeNegocio": 0,
  • "xmlRetorno": "string",
  • "xmlAssinado": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Empresa

Obtém uma empresa

Consultar uma empresa por código.

Authorizations:
Bearer
path Parameters
codigo
required
integer <int32>

O código da empresa que se deseja
Exemplo: 000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém empresas por CNPJ ou nome

Consultar as empresas, permitindo filtrar por nome e CNPJ e a utilização de busca por trecho.
Nota: Caso não sejam informados nenhum parametro, serão retornadas todas as empresas cadastradas.

Authorizations:
Bearer
query Parameters
cnpj
string
Default: ""

O CNPJ para a consulta. Caso seja informado, a consulta será apenas pelo CNPJ.
Exemplo: 36462778000160

nome
string
Default: ""

O nome da empresa para cosulta
Exemplo: Alterdata

nomePorTrecho
boolean
Default: true

Indica se consulta por nome será por trecho. Caso não for informado, o valor padrão será true
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Tipo logradouro

Obtém tipos logradouro por descrição

Consultar os tipos de logradouro pela descrição. Permite busca por trecho.

Authorizations:
Bearer
query Parameters
descricao
string

A descrição do logradouro.
Exemplo: Rua

porTrecho
boolean

Indica se a localização será por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém tipo logradouro

Consultar um tipo de logradouro pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do tipo de logradouro.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém todos os tipos logradouro

Consultar todos os tipos de logradouro cadastrados.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Eventos de baixa

Obtém todos os eventos de baixas.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um evento de baixa por identificador.

Observação: O identificador é composto por 10 caracteres.
Exemplo de utilização:

http://localhost:8085/api/eventos-baixas/00100001LH

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do evento de baixa.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Localizações

Localizar regiões pelo bairro e cidade

Consultar região pelo identificador do bairro e cidade.

Authorizations:
Bearer
query Parameters
IdentificadorBairro
string

O Identificador do Bairro
Exemplo: 00A0000001

IdentificadorCidade
string

O Identiificador da Cidade
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Mensagem

Consulta todas as mensagens

Consulta todas as mensagens cadastradas no Bimer

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar uma mensagem

Consultar uma mensagem pelo código.

Authorizations:
Bearer
path Parameters
codigo
required
string

O código da mensagem.
Exemplo: 000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Operação

Obtém todas as operações cadastradas.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma operação cadastrada pelo seu identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da operação.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Prazo

Obtém todos os prazos.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém um prazo por identificador.

Observação: O identificador é composto por 10 caracteres.
Exemplo de utilização:

http://localhost:8085/api/prazos/00100001LH

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do prazo.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Usuario

Obtém um usuário por login

Consultar um usuário pelo login.

Authorizations:
Bearer
query Parameters
nomeLogin
required
string

O nome de login do usuário
Example: BimerAPI

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Característica pessoa

Obtém característica de pessoa

Consultar característica de pessoa.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da característica.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Remove característica vinculada a pessoa

Remover o vínculo da caracteristica com a pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa.
Exemplo: 00A0000001

identificadorCaracteristica
required
string

O identificador da característica.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém características vinculadas a pessoa

Consultar todas características ou apenas as vinculadas a pessoa.

Authorizations:
Bearer
query Parameters
identificadorPessoa
string

O identificador da pessoa.
Exemplo: 00A0000001

identificadorCaracteristica
string

O identificador da característica.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Categoria

Obtém todas as categorias

Consultar todas as categorias de pessoa.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma categoria

Consultar uma categoria da pessoa cadastrada.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da categoria.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cliente

Cadastra pessoa como cliente

Cadastrar uma pessoa no Bimer na categoria cliente.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como cliente.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

identificador
string or null
object (PessoaDadosCadastroContrato)

Classe de contrato de dados do cliente.

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string",
  • "identificador": "string",
  • "dados": {
    }
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita um cliente

Editar uma pessoa da categoria cliente no Bimer.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa que está sendo editada
Exemplo: 00A0000001

Request Body schema:

A pessoa a ser editada.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Vincula transportador a um cliente

Vincular um transportador a um cliente.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa que está sendo editada
Exemplo: 00A0000001

Request Body schema:

O transportador que será vinculado ao cliente.

identificador
string or null

O identificador único da pessoa no Bimer
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consulta o transportador de um cliente

Consultar o transportador vinculado a um cliente.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa que está sendo consultada.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Fornecedor

Cadastra pessoa como fornecedor

Cadastrar um novo fornecedor no Bimer.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como fornecedor.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

identificador
string or null

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string",
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Pessoa produto versão

Obtém a versão de um produto vinculado a uma pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

The identificador Pessoa.

identificadorProduto
required
string

The identificador Produto.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastra as versoes de um produto da pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa.

identificadorProduto
required
string

O identificador do Produto.

Request Body schema:

O contrato das versões que serão cadastradas.

object (VersaoProdutoCadastroContrato)

O contrato do cadastro da versão do produto.

object (VersaoProdutoCadastroContrato)

O contrato do cadastro da versão do produto.

object (VersaoProdutoCadastroContrato)

O contrato do cadastro da versão do produto.

Responses

Request samples

Content type
{
  • "versao": {
    },
  • "versaoBaixada": {
    },
  • "versaoLiberada": {
    }
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Pessoa relacionamento

Cria um relacionamento para a pessoa

Cadastrar um relacionamento para a pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa principal
Exemplo: 00A0000001

Request Body schema:

As informações do relacionamento.

identificadorCategoriaPessoaPrincipal
required
string or null

O identificador da categoria da pessoa principal
Exemplo: 00A0000001

identificadorCaracteristicaPessoaPrincipal
string or null

O identificador da característica da pessoa principal
Exemplo: 00A0000001

identificadorCategoriaPessoaRelacionamento
required
string or null

O identificador da categoria da pessoa relacionada
Exemplo: 00A0000001

identificadorCaracteristicaPessoaRelacionamento
string or null

O identificador da característica da pessoa relacionada
Exemplo: 00A0000001

identificadorPessoaRelacionamento
required
string or null

O identificador da pessoa relacionada
Exemplo: 00A0000001

pessoaRelacionadaPrincipal
required
boolean

Define se a pessoa relacionada é a principal.
Somente uma pessoa relacionada pode ser principal, as demais devem estar com o atributo como 'false'
Exemplo: true

Responses

Request samples

Content type
{
  • "identificadorCategoriaPessoaPrincipal": "string",
  • "identificadorCaracteristicaPessoaPrincipal": "string",
  • "identificadorCategoriaPessoaRelacionamento": "string",
  • "identificadorCaracteristicaPessoaRelacionamento": "string",
  • "identificadorPessoaRelacionamento": "string",
  • "pessoaRelacionadaPrincipal": true
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém lista de relacionamentos da pessoa

Consultar a lista de relacionamentos da pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa principal
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Remove relacionamento entre duas pessoas

Remover um relacionamento da pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa principal
Exemplo: 00A0000001

query Parameters
identificadorCategoriaPessoa
string

O identificador da categoria da pessoa
Exemplo: 00A0000001

identificadorPessoaRelacionamento
string

O identificador da pessoa do relacionamento
Exemplo: 00A0000001

identificadorCategoriaPessoaRelacionamento
string

O identificador da categoria da pessoa do relacionamento
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Pessoa

Obtém uma pessoa

Consultar uma pessoa pelo identificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da pessoa
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém pessoas por nome

Consultar uma pessoa pelo nome.

Authorizations:
Bearer
query Parameters
nome
string

O nome da pessoa
Exemplo: Bimer

porTrecho
boolean

Valor que indica se a consulta será feita por trecho
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém pessoa por CPF/CNPJ ou código externo

Consultar uma pessoa por CPF/CNPJ ou código externo.

Authorizations:
Bearer
query Parameters
cpfCnpj
integer <int64>

O CPF / CNPJ da pessoa
Exemplo: 36114571088

codigoExterno
string

O código externo da pessoa
Exemplo: 01AB

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém pessoa por código CRM

Consultar uma pessoa pelo código CRM.

Authorizations:
Bearer
path Parameters
codigoCRM
required
string

O código CRM da pessoa
Exemplo: 000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém as pessoas por característica

Consultar de forma paginada todas as pessoas com a característica informada.

Authorizations:
Bearer
query Parameters
identificadorCaracteristica
string

O identificador da característica vinculada a pessoa
Exemplo: 00A0000001

limite
integer <int32>

O limite de registros por pagina
Exemplo: 10

pagina
integer <int32>

A pagina atual a ser consultada
Exemplo: 1

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ],
  • "paginacao": {
    }
}

Realiza vinculo de característica a uma pessoa

Vincular uma característica à pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa
Exemplo: 00A0000001

Request Body schema:

A característica que será vinculada.

identificadorCaracteristica
string or null

O identificador da característica
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "identificadorCaracteristica": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Realiza vinculo de categoria a pessoa

Vincular uma categoria à pessoa.

Authorizations:
Bearer
Request Body schema:

Contrato para realizar o vinculo dos identificadores informados.

identificador
string or null

Identificador da pessoa que será utilizada para vincular a categoria
Exemplo: 00A0000001

identificadorCategoria
string or null

Identificador da categoria
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "identificadorCategoria": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita uma pessoa

Editar uma pessoa no Bimer.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa a ser editada
Exemplo: 00A0000001

Request Body schema:

A pessoa a ser editada.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma pessoa jurídica

Consultar uma pessoa jurídica pelo indentificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da pessoa jurídica
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Obtém uma pessoa fisica

Consultar uma pessoa física pelo indentificador.

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da pessoa física
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Edita a categoria da pessoa

Editar uma categoria da pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa a ser editada
Exemplo: 00A0000001

identificadorCategoria
required
string

O identificador da categoria da pessoa a ser editada
Exemplo: 00A0000001

Request Body schema:

As informações que serão alteradas na categoria.

identificadorPessoaRelacionada
required
string or null

O Identificador da pessoa relacionada à pessoa da categoria
Exemplo: 00A0000001

ativo
required
boolean

Define se a pessoa está ativa ou inativa na categoria
Exemplo: true

codigoChamadaExterno
required
string or null

O código de chamada externo da pessoa em sua categoria
Exemplo: 01AB

Responses

Request samples

Content type
{
  • "identificadorPessoaRelacionada": "string",
  • "ativo": true,
  • "codigoChamadaExterno": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Ativar / Inativar a categoria da pessoa

Ativar ou inativar uma categoria da pessoa.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa
Exemplo: 00A0000001

identificadorCategoria
required
string

O identificador da categoria da pessoa
Exemplo: 00A0000001

Request Body schema:

As informações que serão alteradas na categoria.

identificadorPessoaRelacionada
string or null

Identificador da pessoa relacionada à pessoa da categoria
Exemplo: 00A0000001

ativo
boolean

Indica se a pessoa está ativa ou inativa na categoria
Exemplo: true

codigoChamadaExterno
string or null

Código de chamada externo da pessoa na categoria
Exemplo: 01AB

Responses

Request samples

Content type
{
  • "identificadorPessoaRelacionada": "string",
  • "ativo": true,
  • "codigoChamadaExterno": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Prospectado

Cadastra pessoa como prospectado

Cadastrar uma nova pessoa no sistema como prospectado.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como Prospectado.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

identificador
string or null

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string",
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Altera um prospectado para cliente

Alterar um prospectado para a categoria cliente.

Authorizations:
Bearer
path Parameters
identificadorPessoa
required
string

O identificador da pessoa que está sendo editada
Exemplo: 00A0000001

Request Body schema:

A pessoa a ser editada.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Representante

Cadastra pessoa como representante

Cadastrar uma pessoa como representante.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como representante.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

identificador
string or null

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string",
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Suspect

Cadastra pessoa como Suspect

Cadastrar uma pessoa como suspect.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como suspect.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Transportador

Cadastra pessoa como transportador

Cadastrar uma pessoa no sistema como transportador.

Authorizations:
Bearer
Request Body schema:

A pessoa a ser cadastrada como transportador.

codigo
string or null

Código da pessoa
Exemplo: 123456

cpfCnpj
required
integer <int64>

CPF ou CNPJ da pessoa
Exemplo: 12345678912

dataNascimento
string <date-time>

Data de nascimento da pessoa
Exemplo: 1999-01-01T00:00:00

nome
required
string or null

Nome da pessoa.
Exemplo: Alterdata

nomeCurto
string or null

Nome curto da pessoa
Exemplo: Bimer

retemTributosContribuicoes
boolean

Retenção de tributos e contribuições
Exemplo: true

retemTributosDeQualquerValor
boolean

Retenção de tributos de qualquer valor
Exemplo: true

prestadoraServico
boolean

Pessoa jurídica prestadora de serviço
Exemplo: true

aliquotaIRRF
number <double>

Alíquota de IRRF para pessoa juridica
Exemplo: 0

dataInicioAtividades
string <date-time>

Data de início das atividades
Exemplo: 2020-06-05T17:05:31

entidadeAdministracaoPublicaFederal
boolean

Entidade da administração publíca federal
Exemplo: true

Array of objects or null (PessoaEnderecoCadastroContrato)

Lista de endereços

identificadorRepresentantePrincipal
string or null

Identificador do representante principal
Exemplo: 00A0000001

tipo
string or null

Tipo da pessoa
Exemplo:
"F": Pessoa física;
"J": Pessoa jurídica;

tipoClienteTelecomunicacao
string or null

Tipo de cliente para telecomunicação
Exemplo:
0 - Valor default para casos onde não há um valor definido.
1 - Comercial.
2 - Industrial.
3 - Residêncial / pessoa física.
4 - Produto rural.
5 - Órgão da administração pública estadual direta e suas fundações e autarquias convênio ICMS 107/95.
6 - Prestador de serviço de telecomunicação responsável recolhimento do imposto convênio ICMS 17/13.
7 - Missões diplomáticas, repartições consulares e organismos internacionais convênio ICMS 158/94.
8 - Igrejas e templos de qualquer natureza.
99 - Obtém ou define o tipo de cliente referente o(a) outros não especificados anteriormente.

codigoExterno
string or null

Código externo da pessoa
Exemplo: XPTO

identificadorCNAE
string or null

Identificador do CNAE
Exemplo: 00A0000001

ramoAtividade
string or null

Descrição do ramo de atividade da pessoa
Exemplo: Atividades de contabilidade

identificadorSituacaoCadastralPessoa
string or null

Identificador da situação cadastral da pessoa
Exemplo: 00A0000001

identificador
string or null

Responses

Request samples

Content type
{
  • "codigo": "string",
  • "cpfCnpj": 0,
  • "dataNascimento": "2019-08-24T14:15:22Z",
  • "nome": "string",
  • "nomeCurto": "string",
  • "retemTributosContribuicoes": true,
  • "retemTributosDeQualquerValor": true,
  • "prestadoraServico": true,
  • "aliquotaIRRF": 0.1,
  • "dataInicioAtividades": "2019-08-24T14:15:22Z",
  • "entidadeAdministracaoPublicaFederal": true,
  • "enderecos": [
    ],
  • "identificadorRepresentantePrincipal": "string",
  • "tipo": "string",
  • "tipoClienteTelecomunicacao": "string",
  • "codigoExterno": "string",
  • "identificadorCNAE": "string",
  • "ramoAtividade": "string",
  • "identificadorSituacaoCadastralPessoa": "string",
  • "identificador": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Característica produto

Consultar de característica de produto por identificador

Realizar a busca de característica de produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

Identificador da característica a ser consultada.
Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar de característica de produto por código

Realizar a busca de característica de produto pelo código informado

Authorizations:
Bearer
query Parameters
codigo
required
string

Código da característica a ser consultada.
Exemplo: 12345

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar de característica de produto por nome

Realizar a busca de característica de produto pelo nome informado

Authorizations:
Bearer
query Parameters
nome
required
string

Nome da característica a ser consultada.
Exemplo: Característica teste

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todas as características de produto

Realizar a busca de todas as características de produto cadastradas

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar característica de produto

Realizar o cadastro de característica de produto com dados básicos

Authorizations:
Bearer
Request Body schema:

A característica de produto a ser adicionada.

identificador
string or null

Identificador da característica no banco.
00A000002X

codigo
string or null

Código da característica a ser cadastrado, caso não enviado será gerado um automaticamente.
12345

descricao
string or null

O nome da característica.
Característica teste

tipo
string or null

Tipo da característica, sendo A para analítica e S para sintética.
A

codigoClassificacao
string or null

Nível de classificação da característica.
99.999

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "descricao": "string",
  • "tipo": "string",
  • "codigoClassificacao": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Editar característica de produto

Realizar a edição de característica de produto

Authorizations:
Bearer
Request Body schema:

A característica de produto a ser editada.

identificador
string or null

Identificador da característica no banco.
00A000002X

codigo
string or null

Código da característica a ser cadastrado, caso não enviado será gerado um automaticamente.
12345

descricao
string or null

O nome da característica.
Característica teste

tipo
string or null

Tipo da característica, sendo A para analítica e S para sintética.
A

codigoClassificacao
string or null

Nível de classificação da característica.
99.999

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "descricao": "string",
  • "tipo": "string",
  • "codigoClassificacao": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Estoque produto

Consultar o estoque de um produto

Consultar o estoque de um produto filtrando por código da empresa, identificador do produto, identificador do setor e data

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

codigoEmpresa
required
integer <int32>

O código da empresa que se deseja.
Exemplo: 1

query Parameters
identificadorSetor
string

O identificador do setor.
Exemplo: 00A0000001

dataReferencia
string <date-time>

A data referência (Se omitido considera-se como data atual).
Exemplo: 2023-01-01

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o estoque de lotes de um produto por setor

Consultar os lotes de produto em estoque filtrando por código empresa, indentificador do produto, identificador do setor e data

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

codigoEmpresa
required
integer <int32>

O código da empresa que se deseja.
Exemplo: 1

query Parameters
identificadorSetor
string

O identificador do setor.
Exemplo: 00A0000001

dataReferencia
string <date-time>

A data referência.
Exemplo: 2023-01-01

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o estoque de série de um produto por setor

Consultar as séries de produto em estoque filtrando por código empresa, indentificador do produto, identificador do setor e data

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

codigoEmpresa
required
integer <int32>

Exemplo: 1 O código da empresa.
query Parameters
identificadorSetor
required
string

Exemplo: 00A0000001 O identificador do setor.
dataReferencia
required
string <date-time>

Exemplo: 2023-01-01 A data referência.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o estoque de um produto por setor sem considerar o cache Deprecated

Consultar o estoque de um produto filtrando por código da empresa, identificador do produto, identificador do setor e data

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

codigoEmpresa
required
integer <int32>

O código da empresa que se deseja.
Exemplo: 1

query Parameters
identificadorSetor
string

O identificador do setor.
Exemplo: 00A0000001

dataReferencia
string <date-time>

A data referência.
Exemplo: 2023-01-01

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Família de produto

Consultar família de produto pelo identificador

Consultar a família de produto no Bimer através do identificador

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da família de produto que se deseja localizar.
Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar família de produto pelo código

Consultar uma lista de famílias de produto cadastradas através do código informado

Authorizations:
Bearer
query Parameters
codigo
string

O código da família de produto que se deseja localizar. Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar família de produto pela classificação

Consultar uma lista de famílias de produto cadastradas através da classificação informada

Authorizations:
Bearer
query Parameters
classificacao
string

A classificação dos familias de produto que se deseja localizar.
Exemplo: 123.123

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar família de produto pelo nome

Consultar uma lista de famílias de produto cadastradas através do nome informado

Authorizations:
Bearer
query Parameters
nome
string

O nome da família de produto que se deseja localizar. Exemplo: Descrição da família do produto

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho. Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todas as famílias de produto cadastradas

Consultar todas as famílias de produtos cadastradas no Bimer

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar família de produto

Cadastrar uma nova família de produto no Bimer

Authorizations:
Bearer
Request Body schema:

A família de produto a ser adicionada.

identificador
string or null

Identificador da família de produtos. 00A000002X

codigo
string or null

Código da família do produto. 00A000002X

nome
string or null

Obtém ou define a descrição da família do produto. Descrição da família do produto

tipoClassificacao
string or null

Tipo de classificação da família (Analítico ou sintético). A

codigoClassificacao
string or null

Obtém ou define a classificação da família. 99.999

observacao
string or null

Obtém ou define a observação da família. Observação da família do produto

markupFixo
boolean

Status de Markup fixo. false

aliquotaMargemLucro
number <double>

Obtém ou define a alíquota de margem de lucro. 0.00

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "tipoClassificacao": "string",
  • "codigoClassificacao": "string",
  • "observacao": "string",
  • "markupFixo": true,
  • "aliquotaMargemLucro": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Editar cadastro de família de produto

Editar família de produto no Bimer

Authorizations:
Bearer
Request Body schema:

A família de produto a ser editada.

identificador
string or null

Identificador da família de produtos. 00A000002X

codigo
string or null

Código da família do produto. 00A000002X

nome
string or null

Obtém ou define a descrição da família do produto. Descrição da família do produto

tipoClassificacao
string or null

Tipo de classificação da família (Analítico ou sintético). A

codigoClassificacao
string or null

Obtém ou define a classificação da família. 99.999

observacao
string or null

Obtém ou define a observação da família. Observação da família do produto

markupFixo
boolean

Status de Markup fixo. false

aliquotaMargemLucro
number <double>

Obtém ou define a alíquota de margem de lucro. 0.00

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "tipoClassificacao": "string",
  • "codigoClassificacao": "string",
  • "observacao": "string",
  • "markupFixo": true,
  • "aliquotaMargemLucro": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Grade de produto

Consultar grade de produtos pela descrição

Consultar a grade de produto cadastrada através da descrição informada

Authorizations:
Bearer
query Parameters
descricao
string

A descrição da grade de produtos que se deseja localizar.
Exemplo: Camisa Polo

porTrecho
boolean
Default: false

Define se a pesquisa será feita por trecho
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar detalhes de uma grade de produtos pelo seu identificador

Consultar os detalhes de uma grade de produto cadastrada através do identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da grade de produtos que se deseja localizar.
Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar grade de produtos pelo identificador

Consultar uma grade de produto cadastrada através do identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da grade de produtos que se deseja localizar.
Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todas as grades de produto cadastradas

Consultar todas as grades de produto cadastradas no Bimer

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Grupo de produto

Consultar grupo de produto pelo seu identificador

Consultar o grupo de produto no Bimer através do identificador

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do grupo de produto que se deseja localizar.
Exemplo: 00A000002X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar grupo de produto pelo código

Consultar o grupo de produto no Bimer através do código

Authorizations:
Bearer
query Parameters
codigo
string

O código do grupo de produto que se deseja localizar.
Exemplo: 12345

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar grupo de produto pela classificação

Consultar o grupo de produto no Bimer através da classificação

Authorizations:
Bearer
query Parameters
classificacao
string

A classificação dos grupos de produto que se deseja localizar.
Exemplo: 99.999

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar grupo de produto pelo nome

Consultar o grupo de produto no Bimer através do nome

Authorizations:
Bearer
query Parameters
nome
string

O nome do grupo de produto que se deseja localizar.
Exemplo: Grupo teste

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todos os grupos de produtos

Consultar todos os grupos de produtos cadastrados no Bimer

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar grupo de produto

Realizar o cadastro de grupo de produto com dados básicos

Authorizations:
Bearer
Request Body schema:

O grupo de produto a ser adicionado.

identificador
string or null

Identificador do grupo de produtos.
00A000002X

codigo
string or null

Código do grupo do produto.
12345

nome
string or null

Obtém ou define a descrição do grupo do produto.
Grupo teste

tipoClassificacao
string or null

Tipo de classificação do grupo (Analítico ou sintético).
A

codigoClassificacao
string or null

Obtém ou define a classificação do grupo.
99.999

observacao
string or null

Obtém ou define a observação do grupo.
Observação do grupo teste

aliquotaLucroDesejada
number <double>

Obtém ou define a alíquota de lucro desejada.
20.00

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "tipoClassificacao": "string",
  • "codigoClassificacao": "string",
  • "observacao": "string",
  • "aliquotaLucroDesejada": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Editar grupo de produto

Realizar a edição de grupo de produto com dados básicos

Authorizations:
Bearer
Request Body schema:

O grupo de produto a ser editado.

identificador
string or null

Identificador do grupo de produtos.
00A000002X

codigo
string or null

Código do grupo do produto.
12345

nome
string or null

Obtém ou define a descrição do grupo do produto.
Grupo teste

tipoClassificacao
string or null

Tipo de classificação do grupo (Analítico ou sintético).
A

codigoClassificacao
string or null

Obtém ou define a classificação do grupo.
99.999

observacao
string or null

Obtém ou define a observação do grupo.
Observação do grupo teste

aliquotaLucroDesejada
number <double>

Obtém ou define a alíquota de lucro desejada.
20.00

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "tipoClassificacao": "string",
  • "codigoClassificacao": "string",
  • "observacao": "string",
  • "aliquotaLucroDesejada": 0.1
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Histórico de custo de produto

Consultar o último custo de um produto por empresa e data de referência

Consultar o último preço de um produto em uma empresa filtrando por data

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto.
Exemplo: 00A0000001

codigoEmpresa
required
integer <int32>

O código da empresa.
Exemplo: 01

query Parameters
dataReferencia
required
string <date-time>

A data de referência.
Exemplo: 2023-01-31

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Preço produto

Consultar o preço por empresa e produto

Consultar o preço de um produto em determinada empresa

Authorizations:
Bearer
path Parameters
identificadorEmpresa
required
string

Identificador da empresa que se deseja consultar o preço
Exemplo: 00A0000001

identificadorProduto
required
string

Identificador do produto que se deseja consultar o preço
Exemplo: 00P0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar o preço por empresa, produto e tabela de preços

Consultar o preço de um produto na tebela de preço de determinada empresa

Authorizations:
Bearer
path Parameters
identificadorEmpresa
required
string

Identificador da empresa que se deseja consultar o preço
Exemplo: 00A0000001

identificadorProduto
required
string

Identificador do produto que se deseja consultar o preço
Exemplo: 00P0000001

identificadorPreco
required
string

Identificador da tabela de preço que se deseja
Exemplo: 00T0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Preço

Consultar um preço por identificador

Realizar a busca de preço pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os preços de acordo com uma consulta por nome

Realizar a busca de preço pelo nome informado

Authorizations:
Bearer
query Parameters
nome
required
string

O nome que se deseja consultar.
Exemplo: Tabela de Preço Padrão

porTrecho
boolean

Se deve buscar por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os preços de acordo com uma consulta por código

Realizar a busca de preço pelo código informado

Authorizations:
Bearer
query Parameters
codigo
string

O código que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Produto master

Consultar os produtos da grade relacionados ao produto master indicado pelo identificador

Realizar a busca dos produtos relacionados ao produto master identificado pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto master que se deseja localizar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar produto por código

Realizar a busca de produto pelo código informado

Authorizations:
Bearer
query Parameters
codigo
required
string

O código que se deseja consultar.
Exemplo: 1

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar produtos por identificador

Realizar a busca de produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador que se deseja consultar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar produto por nome

Realizar a busca de produto pelo nome informado

Authorizations:
Bearer
query Parameters
nome
required
string

O nome que se deseja consultar.
Exemplo: Camiseta Polo

porTrecho
boolean

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Produto

Consultar as imagens do produto pelo seu identificador

Consultar as imagens de um produto pelo identificador

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto que se deseja localizar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar um novo produto

Adicionar um novo produto ao sistema.

Authorizations:
Bearer
Request Body schema:

O produto a ser adicionado.

identificador
string or null

Recupera ou atribui o identificador do produto
Exemplo: 00A0000001

codigo
string or null

Recupera ou atribui o código do Produto
Exemplo: 00001

nome
string or null

Recupera ou atribui o nome do produto
Exemplo: Produto X

identificadorProdutoMaster
string or null

Recupera ou atribui o identificador do produto master
Exemplo: 00A0000002

identificadorProdutoOrigem
string or null

Identificador do produto origem.
Exemplo: 00A0000003

fatorConversaoUnidade
number <double>

Fator de conversão da unidade.
Exemplo: 1.000

tipoProduto
string or null

Tipo do produto.
Exemplo: P

tipoComplementarProduto
string or null

Tipo complementar do produto.
Exemplo: M

identificadorUnidade
string or null

Obtém ou define a unidade do Produto
Exemplo: 00A0000007

identificadorClassificacaoFiscal
string or null

Obtém ou define a classificação fiscal do produto
Exemplo: 00A0000008

identificadorCalculoICMS
string or null

Cálculo de ICMS do produto
Exemplo: 00A0000009

pesoBruto
number <double>

Retorna ou atribui o peso bruto.
Exemplo: 10.500

pesoLiquido
number <double>

Retorna ou atribui o peso líquido.
Exemplo: 9.500

Array of objects or null (ProdutoEmpresaCadastroContrato)

A lista de empresas vinculadas ao produto

Array of objects or null (PessoaProdutoCadastroContrato)

A lista de fornecedores vinculadas ao produto

Array of objects or null (CodigoProdutoCadastroContrato)

A lista de códigos vinculados ao produto

observacao
string or null

Obtém ou define a observação do produto
Exemplo: Produto para venda no atacado

identificadorGrupoProduto
string or null

Grupo do Produto
Exemplo: 00A0000002

identificadorFamiliaProduto
string or null

Obtém ou define a família do produto
Exemplo: 00A0000003

nomeCurto
string or null

Nome curto do produto
Exemplo: Produto X

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "identificadorProdutoMaster": "string",
  • "identificadorProdutoOrigem": "string",
  • "fatorConversaoUnidade": 0.1,
  • "tipoProduto": "string",
  • "tipoComplementarProduto": "string",
  • "identificadorUnidade": "string",
  • "identificadorClassificacaoFiscal": "string",
  • "identificadorCalculoICMS": "string",
  • "pesoBruto": 0.1,
  • "pesoLiquido": 0.1,
  • "empresas": [
    ],
  • "fornecedores": [
    ],
  • "codigos": [
    ],
  • "observacao": "string",
  • "identificadorGrupoProduto": "string",
  • "identificadorFamiliaProduto": "string",
  • "nomeCurto": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar um produto por seu código principal

Realizar a busca de um produto pelo código principal informado

Authorizations:
Bearer
query Parameters
codigo
string

O código principal do produto.
Exemplo: 0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Atualizar um produto por identificador, considerando para cada item e pagamento o que foi informado no "TipoCadastro"

Atualizar um produto existente no sistema, considerando para cada item e pagamento o que foi informado no "TipoCadastro"

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto a ser alterado.

Request Body schema:

O contrato do produto a ser alterado.

identificador
string or null

Recupera ou atribui o identificador do produto
Exemplo: 00A0000001

codigo
string or null

Recupera ou atribui o código do Produto
Exemplo: 00001

nome
string or null

Recupera ou atribui o nome do produto
Exemplo: Produto X

identificadorProdutoMaster
string or null

Recupera ou atribui o identificador do produto master
Exemplo: 00A0000002

identificadorProdutoOrigem
string or null

Identificador do produto origem.
Exemplo: 00A0000003

fatorConversaoUnidade
number <double>

Fator de conversão da unidade.
Exemplo: 1.000

tipoProduto
string or null

Tipo do produto.
Exemplo: 00A0000001

tipoComplementarProduto
string or null

Tipo complementar do produto.
Exemplo: 00A0000002

identificadorUnidade
string or null

Obtém ou define a unidade do Produto
Exemplo: 00A0000003

identificadorClassificacaoFiscal
string or null

Obtém ou define a classificação fiscal do produto
Exemplo: 00A0000004

identificadorCalculoICMS
string or null

Cálculo de ICMS do produto
Exemplo: 00A0000005

pesoBruto
number <double>

Retorna ou atribui o peso bruto.
Exemplo: 1.5

pesoLiquido
number <double>

Retorna ou atribui o peso líquido.
Exemplo: 1.2

tipoCadastro
string or null

Tipo de ação a realizar com o cadastro.
Exemplo: A - Alteração. E - Exclusão. I - Inclusão.

Array of objects or null (ProdutoEmpresaAlteracaoContrato)

A lista de empresas vinculadas ao produto

Array of objects or null (PessoaProdutoAlteracaoContrato)

A lista de fornecedores vinculadas ao produto

Array of objects or null (CodigoProdutoAlteracaoContrato)

A lista de códigos vinculados ao produto

observacao
string or null

Obtém ou define a observação do produto
Exemplo: Produto importado

identificadorGrupoProduto
string or null

Grupo do Produto
Exemplo: 00A0000006

identificadorFamiliaProduto
string or null

Obtém ou define a família do produto
Exemplo: 00A0000007

nomeCurto
string or null

Nome curto do produto
Exemplo: Camisa

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "identificadorProdutoMaster": "string",
  • "identificadorProdutoOrigem": "string",
  • "fatorConversaoUnidade": 0.1,
  • "tipoProduto": "string",
  • "tipoComplementarProduto": "string",
  • "identificadorUnidade": "string",
  • "identificadorClassificacaoFiscal": "string",
  • "identificadorCalculoICMS": "string",
  • "pesoBruto": 0.1,
  • "pesoLiquido": 0.1,
  • "tipoCadastro": "string",
  • "empresas": [
    ],
  • "fornecedores": [
    ],
  • "codigos": [
    ],
  • "observacao": "string",
  • "identificadorGrupoProduto": "string",
  • "identificadorFamiliaProduto": "string",
  • "nomeCurto": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar produtos por nome

Realizar a busca de produtos pelo nome informado

Authorizations:
Bearer
query Parameters
nome
required
string

O nome do produto.
Exemplo: Produto Exemplo

porTrecho
boolean

Valor que indica se a consulta do nome será utilizada por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar um produto por seu identificador

Realizar a busca de um produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todos os códigos de produto cadastrados para o produto informado

Realizar a busca de todos os códigos de produto cadastrados para o produto informado

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os identificadores dos produtos com versão do registro superior ao valor determinado

Realizar a busca dos identificadores dos produtos com versão do registro superior ao valor determinado

Authorizations:
Bearer
query Parameters
versaoRegistro
required
integer <int64>

A versão do registro que será usada para filtro (maior que).
Exemplo: 1

itensPorPagina
required
integer <int32>

A quantidade de itens que deverão ser exibidos por página.
Exemplo: 10

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar a composição de um produto pelo seu identificador

Realizar a busca da composição de um produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar a grade de um produto pelo seu identificador

Consultar a grade de um produto pelo seu identificador

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador do produto que se deseja localizar.

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os identificadores de produtos por identificador da família de produto

Realizar a busca dos identificadores de produtos pelo identificador da família de produtos informado

Authorizations:
Bearer
query Parameters
identificadorFamiliaProduto
string

O identificador da família de produtos
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar os identificadores de produtos por identificador do grupo de produto

Realizar a busca dos identificadores de produtos pelo identificador do grupo de produtos informado

Authorizations:
Bearer
query Parameters
identificadorGrupoProduto
string

O identificador do grupo de produtos
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar produto grade

Cadastrar um novo produto do tipo grade

Authorizations:
Bearer
Request Body schema:

A grade de produtos a ser cadastrada.

identificador
string or null

Recupera ou atribui o identificador do produto
Exemplo: 00A0000001

codigo
string or null

Recupera ou atribui o código do Produto
Exemplo: 00001

nome
string or null

Recupera ou atribui o nome do produto
Exemplo: Produto X

identificadorProdutoMaster
string or null

Recupera ou atribui o identificador do produto master
Exemplo: 00A0000002

identificadorProdutoOrigem
string or null

Identificador do produto origem.
Exemplo: 00A0000003

fatorConversaoUnidade
number <double>

Fator de conversão da unidade.
Exemplo: 1.000

tipoProduto
string or null

Tipo do produto.
Exemplo: P

tipoComplementarProduto
string or null

Tipo complementar do produto.
Exemplo: M

identificadorUnidade
string or null

Obtém ou define a unidade do Produto
Exemplo: 00A0000007

identificadorClassificacaoFiscal
string or null

Obtém ou define a classificação fiscal do produto
Exemplo: 00A0000008

identificadorCalculoICMS
string or null

Cálculo de ICMS do produto
Exemplo: 00A0000009

pesoBruto
number <double>

Retorna ou atribui o peso bruto.
Exemplo: 10.500

pesoLiquido
number <double>

Retorna ou atribui o peso líquido.
Exemplo: 9.500

Array of objects or null (ProdutoEmpresaCadastroContrato)

A lista de empresas vinculadas ao produto

Array of objects or null (PessoaProdutoCadastroContrato)

A lista de fornecedores vinculadas ao produto

Array of objects or null (CodigoProdutoCadastroContrato)

A lista de códigos vinculados ao produto

observacao
string or null

Obtém ou define a observação do produto
Exemplo: Produto para venda no atacado

identificadorGrupoProduto
string or null

Grupo do Produto
Exemplo: 00A0000002

identificadorFamiliaProduto
string or null

Obtém ou define a família do produto
Exemplo: 00A0000003

nomeCurto
string or null

Nome curto do produto
Exemplo: Produto X

nomeProdutoGrade
string or null

Retorna ou atribui o nome do produto
Exemplo: Camisa Polo

classificacaoGrade
string or null

Retorna ou atribui a classificação da grade
Exemplo: Roupa

identificadorGradeHorizontal
string or null

Retorna ou atribui o identificador da grade horizontal
Exemplo: 00A0000001

identificadorGradeVertical
string or null

Retorna ou atribui o identificador da grade vertical
Exemplo: 00A0000002

Array of objects or null (ProdutoGradeDetalheCadastroContrato)

Retorna ou atribui os detalhes da grade

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "identificadorProdutoMaster": "string",
  • "identificadorProdutoOrigem": "string",
  • "fatorConversaoUnidade": 0.1,
  • "tipoProduto": "string",
  • "tipoComplementarProduto": "string",
  • "identificadorUnidade": "string",
  • "identificadorClassificacaoFiscal": "string",
  • "identificadorCalculoICMS": "string",
  • "pesoBruto": 0.1,
  • "pesoLiquido": 0.1,
  • "empresas": [
    ],
  • "fornecedores": [
    ],
  • "codigos": [
    ],
  • "observacao": "string",
  • "identificadorGrupoProduto": "string",
  • "identificadorFamiliaProduto": "string",
  • "nomeCurto": "string",
  • "nomeProdutoGrade": "string",
  • "classificacaoGrade": "string",
  • "identificadorGradeHorizontal": "string",
  • "identificadorGradeVertical": "string",
  • "detalhes": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Incluir novos itens em uma grade existente

Adicionar novos itens em uma grade existente com base no produto master informado

Authorizations:
Bearer
path Parameters
identificadorProdutoMaster
required
string

O identificador do produto a ser alterado.
Exemplo: 00A0000001

Request Body schema:

O contrato do produto a ser alterado.

identificador
string or null

Recupera ou atribui o identificador do produto
Exemplo: 00A0000001

codigo
string or null

Recupera ou atribui o código do Produto
Exemplo: 00001

nome
string or null

Recupera ou atribui o nome do produto
Exemplo: Produto X

identificadorProdutoMaster
string or null

Recupera ou atribui o identificador do produto master
Exemplo: 00A0000002

identificadorProdutoOrigem
string or null

Identificador do produto origem.
Exemplo: 00A0000003

fatorConversaoUnidade
number <double>

Fator de conversão da unidade.
Exemplo: 1.000

tipoProduto
string or null

Tipo do produto.
Exemplo: P

tipoComplementarProduto
string or null

Tipo complementar do produto.
Exemplo: M

identificadorUnidade
string or null

Obtém ou define a unidade do Produto
Exemplo: 00A0000007

identificadorClassificacaoFiscal
string or null

Obtém ou define a classificação fiscal do produto
Exemplo: 00A0000008

identificadorCalculoICMS
string or null

Cálculo de ICMS do produto
Exemplo: 00A0000009

pesoBruto
number <double>

Retorna ou atribui o peso bruto.
Exemplo: 10.500

pesoLiquido
number <double>

Retorna ou atribui o peso líquido.
Exemplo: 9.500

Array of objects or null (ProdutoEmpresaCadastroContrato)

A lista de empresas vinculadas ao produto

Array of objects or null (PessoaProdutoCadastroContrato)

A lista de fornecedores vinculadas ao produto

Array of objects or null (CodigoProdutoCadastroContrato)

A lista de códigos vinculados ao produto

observacao
string or null

Obtém ou define a observação do produto
Exemplo: Produto para venda no atacado

identificadorGrupoProduto
string or null

Grupo do Produto
Exemplo: 00A0000002

identificadorFamiliaProduto
string or null

Obtém ou define a família do produto
Exemplo: 00A0000003

nomeCurto
string or null

Nome curto do produto
Exemplo: Produto X

nomeProdutoGrade
string or null

Retorna ou atribui o nome do produto
Exemplo: Camisa Polo

classificacaoGrade
string or null

Retorna ou atribui a classificação da grade
Exemplo: Roupa

identificadorGradeHorizontal
string or null

Retorna ou atribui o identificador da grade horizontal
Exemplo: 00A0000001

identificadorGradeVertical
string or null

Retorna ou atribui o identificador da grade vertical
Exemplo: 00A0000002

Array of objects or null (ProdutoGradeDetalheCadastroContrato)

Retorna ou atribui os detalhes da grade

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "identificadorProdutoMaster": "string",
  • "identificadorProdutoOrigem": "string",
  • "fatorConversaoUnidade": 0.1,
  • "tipoProduto": "string",
  • "tipoComplementarProduto": "string",
  • "identificadorUnidade": "string",
  • "identificadorClassificacaoFiscal": "string",
  • "identificadorCalculoICMS": "string",
  • "pesoBruto": 0.1,
  • "pesoLiquido": 0.1,
  • "empresas": [
    ],
  • "fornecedores": [
    ],
  • "codigos": [
    ],
  • "observacao": "string",
  • "identificadorGrupoProduto": "string",
  • "identificadorFamiliaProduto": "string",
  • "nomeCurto": "string",
  • "nomeProdutoGrade": "string",
  • "classificacaoGrade": "string",
  • "identificadorGradeHorizontal": "string",
  • "identificadorGradeVertical": "string",
  • "detalhes": [
    ]
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Editar produtos da grade

Endpoint possibilita editar as informações dos produtos da grade de forma sincrona, ou seja, ao alterar uma informação ela será replicada para todos os itens da grade. Para a edição individual de um item deve ser utilizado o endpoint de edição de produto.

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto a ser alterado.
Exemplo: 00A0000001

Request Body schema:

O contrato do produto a ser alterado.

identificador
string or null

Recupera ou atribui o identificador do produto
Exemplo: 00A0000001

codigo
string or null

Recupera ou atribui o código do Produto
Exemplo: 00001

nome
string or null

Recupera ou atribui o nome do produto
Exemplo: Produto X

identificadorProdutoMaster
string or null

Recupera ou atribui o identificador do produto master
Exemplo: 00A0000002

identificadorProdutoOrigem
string or null

Identificador do produto origem.
Exemplo: 00A0000003

fatorConversaoUnidade
number <double>

Fator de conversão da unidade.
Exemplo: 1.000

tipoProduto
string or null

Tipo do produto.
Exemplo: 00A0000001

tipoComplementarProduto
string or null

Tipo complementar do produto.
Exemplo: 00A0000002

identificadorUnidade
string or null

Obtém ou define a unidade do Produto
Exemplo: 00A0000003

identificadorClassificacaoFiscal
string or null

Obtém ou define a classificação fiscal do produto
Exemplo: 00A0000004

identificadorCalculoICMS
string or null

Cálculo de ICMS do produto
Exemplo: 00A0000005

pesoBruto
number <double>

Retorna ou atribui o peso bruto.
Exemplo: 1.5

pesoLiquido
number <double>

Retorna ou atribui o peso líquido.
Exemplo: 1.2

tipoCadastro
string or null

Tipo de ação a realizar com o cadastro.
Exemplo: A - Alteração. E - Exclusão. I - Inclusão.

Array of objects or null (ProdutoEmpresaAlteracaoContrato)

A lista de empresas vinculadas ao produto

Array of objects or null (PessoaProdutoAlteracaoContrato)

A lista de fornecedores vinculadas ao produto

Array of objects or null (CodigoProdutoAlteracaoContrato)

A lista de códigos vinculados ao produto

observacao
string or null

Obtém ou define a observação do produto
Exemplo: Produto importado

identificadorGrupoProduto
string or null

Grupo do Produto
Exemplo: 00A0000006

identificadorFamiliaProduto
string or null

Obtém ou define a família do produto
Exemplo: 00A0000007

nomeCurto
string or null

Nome curto do produto
Exemplo: Camisa

nomeProdutoGrade
string or null

Retorna ou atribui o nome do produto
Exemplo: Camisa Polo

classificacaoGrade
string or null

Retorna ou atribui a classificação do produto
Exemplo: Roupa

Responses

Request samples

Content type
{
  • "identificador": "string",
  • "codigo": "string",
  • "nome": "string",
  • "identificadorProdutoMaster": "string",
  • "identificadorProdutoOrigem": "string",
  • "fatorConversaoUnidade": 0.1,
  • "tipoProduto": "string",
  • "tipoComplementarProduto": "string",
  • "identificadorUnidade": "string",
  • "identificadorClassificacaoFiscal": "string",
  • "identificadorCalculoICMS": "string",
  • "pesoBruto": 0.1,
  • "pesoLiquido": 0.1,
  • "tipoCadastro": "string",
  • "empresas": [
    ],
  • "fornecedores": [
    ],
  • "codigos": [
    ],
  • "observacao": "string",
  • "identificadorGrupoProduto": "string",
  • "identificadorFamiliaProduto": "string",
  • "nomeCurto": "string",
  • "nomeProdutoGrade": "string",
  • "classificacaoGrade": "string"
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Tipo de código de produto

Consultar tipos de código de produto por identificador

Realizar a busca de tipos de código de produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da unidade de produto que se deseja localizar.
Exemplo: 00A0000001X

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar tipos de código de produto por código

Realizar a busca de tipos de código de produto pelo código informado

Authorizations:
Bearer
query Parameters
codigo
required
string

O código de chamada do tipo de código de produto que se deseja localizar.
Exemplo: 00001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar tipos de código de produto por nome e trecho

Realizar a busca de tipos de código de produto pelo nome informado, podendo ser por trecho

Authorizations:
Bearer
query Parameters
nome
required
string

O nome do tipo de código de produto que se deseja localizar.
Exemplo: Principal

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todos os tipos de código de produto

Realizar a busca de todos os tipos de código de produto cadastrados

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Unidade de produto

Consultar unidade de produto por identificador

Realizar a busca de unidade de produto pelo identificador informado

Authorizations:
Bearer
path Parameters
identificador
required
string

O identificador da unidade de produto que se deseja localizar.
Exemplo: 00A0000001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar unidade de produto por código

Realizar a busca de unidade de produto pelo código informado

Authorizations:
Bearer
query Parameters
codigo
required
string

O código da unidade de produto que se deseja localizar.
Exemplo: 00001

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar unidade de produto por nome e por trecho

Realizar a busca de unidade de produto pelo nome informado e por trecho

Authorizations:
Bearer
query Parameters
nome
required
string

O nome da unidade que se deseja localizar.
Exemplo: Unidade Exemplo

porTrecho
boolean
Default: false

Indica se a pesquisa deve ser feita por trecho.
Exemplo: true

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Consultar todas as unidades de produtos

Realizar a busca de todas as unidades de produtos cadastradas no sistema.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Versão de produto

Consultar uma determinada versão do produto

Realizar a consulta de uma versão do produto pelo identificador do produto e número da versão.

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

query Parameters
numeroVersao
required
string

O numero da versão.
Exemplo: 2.23.45.0

Responses

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Cadastrar uma versão no produto

Cadastrar uma nova versão no produto identificado pelo identificador do produto

Authorizations:
Bearer
path Parameters
identificadorProduto
required
string

O identificador do produto.
Exemplo: 00A0000001

Request Body schema:

O contrato versoes.

dataLiberacao
string <date-time>

Obtém ou atribui a data liberação da versão.
Exemplo: 2020-06-15T16:53:02.339Z

dataProgramada
string <date-time>

Obtém ou atribui a data programada da versão.
Exemplo: 2020-06-20T16:53:02.339Z

numero
string or null

Obtém ou atribui o numero da versão.
Exemplo: 2.07.45.5

observacao
string or null

Obtém ou atribuí a observação da versão.
Exemplo: Versão com melhorias no desempenho.

tipoVersao
integer <int32> (ETipoVersaoProduto)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "dataLiberacao": "2019-08-24T14:15:22Z",
  • "dataProgramada": "2019-08-24T14:15:22Z",
  • "numero": "string",
  • "observacao": "string",
  • "tipoVersao": 0
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}

Atualizar uma versão

Atualizar uma versão do produto pelo identificador da versão

Authorizations:
Bearer
path Parameters
identificadorVersao
required
string

The identificador versao.
Exemplo: 00A000002X

Request Body schema:

The contrato versoes.

dataLiberacao
string <date-time>

Obtém ou atribui a data liberação da versão.
Exemplo: 2020-06-15T16:53:02.339Z

dataProgramada
string <date-time>

Obtém ou atribui a data programada da versão.
Exemplo: 2020-06-20T16:53:02.339Z

numero
string or null

Obtém ou atribui o numero da versão.
Exemplo: 2.07.45.5

observacao
string or null

Obtém ou atribuí a observação da versão.
Exemplo: Versão com melhorias no desempenho.

tipoVersao
integer <int32> (ETipoVersaoProduto)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "dataLiberacao": "2019-08-24T14:15:22Z",
  • "dataProgramada": "2019-08-24T14:15:22Z",
  • "numero": "string",
  • "observacao": "string",
  • "tipoVersao": 0
}

Response samples

Content type
application/json
{
  • "erros": [
    ],
  • "listaObjetos": [
    ]
}