API docs by Redocly

API - Alterdata Bimer - v10.00.03.00

Download OpenAPI specification:

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.

Primeiros passos

Veja como é simples começar a desenvolver com a nossa API:

1 - Registre-se!

Para obter acesso às APIs, é necessário entrar em contato com nosso canal de atendimento no karoo e verificar a viabilidade de disponibilização para sua empresa.

Após isto, cadastraremos sua aplicação e lhe passaremos seus Tokens de acesso.

Leia o tópico de autenticação para entender como funcionam os Tokens.

2 - Conhecendo as APIs

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.

3 - Desenvolva sua aplicação

Agora que você já possui seu cadastro, os Tokens de acesso e já conhece melhor a API, comece a desenvolver sua aplicação.

APIs

Esta API fornece aos desenvolvedores que a consomem a possibilidade de integração com diversas funcionalidades do Bimer.

Modelagem das API's

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 / PATCH
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 BimerAPI

  • Versã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

Reautenticar o token para utilização no serviço

O Refresh Token, tem sempre uma validade de 30 minutos, caso o tempo da sessão tenha expirado será necessário realizar os passos de autenticação novamente.

Request Body schema: application/x-www-form-urlencoded
Array
client_id
string

Este valor será passado pela Alterdata com o nome da sua aplicação que será liberada para acesso a api.

grant_type
string

No caso de reautenticação será sempre fixo "refresh_token".

refresh_token
string

Hash de refresh token recebido no retorno da autenticação.

Responses

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlI",
  • "token_type": "bearer",
  • "expires_in": 899,
  • "refresh_token": "df11fb7117264120a71b65311c943789",
  • "client_id": "aplicação.js",
  • "userName": "usuário",
  • ".issued": "Thu, 01 Oct 2015 18:27:26 GMT",
  • ".expires": "Thu, 01 Oct 2015 18:42:26 GMT"
}

Agência

Consultar uma agência por seu identificador

Consulta uma agência cadastrada no Bimer por seu identificador, não confundir com o código.

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da agência

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer token

e.g. Bearer token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

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

query Parameters
identificadorBanco
required
string
Example: identificadorBanco=353
numeroAgencia
required
string
Example: numeroAgencia=3334
header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer token

e.g. Bearer token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Agenda

Cadastrar um novo agendamento

Cadastra um novo agendamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorTipoAgendamento
string

O identificador do tipo de agendamento

IdentificadorTipoAtendimento
string

O identificador do tipo de atendimento

Observacao
string

Observação do agendamento

Array of objects (DataAgendamento)

A data do agendamento

Array of objects (PessoaAgendamento)

A pessoa do contato

IdentificadoresUsuarios
Array of strings

O código do usuário do agendamento

Responses

Request samples

Content type
application/json
{
  • "IdentificadorTipoAgendamento": "00A0000002",
  • "IdentificadorTipoAtendimento": "00A0000001",
  • "Observacao": "Observação",
  • "DatasAgendamento": [
    ],
  • "Pessoas": [
    ],
  • "IdentificadoresUsuarios": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Anexo

Cadastrar um novo anexo

Cadastra um novo anexo no banco utilizando multipart/form-data

path Parameters
nomeEntidade
required
string
Example: PedidoDeVenda

O nome da entidade de origem.

identificadorEntidade
required
string
Example: 00A0000001

O identificador da entidade de origem

header Parameters
Authorization
string
Example: Bearer token

e.g. Bearer token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Atendimento

Cadastrar um atendimento

Cadastra um novo atendimento que pode ser visualizado no CRM

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Agrupamento
string

O agrupamento ao que o atendimento pertence

Assunto
string

O assunto do atendimento

CodigoExterno
string

O código externo do atendimento

DataAbertura
string

A data de abertura

DataContatoInterno
string

A data de contato Interno

DataEntrega
string

A data de entrega

DataPrevista
string

A data prevista

DestinatariosSpySystem
Array of strings

Array com o login de quem deve receber e-mails do SpySystem

IdentificadorPessoa
required
string

O identificador da pessoa do atendimento

IdentificadorProduto
string

O identificador do produto

IdentificadorTipoAtendimento
required
string

O identificador do tipo de atendimento

IdentificadorUsuarioContatoInterno
string

O identificador do usuário de contato interno

IdentificadorVersaoProduto
string

O identificador da versão do produto

object (AtendimentoParecerCadastroContrato)
Prioridade
number

O valor da prioridade do atendimento

Tag
string

Uma tag para o atendimento

IdentificadorEntidadeOrigem
string

O identificador da entidade origem

NomeEntidadeOrigem
string

O nome da entidade origem

Responses

Request samples

Content type
application/json
{
  • "Agrupamento": "A",
  • "Assunto": "A",
  • "CodigoExterno": "A",
  • "DataAbertura": "2020-06-10T12:32:15.992Z",
  • "DataContatoInterno": "2020-06-10T12:32:15.992Z",
  • "DataEntrega": "2020-06-10T12:32:15.992Z",
  • "DataPrevista": "2020-06-10T12:32:15.992Z",
  • "DestinatariosSpySystem": [ ],
  • "IdentificadorPessoa": "00A0000001",
  • "IdentificadorProduto": "00A0000001",
  • "IdentificadorTipoAtendimento": "00A0000001",
  • "IdentificadorUsuarioContatoInterno": "00A0000001",
  • "IdentificadorVersaoProduto": "00A0000001",
  • "ParecerAbertura": {
    },
  • "Prioridade": 0,
  • "Tag": "A",
  • "IdentificadorEntidadeOrigem": "00A0000001",
  • "NomeEntidadeOrigem": "Entidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Adicionar um parecer em um atendimento

Adiciona um parecer em um atendimento

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do atendimento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataInicialParecer
string

A data de início do parecer

DataFinalParecer
string

A data do fim do parecer

DataProximoContato
string

A data de próximo contato

Descricao
string

A descrição do parecer

IdentificadorTipoContato
string

O identificador do tipo de contato

IdentificadorUsuarioProximoContato
string

O identificador do usuário de próximo contato

IdentificadorWorkFlowDestino
string

O identificador do WorkFlow de destino

IdentificadorWorkFlowItemDestino
string

O identificador do item do WorkFlow de destino

NomePessoaContato
string

O nome da pessoa de contato do parecer

Responses

Request samples

Content type
application/json
{
  • "DataInicialParecer": "2020-06-10T12:32:15.992Z",
  • "DataFinalParecer": "2020-06-10T12:32:15.992Z",
  • "DataProximoContato": "2020-06-10T12:32:15.992Z",
  • "Descricao": "Parecer",
  • "IdentificadorTipoContato": "00A0000001",
  • "IdentificadorUsuarioProximoContato": "00A0000001",
  • "IdentificadorWorkFlowDestino": "00A0000001",
  • "IdentificadorWorkFlowItemDestino": "00A0000001",
  • "NomePessoaContato": "Cliente"
}

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

query Parameters
identificadorUsuario
required
string
Example: identificadorUsuario=00A0000001

O identificador do usuário

identificadorAtendimento
string
Example: identificadorAtendimento=00A0000001

O identificador do atendimento

*Obs.: É necessário preencher o parâmetro 'identificadorAtendimento' ou 'identificadorTipoAtendimento'

identificadorTipoAtendimento
string
Example: identificadorTipoAtendimento=00A0000001

O identificador do tipo de atendimento

*Obs.: É necessário preencher o parâmetro 'identificadorAtendimento' ou 'identificadorTipoAtendimento'

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "Listaobjetos": [
    ]
}

Bairro

Consultar bairros por nome

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

query Parameters
nomeBairro
required
string
Example: nomeBairro=CENTRO

O nome do bairro que está sendo consultada.

porTrecho
required
boolean
Example: porTrecho=true

Valor que indica se a consulta deverá ser feita por trecho

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um bairro por seu identificador

Consulta um bairro cadastrado no Bimer pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do bairro

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um bairro

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Codigo
string

O código do bairro no desktop

Identificador
string

O identificador do bairro

Nome
string

O nome do bairro

Responses

Request samples

Content type
application/json
{
  • "Codigo": "000001",
  • "Identificador": "00A0000001",
  • "Nome": "CENTRO"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Banco

Consultar um banco através de seu identificador

Consulta um banco cadastrado no Bimer pelo identificador

path Parameters
identificador
required
string
Example: 001

O identificador do banco

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Característica Pessoa

Consultar todas as características de pessoa cadastradas

Obtém todas as características de pessoas cadastradas no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a característica de pessoa por seu identificador

Consulta uma característica de pessoa cadastrada no Bimer pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da característica

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar características vinculadas a pessoa por seu identificador

Consulta características vinculadas a pessoa cadastrada no Bimer por seu identificador

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

O identificador da pessoa

identificadorCaracteristica
string
Example: identificadorCaracteristica=00A0000002

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Remover uma característica vinculada a uma pessoa

Remove o vínculo da característica com a pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

identificadorCaracteristica
required
string
Example: 00A0000001

O identificador da característica

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Categoria

Consultar todas as categorias cadastradas

Obtém todas as categorias cadastradas no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma categoria por seu identificador

Consulta uma categoria cadastrada no Bimer pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da categoria

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Centro de Custo

Consultar todos os centros de custo cadastrados

Obtém todos os centros de custo cadastrados no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Deletar um lançamento de centro de custo

Deleta um lançamento de centro de custo

path Parameters
identificador
required
string
Example: 00A0000001

Identificador do lançamento de centro de custo

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

CEP

Cadastrar um CEP

Cadastra um CEP no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Codigo
string

000 (string, required) - O código do CEP

IdentificadorBairro
string

O identificador do bairro

IdentificadorCidade
string

O identificador da cidade

IdentificadorUF
string

O identificador da UF

NomeLogradouro
required
string

O nome do logradouro

TipoLogradouro
string

O tipo do logradouro

IdentificadorTipoLogradouro
string

O identificador do tipo de logradouro

Responses

Request samples

Content type
application/json
{
  • "Codigo": "00000",
  • "IdentificadorBairro": "00A0000001",
  • "IdentificadorCidade": "00A0000001",
  • "IdentificadorUF": "RJ",
  • "NomeLogradouro": "Teste CEP",
  • "TipoLogradouro": "Teste",
  • "IdentificadorTipoLogradouro": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um CEP pelo seu código

Busca um CEP pelo código

path Parameters
codigo
required
string
Example: 25953-200

O código do CEP

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar CEPs por cidade

Consulta os CEPs cadastrados para uma cidade

path Parameters
identificadorCidade
required
string
Example: 00A0000001

O identificador da cidade

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar CEPs por logradouro

Consulta os CEPs pelo nome do logradouro

path Parameters
nomeLogradouro
required
string
Example: PREFEITO SEBASTIÃO TEIXEIRA

O nome do logradouro

query Parameters
porTrecho
boolean
Example: porTrecho=true

Valor que indica se a consulta deverá ser feita por trecho

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cidades

Cadastrar uma cidade

Cadastra uma cidade no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorUF
required
string

O identificador da UF

CodigoIBGE
required
string

O código do IBGE

Codigo
string

O código da cidade no Bimer

CodigoDDD
string

O código do DDD da cidade

Nome
required
string

O nome da cidade

Responses

Request samples

Content type
application/json
{
  • "IdentificadorUF": "RJ",
  • "CodigoIBGE": "2900306",
  • "Codigo": "004223",
  • "CodigoDDD": "21",
  • "Nome": "Teresópolis"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Editar uma cidade

Edita uma cidade de acordo com o identificador

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorUF
required
string

O identificador da UF

CodigoIBGE
required
string

O código do IBGE

Codigo
string

O código da cidade no Bimer

CodigoDDD
string

O código do DDD da cidade

Nome
required
string

O nome da cidade

Responses

Request samples

Content type
application/json
{
  • "IdentificadorUF": "RJ",
  • "CodigoIBGE": "2900306",
  • "Codigo": "004223",
  • "CodigoDDD": "21",
  • "Nome": "Teresópolis"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar cidades por nome e UF

Consulta uma cidade pelo nome e pela UF

path Parameters
siglaUF
required
string
Example: RJ

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

query Parameters
nomeCidade
required
string
Example: nomeCidade=Teresópolis

O nome da cidade que está sendo consultada.

nomeCidadePorTrecho
required
boolean
Example: nomeCidadePorTrecho=true

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma cidade por seu identificador

Consulta uma cidade pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da cidade

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cliente

Cadastrar uma pessoa como cliente

Cadastra uma pessoa no Bimer e a adiciona a lista de clientes

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal da pessoa

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

Codigo
string

O código da pessoa no Bimer

CodigoExterno
string

O código externo da pessoa

CpfCnpj
required
number

O CPF ou CNPJ da pessoa

Caso o usuário queira cadastrar um cliente com o mesmo CPF/CNPJ, deverá ser alterada a configuração em Configurador do Bimer / Geral / Opções / Pessoa. Verificar seção "Ao cadastrar mais de uma vez o mesmo CPF/CNPJ".

DataNascimento
string

A data de nascimento da pessoa

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto da pessoa. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributações

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviços

AliquotaIRRF
number

Define a alíquota de IRRF para a pessoa jurídica

DataInicioAtividades
string

A data do início das atividades da empresa

EntidadeAdministracaoPublicaFederal
boolean

Define se a pessoa é uma entidade da administração pública federal

IdentificadorCNAE
string

O identificador do CNAE da pessoa

IdentificadorSituacaoCadastralPessoa
string

O Identificador da situação cadastral da pessoa

RamoAtividade
string

A descrição do ramo de atividade da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "Codigo": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-05T17:05:31.298Z",
  • "Nome": "Pessoa Documentação",
  • "NomeCurto": "Pessoa",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 0,
  • "DataInicioAtividades": "2020-06-05T17:05:31",
  • "EntidadeAdministracaoPublicaFederal": true,
  • "IdentificadorCNAE": "00A0000001",
  • "IdentificadorSituacaoCadastralPessoa": "00A0000001",
  • "RamoAtividade": "Atividades de contabilidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o transportador de um cliente

Consulta o transportador vinculado a um cliente

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Vincular um transportador a um cliente

Vincula um transportador ao cliente

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa que está sendo editada

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Configuração

Consultar configurações de uma seção por seu nome

Consulta uma configuração pelo nome da seção

query Parameters
nomeSecao
required
string
Example: nomeSecao=Geral

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Conta Bancária

Consultar todas as contas bancárias cadastradas

Consulta todas as contas bancárias cadastradas no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma conta bancária por seu identificador

Consulta a conta bancária com base no identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da conta bancária

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os saldos das contas bancárias por seu código de empresa

Consulta o salda bancário de uma conta com base na empresa

path Parameters
codigoEmpresa
required
number
Example: 1

Código da empresa cadastrada no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Conta-Corrente

Cadastrar um novo lançamento na conta-corrente

Cadastra um novo lançamento na conta-corrente

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
AliquotaMovimento
number

A alíquota do movimento

DataLiberacao
string

A data de liberação

DataMovimento
required
string

A data do movimento

CodigoEmpresa
required
number

O código da empresa

Historico
string

corrente feito através da API do Bimer (string) - O histórico

LancamentoCompoeFatura
boolean

Define se o lançamento compõe fatura

LancamentoCompoeIRRF
boolean

Define se o lançamento compõe IRRF

IdentificadorNaturezaLancamento
required
string

O identificador da natureza de lançamento

IdentificadorPessoa
required
string

O identificador da pessoa

ValorBaseMovimento
number

O valor de base do movimento

ValorMovimento
required
number

O valor do movimento

Responses

Request samples

Content type
application/json
{
  • "AliquotaMovimento": 10,
  • "DataLiberacao": "2020-06-08T12:10:45.123Z",
  • "DataMovimento": "2020-06-08T12:10:45.123Z",
  • "CodigoEmpresa": 1,
  • "Historico": "Lançamento na conta",
  • "LancamentoCompoeFatura": true,
  • "LancamentoCompoeIRRF": true,
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "ValorBaseMovimento": 1000,
  • "ValorMovimento": 100
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Contato de Venda

Cadastrar um novo Contato de Venda

Cadastrar um novo contato de venda

Nota: Ao informar "pagamentos" é necessário informar uma data de fechamento (DataFechamentoCobranca ou DataFechamentoPedido) na requisição para calcular o vencimento da parcela.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
AssuntoAtual
required
string

O assunto.

DescricaoContato
required
string

A descrição do contato. Máx. 50 caracteres.

ContatoPrioritario
boolean

Define se o contato é prioritário.

DataAbertura
required
string

A data de abertura.

DataContatoInterno
required
string

A data do contato interno.

DataProximoContato
required
string

A data de próximo contato.

DataEncerramento
string

A data de encerramento.

DataPrevistaFechamento
required
string

A data prevista para fechamento.

DestinatariosSpySystem
Array of strings

Destinatários para receber spy system.

IdentificadorOperacaoNotaFiscal
string

O identificador da operação de nota fiscal.

Encerrado
required
boolean

Define se o contato está encerrado.

IdentificadorMeioContato
required
string

O identificador do meio de contato.

IdentificadorSistemaAtual
required
string

O identificador do sistema atual.

IdentificadorPrazo
required
string

O identificador do prazo.

ObservacaoDocumento
string

A observação do documento.

Array of objects (ContatoVendaItens)

Os itens do contato de venda.

Array of objects (ContatoVendaParecer)

O parecer do contato de venda.

Array of objects (RepasseContatoVenda)

O Repasse do contato de venda.

Array of objects (ConcorrentesContatoVenda)

Concorrentes do contato de venda.

PercentualFechamento
required
number

Valor do percentual do fechamento.

object (PessoaIdentificadorContatoVenda)
Array of objects (PagamentoContatoVenda)

A forma de pagamento no contato de venda. Atenção: É necessário informar o campo DataFechamentoCobranca ou DataFechamentoPedido ao informar pagamentos.

DataFechamentoCobranca
string

A data do fechamento da cobrança.

DataFechamentoPedido
string

A data do fechamento do pedido.

Restrito
boolean

Define se o contato é restrito.

IdentificadorTipoAtendimento
required
string

O identificador do tipo de atendimento .

IdentificadorUsuarioContatoInterno
required
string

O identificador do usuário do contato interno.

IdentificadorUsuarioProximoContato
required
string

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

IdentificadorUsuarioSolicitanteAbertura
required
string

O identificador do usuário solicitante da abertura.

IdentificadorUsuarioAbertura
required
string

O identificador do usuário de abertura.

ValorAproximado
required
number

O valor aproximado do contato.

IdentificadorClienteResponsavelFinanceiro
string

O identificador do cliente responsável pelo financeiro.

GerarPedidoPessoaFinanceiro
boolean

Define se irá gerar o pedido para o responsável pelo financeiro.

Obs.: Quando for 'true', será obrigado a informação do identificador do cliente responsável pelo financeiro.

Responses

Request samples

Content type
application/json
{
  • "AssuntoAtual": "A",
  • "DescricaoContato": "A",
  • "ContatoPrioritario": false,
  • "DataAbertura": "2020-06-15T12:32:15.992Z",
  • "DataContatoInterno": "2020-06-15T12:32:15.992Z",
  • "DataProximoContato": "2020-06-15T12:32:15.992Z",
  • "DataEncerramento": "2020-06-15T12:32:15.992Z",
  • "DataPrevistaFechamento": "2020-06-15T12:32:15.992Z",
  • "DestinatariosSpySystem": [ ],
  • "IdentificadorOperacaoNotaFiscal": "00A0000001",
  • "Encerrado": false,
  • "IdentificadorMeioContato": "00A0000001",
  • "IdentificadorSistemaAtual": "00A0000001",
  • "IdentificadorPrazo": "00A0000001",
  • "ObservacaoDocumento": "Documento cadastrado pela BimerAPI",
  • "Itens": [
    ],
  • "Pareceres": [
    ],
  • "Repasses": [
    ],
  • "Concorrentes": [
    ],
  • "PercentualFechamento": 100,
  • "Pessoa": {
    },
  • "Pagamentos": [
    ],
  • "DataFechamentoCobranca": "2020-06-10T17:53:34.947Z",
  • "DataFechamentoPedido": "2020-06-10T17:53:34.947Z",
  • "Restrito": true,
  • "IdentificadorTipoAtendimento": "00A0000001",
  • "IdentificadorUsuarioContatoInterno": "00A0000001",
  • "IdentificadorUsuarioProximoContato": "00A0000001",
  • "IdentificadorUsuarioSolicitanteAbertura": "00A0000001",
  • "IdentificadorUsuarioAbertura": "00A0000001",
  • "ValorAproximado": 100,
  • "IdentificadorClienteResponsavelFinanceiro": "00A0000001",
  • "GerarPedidoPessoaFinanceiro": true
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Documento

Consultar todos os documentos de venda por emitente

Consulta pagina por documentos de venda por emitente, permitindo filtrar por código da empresa, data inicial e final

query Parameters
codigoEmpresa
required
number
Example: codigoEmpresa=1

Código da empresa cadastrada no Bimer

dataInicial
required
string
Example: dataInicial=2017-03-21

A data inicial de emissão do documento

dataFinal
required
string
Example: dataFinal=2017-03-21

A data final de emissão do documento

limite
required
number
Example: limite=1

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

pagina
required
number
Example: pagina=1

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma lista de documentos pelo identificador do pedido de venda

Consultar os documentos com base no identificador do pedido de venda de origem Nota: O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro

path Parameters
identificadorPedido
required
string
Example: 00A0000001

O identificador do pedido de venda

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

Consultar os documentos com base no código do pedido de venda de origem Nota: O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro

path Parameters
codigoPedidoDeVenda
required
string
Example: 00A0000001

O código do pedido de venda

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

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

path Parameters
codigoPedidoDeCompra
required
string
Example: 00A0000001

Código do documento do pedido de compra a ser consultado

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o documento pelo identificador

Consulta o documento com base no identificador

path Parameters
identificadorDocumento
required
string
Example: 00A0000001

O identificador documento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

Consulta documentos com filtro por Identificador da Pessoa, tipo de operação, data de emissão inicial e final

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

Obtém o identificador de Pessoa

tipoOperacao
required
string
Example: tipoOperacao=V
dataInicial
required
string
Example: dataInicial=2017-03-21

Obtém data Inicial

dataFinal
required
string
Example: dataFinal=2017-03-21

Obtém data Final

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o PDF do DANFE por identificador documento

Consulta o PDF do DANFE com base no identificador do documento

O retorno da consulta será um PDF em BASE64, necessitando apenas ser convertido para PDF.
Exemplo:
GET: /00A000001C/DANFE/PDF
    {
       JVBERi0xLjQNCiW17a77DQoyIDAgb2JqDQo8PCAvTGVuZ3RoIDMgMCBSDQogICAv
       VHlwZSAvWE9iamVjdA0KICAgL1N1YnR5cGUgL0Zvcm0NCiAgIC9CQm94IFsgMCAw
       IDIxNiA0MDQgXQ0KPj4NCnN0cmVhbQ0KMSAwIDAgLTEgMCA0MDQgY20NCnEgMzYg
       ...
       MjA5OSAwMDAwMCBuDQowMDAwMDIyMjI5IDAwMDAwIG4NCnRyYWlsZXINCjw8IC9T
       aXplIDEwDQogICAvUm9vdCA5IDAgUg0KICAgL0luZm8gOCAwIFINCj4+DQpzdGFy
       dHhyZWYNCjIyMjg2DQolJUVPRg0K
    }
path Parameters
identificadorDocumento
required
string
Example: 00A0000001

O identificador documento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Consultar o XML do DANFE por identificador documento

Consulta o XML do DANFE com base no identificador do documento

path Parameters
identificadorDocumento
required
string
Example: 00A0000001

O identificador documento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Consultar o documento pela chave de acesso

Consulta um documento pela chave de acesso

path Parameters
chaveAcesso
required
string
Example: 11111111111111111111111111111111111111111111

A chave de acesso

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o documento pela empresa e numero

Consulta o documento filtrando por empresa e número

query Parameters
numero
required
string
Example: numero=1

O número do documento

codigoEmpresa
required
number
Example: codigoEmpresa=01

O código da empresa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todas as notas inutilizadas por empresa

Consultar todas as notas inutilizadas por empresa e numero do documento

query Parameters
identificadorEmpresa
required
number
Example: identificadorEmpresa=1

O identificador da empresa

dataInicial
required
string
Example: dataInicial=2017-03-21

A data inicial de emissão do documento

dataFinal
required
string
Example: dataFinal=2017-03-21

A data final de emissão do documento

codigoSerieSubSerie
required
number
Example: codigoSerieSubSerie=1

O código da sub série

numeroDocumento
required
number
Example: numeroDocumento=123456

O número do documento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um novo documento de saída

Cadastra um novo documento de saída no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
StatusNotaFiscalEletronica
string

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

CodigoContratoCompraCliente
string

O código do contrato do cliente

CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento está pronto para ser liberado

TipoDocumento
required
string

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

TipoPagamento
required
string

O tipo de pagamento: "0": À Vista | "1": Parcelado

CodigoEmpresa
required
string

O código da empresa

DataEmissao
required
string

A data de emissão

DataReferencia
required
string

A data de referência

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorOperacao
required
string

O identificador da operação

IdentificadorPessoa
required
string

O identificador da pessoa

Array of objects (DocumentoItemCadastroContrato)

Os itens do documento

NomeEntidadeOrigem
string

O nome da entidade origem

Identificador
string

O identificador do documento. No cadastro ele será desconsiderado

Numero
required
string

O número do documento

Observacao
string

A observação

Array of objects (DocumentoPagamentoCadastroContrato)

Os pagamentos

Responses

Request samples

Content type
application/json
{
  • "StatusNotaFiscalEletronica": "A",
  • "CodigoContratoCompraCliente": "1234",
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "TipoDocumento": "F",
  • "TipoPagamento": "0",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-08T12:10:45.126Z",
  • "DataReferencia": "20-06-08T12:10:45.126Z",
  • "DataReferenciaPagamento": "2020-06-08T12:10:45.126Z",
  • "IdentificadorOperacao": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "Itens": [
    ],
  • "NomeEntidadeOrigem": "PedidoVenda",
  • "Identificador": "00A0000001",
  • "Numero": "123456",
  • "Observacao": "Observação",
  • "Pagamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
StatusNotaFiscalEletronica
string

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

CodigoContratoCompraCliente
string

O código do contrato do cliente

CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento está pronto para ser liberado

TipoDocumento
required
string

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

TipoPagamento
required
string

O tipo de pagamento: "0": À Vista | "1": Parcelado

CodigoEmpresa
required
string

O código da empresa

DataEmissao
required
string

A data de emissão

DataReferencia
required
string

A data de referência

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorOperacao
required
string

O identificador da operação

IdentificadorPessoa
required
string

O identificador da pessoa

Array of objects (DocumentoItemCadastroContrato)

Os itens do documento

NomeEntidadeOrigem
string

O nome da entidade origem

Identificador
string

O identificador do documento. No cadastro ele será desconsiderado

Numero
required
string

O número do documento

Observacao
string

A observação

Array of objects (DocumentoPagamentoCadastroContrato)

Os pagamentos

Responses

Request samples

Content type
application/json
{
  • "StatusNotaFiscalEletronica": "A",
  • "CodigoContratoCompraCliente": "1234",
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "TipoDocumento": "F",
  • "TipoPagamento": "0",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-08T12:10:45.126Z",
  • "DataReferencia": "20-06-08T12:10:45.126Z",
  • "DataReferenciaPagamento": "2020-06-08T12:10:45.126Z",
  • "IdentificadorOperacao": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "Itens": [
    ],
  • "NomeEntidadeOrigem": "PedidoVenda",
  • "Identificador": "00A0000001",
  • "Numero": "123456",
  • "Observacao": "Observação",
  • "Pagamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um novo documento de entrada

Cadastra um documento de entrada

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
ChaveAcessoNotaFiscalEletronica
string

A chave de acesso

CodigoContratoCompraCliente
string

O código do contrato do cliente

CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento está pronto para ser liberado

TipoDocumento
required
string

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

TipoPagamento
required
string

O tipo de pagamento: "0": À Vista | "1": Parcelado

CodigoEmpresa
required
string

O código da empresa

DataEmissao
required
string

A data de emissão

DataReferencia
required
string

A data de referência

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorOperacao
required
string

O identificador da operação

IdentificadorPessoa
required
string

O identificador da pessoa

Array of objects (DocumentoItemCadastroContrato)

Os itens do documento

NomeEntidadeOrigem
string

O nome da entidade origem

Identificador
string

O identificador do documento. No cadastro ele será desconsiderado

Numero
required
string

O número do documento

Observacao
string

A observação

Array of objects (DocumentoPagamentoCadastroContrato)

Os pagamentos

Responses

Request samples

Content type
application/json
{
  • "ChaveAcessoNotaFiscalEletronica": "12345678912345678912345689",
  • "CodigoContratoCompraCliente": "1234",
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "TipoDocumento": "F",
  • "TipoPagamento": "0",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-08T12:10:45.126Z",
  • "DataReferencia": "20-06-08T12:10:45.126Z",
  • "DataReferenciaPagamento": "2020-06-08T12:10:45.126Z",
  • "IdentificadorOperacao": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "Itens": [
    ],
  • "NomeEntidadeOrigem": "PedidoVenda",
  • "Identificador": "00A0000001",
  • "Numero": "123456",
  • "Observacao": "Observação",
  • "Pagamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um documento como beneficiamento

Cadastra um documento de beneficiamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador do documento

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um documento de telecomunicações

Cadastra um documento de telecomunicação

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
TipoFinalidade
number

O tipo de finalidade da nota de telecomunicações: [0 - NaoDefinido] [1 - Telefônia] [2 - Comunicação de dados] [3 - TV Por Assinatura] [4 - Provimento de acesso à internet] [5 - Multimídia] [6 - Outros]

CodigoContratoCompraCliente
string

O código do contrato do cliente

CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento está pronto para ser liberado

TipoDocumento
required
string

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

TipoPagamento
required
string

O tipo de pagamento: "0": À Vista | "1": Parcelado

CodigoEmpresa
required
string

O código da empresa

DataEmissao
required
string

A data de emissão

DataReferencia
required
string

A data de referência

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorOperacao
required
string

O identificador da operação

IdentificadorPessoa
required
string

O identificador da pessoa

Array of objects (DocumentoItemCadastroContrato)

Os itens do documento

NomeEntidadeOrigem
string

O nome da entidade origem

Identificador
string

O identificador do documento. No cadastro ele será desconsiderado

Numero
required
string

O número do documento

Observacao
string

A observação

Array of objects (DocumentoPagamentoCadastroContrato)

Os pagamentos

Responses

Request samples

Content type
application/json
{
  • "TipoFinalidade": 0,
  • "CodigoContratoCompraCliente": "1234",
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "TipoDocumento": "F",
  • "TipoPagamento": "0",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-08T12:10:45.126Z",
  • "DataReferencia": "20-06-08T12:10:45.126Z",
  • "DataReferenciaPagamento": "2020-06-08T12:10:45.126Z",
  • "IdentificadorOperacao": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "Itens": [
    ],
  • "NomeEntidadeOrigem": "PedidoVenda",
  • "Identificador": "00A0000001",
  • "Numero": "123456",
  • "Observacao": "Observação",
  • "Pagamentos": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar uma nova devolução

Cadastra uma devolução de um documento

path Parameters
identificadorDocumento
required
string
Example: 00A0000001

O identificador do documento a ser devolvido

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento está pronto para ser liberado

DataEmissao
string

A data de emissão

DataReferencia
string

A data de referência

IdentificadorOperacao
string

O identificador da operação

Array of objects (DevolucaoItemCadastroContrato)

Os itens do documento

Numero
string

O número do documento

Observacao
string

A observação

StatusNotaFiscalEletronica
string

O 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
application/json
{
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "DataEmissao": "2020-06-08T12:10:45.126Z",
  • "DataReferencia": "20-06-08T12:10:45.126Z",
  • "IdentificadorOperacao": "00A0000001",
  • "Itens": [
    ],
  • "Numero": "123456",
  • "Observacao": "Observação",
  • "StatusNotaFiscalEletronica": "A"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Empresa

Consultar as empresas por nome ou CNPJ

Consulta as empresas, permitindo filtrar por nome e CNPJ e a utilização de busca por trecho Nota: Caso não sejam informados os parâmetros, retornará todas as empresas

query Parameters
cnpj
string
Example: cnpj=0

O CNPJ da empresa que está sendo consultada.

nome
string
Example: nome=Alterdata

O nome da empresa que está sendo consultada.

nomePorTrecho
boolean
Example: nomePorTrecho=true

Valor que indica se o nome será consultado por trecho.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma empresa por seu código

Consulta uma empresa por código

path Parameters
codigo
required
number
Example: 01

O código da empresa que se deseja

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Estoque Produto

Consultar o estoque de um produto

Consulta o estoque de um produto filtrando por código da empresa, identificador do produto, identificador do setor e data

path Parameters
codigoEmpresa
required
number
Example: 01

O código da empresa que se deseja

identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

query Parameters
identificadorSetor
string
Example: identificadorSetor=00A0000001

O identificador do setor

dataReferencia
string
Example: dataReferencia=2017-03-21

A data de referência, Se omitido considera-se como data atual

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o estoque de lotes de um produto por setor

Consulta os lotes de produto em estoque filtrando por empresa, produto, setor e data

path Parameters
codigoEmpresa
required
number
Example: 01

O código da empresa que se deseja

identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

query Parameters
identificadorSetor
required
string
Example: identificadorSetor=00A0000001

O identificador do setor

dataReferencia
required
string
Example: dataReferencia=2017-03-21

A data referência

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o estoque de série de um produto por setor

Consulta as séries de produto em estoque filtrando por empresa, produto, setor e data

path Parameters
codigoEmpresa
required
number
Example: 01

O código da empresa que se deseja

identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

query Parameters
identificadorSetor
required
string
Example: identificadorSetor=00A0000001

O identificador do setor

dataReferencia
required
string
Example: dataReferencia=2017-03-21

A data referência

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o estoque de um produto por setor sem considerar o cache

Consulta o estoque de um produto sem considerar o cache

path Parameters
codigoEmpresa
required
number
Example: 01

O código da empresa que se deseja

identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

query Parameters
identificadorSetor
required
string
Example: identificadorSetor=00A0000001

O identificador do setor

dataReferencia
required
string
Example: dataReferencia=2017-03-21

A data de referência

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o estoque de vários produtos em um mesmo setor

Consultar o estoque de vários produtos em um mesmo setor

*Obs: Retorna as quantidades em estoque de uma lista de produtos em uma lista de setores em uma determinada data.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataReferencia
string

A data de referência

Produtos
Array of strings

O(s) identificador(es) do(s) produto(s)

Setores
Array of strings

O(s) identificador(es) do(s) setor(es)

Responses

Request samples

Content type
application/json
{
  • "DataReferencia": "2020-06-08T18:10:09.027Z",
  • "Produtos": [ ],
  • "Setores": [ ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Evento Baixa

Consultar todos os eventos de baixas

Consulta todos os eventos de baixa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um evento de baixa por identificador

Consulta o evento de baixa com base no identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do evento de baixa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Forma Pagamento

Consultar todas as formas de pagamento cadastradas

Consulta todas as formas de pagamento cadastradas

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma forma de pagamento por seu identificador

Consulta uma forma de pagamento pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da forma de pagamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Fornecedor

Cadastrar uma pessoa como fornecedor

Cadastra um novo fornecedor no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal da pessoa

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

Codigo
string

O código da pessoa no Bimer

CodigoExterno
string

O código externo da pessoa

CpfCnpj
required
number

O CPF ou CNPJ da pessoa

Caso o usuário queira cadastrar um cliente com o mesmo CPF/CNPJ, deverá ser alterada a configuração em Configurador do Bimer / Geral / Opções / Pessoa. Verificar seção "Ao cadastrar mais de uma vez o mesmo CPF/CNPJ".

DataNascimento
string

A data de nascimento da pessoa

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto da pessoa. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributações

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviços

AliquotaIRRF
number

Define a alíquota de IRRF para a pessoa jurídica

DataInicioAtividades
string

A data do início das atividades da empresa

EntidadeAdministracaoPublicaFederal
boolean

Define se a pessoa é uma entidade da administração pública federal

IdentificadorCNAE
string

O identificador do CNAE da pessoa

IdentificadorSituacaoCadastralPessoa
string

O Identificador da situação cadastral da pessoa

RamoAtividade
string

A descrição do ramo de atividade da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "Codigo": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-05T17:05:31.298Z",
  • "Nome": "Pessoa Documentação",
  • "NomeCurto": "Pessoa",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 0,
  • "DataInicioAtividades": "2020-06-05T17:05:31",
  • "EntidadeAdministracaoPublicaFederal": true,
  • "IdentificadorCNAE": "00A0000001",
  • "IdentificadorSituacaoCadastralPessoa": "00A0000001",
  • "RamoAtividade": "Atividades de contabilidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Grade Produto

Consultar a grade de um produto pelo seu identificador

Consulta a grade de um produto pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do produto que se deseja localizar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Histórico Custo Produto

Consultar o último custo de um produto por empresa e data de referência

Consulta o último preço de um produto em uma empresa filtrando por data

path Parameters
codigoEmpresa
required
number
Example: 01

O código da empresa

identificador
required
string
Example: 00A0000001

O identificador do produto

query Parameters
dataReferencia
required
string
Example: dataReferencia=2017-03-21

A data de referência

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Imagem Produto

Consultar as imagens de um produto pelo seu identificador

Consulta as imagens de um produto pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do produto que se deseja localizar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Mensagem

Consultar todas as mensagens

Consulta todas as mensagens cadastradas no Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a mensagem pelo código

Consulta uma mensagem pelo código

path Parameters
codigo
required
string
Example: 1

O código da mensagem

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Modalidade de Pagamento

Consultar todas as modalidades de pagamento cadastradas

Consulta todas as modalidades de pagamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma modalidade de pagamento por identificador

Consulta uma modalidade de pagamento pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da modalidade de pagamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Movimento de Cobrança

Cadastrar um movimento de cobrança

Cadastra um movimento de cobrança

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataCadastro
required
string

A data de cadastro

DataEmissao
required
string

A data de emissão

IdentificadorCliente
required
string

O identificador do cliente

IdentificadorTipoMovimentoCobranca
required
string

O 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
required
string

O tipo de movimento. "F": Fixo, "V": Variável, "P": Prazo

Array of objects (MovimentoCobrancaPagamentoContrato)

Os pagamentos do movimentos de cobrança

AglutinaCobrancaEmTitulo
boolean

Define se aglutina a cobrança no título

CobraTaxaBancaria
boolean

Define se cobra taxa bancária

CodigoEmpresa
required
string

Define o código da empresa

CodigoEnderecoCobranca
string

O código do endereço de cobrança

CodigoEnderecoEntrega
string

O código do endereço de entrega

ContratoLiberado
boolean

Define se o contrato está liberado

Destino
required
string

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

DiaVencimento
required
number

O dia do vencimento

IdentificadorFormaPagamento
string

O identificador da forma de pagamento

IdentificadorNaturezaLancamento
string

O identificador da natureza de lançamento

IdentificadorOperacaoNotaFiscal
string

A operação da nota fiscal que poderá ser gerada pelo movimento caso o destino do mesmo seja nota fiscal

IdentificadorTipoCobranca
string

O identificador do tipo de cobrança

AliquotaRepasseRepresentantePrincipal
number

A alíquota de repasse do representante principal da pessoa

Array of objects (MovimentoCobrancaItemCadastroContrato)

Os itens do movimento de cobrança

NumeroContrato
string

O número do contrato

IdentificadorResponsavelFinanceiro
string

O identificador do responsável financeiro

DataFimVigenciaContrato
string

A data do fim de vigência do contrato

DataInicialVigenciaContrato
string

A data de início de vigência do contrato

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorPrazo
string

O identificador do prazo

object (AcrescimoDescontoContrato)
object (AcrescimoDescontoContrato)
CodigoContrato
string

O código do contrato

Responses

Request samples

Content type
application/json
{
  • "DataCadastro": "2020-06-10T12:32:15.993Z",
  • "DataEmissao": "2020-06-10T12:32:15.993Z",
  • "IdentificadorCliente": "00A0000001",
  • "IdentificadorTipoMovimentoCobranca": "00A0000001",
  • "TipoMovimento": "F",
  • "Pagamentos": [
    ],
  • "AglutinaCobrancaEmTitulo": true,
  • "CobraTaxaBancaria": true,
  • "CodigoEmpresa": "01",
  • "CodigoEnderecoCobranca": "01",
  • "CodigoEnderecoEntrega": "01",
  • "ContratoLiberado": true,
  • "Destino": "A",
  • "DiaVencimento": 15,
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "IdentificadorOperacaoNotaFiscal": "00A0000001",
  • "IdentificadorTipoCobranca": "00A0000001",
  • "AliquotaRepasseRepresentantePrincipal": 10,
  • "Itens": [
    ],
  • "NumeroContrato": "01",
  • "IdentificadorResponsavelFinanceiro": "00A0000001",
  • "DataFimVigenciaContrato": "2020-06-10T12:32:15.993Z",
  • "DataInicialVigenciaContrato": "2020-06-10T12:32:15.993Z",
  • "DataReferenciaPagamento": "2020-06-10T12:32:15.993Z",
  • "IdentificadorPrazo": "00A0000001",
  • "Acrescimo": {
    },
  • "Desconto": {
    },
  • "CodigoContrato": "123"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a lista de movimentos de cobrança de uma pessoa com um determinado produto

Consulta a lista de movimentos de uma pessoa com um produto, permitindo selecionar o tipo de movimento e se considera inativos

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

O identificador da pessoa

identificadorProduto
required
string
Example: identificadorProduto=00A0000001

O identificador do produto

tipoMovimento
required
string
Example: tipoMovimento=F

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

considerarInativos
required
boolean
Example: considerarInativos=false

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Editar um movimento de cobrança

Edita um movimento de cobrança

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do movimento de cobrança a ser editado

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (MovimentoCobrancaPagamentoContrato)

Os pagamentos

AglutinaCobrancaEmTitulo
boolean

Define se aglutina a cobrança em título

CobraTaxaBancaria
boolean

Define se cobra taxa bancária

CodigoEmpresa
required
string

O código da empresa

CodigoEnderecoCobranca
string

O código do endereço de cobrança

CodigoEnderecoEntrega
string

O código do endereço de entrega

ContratoLiberado
boolean

Define se o contrato está liberado

Destino
required
string

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

DiaVencimento
required
number

Define o dia do vencimento

IdentificadorFormaPagamento
required
string

O identificador da forma de pagamento

IdentificadorNaturezaLancamento
required
string

O identificador da natureza de lançamento

IdentificadorOperacaoNotaFiscal
string

O identificador da operação de nota fiscal

IdentificadorTipoCobranca
required
string

O identificador do tipo de cobrança

Array of objects (MovimentoCobrancaEdicaoItemContrato)

Os itens

NumeroContrato
string

O número do contrato

IdentificadorResponsavelFinanceiro
string

O identificador do responsável financeiro

DataFimVigenciaContrato
string

A data do fim de vigência do contrato

DataInicialVigenciaContrato
string

A data de início de vigência de contrato

DataReferenciaPagamento
string

A data de referência do pagamento

IdentificadorPrazo
string

O identificador do prazo

object (AcrescimoDescontoContrato)
object (AcrescimoDescontoContrato)
CodigoContrato
string

O código do contrato

Identificador
string

O identificador

AliquotaRepasseRepresentantePrincipal
number

A aliquota de repasse para o representante principal

Responses

Request samples

Content type
application/json
{
  • "Pagamentos": [
    ],
  • "AglutinaCobrancaEmTitulo": true,
  • "CobraTaxaBancaria": true,
  • "CodigoEmpresa": "00A0000001",
  • "CodigoEnderecoCobranca": "01",
  • "CodigoEnderecoEntrega": "02",
  • "ContratoLiberado": true,
  • "Destino": "R",
  • "DiaVencimento": 15,
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "IdentificadorOperacaoNotaFiscal": "00A0000001",
  • "IdentificadorTipoCobranca": "00A0000001",
  • "Itens": [
    ],
  • "NumeroContrato": "123",
  • "IdentificadorResponsavelFinanceiro": "00A0000001",
  • "DataFimVigenciaContrato": "2020-06-10T12:32:15.992Z",
  • "DataInicialVigenciaContrato": "2020-06-10T12:32:15.992Z",
  • "DataReferenciaPagamento": "2020-06-10T12:32:15.992Z",
  • "IdentificadorPrazo": "00A0000001",
  • "Acrescimo": {
    },
  • "Desconto": {
    },
  • "CodigoContrato": "01",
  • "Identificador": "00A0000001",
  • "AliquotaRepasseRepresentantePrincipal": 10
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um movimento de cobrança por identificador

Consulta um movimento de cobrança pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do movimento de cobrança

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todos os contratos do cliente assim como seus respectivos vencimentos

Consulta todos os contratos de um cliente e seus vencimentos

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador do cliente

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a lista de movimentos de cobrança completa de uma pessoa com um determinado produto

Consulta a lista de movimentos completa de uma pessoa com um produto, permitindo selecionar o tipo de movimento e se considera inativos

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

O identificador da pessoa

identificadorProduto
required
string
Example: identificadorProduto=00A0000001

O identificador do produto

tipoMovimento
required
string
Example: tipoMovimento=F

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

considerarInativos
required
boolean
Example: considerarInativos=false

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Adicionar um item no movimento de cobrança

Adicionar um item no movimento de cobrança

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do movimento de cobrança

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorIndexador
string

O identificador do indexador

IdentificadorProduto
string

O identificador do produto

IdentificadorProdutoVinculado
string

O identificador do produto do item vinculado

IdentificadorStatusProduto
required
string

O identificador do status do produto

IdentificadorTipoMovimentoCobranca
required
string

O identificador do tipo de movimento de cobrança

Ativo
boolean

Define se o item está ativo

DataCadastro
string

A data de cadastro

DataFinalCarencia
string

A data do fim da carência

DataInicialReajuste
string

A data de início do reajuste

DataValidoAPartir
string

A data de válido a partir de

DataValidoAte
string

A data de válido até

Doacao
boolean

Define se é uma doação

Array of objects (InformacoesComplementaresItemCadastroContrato)

Informações complementares do item do contrato

MesesGeracaoDestinoMovimentoCobranca
Array of strings

Os meses de geração do destino de movimento de cobrança. Os meses devem ser informados com suas siglas

PeriodoReajusteMovimentoCobranca
string

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

Valor
number

O valor do item

Array of objects (MovimentoCobrancaRepasseContrato)

O repasse do contrato

MotivoDoacao
string

O motivo da doação

Observacao
string

A observação

Responses

Request samples

Content type
application/json
{
  • "IdentificadorIndexador": "00A0000001",
  • "IdentificadorProduto": "00A0000001",
  • "IdentificadorProdutoVinculado": "00A0000001",
  • "IdentificadorStatusProduto": "00A0000001",
  • "IdentificadorTipoMovimentoCobranca": "00A0000001",
  • "Ativo": true,
  • "DataCadastro": "2020-06-10T12:32:15.993Z",
  • "DataFinalCarencia": "2020-06-10T12:32:15.993Z",
  • "DataInicialReajuste": "2020-06-10T12:32:15.993Z",
  • "DataValidoAPartir": "2020-06-10T12:32:15.993Z",
  • "DataValidoAte": "2020-06-10T12:32:15.993Z",
  • "Doacao": true,
  • "InformacoesComplementares": [
    ],
  • "MesesGeracaoDestinoMovimentoCobranca": [
    ],
  • "PeriodoReajusteMovimentoCobranca": "ANO",
  • "Valor": 100,
  • "Repasse": [
    ],
  • "MotivoDoacao": "Motivo",
  • "Observacao": "Observação"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Editar um item do movimento de cobrança

Editar um item do movimento de cobrança

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do movimento de cobrança

'Nota: Identificador do contrato'

identificadorItem
required
string
Example: 00A0000002

O identificador do item do movimento de cobrança

'Nota: Quando contrato fixo será o 'Id_Pessoa_Categoria_Produto', quando contrato variável será o 'IdMovimentoCobrancaitem''

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorProduto
string

O identificador do produto

IdentificadorProdutoVinculado
string

O identificador do produto do item vinculado

`Nota: Para desvincular um item, basta informar o mesmo 'IdentificadorProduto' no campo 'IdentificadorProdutoVinculado'.'

IdentificadorStatusProduto
required
string

O identificador do status do produto

IdentificadorTipoMovimentoCobranca
required
string

O identificador do tipo de movimento de cobrança

Ativo
boolean

Define se o item está ativo

DataCadastro
string

A data de cadastro

DataFinalCarencia
string

A data do fim da carência, início da cobrança

DataValidoAPartir
string

A data de válido a partir de

DataValidoAte
required
string

Data final da cobrança.

'Nota: Deve ser preenchido somente quando o tipo de movimento for Fixo ou Negociação. Este atributo somente é obrigatório se caso for informado um status do produto que desative o item da cobrança.'

DataInicialReajuste
string

A data de início do reajuste

'Nota: Exige preencher o indexador.'

IdentificadorIndexador
string

O identificador do indexador

'Nota: Exige preencher a data de reajuste.'

IdentificadorMotivoCancelamento
required
string

Identificador do motivo da devolucao/ cancelamento - Esse identificador fica na tabela de Informação geral no banco.

'Nota: Obrigatório somente quando a situação do produto for do tipo cancelamento/devolução/sem manutenção'

TipoProdutoMotivoCancelamento
string

Tipo que motivou o cancelamento ou devolução sendo um produto específico, todos, ou não informado pelo cliente.

'Nota: Preencher somente quando a situação do produto for do tipo cancelamento/devolução/sem manutenção'

IdentificadorProdutoMotivoCancelamento
string

Identificador do produto que motivou o cancelamento ou devolução - Este só será informado quando o 'TipoProdutoMotivoCancelamento' for informado como 'Produto'.

'Nota: Preencher somente quando a situação do produto for do tipo cancelamento/devolução/sem manutenção'

IdentificadorAtendimentoVinculadoCancelamento
string

Caso exista, informar o identificador do atendimento vinculado ao contrato que motivou a devolucao/ cancelamento.

'Nota: Preencher somente quando a situação do produto for do tipo cancelamento/devolução/sem manutenção'

Doacao
boolean

Define se é uma doação

Array of objects (InformacoesComplementaresItemCadastroContrato)

Informações complementares do item do contrato

MesesGeracaoDestinoMovimentoCobranca
Array of strings

Os meses de geração do destino de movimento de cobrança.

'Nota: Os meses devem ser informados como JAN, FEV, MAR'

PeriodoReajusteMovimentoCobranca
string

O período de reajuste do item do movimento de cobrança.

'Nota: Os períodos devem ser informados como "ANO", "SEMESTRE", "TRIMESTRE", "BIMESTRE", "MES", "DIA"'

Valor
required
number

O valor do item

MotivoDoacao
string

O motivo da doação

Observacao
string

A observação

Responses

Request samples

Content type
application/json
{
  • "IdentificadorProduto": "00A0000001",
  • "IdentificadorProdutoVinculado": "00A0000001",
  • "IdentificadorStatusProduto": "00A0000001",
  • "IdentificadorTipoMovimentoCobranca": "00A0000001",
  • "Ativo": true,
  • "DataCadastro": "2020-06-10T12:32:15.993Z",
  • "DataFinalCarencia": "2020-06-10T12:32:15.993Z",
  • "DataValidoAPartir": "2020-06-10T12:32:15.993Z",
  • "DataValidoAte": "2020-06-10T12:32:15.993Z",
  • "DataInicialReajuste": "2020-06-10T12:32:15.993Z",
  • "IdentificadorIndexador": "00A0000001",
  • "IdentificadorMotivoCancelamento": "00A0000001",
  • "TipoProdutoMotivoCancelamento": "Produto",
  • "IdentificadorProdutoMotivoCancelamento": "00A0000001",
  • "IdentificadorAtendimentoVinculadoCancelamento": "00A0000001",
  • "Doacao": true,
  • "InformacoesComplementares": [
    ],
  • "MesesGeracaoDestinoMovimentoCobranca": [
    ],
  • "PeriodoReajusteMovimentoCobranca": "ANO",
  • "Valor": 100,
  • "MotivoDoacao": "Motivo",
  • "Observacao": "Observação"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Natureza de Lançamento

Consultar uma natureza de lançamento por descrição

Consulta as naturezas de lançamento pela descrição, permite escolher se a busca será feita por trecho

query Parameters
descricao
required
string
Example: descricao=A

A descrição

porTrecho
required
boolean
Example: porTrecho=true

Valor que indica se a consulta será realizada por trecho

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma natureza de lançamento por identificador

Consulta as naturezas de lançamento pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Operação

Consultar todas as operações cadastradas

Consulta todas as operações cadastradas

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma operação cadastrada pelo seu identificador

Consulta uma operação pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da operação

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Pedido de Compra

Cadastrar um pedido de compra

Cadastra um pedido de compra

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (PedidoDeCompraItemCadastroContrato)

Os itens do pedido de compra

Array of objects (PedidoDeCompraPagamentoCadastroContrato)

Os pagamentos do pedido de compra

CodigoEmpresa
required
string

O código da empresa

CodigoEmpresaFinanceiro
required
string

O código da empresa financeiro

IdentificadorBairro
string

O identificador do bairro

IdentificadorCidade
string

O identificador da cidade

IdentificadorFornecedor
required
string

O identificador do fornecedor

IdentificadorIndexador
string

O identificador do indexador

IdentificadorNaturezaLancamento
required
string

O identificador da natureza de lançamento

IdentificadorTransportador
string

O identificador do transportador

IdentificadorUsuarioLiberacao
string

O identificador do usuário de liberação

ValorAcrescimo
number

O valor do acréscimo

ValorDesconto
number

O valor do desconto

ValorFrete
number

O valor do frete

ValorSeguro
number

O valor do seguro

ValorOutrasDespesas
number

O valor das outras despesas

ValorACT
number

o valor do Aviso de Conhecimento de Transporte

object (PedidoDeCompraConhecimentoTransporteContratoDePedidoDeCompraPagamentoTransporteCadastroContrato)
TipoFrete
string

O tipo de frete do pedido de compra. 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")

CEP
string

O cep

Codigo
string

O código

ComplementoEndereco
string

O complemento do endereço

DataEmissao
required
string

A data de emissão

DataEmissaoACT
string

A data de emissão do ACT

DataEntrega
required
string

A data de entrega

Descricao
string

A descrição

EntregaParcial
boolean

Define se é entrega parcial

Logradouro
string

O logradouro

NumeroEndereco
string

O número do endereço

NumeroOrcamento
string

O número do orçamento

Observacao
string

A observação

object (PrazoContrato)
TipoLogradouro
string

O tipo de logradouro

UF
string

A UF

Responses

Request samples

Content type
application/json
{
  • "Itens": [
    ],
  • "Pagamentos": [
    ],
  • "CodigoEmpresa": "01",
  • "CodigoEmpresaFinanceiro": "01",
  • "IdentificadorBairro": "00A0000001",
  • "IdentificadorCidade": "00A0000001",
  • "IdentificadorFornecedor": "00A0000001",
  • "IdentificadorIndexador": "00A0000001",
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "IdentificadorTransportador": "00A0000001",
  • "IdentificadorUsuarioLiberacao": "00A0000001",
  • "ValorAcrescimo": 1,
  • "ValorDesconto": 2,
  • "ValorFrete": 3,
  • "ValorSeguro": 4,
  • "ValorOutrasDespesas": 5,
  • "ValorACT": 6,
  • "ConhecimentoTransporte": {
    },
  • "TipoFrete": "D",
  • "CEP": "25123123",
  • "Codigo": "00001",
  • "ComplementoEndereco": "Apto 123",
  • "DataEmissao": "2020-06-10T17:53:34.896Z",
  • "DataEmissaoACT": "2020-06-10T17:53:34.896Z",
  • "DataEntrega": "2020-06-10T17:53:34.896Z",
  • "Descricao": "Pedido cadastrado pela BimerAPI",
  • "EntregaParcial": true,
  • "Logradouro": "Avenida principal",
  • "NumeroEndereco": "400",
  • "NumeroOrcamento": "123",
  • "Observacao": "Cadastrado pela Bimer API",
  • "Prazo": {
    },
  • "TipoLogradouro": "A",
  • "UF": "RJ"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

Edita 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
path Parameters
identificadorPedido
required
string
Example: 00A0000001

O identificador do pedido de compra

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (PedidoDeCompraItemAlteracaoContrato)

Os itens do pedido de compra

Array of objects (PedidoDeCompraPagamentoAlteracaoContrato)

Os pagamentos do pedido de compra

CodigoEmpresa
string

O código da empresa

CodigoEmpresaFinanceiro
string

O código da empresa financeiro

IdentificadorBairro
string

O identificador do bairro

IdentificadorCidade
string

O identificador da cidade

IdentificadorFornecedor
string

O identificador do fornecedor

IdentificadorIndexador
string

O identificador do indexador

IdentificadorNaturezaLancamento
string

O identificador da natureza de lançamento

IdentificadorTransportador
string

O identificador do transportador

IdentificadorUsuarioLiberacao
string

O identificador do usuário de liberação

ValorAcrescimo
number

O valor do acréscimo

ValorDesconto
number

O valor do desconto

ValorFrete
number

O valor do frete

ValorSeguro
number

O valor do seguro

ValorOutrasDespesas
number

O valor das outras despesas

ValorACT
number

o valor do Aviso de Conhecimento de Transporte

object (PedidoDeCompraConhecimentoTransporteContratoDePedidoDeCompraPagamentoTransporteCadastroContrato)
TipoFrete
string

O tipo de frete do pedido de compra. 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")

CEP
string

O CEP

Codigo
string

O código

ComplementoEndereco
string

O complemento do endereço

DataEmissao
string

A data de emissão

DataEmissaoACT
string

A data de emissão do ACT

DataEntrega
string

A data de entrega

Descricao
string

A descrição

EntregaParcial
boolean

Define se é entrega parcial

Logradouro
string

O logradouro

NumeroEndereco
string

O número do endereço

NumeroOrcamento
string

O número do orçamento

Observacao
string

A observação

object (PrazoContrato)
TipoLogradouro
string

O tipo de logradouro

UF
string

A UF

Responses

Request samples

Content type
application/json
{
  • "Itens": [
    ],
  • "Pagamentos": [
    ],
  • "CodigoEmpresa": "01",
  • "CodigoEmpresaFinanceiro": "01",
  • "IdentificadorBairro": "00A0000001",
  • "IdentificadorCidade": "00A0000001",
  • "IdentificadorFornecedor": "00A0000001",
  • "IdentificadorIndexador": "00A0000001",
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "IdentificadorTransportador": "00A0000001",
  • "IdentificadorUsuarioLiberacao": "00A0000001",
  • "ValorAcrescimo": 1,
  • "ValorDesconto": 2,
  • "ValorFrete": 3,
  • "ValorSeguro": 4,
  • "ValorOutrasDespesas": 5,
  • "ValorACT": 6,
  • "ConhecimentoTransporte": {
    },
  • "TipoFrete": "D",
  • "CEP": "25123123",
  • "Codigo": "00001",
  • "ComplementoEndereco": "Apto 123",
  • "DataEmissao": "2020-06-10T17:53:34.896Z",
  • "DataEmissaoACT": "2020-06-10T17:53:34.896Z",
  • "DataEntrega": "2020-06-10T17:53:34.896Z",
  • "Descricao": "Pedido cadastrado pela BimerAPI",
  • "EntregaParcial": true,
  • "Logradouro": "Avenida principal",
  • "NumeroEndereco": "400",
  • "NumeroOrcamento": "123",
  • "Observacao": "Cadastrado pela Bimer API",
  • "Prazo": {
    },
  • "TipoLogradouro": "A",
  • "UF": "RJ"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um pedido de compra pelo identificador

Consulta um pedido de compra pelo identificador

path Parameters
identificadorPedido
required
string
Example: 00A0000001

O identificador do pedido de compra

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

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

query Parameters
codigoEmpresa
required
string
Example: codigoEmpresa=01

O código da empresa cadastrada

identificadorFornecedor
required
string
Example: identificadorFornecedor=00A0000001

O identificador do fornecedor

status
required
string
Example: status=A

O status do pedido de compra.

  • Aberto ('A')

  • Em digitação ('D')

  • Aguardando ('G')

  • Cancelado ('C')

  • Atend. C/Corte ('X')

  • Parcialmente atendido ('P')

  • Atendido ('T')

  • Confirmado ('F')

  • Encerrado ('R')

dataInicialEmissao
required
string
Example: dataInicialEmissao=2017-03-21

A data inicial de emissão do pedido de compra

dataFinalEmissao
required
string
Example: dataFinalEmissao=2017-03-21

A data final de emissão do pedido de compra

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Pedido de Venda

Cadastrar um pedido de venda

Cadastra um pedido de venda

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
object (PedidoDeVendaTransportadoraContrato)
object (AcrescimoDescontoContrato)
CodigoEmpresa
required
number

O código da empresa

CodigoEmpresaEstoque
number

O código da empresa de estoque

CodigoEmpresaFinanceiro
number

O código da empresa do financeiro

CodigoEnderecoCobranca
string

O código do endereço de cobrança

CodigoEnderecoEntrega
string

O código do endereço de entrega

CodigoPedidoDeCompraCliente
string

O código do cliente do pedido de compra

DataEmissao
required
string

A data de emissão

DataEntrada
string

A data de entrada

DataEntrega
required
string

A data de entrega

DataCotacaoIndexador
string

A data de cotação do indexador

DataReferenciaPagamento
string

A data de referência do pagamento

object (AcrescimoDescontoContrato)
FaturamentoParcial
boolean

Define se é um faturamento parcial

IdentificadorCliente
required
string

O identificador do cliente

IdentificadoresMensagens
Array of strings

Os identificadores das mensagens

IdentificadorIndexador
string

O identificador do indexador

IdentificadorMeioContato
string

O identificador do meio de contato

IdentificadorOperacao
required
string

O identificador da operação

IdentificadorOperacaoOE
string

O identificador da operação para ordens de entrega.

Esse campo obedecerá a configuração presente em Configurador Bimer/Faturamento/Opções/Pedido de venda/Permissões, "Permitir no cadastro do pedido informar uma operação para nota fiscal e outra para ordem de entrega". Caso esteja marcada, será possível informar ambas operações. Caso esteja desmarcada, ao informar as duas operações, será retornada uma mensagem informativa sem realizar o cadastro.

IdentificadorSetor
string

O identificador do setor

IdentificadorTransportador
string

O identificador do transportador

Array of objects (PedidoDeVendaItemCadastroContrato)

Os itens

NomePessoaContato
string

O nome da pessoa de contato

Observacao
string

A observação

ObservacaoDocumento
string

A observação do documento

Array of objects (PedidoDeVendaPagamentoCadastroContrato)

Os pagamentos

object (PrazoContrato)
Status
string

O 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

O 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

A 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

Identificador
string

O Identificador. Caso seja um cadastro não é necessário informar

Codigo
string

O código

Responses

Request samples

Content type
application/json
{
  • "Transportadora": {
    },
  • "Acrescimo": {
    },
  • "CodigoEmpresa": 1,
  • "CodigoEmpresaEstoque": 1,
  • "CodigoEmpresaFinanceiro": 1,
  • "CodigoEnderecoCobranca": "01",
  • "CodigoEnderecoEntrega": "01",
  • "CodigoPedidoDeCompraCliente": "0001",
  • "DataEmissao": "2020-06-10T17:53:34.947Z",
  • "DataEntrada": "2020-06-10T17:53:34.947Z",
  • "DataEntrega": "2020-06-10T17:53:34.947Z",
  • "DataCotacaoIndexador": "2020-06-10T17:53:34.947Z",
  • "DataReferenciaPagamento": "2020-06-10T17:53:34.947Z",
  • "Desconto": {
    },
  • "FaturamentoParcial": true,
  • "IdentificadorCliente": "00A0000001",
  • "IdentificadoresMensagens": [
    ],
  • "IdentificadorIndexador": "00A0000001",
  • "IdentificadorMeioContato": "00A0000001",
  • "IdentificadorOperacao": "00A0000001",
  • "IdentificadorOperacaoOE": "00A0000001",
  • "IdentificadorSetor": "00A0000001",
  • "IdentificadorTransportador": "00A0000001",
  • "Itens": [
    ],
  • "NomePessoaContato": "Pessoa Contato",
  • "Observacao": "Cadastrado pela BimerAPI",
  • "ObservacaoDocumento": "Documento cadastrado pela BimerAPI",
  • "Pagamentos": [
    ],
  • "Prazo": {
    },
  • "Status": "A",
  • "TipoFrete": "D",
  • "IndicadorAtendimentoPresencial": "1",
  • "Identificador": "00A0000001",
  • "Codigo": "0001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Baixar um pedido de venda totalmente ou parcialmente

Baixa um pedido de venda, gerando um documento no Faturamento

path Parameters
identificadorPedidoDeVenda
required
string
Example: 00A0000001

O identificador do pedido de venda

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
CriaDocumentoProntoParaSerLiberado
boolean

Define se o documento será criado como pronto para ser liberado

Array of objects (PedidoDeVendaBaixaItemContrato)

Os itens a serem baixados

StatusNotaFiscalEletronica
string

O status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro. Lembrando que esse status funcionará diretamente relacionado ao campo "CriaDocumentoProntoParaSerLiberado", já que por exemplo, não faria sentido uma nota fiscal com status aberto estar pronta pra ser liberada.

Responses

Request samples

Content type
application/json
{
  • "CriaDocumentoProntoParaSerLiberado": true,
  • "Itens": [
    ],
  • "StatusNotaFiscalEletronica": "A"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um pedido de venda pelo seu identificador

Consulta um pedido de venda pelo identificador

path Parameters
identificadorPedidoDeVenda
required
string
Example: 00A0000001

O identificador do pedido de venda

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

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

query Parameters
empresa
number
Example: empresa=1

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

cliente
string
Example: cliente=00A0000001

O identificador do cliente que será usado na consulta

pedidoDeVenda
string
Example: pedidoDeVenda=10

O código do pedido de venda

pedidoDeCompraCliente
string
Example: pedidoDeCompraCliente=10

O código do pedido de compra do cliente

status
required
string
Example: status=T

O status do pedido de venda

  • A - Aberto

  • L - Liberado

  • P - Parcialmente Atendimento

  • T - Totalmente Atendido

  • X - Atendido com Corte

  • C - Cancelado

emissaoInicial
string
Example: emissaoInicial=2017-03-21

A data inicial de emissão do pedido de venda.

emissaoFinal
string
Example: emissaoFinal=2017-03-21

A data final de emissão do pedido de venda.

limite
required
number
Example: limite=1

Define a quantidade de registros que serão apresentados

pagina
required
number
Example: pagina=1

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Pessoa

Consultar uma pessoa por seu CPF/CNPJ ou código externo

Consulta uma pessoa cadastrada no Bimer por seu CPF/CNPJ ou código externo

query Parameters
cpfCnpj
number
Example: cpfCnpj=36114571088

O CPF / CNPJ

*Obs.: É necessário preencher o parâmetro 'cpfCnpj' ou 'codigoExterno'

codigoExterno
string
Example: codigoExterno=01ext

O código externo

*Obs.: É necessário preencher o parâmetro 'cpfCnpj' ou 'codigoExterno'

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma pessoa por seu identificador

Consulta uma pessoa pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar pessoas por nome

Consultar pessoas pelo nome, permitindo flitar por trecho

query Parameters
nome
required
string
Example: nome=q

O nome da pessoa

porTrecho
required
boolean
Example: porTrecho=true

Valor que indica que a consulta será feita por nome

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar pessoas por código CRM

Consulta as pessoas pelo código do CRM

path Parameters
codigoCRM
required
string
Example: 00A0000001

O código CRM

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todas as pessoas com a característica informada

Realiza uma consulta paginada por todas as pessoas com a característica informada

query Parameters
identificadorCaracteristica
required
string
Example: identificadorCaracteristica=00A0000001

O identificador da característica

limite
required
number
Example: limite=1

O limite de registros por página

pagina
required
number
Example: pagina=1

A página atual a ser consultada

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Vincular uma categoria a uma pessoa

Vincula uma categoria a uma pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa que será utilizada para vincular a categoria

IdentificadorCategoria
string

O identificador da categoria. Disponíveis: Cliente,Dependente,Fornecedor,Funcionario,Prospectado,Representante,Transportador

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "IdentificadorCategoria": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Víncular uma característica a uma pessoa

Vincula uma característica a uma pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorCaracteristica
string

O identificador da característica

Responses

Request samples

Content type
application/json
{
  • "IdentificadorCaracteristica": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Editar uma pessoa

Edita uma pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (PessoaEnderecoCadastroContrato)

Os endereços da pessoa

IdentificadorRepresentantePrincipal
string

O identificador do representante principal

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

O código externo da pessoa

CpfCnpj
number

O CPF/CNPJ da pessoa

DataNascimento
string

A data de nascimento

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributos e contribuições

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviço

AliquotaIRRF
number

A alíquota de IRRF para a pessoa jurídica

Responses

Request samples

Content type
application/json
{
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-12T12:28:43.141Z",
  • "Nome": "Bimer API",
  • "NomeCurto": "API",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 10
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma pessoa física por seu identificador

Consulta uma pessoa física pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da pessoa física

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma pessoa jurídica por seu identificador

Consulta uma pessoa jurídica pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador da pessoa jurídica

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

PessoaProdutoVersão

Cadastrar as versões de um produto da pessoa

Cadastra as versões de um produto da pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

identificadorProduto
required
string
Example: 00A0000001

O identificador Produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
object (VersaoProdutoCadastroContrato)
object (VersaoProdutoCadastroContrato)
object (VersaoProdutoCadastroContrato)

Responses

Request samples

Content type
application/json
{
  • "Versao": {
    },
  • "VersaoBaixada": {
    },
  • "VersaoLiberada": {
    }
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a versão de um produto vinculado a uma pessoa

Consulta a versão de um produto vinculado a uma pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

identificadorProduto
required
string
Example: 00A0000001

O identificador Produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

PessoaRelacionamento

Cadastrar um relacionamento para a pessoa

Cadastra um relacionamento para a pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorCategoriaPessoaPrincipal
string

O identificador da categoria da pessoa principal

IdentificadorCategoriaPessoaRelacionamento
string

O identificador da categoria da pessoa relacionada

IdentificadorPessoaRelacionamento
string

O identificador da pessoa de relacionamento

PessoaRelacionadaPrincipal
boolean

Define se a pessoa relacionada é a principal

Responses

Request samples

Content type
application/json
{
  • "IdentificadorCategoriaPessoaPrincipal": "00A0000001",
  • "IdentificadorCategoriaPessoaRelacionamento": "00A0000001",
  • "IdentificadorPessoaRelacionamento": "00A0000001",
  • "PessoaRelacionadaPrincipal": true
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma lista de relacionamentos da pessoa

Consulta a lista de relacionamentos da pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Ping

Obtém o ping

Retorna 1 caso a API consiga se comunicar com o banco de dados ou 0 caso haja algum problema na comunicação.

Responses

Consultar a versão da API

Retorna a versão da API.

Responses

Preço

Consultar os preços de acordo com uma consulta por código

Consulta o preço de acordo com o código

query Parameters
codigo
required
string
Example: codigo=00A0000001

O código que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um preço pelo identificador

Consulta um preço pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do produto que se deseja localizar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os preços de acordo com uma consulta por nome

Consulta os preços de acordo com o nome

query Parameters
nome
required
string
Example: nome=q

O nome que se deseja consultar

porTrecho
required
boolean
Example: porTrecho=true

Valor que indica que a consulta será feita por nome

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Preço Produto

Consultar o preço por empresa e por produto

Consulta o preço de um produto em determinada empresa

path Parameters
identificadorEmpresa
required
string
Example: 00A0000001

Identificador da empresa que se deseja consultar o preço

identificadorProduto
required
string
Example: 00A0000001

Identificador do produto que se deseja consultar o preço

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar o preço por empresa, produto e tabela de preços

Consulta o preço de um produto na tebela de preço de determinada empresa

path Parameters
identificadorEmpresa
required
string
Example: 00A0000001

Identificador da empresa que se deseja consultar o preço

identificadorProduto
required
string
Example: 00A0000001

Identificador do produto que se deseja consultar o preço

identificadorPreco
required
string
Example: 00A0000001

Identificador da tabela de preço que se deseja

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Produto

Consultar um produto por seu código principal

Consulta um produto pelo código principal

query Parameters
codigo
required
string
Example: codigo=1

O código principal do produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um produto por seu identificador

Consulta um produto pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar produtos por nome

Consulta os produtos pelo nome

query Parameters
nome
required
string
Example: nome=q

O nome do produto

porTrecho
required
boolean
Example: porTrecho=true

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todos os códigos de produto cadastrados para o produto informado

Consulta todos os códigos do produto

path Parameters
identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os identificadores dos produtos com versão de registro superior ao valor determinado

Consulta os identificadores das versões de registro superiores a determinada

query Parameters
versaoRegistro
required
number
Example: versaoRegistro=1

A versão do registro que será usada para filtro

itensPorPagina
required
number
Example: itensPorPagina=1

A quantidade de itens que deverão ser exibidos por página

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a composição de um produto por seu identificador

Consulta a composição de um produto pelo identificador

Nota: Caso deseje trabalhar com separação de kits será necessária a utilização desse endpoint. Por padrão a api nao trabalha com essa configuração

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Produto Master

Consultar o produto por código

Consulta o produto master pelo código

query Parameters
codigo
required
string
Example: codigo=1

O código que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar produtos por identificador

Consulta o produto master pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar produtos por nome

Consulta os produtos master pelo nome. Permite busca por trecho

query Parameters
nome
required
string
Example: nome=q

O nome que se deseja consultar

porTrecho
required
boolean
Example: porTrecho=true

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

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os produtos da grade relacionados ao produto master indicado pelo identificador

Consulta os produtos da grade do produto master

path Parameters
identificador
required
string
Example: 00A0000001

O identificador que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Prospectado

Cadastrar uma pessoa como prospectado

Cadastra uma nova pessoa no sistema com a característica de prospectado

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal da pessoa

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

Codigo
string

O código da pessoa no Bimer

CodigoExterno
string

O código externo da pessoa

CpfCnpj
required
number

O CPF ou CNPJ da pessoa

Caso o usuário queira cadastrar um cliente com o mesmo CPF/CNPJ, deverá ser alterada a configuração em Configurador do Bimer / Geral / Opções / Pessoa. Verificar seção "Ao cadastrar mais de uma vez o mesmo CPF/CNPJ".

DataNascimento
string

A data de nascimento da pessoa

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto da pessoa. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributações

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviços

AliquotaIRRF
number

Define a alíquota de IRRF para a pessoa jurídica

DataInicioAtividades
string

A data do início das atividades da empresa

EntidadeAdministracaoPublicaFederal
boolean

Define se a pessoa é uma entidade da administração pública federal

IdentificadorCNAE
string

O identificador do CNAE da pessoa

IdentificadorSituacaoCadastralPessoa
string

O Identificador da situação cadastral da pessoa

RamoAtividade
string

A descrição do ramo de atividade da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "Codigo": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-05T17:05:31.298Z",
  • "Nome": "Pessoa Documentação",
  • "NomeCurto": "Pessoa",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 0,
  • "DataInicioAtividades": "2020-06-05T17:05:31",
  • "EntidadeAdministracaoPublicaFederal": true,
  • "IdentificadorCNAE": "00A0000001",
  • "IdentificadorSituacaoCadastralPessoa": "00A0000001",
  • "RamoAtividade": "Atividades de contabilidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Alterar um prospectado para cliente

Edita um prospectado em um cliente

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa que está sendo editada

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (PessoaEnderecoCadastroContrato)

Os endereços da pessoa

IdentificadorRepresentantePrincipal
string

O identificador do representante principal

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

O código externo da pessoa

CpfCnpj
number

O CPF/CNPJ da pessoa

DataNascimento
string

A data de nascimento

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributos e contribuições

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviço

AliquotaIRRF
number

A alíquota de IRRF para a pessoa jurídica

Responses

Request samples

Content type
application/json
{
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-12T12:28:43.141Z",
  • "Nome": "Bimer API",
  • "NomeCurto": "API",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 10
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Refresh Tokens

Obtém o refresh token

Obtém o refresh token

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deleta o refresh token

Deleta o refresh token

query Parameters
tokenId
required
string
Example: tokenId=dfd87bc54a1a42fca09282aee5e46714

O id do token

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Região

Consultar região por bairro e cidade

Consulta região pelo identificador do bairro e cidade

query Parameters
IdentificadorBairro
required
string
Example: IdentificadorBairro=00A0000001

O identificador do bairro

IdentificadorCidade
required
string
Example: IdentificadorCidade=00A0000001

O identificador da cidade

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Representante

Cadastrar uma pessoa como representante

Cadastra uma nova pessoa no sistema com a característica de representante

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal da pessoa

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

Codigo
string

O código da pessoa no Bimer

CodigoExterno
string

O código externo da pessoa

CpfCnpj
required
number

O CPF ou CNPJ da pessoa

Caso o usuário queira cadastrar um cliente com o mesmo CPF/CNPJ, deverá ser alterada a configuração em Configurador do Bimer / Geral / Opções / Pessoa. Verificar seção "Ao cadastrar mais de uma vez o mesmo CPF/CNPJ".

DataNascimento
string

A data de nascimento da pessoa

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto da pessoa. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributações

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviços

AliquotaIRRF
number

Define a alíquota de IRRF para a pessoa jurídica

DataInicioAtividades
string

A data do início das atividades da empresa

EntidadeAdministracaoPublicaFederal
boolean

Define se a pessoa é uma entidade da administração pública federal

IdentificadorCNAE
string

O identificador do CNAE da pessoa

IdentificadorSituacaoCadastralPessoa
string

O Identificador da situação cadastral da pessoa

RamoAtividade
string

A descrição do ramo de atividade da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "Codigo": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-05T17:05:31.298Z",
  • "Nome": "Pessoa Documentação",
  • "NomeCurto": "Pessoa",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 0,
  • "DataInicioAtividades": "2020-06-05T17:05:31",
  • "EntidadeAdministracaoPublicaFederal": true,
  • "IdentificadorCNAE": "00A0000001",
  • "IdentificadorSituacaoCadastralPessoa": "00A0000001",
  • "RamoAtividade": "Atividades de contabilidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Requisição Material

Cadastrar uma requisição de material

Cadastra uma requisição de material

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
CodigoEmpresa
number

O código da empresa

Data
string

A data da requisição

IdentificadorCentroDeCusto
string

O identificador do centro de custo

IdentificadorSetorRequisitado
string

O identificador do setor requisitado

IdentificadorSetorRequisitante
string

O identificador do setor requisitante

Array of objects (RequisicaoMaterialItemCadastroContrato)

Os itens requisitados

NumeroOrdemProducao
string

O número da ordem de produção

Observacao
string

A observação

Prioridade
number

A prioridade

Tipo
string

O tipo da requisição. Valores permitidos: "R" - Requisição, "C" - Requisição Consumo, "D" - Devolução, "P" - Perda, "S" - Reposição, "T" - Transferência

Urgente
boolean

Define se a requisição é urgente

Responses

Request samples

Content type
application/json
{
  • "CodigoEmpresa": 1,
  • "Data": "2020-06-12T16:52:57.315Z",
  • "IdentificadorCentroDeCusto": "00A0000001",
  • "IdentificadorSetorRequisitado": "00A0000001",
  • "IdentificadorSetorRequisitante": "00A0000001",
  • "Itens": [
    ],
  • "NumeroOrdemProducao": "21333",
  • "Observacao": "Requisição cadastrada pela BimerAPI",
  • "Prioridade": 0,
  • "Tipo": "R",
  • "Urgente": true
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os dados da requisição por identificador

Consulta uma requisição pelo identificador

path Parameters
identificadorRequisicao
required
string
Example: 00A0000001

O identificador da requisição que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os itens da requisição de acordo com o identificador da requisição informado

Consulta os itens de uma requisição

path Parameters
identificadorRequisicao
required
string
Example: 00A0000001

O identificador da requisição que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

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

Consulta as baixas de uma requisição

path Parameters
identificadorRequisicao
required
string
Example: 00A0000001

O identificador da requisição que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os dados da baixa de itens da requisição de materiais de acordo com os identificadores informados

Consulta os dados das baixas de itens

path Parameters
identificadorRequisicao
required
string
Example: 00A0000001

O identificador da requisição que se deseja consultar

identificadorRequisicaoItem
required
string
Example: 00A0000001

O identificador do item da requisição que se deseja consultar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Setor

Consultar todos os setores

Consulta todos os setores

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar por identificador

Consulta os setores pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do setor

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Suspect

Cadastrar uma pessoa como Suspect

Cadastra uma nova pessoa no sistema com a característica de suspect

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

Codigo
string

O código

CpfCnpj
number

O CPF ou CNPJ

DataNascimento
string

A data de nascimento

Nome
string

O nome

NomeCurto
string

O nome curto

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retem tributos e contribuições

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviço

AliquotaIRRF
number

A alíquota de IRRF para pessoa jurídica

Responses

Request samples

Content type
application/json
{
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "A",
  • "Tipo": "F",
  • "Codigo": "00001",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-12T16:52:57.317Z",
  • "Nome": "SuspectAPI",
  • "NomeCurto": "Api",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 15
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Tipo de atendimento

Consultar um tipo de atendimento

Consulta um tipo de atendimento

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do tipo de atendimento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Tipo de baixa

Consultar todos os tipos de baixas cadastrados

Consulta os tipos de baixa cadastrados

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um tipo de baixa cadastrado por seu identificador

Consulta um tipo de baixa pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do tipo de baixa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Tipo de cobrança

Consultar todos os tipos de cobrança

Consulta todos os tipos de cobrança cadastrados

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar por identificador

Consulta um tipo de cobrança por identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do tipo de cobrança

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

TipoLogradouro

Consultar todos os tipos de logradouro cadastrados

Consulta todos os tipos de logradouro cadastrados

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar tipos de logradouro por descrição

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

query Parameters
descricao
required
string
Example: descricao=Rua

A descrição do logradouro

porTrecho
required
boolean
Example: porTrecho=true

Indica se a localização será por trecho

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um tipo de logradouro por seu identificador

Consulta um tipo de logradouro pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do tipo de logradouro

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Título a pagar

Cadastrar um novo título a pagar

Cadastra um título a pagar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataCadastro
string

A data de cadastro

IdentificadorNaturezaLancamento
string

O identificador da natureza de lançamento

Array of objects (APagarItemInclusaoContrato)

Os itens do pedido

Valor
required
number

O valor

IdentificadorBanco
string

O identificador do banco

IdentificadorCategoriaPessoa
string

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

O identificador da forma de pagamento

IdentificadorModalidadePagamento
string

O identificador da modalidade de pagamento

CodigoEmpresa
required
string

O código da empresa

DataEmissao
required
string

A data de emissão

DataReferencia
string

A data de referência

DataVencimento
string

A data de vencimento

Descricao
string

A descrição

object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
IdentificadorPessoa
required
string

O identificador da pessoa

Numero
required
string

O número

NumeroAgenciaBancaria
string

O número da agencia bancária de origem do título

NumeroCodigoBarra
string

O número do código de barra

NumeroContaBancaria
string

O número da conta bancária de origem do título

NumeroTituloBanco
string

O número do título no banco

Observacao
string

A observação

Previsao
boolean

Define se é uma previsão

TipoLiquidacao
string

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

Responses

Request samples

Content type
application/json
{
  • "DataCadastro": "2020-06-15T11:04:06.427Z",
  • "IdentificadorNaturezaLancamento": "00A0000001",
  • "Itens": [
    ],
  • "Valor": 100,
  • "IdentificadorBanco": "353",
  • "IdentificadorCategoriaPessoa": "00A0000001",
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorModalidadePagamento": "00A0000001",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-15T11:04:06.427Z",
  • "DataReferencia": "2020-06-15T11:04:06.427Z",
  • "DataVencimento": "2020-06-15T11:04:06.427Z",
  • "Descricao": "Teste a pagar",
  • "DesmembramentoCOFINS": {
    },
  • "DesmembramentoCSLL": {
    },
  • "DesmembramentoDesconto": {
    },
  • "DesmembramentoINSS": {
    },
  • "DesmembramentoIRRF": {
    },
  • "DesmembramentoISS": {
    },
  • "DesmembramentoJuros": {
    },
  • "DesmembramentoMulta": {
    },
  • "DesmembramentoOutros": {
    },
  • "DesmembramentoPIS": {
    },
  • "DesmembramentoPisCofinsCsll": {
    },
  • "IdentificadorPessoa": "00A0000001",
  • "Numero": "123",
  • "NumeroAgenciaBancaria": "123456",
  • "NumeroCodigoBarra": "123465789",
  • "NumeroContaBancaria": "123456",
  • "NumeroTituloBanco": "123456789",
  • "Observacao": "Observação a pagar",
  • "Previsao": true,
  • "TipoLiquidacao": "B"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Consultar todos os títulos a pagar

Consulta de forma paginada todos os títulos a pagar. Permite filtrar por data de cadastro, pessoa, empresa e data de vencimento.

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

dataCadastroInicial
string
Example: dataCadastroInicial=2017-03-21

Data cadastro inicial

dataCadastroFinal
string
Example: dataCadastroFinal=2017-03-21

Data cadastro final

identificadorPessoa
string
Example: identificadorPessoa=00A0000001

O identificador da Pessoa

codigoEmpresa
number
Example: codigoEmpresa=01

O código da empresa

dataVencimentoInicial
string
Example: dataVencimentoInicial=2017-03-21

Data vencimento inicial

dataVencimentoFinal
string
Example: dataVencimentoFinal=2017-03-21

Data vencimento final

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Baixar um título a pagar

Baixar título a pagar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorTituloAPagar
required
string

O identificador do título a pagar que deseja fazer a baixa

ValorBaixa
required
number

Valor da baixa do título (o valor deve ser igual ao valor do título para baixas totais que será preenchida pelo campo IdentificadorTipoBaixa)

IdentificadorTipoBaixa
required
string

O identificador do tipo da baixa

IdentificadorFormaPagamento
required
string

O identificador da forma de pagamento para realzar a baixa

Descricao
string

Descrição da baixa do título a pagar

Observacao
string

Observação adicionada para a realização da baixa a pagar

LiberacaoAutomatica
required
boolean

True - Ativa a liberação automática do lote de baixa / False - Desativa a liberação automática do lote de baixa

IdentificadorContaBancaria
required
string

O identificador da conta bancária para realizar a baixa do título a pagar

Responses

Request samples

Content type
application/json
{
  • "IdentificadorTituloAPagar": "00A0000001",
  • "ValorBaixa": 1000,
  • "IdentificadorTipoBaixa": "00A0000001",
  • "IdentificadorFormaPagamento": "00A0000001",
  • "Descricao": "Teste baixa a pagar",
  • "Observacao": "Observação baixa a pagar",
  • "LiberacaoAutomatica": true,
  • "IdentificadorContaBancaria": "00A0000001"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Editar um titulo a pagar pelo identificador

Edita um título a pagar com base no identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do título a pagar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorBanco
string

O identificador do banco

IdentificadorCategoriaPessoa
string

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

O identificador da forma de pagamento

IdentificadorModalidadePagamento
string

O identificador da modalidade de pagamento

CodigoEmpresa
string

O código da empresa

DataEmissao
string

A data de emissão

DataReferencia
string

A data de referência

DataVencimento
string

A data de vencimento

DataExclusao
string

A data da exclusão. Caso a data de exclusão seja informada o título será excluído.

Descricao
string

A descrição

object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoValoresContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
object (DesmembramentoImpostosContrato)
IdentificadorPessoa
string

O identificador da peso

Numero
string

O número

NumeroAgenciaBancaria
string

O número da agência bancária

NumeroCodigoBarra
string

O número do código de barras

NumeroContaBancaria
string

O número da conta bancária

NumeroTituloBanco
string

O número do título do banco

Observacao
string

A observação

Previsao
boolean

Define se é um título de previsão

TipoLiquidacao
string

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

Responses

Request samples

Content type
application/json
{
  • "IdentificadorBanco": "353",
  • "IdentificadorCategoriaPessoa": "00A0000001",
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorModalidadePagamento": "00A0000001",
  • "CodigoEmpresa": "01",
  • "DataEmissao": "2020-06-15T11:04:06.427Z",
  • "DataReferencia": "2020-06-15T11:04:06.427Z",
  • "DataVencimento": "2020-06-15T11:04:06.427Z",
  • "DataExclusao": "2020-06-15T11:04:06.427Z",
  • "Descricao": "Descrição a pagar",
  • "DesmembramentoCOFINS": {
    },
  • "DesmembramentoCSLL": {
    },
  • "DesmembramentoDesconto": {
    },
  • "DesmembramentoINSS": {
    },
  • "DesmembramentoIRRF": {
    },
  • "DesmembramentoISS": {
    },
  • "DesmembramentoJuros": {
    },
  • "DesmembramentoMulta": {
    },
  • "DesmembramentoOutros": {
    },
  • "DesmembramentoPIS": {
    },
  • "DesmembramentoPisCofinsCsll": {
    },
  • "IdentificadorPessoa": "00A0000001",
  • "Numero": "01",
  • "NumeroAgenciaBancaria": "01",
  • "NumeroCodigoBarra": "123456789",
  • "NumeroContaBancaria": "123456",
  • "NumeroTituloBanco": "123456789",
  • "Observacao": "Observação a pagar",
  • "Previsao": false,
  • "TipoLiquidacao": "B"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar um titulo a pagar pelo identificador

Consulta um título a pagar pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do título a pagar

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os títulos a pagar de uma empresa por status

Consulta de forma paginada os títulos a pagar de uma empresa pelo código da empresa e status do título. Permite filtrar por data de emissão

path Parameters
codigoEmpresa
required
number
Example: 0

O código da empresa

query Parameters
status
required
string
Example: status=0

O status que deverá ser consultado.

  • 0 = Títulos baixados.

  • 1 = Títulos excluídos.

  • 2 = Títulos de previsão.

dataEmissaoInicial
string
Example: dataEmissaoInicial=2001-09-11

A data emissão inicial. Caso não seja informado nenhum valor, por padrão será adotada a data '1900-01-01'.

dataEmissaoFinal
string
Example: dataEmissaoFinal=2012-03-05

Data emissão final. Caso não seja informado nenhum valor, por padrão será adotada a data atual da execução da consulta.

limite
number
Example: limite=25

Limite de títulos por consulta. Por padrão será adotado o valor 25.

pagina
number
Example: pagina=1

A página da consulta. Por padrão será adotado o valor 1.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a quantidade de titulos a pagar

Consulta a quantidade de títulos a pagar. Permite filtrar por pessoa, data de vencimento, data de emissão, data de baixa e por título aberto ou fechado.

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

O identificador da Pessoa

titulosEmAberto
required
boolean
Example: titulosEmAberto=true

Obtém ou define os títulos em aberto

dataInicialVencimento
required
string
Example: dataInicialVencimento=2017-03-21

Obtém ou define a data inicial do vencimento

dataFinalVencimento
required
string
Example: dataFinalVencimento=2017-03-21

Obtém ou define a data final do vencimento

dataInicialEmissao
required
string
Example: dataInicialEmissao=2017-03-21

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

dataFinalEmissao
required
string
Example: dataFinalEmissao=2017-03-21

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

dataInicialBaixa
required
string
Example: dataInicialBaixa=2017-03-21

Obtém ou define a data inicial da baixa

dataFinalBaixa
required
string
Example: dataFinalBaixa=2017-03-21

Obtém ou define a data final da baixa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os titulos a pagar encontrados por pessoa a partir de um filtro de datas

Consulta os titulos a pagar por pessoa a partir de um filtro de datas

query Parameters
identificadorPessoa
required
string
Example: identificadorPessoa=00A0000001

O identificador da Pessoa

titulosEmAberto
required
boolean
Example: titulosEmAberto=true

Obtém ou define os títulos em aberto

dataInicialVencimento
required
string
Example: dataInicialVencimento=2017-03-21

Obtém ou define a data inicial do vencimento

dataFinalVencimento
required
string
Example: dataFinalVencimento=2017-03-21

Obtém ou define a data final do vencimento

dataInicialEmissao
required
string
Example: dataInicialEmissao=2017-03-21

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

dataFinalEmissao
required
string
Example: dataFinalEmissao=2017-03-21

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

dataInicialBaixa
required
string
Example: dataInicialBaixa=2017-03-21

Obtém ou define a data inicial da baixa

dataFinalBaixa
required
string
Example: dataFinalBaixa=2017-03-21

Obtém ou define a data final da baixa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os titulos a pagar a partir da entidade origem

Consulta de forma paginada os títulos a pagar filtrando pela entidade origem

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

idEntidadeOrigem
required
string
Example: idEntidadeOrigem=00A0000001

O identificador da entidade origem

nomeEntidadeOrigem
required
string
Example: nomeEntidadeOrigem=PedidoDeVenda

O nome da entidade origem

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todos os títulos a pagar

Consulta de forma paginada todos os títulos a pagar. Permite filtrar por data de cadastro, pessoa, empresa, data de vencimento e natureza de lançamento.

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

dataCadastroInicial
string
Example: dataCadastroInicial=2017-03-21

Data cadastro inicial

dataCadastroFinal
string
Example: dataCadastroFinal=2017-03-21

Data cadastro final

identificadorPessoa
string
Example: identificadorPessoa=00A0000001

O identificador da Pessoa

codigoEmpresa
number
Example: codigoEmpresa=01

O código da empresa

dataVencimentoInicial
string
Example: dataVencimentoInicial=2017-03-21

Data vencimento inicial

dataVencimentoFinal
string
Example: dataVencimentoFinal=2017-03-21

Data vencimento final

identificadorNaturezaLancamento
string
Example: identificadorNaturezaLancamento=00A0000001

O identificador da Natureza de Lançamento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Título a receber

Consultar um título pelo identificador

Consulta um título pelo identificador

path Parameters
identificador
required
string
Example: 00A0000001

O identificador do título a receber

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar todos os títulos a receber

Consulta todos os títulos a receber de forma paginada. Permite filtrar por data de cadastro, pessoa, empresa e data de vencimento.

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

dataCadastroInicial
string
Example: dataCadastroInicial=2017-03-21

Data cadastro inicial

dataCadastroFinal
string
Example: dataCadastroFinal=2017-03-21

Data cadastro final

identificadorPessoa
string
Example: identificadorPessoa=00A0000001

O identificador da Pessoa

codigoEmpresa
number
Example: codigoEmpresa=01

O código da empresa

dataVencimentoInicial
string
Example: dataVencimentoInicial=2017-03-21

Data vencimento inicial

dataVencimentoFinal
string
Example: dataVencimentoFinal=2017-03-21

Data vencimento final

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um novo título a receber

Cadastra um título a receber

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
object (AReceberConvenioContrato)
Array of objects (AReceberItemContrato)

Os itens

ValorTitulo
required
number

O valor

CodigoEmpresa
required
string

O código da empresa

CodigoEnderecoCobranca
required
string

O código do endereço de cobrança

IdentificadorAgenciaCobranca
string

O identificador da agência de cobrança

IdentificadorBancoCobranca
string

O identificador do banco de cobrança

IdentificadorCategoria
string

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
required
string

O identificador da forma de pagamento

IdentificadorNaturezaLancamento
required
string

O identificador da natureza de lançamento

IdentificadorNaturezaLancamentoConvenio
string

O identificador da natureza de lançamento convênio

IdentificadorNaturezaLancamentoTACConvenio
string

O identificador da natureza de lançamento TAC convênio

IdentificadorNaturezaLancamentoTACEmpresa
string

O identificador da natureza de lançamento TAC empresa

IdentificadorPessoa
required
string

O identificador da pessoa

IdentificadorSituacaoAdministrativa
string

O identificador da situação administrativa

IdentificadorMotivoExclusao
string

O 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

Agrupamento
string

A descrição do agrupamento

AliquotaConvenio
number

A alíquota de convênio

Array of objects (LancamentoCentroCustoInclusaoContrato)

Os centros de custo

object (AReceberCheque)
DataCadastro
string

A data de cadastro

DataEmissao
string

A data de emissão

DataReferencia
string

A data de referência

DataVencimento
string

A data de vencimento

DescricaoTitulo
string

A descrição do título

object (HistoricoCarteiraContrato)
IdentificadorContaBancaria
string

O identificado da conta bancária

NumeroParcela
number

O número de parcelas

NumeroTitulo
required
string

O número do título

NumeroTransacao
string

O número da transação

Observacao
string

A observação

Previsao
boolean

Define se é um título de previsão

ValorTACConvenio
number

O valor TAC convênio

ValorTACEmpresa
number

O valor TAC empresa

Responses

Request samples

Content type
application/json
{
  • "Convenio": {
    },
  • "Itens": [
    ],
  • "ValorTitulo": 100,
  • "CodigoEmpresa": "01",
  • "CodigoEnderecoCobranca": "01",
  • "IdentificadorAgenciaCobranca": "123456",
  • "IdentificadorBancoCobranca": "353",
  • "IdentificadorCategoria": "00A0000001",
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorNaturezaLancamento": "00A00000011",
  • "IdentificadorNaturezaLancamentoConvenio": "00A0000001",
  • "IdentificadorNaturezaLancamentoTACConvenio": "00A0000001",
  • "IdentificadorNaturezaLancamentoTACEmpresa": "00A0000001",
  • "IdentificadorPessoa": "00A0000001",
  • "IdentificadorSituacaoAdministrativa": "00A0000001",
  • "IdentificadorMotivoExclusao": "00A0000001",
  • "Agrupamento": "Agrupamento",
  • "AliquotaConvenio": 5,
  • "CentrosDeCusto": [
    ],
  • "Cheque": {
    },
  • "DataCadastro": "2020-06-15T16:53:02.336Z",
  • "DataEmissao": "2020-06-15T16:53:02.336Z",
  • "DataReferencia": "2020-06-15T16:53:02.336Z",
  • "DataVencimento": "2020-06-15T16:53:02.336Z",
  • "DescricaoTitulo": "Descrição",
  • "HistoricoCarteira": {
    },
  • "IdentificadorContaBancaria": "00A0000001",
  • "NumeroParcela": 10,
  • "NumeroTitulo": "123456",
  • "NumeroTransacao": "1",
  • "Observacao": "Observação",
  • "Previsao": true,
  • "ValorTACConvenio": 4,
  • "ValorTACEmpresa": 3
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Consultar os títulos a receber por empresa e por status

Consulta os títulos a receber por empresa e status de forma paginada. Permite filtrar pela data de emissão e/ou data de baixa.

path Parameters
codigoEmpresa
required
number
Example: 0

O código da empresa

query Parameters
status
required
string
Example: status=0

O status 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
Example: dataEmissaoInicial=2023-03-07

A data de emissão inicial. Caso não seja informado nenhum valor, por padrão será adotada a data '1900-01-01'.

dataEmissaoFinal
string
Example: dataEmissaoFinal=2023-03-10

A data de emissão final. Caso não seja informado nenhum valor, por padrão será adotada a data atual da execução da consulta.

dataBaixaInicial
string
Example: dataBaixaInicial=2023-03-07

A data de baixa inicial. Caso não seja informado nenhum valor, por padrão será adotada a data '1900-01-01'.

dataBaixaFinal
string
Example: dataBaixaFinal=2023-03-10

A data de baixa final. Caso não seja informado nenhum valor, por padrão será adotada a data atual da execução da consulta.

limite
number
Example: limite=25

Limite de títulos por consulta. Por padrão será adotado o valor 25.

pagina
number
Example: pagina=1

A página da consulta. Por padrão será adotado o valor 1.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar os titulos a receber a partir da entidade origem

Consulta de forma paginada os títulos a receber filtrando pela entidade origem

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

idEntidadeOrigem
required
string
Example: idEntidadeOrigem=00A0000001

O identificador da entidade origem

nomeEntidadeOrigem
required
string
Example: nomeEntidadeOrigem=PedidoDeVenda

O nome da entidade origem

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar título por natureza de lançamento

Consulta todos os títulos a receber de forma paginada. Permite filtrar por data de cadastro, pessoa, empresa e data de vencimento.

query Parameters
limite
required
number
Example: limite=1

Limite de títulos por consulta

pagina
required
number
Example: pagina=1

Página

titulosEmAberto
boolean
Example: titulosEmAberto=true

Opção para escolher se irá consultar títulos em aberto. "true" para sim, "false" para não.

identificadorNaturezaLancamento
string
Example: identificadorNaturezaLancamento=2017-03-21

Identificador da natureza de lançamento

dataInicialVencimento
string
Example: dataInicialVencimento=2017-03-21

Data Inicial do Vencimento

dataFinalVencimento
string
Example: dataFinalVencimento=2017-03-21

Data Final do Vencimento

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Paginacao": {
    },
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a quantidade de títulos a receber da pessoa a partir de um filtro

Consulta a quantidade de títulos a receber da pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataFinalBaixa
string

A data final da baixa

DataFinalEmissao
string

A data final de emissão

DataFinalVencimento
string

A data final de vencimento

DataInicialBaixa
string

A data inicial de baixa

DataInicialEmissao
string

A data inicial de emissão

DataInicialVencimento
string

A data inicial de vencimento

SomenteTitulosEmAberto
boolean

Define se consulta somente títulos em aberto

IdentificadoresTiposMovimentoCobranca
Array of strings

O identificador dos tipos de movimento de cobrança

Responses

Request samples

Content type
application/json
{
  • "DataFinalBaixa": "2020-06-15T16:53:02.337Z",
  • "DataFinalEmissao": "2020-06-15T16:53:02.337Z",
  • "DataFinalVencimento": "2020-06-15T16:53:02.337Z",
  • "DataInicialBaixa": "2020-06-15T16:53:02.337Z",
  • "DataInicialEmissao": "2020-06-15T16:53:02.337Z",
  • "DataInicialVencimento": "2020-06-15T16:53:02.337Z",
  • "SomenteTitulosEmAberto": true,
  • "IdentificadoresTiposMovimentoCobranca": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [ ]
}

Consultar os títulos a receber da pessoa a partir de um filtro

Consulta os títulos a receber da pessoa

path Parameters
identificadorPessoa
required
string
Example: 00A0000001

O identificador da pessoa

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataFinalBaixa
string

A data final da baixa

DataFinalEmissao
string

A data final de emissão

DataFinalVencimento
string

A data final de vencimento

DataInicialBaixa
string

A data inicial de baixa

DataInicialEmissao
string

A data inicial de emissão

DataInicialVencimento
string

A data inicial de vencimento

SomenteTitulosEmAberto
boolean

Define se consulta somente títulos em aberto

IdentificadoresTiposMovimentoCobranca
Array of strings

O identificador dos tipos de movimento de cobrança

Responses

Request samples

Content type
application/json
{
  • "DataFinalBaixa": "2020-06-15T16:53:02.337Z",
  • "DataFinalEmissao": "2020-06-15T16:53:02.337Z",
  • "DataFinalVencimento": "2020-06-15T16:53:02.337Z",
  • "DataInicialBaixa": "2020-06-15T16:53:02.337Z",
  • "DataInicialEmissao": "2020-06-15T16:53:02.337Z",
  • "DataInicialVencimento": "2020-06-15T16:53:02.337Z",
  • "SomenteTitulosEmAberto": true,
  • "IdentificadoresTiposMovimentoCobranca": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um convênio a um título a receber

Cadastra um convênio em um título a receber

path Parameters
identificadorTitulo
required
string
Example: 00A0000001

O identificador do título a receber

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
NomeAdquirinte
string

O nome da adquirente

NumeroAutorizacao
string

O número de autorização

NumeroSequencialUnico
string

O número sequencial único do cartão

QuantidadeParcelas
number

A quantidade de parcelas

Responses

Request samples

Content type
application/json
{
  • "NomeAdquirinte": "BimerAPI",
  • "NumeroAutorizacao": "123",
  • "NumeroSequencialUnico": "123456789123",
  • "QuantidadeParcelas": 10
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um lote de baixa a receber em aberto

Cadastra um lote de baixa para o título a receber.

Obs: Este endpoint não realiza baixa de títulos de cheque. A liberação do lote de baixa gerado somente ocorrerá automaticamente caso a tarefa GELiberaLoteBaixaAReceber.exe estiver ativa no módulo gerente eletrônico.

O campo "ValorBaixa" não pode ser utilizado para baixas totais.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
CodigoEmpresa
number

O código da empresa

DescricaoLote
string

A descrição do lote

Array of objects (LoteAReceberItemBaixaContrato)

Os itens do lote

Responses

Request samples

Content type
application/json
{
  • "CodigoEmpresa": 1,
  • "DescricaoLote": "Descrição",
  • "LoteAReceberItemBaixa": [
    ]
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Cadastrar um lote de baixa a receber liberado

Cadastra um lote de baixa parcial e total para o título a receber.

*`Obs: Este endpoint não realiza baixa de títulos de cartão ou cheque.

O campo "ValorBaixa" não pode ser utilizado para baixas totais.

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
IdentificadorTituloAReceber
required
string

O identificador do título a receber

IdentificadorFormaPagamento
required
string

O identificador da forma de pagamento

IdentificadorContaBancaria
required
string

O identificador da conta bancária

ValorBaixa
number

Valor da baixa parcial. Não pode ser utilizado para baixa total.

Descricao
string

A descrição do lote de baixa

Observacao
string

A Observação do lote de baixa

object (TipoBaixaContrato)

Responses

Request samples

Content type
application/json
{
  • "IdentificadorTituloAReceber": "00A0000001",
  • "IdentificadorFormaPagamento": "00A0000001",
  • "IdentificadorContaBancaria": "00A0000001",
  • "ValorBaixa": 100,
  • "Descricao": "descrição do lote",
  • "Observacao": "observação do lote",
  • "TipoBaixa": {
    }
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Editar um título a receber

Edita um título a receber

path Parameters
identificadorTitulo
required
string
Example: 00A0000001

O identificador do título a receber

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
CodigoEmpresa
string

O código da empresa

CodigoEnderecoCobranca
string

O código do endereço de cobrança

IdentificadorAgenciaCobranca
string

O identificador da agência de cobrança

IdentificadorBancoCobranca
string

O identificador do banco de cobrança

IdentificadorCategoria
string

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

O identificador da forma de pagamento

IdentificadorNaturezaLancamento
string

O identificador da natureza de lançamento

IdentificadorNaturezaLancamentoConvenio
string

O identificador da natureza de lançamento de convênio

IdentificadorNaturezaLancamentoTACConvenio
string

O identificador da natureza de lançamento TAC convênio

IdentificadorNaturezaLancamentoTACEmpresa
string

O identificador da natureza de lançamento TAC empresa

IdentificadorPessoa
string

O identificador da pessoa

IdentificadorSituacaoAdministrativa
string

O identificador da situação administrativa

IdentificadorMotivoExclusao
string

O 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

Agrupamento
string

O agrupamento

AliquotaConvenio
number

A alíquota de convênio

Array of objects (LancamentoCentroCustoInclusaoContrato)

Os centros de custo

object (AReceberCheque)
DataCadastro
string

A data de cadastro

DataEmissao
string

A data de emissão

DataReferencia
string

A data de referência

DataVencimento
string

A data de vencimento

DescricaoTitulo
string

A descrição do título

object (HistoricoCarteiraContrato)
IdentificadorContaBancaria
string

O identificador da conta bancária

NumeroParcela
number

O número da parcela

NumeroTitulo
string

O número do título

NumeroTransacao
string

O número da transação

Observacao
string

A observação

Previsao
boolean

Define se é um título de previsão

ValorTACConvenio
number

O valor TAC convênio

ValorTACEmpresa
number

O valor TAC empresa

Responses

Request samples

Content type
application/json
{
  • "CodigoEmpresa": "A",
  • "CodigoEnderecoCobranca": "A",
  • "IdentificadorAgenciaCobranca": "A",
  • "IdentificadorBancoCobranca": "353",
  • "IdentificadorCategoria": "A",
  • "IdentificadorFormaPagamento": "A",
  • "IdentificadorNaturezaLancamento": "A",
  • "IdentificadorNaturezaLancamentoConvenio": "A",
  • "IdentificadorNaturezaLancamentoTACConvenio": "A",
  • "IdentificadorNaturezaLancamentoTACEmpresa": "A",
  • "IdentificadorPessoa": "A",
  • "IdentificadorSituacaoAdministrativa": "A",
  • "IdentificadorMotivoExclusao": "A",
  • "Agrupamento": "A",
  • "AliquotaConvenio": 0,
  • "CentrosDeCusto": [
    ],
  • "Cheque": {
    },
  • "DataCadastro": "2020-06-15T16:53:02.338Z",
  • "DataEmissao": "2020-06-15T16:53:02.338Z",
  • "DataReferencia": "2020-06-15T16:53:02.338Z",
  • "DataVencimento": "2020-06-15T16:53:02.338Z",
  • "DescricaoTitulo": "A",
  • "HistoricoCarteira": {
    },
  • "IdentificadorContaBancaria": "A",
  • "NumeroParcela": 0,
  • "NumeroTitulo": "A",
  • "NumeroTransacao": "A",
  • "Observacao": "A",
  • "Previsao": true,
  • "ValorTACConvenio": 0,
  • "ValorTACEmpresa": 0
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Tranportador

Cadastrar uma pessoa como transportador

Cadastra uma pessoa com a característica de transportador

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
Identificador
string

O identificador da pessoa

Array of objects (PessoaEnderecoCadastroContrato)

Os endereços

IdentificadorRepresentantePrincipal
string

O identificador do representante principal da pessoa

Tipo
string

O tipo da pessoa. "F": Pessoa física; "J": Pessoa jurídica

TipoClienteTelecomunicacao
string

Tipo de cliente para telecomunicação

Valores aceitos: "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

Codigo
string

O código da pessoa no Bimer

CodigoExterno
string

O código externo da pessoa

CpfCnpj
required
number

O CPF ou CNPJ da pessoa

Caso o usuário queira cadastrar um cliente com o mesmo CPF/CNPJ, deverá ser alterada a configuração em Configurador do Bimer / Geral / Opções / Pessoa. Verificar seção "Ao cadastrar mais de uma vez o mesmo CPF/CNPJ".

DataNascimento
string

A data de nascimento da pessoa

Nome
required
string

O nome da pessoa. Máx. 50 caracteres

NomeCurto
string

O nome curto da pessoa. Máx. 30 caracteres

RetemTributosContribuicoes
boolean

Define se a pessoa jurídica retém tributações

RetemTributosDeQualquerValor
boolean

Define se a pessoa jurídica retém tributos de qualquer valor

PrestadoraServico
boolean

Define se a pessoa jurídica é prestadora de serviços

AliquotaIRRF
number

Define a alíquota de IRRF para a pessoa jurídica

DataInicioAtividades
string

A data do início das atividades da empresa

EntidadeAdministracaoPublicaFederal
boolean

Define se a pessoa é uma entidade da administração pública federal

IdentificadorCNAE
string

O identificador do CNAE da pessoa

IdentificadorSituacaoCadastralPessoa
string

O Identificador da situação cadastral da pessoa

RamoAtividade
string

A descrição do ramo de atividade da pessoa

Responses

Request samples

Content type
application/json
{
  • "Identificador": "00A0000001",
  • "Enderecos": [
    ],
  • "IdentificadorRepresentantePrincipal": "00A0000001",
  • "Tipo": "F",
  • "TipoClienteTelecomunicacao": "01",
  • "Codigo": "01",
  • "CodigoExterno": "01ext",
  • "CpfCnpj": 12345678912,
  • "DataNascimento": "2020-06-05T17:05:31.298Z",
  • "Nome": "Pessoa Documentação",
  • "NomeCurto": "Pessoa",
  • "RetemTributosContribuicoes": true,
  • "RetemTributosDeQualquerValor": true,
  • "PrestadoraServico": true,
  • "AliquotaIRRF": 0,
  • "DataInicioAtividades": "2020-06-05T17:05:31",
  • "EntidadeAdministracaoPublicaFederal": true,
  • "IdentificadorCNAE": "00A0000001",
  • "IdentificadorSituacaoCadastralPessoa": "00A0000001",
  • "RamoAtividade": "Atividades de contabilidade"
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Usuário

Consultar um usuário por login

Consulta um usuário pelo login

query Parameters
nomeLogin
required
string
Example: nomeLogin=BimerAPI

O nome de login do usuário

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Versão do Bimer

Consultar a versão da API

Consulta a versão da API

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar a versão do Bimer

Consulta a versão do Bimer

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Versão do produto

Cadastrar uma versão no produto

Cadastra uma versão do produto

path Parameters
identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataLiberacao
string

A data de liberação

DataProgramada
string

A data programada

Numero
string

O número

Observacao
string

A observação

TipoVersao
number

O tipo da versão. Dicionário: 0 - Nenhum 1 - Geral 2 - Homologada 3

Responses

Request samples

Content type
application/json
{
  • "DataLiberacao": "2020-06-15T16:53:02.339Z",
  • "DataProgramada": "2020-06-15T16:53:02.339Z",
  • "Numero": "2.07.45.5",
  • "Observacao": "Observação",
  • "TipoVersao": 0
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Consultar uma determinada versão do produto

Consulta os dados de uma versão específica do produto

path Parameters
identificadorProduto
required
string
Example: 00A0000001

O identificador do produto

query Parameters
numeroVersao
required
string
Example: numeroVersao=2.23.45.0

O número da versão

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Atualizar uma versão

Atualiza uma versão

path Parameters
identificadorVersao
required
string
Example: 00A0000001

O identificador da versão

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Request Body schema: application/json
DataLiberacao
string

A data de liberação

DataProgramada
string

A data programada

Numero
string

O número

Observacao
string

A observação

TipoVersao
number

O tipo da versão. Dicionário: 0 - Nenhum 1 - Geral 2 - Homologada 3

Responses

Request samples

Content type
application/json
{
  • "DataLiberacao": "2020-06-15T16:53:02.339Z",
  • "DataProgramada": "2020-06-15T16:53:02.339Z",
  • "Numero": "2.07.45.5",
  • "Observacao": "Observação",
  • "TipoVersao": 0
}

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}

Workflow

Consultar o item de um workflow

Consulta um item de um workflow

path Parameters
identificadorWorkFlow
required
string
Example: 00A0000001

O identificador do workflow

identificadorWorkFlowItem
required
string
Example: 00A0000001

O identificador do item do workflow

header Parameters
Accept
string
Example: application/json

e.g. application/json

Authorization
string
Example: Bearer Token

e.g. Bearer Token

Responses

Response samples

Content type
application/json
{
  • "Erros": [
    ],
  • "ListaObjetos": [
    ]
}