API - Alterdata Bimer (11.02.02.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.
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.
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.
- O serviço é formado da seguinte forma: http://hostname/versaoapi/recursoRaiz
Onde:
- Hostname: Endereço principal do serviço
- Versão da API: Versão do serviço que está sendo consumido
- Recurso Raiz: Nome do serviço
Por exemplo: https://seuservidordaAPI.com.br/api/clientes
No Recurso Raiz, podemos acessar as principais operações do serviço (CRUD), através dos métodos do padrão HTTP, conforme tabela abaixo:
| CRUD | Métodos HTTP |
|---|---|
| Create | POST |
| Read | GET |
| Update | PUT |
| Delete | DELETE |
Ou seja, no serviço /clientes, do exemplo acima, se fizermos uma operação POST, salvaremos um novo cliente.
A tabela abaixo mostra algumas das operações que conseguimos executar sobre determinados serviços:
| Recurso | GET | POST |
|---|---|---|
| /clientes | * | Cria um novo cliente |
| /produtos | Lista com todos os produtos cadastrados | * |
| /produtos/00A0000001 | Lista detalhes do produto com identificador 00A0000001 | * |
- O '*' representa que o método não está disponível, então espera-se o retorno com ERRO 405 - method not allowed
HTTP 1.1
O protocolo padrão para comunicação com as APIs é o HTTP versão 1.1.
Para mais informações sobre esse protocolo, consulte:
http://www.w3.org/Protocols/rfc2616/rfc2616.html
http://www.ietf.org/rfc/rfc2616.txt
UTF-8
O Charset padrão para chamadas às APIs é o UTF-8. Para mais informações sobre essa codificação, consulte:
https://tools.ietf.org/html/rfc3629
JSON
JSON (JavaScript Object Notation) é um padrão para descrição de dados para intercâmbio entre sistemas e é mais simples e mais leve que o XML.
Por padrão, toda a API trafega JSON, tanto para receber informações (métodos POST e PUT) quanto no retorno (método GET)
Devido a essa padronização, para as chamadas POST e PUT é necessário informar o HTTP Header content-type:application/json. Do contrário, você receberá um erro HTTP 415: Unsupported Media Type
Para poder utilizar a api é necessário se atentar aos seguintes requisitos:
- Verificar se a api atende suas necessidades através de uma exploração maior da documentação a fim de verificar se as funcionalidades disponibilizadas irão atender às pretendidas.
- IIS 7.5 ou superior instalado no servidor;
- Net Framework 4.7.2 ou superior instalado no servidor;
- Acesso ao banco de dados SQL onde está a base do Bimer;
- Para a criação de um login para ser utilizado pelo Bimer
- APIVersão corrente da documentação ou superior do Alterdata Bimer ERP
- Caso não esteja na versão informada, solicite a atualização via suporte
- Acesso ao módulo Cadastro de Usuário do Bimer.
- Versão do Windows em período de suporte da Microsoft (A instalação pode ser realizada em uma versão fora do suporte, mas não há garantia de funcionamento)
- Base de homologação do Bimer (Não é um requisito, mas é altamente recomendado)
- Base de dados que é uma cópia da base de produção voltada para os testes.
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.
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 '...'.
- 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.
- Pode ser causado por um identificador incorreto. Lembre-se que os identificadores do Bimer são compostos de 10 caracteres alfanuméricos.
- 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.
- O token de autenticação utilizado expirou ou é inválido
- Erro 403 - Forbidden
- O usuário atual não possui acesso a essa rota. Libere o acesso no módulo cadastro de usuários.
Atualização do Token de acesso
Atualiza o token de acesso à API.
Authorizations:
Request Body schema: multipart/form-data
| username required | string O login do usuário |
| token required | string O token de acesso (sem 'bearer' no início) |
| refreshToken required | string O refresh token (sem 'bearer' no início) |
Responses
Response samples
- 200
- 400
Cadastrar um atendimento
Cadastra um novo atendimento que pode ser visualizado no CRM.
Authorizations:
Request Body schema:
O atendimento que será adicionado.
| agrupamento | string or null O agrupamento ao que o atendimento pertence. |
| assunto | string or null O assunto do atendimento. |
| codigoExterno | string or null Código externo do atendimento. |
| dataAbertura | string <date-time> A data de abertura. |
| dataContatoInterno | string <date-time> A data de contato interno. |
| dataEntrega | string <date-time> A data de entrega. |
| dataPrevista | string <date-time> A data prevista. |
| destinatariosSpySystem | Array of strings or null Obtém ou define a lista de destinatários de spy. |
| identificadorPessoa required | string Identificador da pessoa do atendimento. |
| identificadorProduto | string or null Identificador do produto do atendimento. |
| identificadorTipoAtendimento required | string O identificador do tipo de atendimento. |
| identificadorUsuarioContatoInterno | string or null O identificador do usuário de contato interno. |
| identificadorVersaoProduto | string or null O identificador da versão do produto. |
object (AtendimentoParecerCadastroContrato) Contrato cadastro de parecer de atendimento. | |
| prioridade | integer <int32> O valor da prioridade do atendimento. |
| tag | string or null Uma tag para o atendimento. |
| prioritario | boolean Define se o atendimento é prioritário. |
| identificadorEntidadeOrigem | string or null O identificador da entidade origem. |
| nomeEntidadeOrigem | string or null O nome da entidade origem. |
Responses
Request samples
- Payload
{- "agrupamento": "string",
- "assunto": "string",
- "codigoExterno": "string",
- "dataAbertura": "2019-08-24T14:15:22Z",
- "dataContatoInterno": "2019-08-24T14:15:22Z",
- "dataEntrega": "2019-08-24T14:15:22Z",
- "dataPrevista": "2019-08-24T14:15:22Z",
- "destinatariosSpySystem": [
- "string"
], - "identificadorPessoa": "string",
- "identificadorProduto": "string",
- "identificadorTipoAtendimento": "string",
- "identificadorUsuarioContatoInterno": "string",
- "identificadorVersaoProduto": "string",
- "parecerAbertura": {
- "dataFinalParecer": "2019-08-24T14:15:22Z",
- "dataInicialParecer": "2019-08-24T14:15:22Z",
- "dataProximoContato": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "identificadorTipoContato": "string",
- "identificadorUsuarioProximoContato": "string",
- "identificadorWorkFlowDestino": "string",
- "identificadorWorkFlowItemDestino": "string",
- "nomePessoaContato": "string",
- "identificadorCentroResponsabilidadeDestino": "string"
}, - "prioridade": 0,
- "tag": "string",
- "prioritario": true,
- "identificadorEntidadeOrigem": "string",
- "nomeEntidadeOrigem": "string"
}Response samples
- 200
Adicionar um parecer em um atendimento
Adiciona um parecer em um atendimento
Authorizations:
path Parameters
| identificador required | string |
Request Body schema:
| dataFinalParecer | string <date-time> A data do fim do parecer. |
| dataInicialParecer | string <date-time> A data de início do parecer. |
| dataProximoContato | string <date-time> A data de próximo contato. |
| descricao | string or null A descrição do parecer. |
| identificadorTipoContato | string or null O identificador do tipo de contato. |
| identificadorUsuarioProximoContato | string or null O identificador do usuário de próximo contato. |
| identificadorWorkFlowDestino | string or null O identificador do WorkFlow de destino. |
| identificadorWorkFlowItemDestino | string or null O identificador do item do WorkFlow de destino. |
| nomePessoaContato | string or null O nome da pessoa de contato do atendimento. |
Responses
Request samples
- Payload
{- "dataFinalParecer": "2019-08-24T14:15:22Z",
- "dataInicialParecer": "2019-08-24T14:15:22Z",
- "dataProximoContato": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "identificadorTipoContato": "string",
- "identificadorUsuarioProximoContato": "string",
- "identificadorWorkFlowDestino": "string",
- "identificadorWorkFlowItemDestino": "string",
- "nomePessoaContato": "string"
}Response samples
- 200
Consultar permissão de encerramento
Consultar se derterminado usuário possui permissão para encerrar um atendimento, conforme a configuração do tipo de atendimento.
Authorizations:
query Parameters
| identificadorUsuario required | string O identificador do usuário. |
| identificadorAtendimento | string O identificador do atendimento. |
| identificadorTipoAtendimento | string O identificador do tipo de atendimento. |
Responses
Response samples
- 200
Cria um contato de venda.
Authorizations:
Request Body schema:
O contrato do contato de venda que será criado.
| assuntoAtual | string or null Assunto atual |
| descricaoContato | string or null Decrição do Contato de Venda |
| contatoPrioritario | boolean Indica se é um contato prioritário |
| dataAbertura | string or null <date-time> Data de abertura |
| dataContatoInterno | string or null <date-time> Data de contato interno |
| dataProximoContato | string or null <date-time> Data de próximo contato |
| dataEncerramento | string or null <date-time> Data de Encerramento do contato |
| dataPrevistaFechamento | string or null <date-time> Data de previsão de fechamento do contato de venda |
| dataFechamentoCobranca | string or null <date-time> Data de fechamento da cobrança |
| dataFechamentoPedido | string or null <date-time> Data de pfechamento do pedido |
| descricaoMeioDeContato | string or null Descrição do Meio de contato de venda |
| descricaoSistemaAtual | string or null Descrição do sistema atual |
| destinatariosSpySystem | Array of strings or null Destinatários para envio de Spy System |
| encerrado | boolean Define se o contato já está encerrado. |
| identificadorMeioContato | string or null Identificador meio de contato |
| identificadorSistemaAtual | string or null Identificador sistema atual |
| identificadorPrazo | string or null Identificador do prazo. |
| identificadorFormaPagamentoContrato | string or null Identificador da forma de pagamento da cobrança do contrato que será gerado após o fechamento do contato de venda. |
| identificadorCentroResponsabilidade | string or null Identificador centro de responsabilidade |
| identificadorOperacaoNotaFiscal | string or null Identificador operação nota fiscal |
Array of objects or null (ContatoVendaItemCadastroContrato) Produtos | |
Array of objects or null (ContatoVendaParecerCadastroContrato) Pareceres de abertura de contato de venda | |
Array of objects or null (ContatoVendaConcorrenteCadastroContrato) Concorrentes do contato de venda | |
Array of objects or null (ContatoVendaRepasseCadastroContrato) Repasses do contato de venda | |
| percentualFechamento | number or null <double> Percentual da probabilidade de fechamento do contato |
| restrito | boolean Indica que o conteúdo do contato é restrito |
object (ContatoVendaPessoaContrato) Contrato pessoa contato de venda. | |
| identificadorTipoAtendimento | string or null Identificador tipo de atendimento |
| identificadorUsuarioContatoInterno | string or null Usuário de contato interno do contato |
| identificadorUsuarioProximoContato | string or null Identificador usuário próximo contato |
| identificadorUsuarioSolicitanteAbertura | string or null Identificador usuário do que solicitou a abertura do contato de venda |
| identificadorUsuarioAbertura | string or null Identificador usuário de abertura |
| valorAproximado | number or null <double> Valor aproximado do contato de venda |
| identificadorClienteResponsavelFinanceiro | string or null O identificador do cliente responsável financeiro |
| gerarPedidoPessoaFinanceiro | boolean Informação se o contato vai gerar pedido para o responsável financeiro. |
| observacaoDocumento | string or null A observação do documento |
| nomeEntidadeOrigem | string or null Nome da entidade de origem do documento de venda. |
| identificadorEntidadeOrigem | string or null Identificador da entidade de origem do documento de venda. |
Array of objects or null (ContatoVendaPagamentoCadastroContrato) Os pagamentos do contato de venda. |
Responses
Request samples
- Payload
{- "assuntoAtual": "string",
- "descricaoContato": "string",
- "contatoPrioritario": true,
- "dataAbertura": "2019-08-24T14:15:22Z",
- "dataContatoInterno": "2019-08-24T14:15:22Z",
- "dataProximoContato": "2019-08-24T14:15:22Z",
- "dataEncerramento": "2019-08-24T14:15:22Z",
- "dataPrevistaFechamento": "2019-08-24T14:15:22Z",
- "dataFechamentoCobranca": "2019-08-24T14:15:22Z",
- "dataFechamentoPedido": "2019-08-24T14:15:22Z",
- "descricaoMeioDeContato": "string",
- "descricaoSistemaAtual": "string",
- "destinatariosSpySystem": [
- "string"
], - "encerrado": true,
- "identificadorMeioContato": "string",
- "identificadorSistemaAtual": "string",
- "identificadorPrazo": "string",
- "identificadorFormaPagamentoContrato": "string",
- "identificadorCentroResponsabilidade": "string",
- "identificadorOperacaoNotaFiscal": "string",
- "itens": [
- {
- "identificadorProduto": "string",
- "identificadoresProdutosFilhos": [
- "string"
], - "produtosFilhos": [
- {
- "identificadorProduto": "string",
- "produtosFilhos": [
- { }
]
}
], - "identificadorTipoMovimentoCobranca": "string",
- "identificadorSituacaoProduto": "string",
- "quantidade": 0.1,
- "valorProduto": 0.1,
- "dataCarencia": "2019-08-24T14:15:22Z",
- "mesesCobranca": [
- "string"
], - "periodoCobranca": "string",
- "dataReajuste": "2019-08-24T14:15:22Z",
- "dataEntrega": "2019-08-24T14:15:22Z",
- "codigoEmpresaERP": "string",
- "identificadorSetorSaida": "string",
- "informacoesComplementares": [
- {
- "identificador": "string",
- "valor": "string"
}
]
}
], - "pareceres": [
- {
- "descricao": "string",
- "dataContatoInterno": "2019-08-24T14:15:22Z",
- "identificadorUsuarioContatoInterno": "string",
- "identificadorUsuarioProximoContato": "string",
- "dataProximoContato": "2019-08-24T14:15:22Z",
- "identificadorUsuarioParecer": "string",
- "identificadorTipoContato": "string",
- "nomePessoaContato": "string",
- "identificadorCentroResponsabilidadeDestino": "string"
}
], - "concorrentes": [
- {
- "identificadorPessoaConcorrente": "string",
- "identificadorMeioContato": "string"
}
], - "repasses": [
- {
- "identificadorPessoaRepasse": "string",
- "identificadorCategoriaPessoaRepasse": "string",
- "repassePrincipal": true,
- "aliquotaRepasseDuplicata": 0.1,
- "aliquotaRepasseFaturamento": 0.1
}
], - "percentualFechamento": 0.1,
- "restrito": true,
- "pessoa": {
- "identificador": "string",
- "nome": "string",
- "tipo": "string",
- "cpfCnpj": 0
}, - "identificadorTipoAtendimento": "string",
- "identificadorUsuarioContatoInterno": "string",
- "identificadorUsuarioProximoContato": "string",
- "identificadorUsuarioSolicitanteAbertura": "string",
- "identificadorUsuarioAbertura": "string",
- "valorAproximado": 0.1,
- "identificadorClienteResponsavelFinanceiro": "string",
- "gerarPedidoPessoaFinanceiro": true,
- "observacaoDocumento": "string",
- "nomeEntidadeOrigem": "string",
- "identificadorEntidadeOrigem": "string",
- "pagamentos": [
- {
- "aliquotaConvenio": 0.1,
- "aliquotaParcela": 0.1,
- "aliquotaTacConvenio": 0.1,
- "aliquotaTacEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "cartaCredito": true,
- "entrada": true,
- "identificador": "string",
- "identificadorBanco": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTipoCobranca": "string",
- "numeroAgencia": "string",
- "numeroCheque": "string",
- "numeroConta": "string",
- "numeroDiasIntervaloEntreParcelas": 0,
- "numeroDiasPagamento": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelasPagamento": 0,
- "numeroParcelasRecebimento": 0,
- "valorParcela": 0.1,
- "valorTacConvenio": 0.1,
- "valorTacEmpresa": 0.1
}
]
}Response samples
- 200
Cria um novo inventário.
Authorizations:
Request Body schema:
O inventário a ser criado.
| codigoEmpresa | string or null |
| identificadorUsuario | string or null |
| identificadorSetor | string or null |
| descricaoLoteInventario | string or null |
| descricaoMotivoContagem | string or null |
| dataLancamento | string <date-time> |
| dataInventario | string <date-time> |
| identificadorUsuarioDestinoContagem | string or null |
Array of objects or null (InserirLoteInventarioItemRequestDTO) |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "identificadorUsuario": "string",
- "identificadorSetor": "string",
- "descricaoLoteInventario": "string",
- "descricaoMotivoContagem": "string",
- "dataLancamento": "2019-08-24T14:15:22Z",
- "dataInventario": "2019-08-24T14:15:22Z",
- "identificadorUsuarioDestinoContagem": "string",
- "itens": [
- {
- "identificadorProduto": "string",
- "identificadorProdutoLote": "string",
- "quantidadeItem": 0.1,
- "identificadorUsuarioLoteInventarioItem": "string"
}
]
}Response samples
- 200
Cria um novo inventário.
Authorizations:
Request Body schema:
O inventário a ser criado.
| codigoEmpresa | string or null |
| identificadorUsuario | string or null |
| identificadorSetor | string or null |
| descricaoLoteInventario | string or null |
| descricaoMotivoContagem | string or null |
| dataLancamento | string <date-time> |
| dataInventario | string <date-time> |
| identificadorUsuarioDestinoContagem | string or null |
Array of objects or null (InserirLoteInventarioItemRequestDTO) |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "identificadorUsuario": "string",
- "identificadorSetor": "string",
- "descricaoLoteInventario": "string",
- "descricaoMotivoContagem": "string",
- "dataLancamento": "2019-08-24T14:15:22Z",
- "dataInventario": "2019-08-24T14:15:22Z",
- "identificadorUsuarioDestinoContagem": "string",
- "itens": [
- {
- "identificadorProduto": "string",
- "identificadorProdutoLote": "string",
- "quantidadeItem": 0.1,
- "identificadorUsuarioLoteInventarioItem": "string"
}
]
}Response samples
- 200
Adiciona um pedido de compra.
Authorizations:
Request Body schema:
O pedido de compra a ser adicionado.
| cep | string or null CEP. |
| codigo | string or null Codigo do pedido de compra. |
| complementoEndereco | string or null Complemento do endereco. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataEmissaoACT | string <date-time> Obtém ou define a data de emissao do aviso de conhecimento do transporte. |
| dataEntrega | string <date-time> Obtém ou define a data da entrega. |
| descricao | string or null Obtém ou define a descricao. |
| entregaParcial | boolean Obtém ou define se o pedido de compra terá entrega parcial. |
| logradouro | string or null Logradouro. |
| numeroEndereco | string or null Numero do endereco. |
| numeroOrcamento | string or null Numero de orçamento. |
| observacao | string or null Obtém ou define a observacao. |
object (PrazoContrato) Contrato do prazo. | |
| tipoLogradouro | string or null Tipo do logradouro. |
| uf | string or null Obtém ou define a UF. |
| identificadorEntidadeOrigem | string or null Identificador da entidade de origem. |
| nomeEntidadeOrigem | string or null Entidade de Origem. |
| codigoEmpresa | string or null Codigo da empresa. |
| codigoEmpresaFinanceiro | string or null Codigo da empresa financeiro. |
| identificadorBairro | string or null Identificador do bairro. |
| identificadorCidade | string or null Identificador da cidade. |
| identificadorFornecedor | string or null Identificador da pessoa fornecedora. |
| identificadorIndexador | string or null Identificador do indexador. |
| identificadorNaturezaLancamento | string or null Identificador da natureza de lancamento. |
| identificadorTransportador | string or null Identificador da pessoa transportadora. |
| identificadorUsuarioLiberacao | string or null Identificador do usuario responsavel pela liberacao. |
| valorAcrescimo | number <double> Valor do acrescimo. |
| valorDesconto | number <double> Valor do desconto. |
| valorFrete | number <double> Valor do frete. |
| valorSeguro | number <double> Valor do seguro. |
| valorOutrasDespesas | number <double> Valor de outras despesas. |
| valorACT | number <double> Valor do aviso de conhecimento de transporte. |
object (PedidoDeCompraPagamentoTransporteCadastroContratoPedidoDeCompraConhecimentoTransporteContrato) Contrato do conhecimento de transporte. | |
| tipoFrete | string or null 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"). |
| status | string or null Status do pedido de compra. Valores aceitos: "A": Aberto, "G": Aguardando; Caso seja omitido, será considerado como Aberto ("A"). |
Responses
Request samples
- Payload
{- "cep": "string",
- "codigo": "string",
- "complementoEndereco": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataEmissaoACT": "2019-08-24T14:15:22Z",
- "dataEntrega": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "entregaParcial": true,
- "logradouro": "string",
- "numeroEndereco": "string",
- "numeroOrcamento": "string",
- "observacao": "string",
- "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "tipoLogradouro": "string",
- "uf": "string",
- "identificadorEntidadeOrigem": "string",
- "nomeEntidadeOrigem": "string",
- "codigoEmpresa": "string",
- "codigoEmpresaFinanceiro": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorFornecedor": "string",
- "identificadorIndexador": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTransportador": "string",
- "identificadorUsuarioLiberacao": "string",
- "valorAcrescimo": 0.1,
- "valorDesconto": 0.1,
- "valorFrete": 0.1,
- "valorSeguro": 0.1,
- "valorOutrasDespesas": 0.1,
- "valorACT": 0.1,
- "conhecimentoTransporte": {
- "prazoTransporte": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}
}, - "tipoFrete": "string",
- "status": "string"
}Response samples
- 200
Altera um pedido de compra por identificador, considerando para cada item e pagamento o que foi informado no "TipoCadastro".
Authorizations:
path Parameters
| identificadorPedido required | string O identificador do pedido a ser alterado. |
Request Body schema:
O contrato do pedido de compra a ser alterado.
| cep | string or null CEP. |
| codigo | string or null Codigo do pedido de compra. |
| complementoEndereco | string or null Complemento do endereco. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataEmissaoACT | string <date-time> Obtém ou define a data de emissao do aviso de conhecimento do transporte. |
| dataEntrega | string <date-time> Obtém ou define a data da entrega. |
| descricao | string or null Obtém ou define a descricao. |
| entregaParcial | boolean Obtém ou define se o pedido de compra terá entrega parcial. |
| logradouro | string or null Logradouro. |
| numeroEndereco | string or null Numero do endereco. |
| numeroOrcamento | string or null Numero de orçamento. |
| observacao | string or null Obtém ou define a observacao. |
object (PrazoContrato) Contrato do prazo. | |
| tipoLogradouro | string or null Tipo do logradouro. |
| uf | string or null Obtém ou define a UF. |
| identificadorEntidadeOrigem | string or null Identificador da entidade de origem. |
| nomeEntidadeOrigem | string or null Entidade de Origem. |
| codigoEmpresa | string or null Codigo da empresa. |
| codigoEmpresaFinanceiro | string or null Codigo da empresa financeiro. |
| identificadorBairro | string or null Identificador do bairro. |
| identificadorCidade | string or null Identificador da cidade. |
| identificadorFornecedor | string or null Identificador da pessoa fornecedora. |
| identificadorIndexador | string or null Identificador do indexador. |
| identificadorNaturezaLancamento | string or null Identificador da natureza de lancamento. |
| identificadorTransportador | string or null Identificador da pessoa transportadora. |
| identificadorUsuarioLiberacao | string or null Identificador do usuario responsavel pela liberacao. |
| valorAcrescimo | number <double> Valor do acrescimo. |
| valorDesconto | number <double> Valor do desconto. |
| valorFrete | number <double> Valor do frete. |
| valorSeguro | number <double> Valor do seguro. |
| valorOutrasDespesas | number <double> Valor de outras despesas. |
| valorACT | number <double> Valor do aviso de conhecimento de transporte. |
object (PedidoDeCompraPagamentoTransporteCadastroContratoPedidoDeCompraConhecimentoTransporteContrato) Contrato do conhecimento de transporte. | |
| tipoFrete | string or null 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"). |
| status | string or null Status do pedido de compra. Valores aceitos: "A": Aberto, "G": Aguardando; Caso seja omitido, será considerado como Aberto ("A"). |
Responses
Request samples
- Payload
{- "cep": "string",
- "codigo": "string",
- "complementoEndereco": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataEmissaoACT": "2019-08-24T14:15:22Z",
- "dataEntrega": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "entregaParcial": true,
- "logradouro": "string",
- "numeroEndereco": "string",
- "numeroOrcamento": "string",
- "observacao": "string",
- "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "tipoLogradouro": "string",
- "uf": "string",
- "identificadorEntidadeOrigem": "string",
- "nomeEntidadeOrigem": "string",
- "codigoEmpresa": "string",
- "codigoEmpresaFinanceiro": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorFornecedor": "string",
- "identificadorIndexador": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTransportador": "string",
- "identificadorUsuarioLiberacao": "string",
- "valorAcrescimo": 0.1,
- "valorDesconto": 0.1,
- "valorFrete": 0.1,
- "valorSeguro": 0.1,
- "valorOutrasDespesas": 0.1,
- "valorACT": 0.1,
- "conhecimentoTransporte": {
- "prazoTransporte": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}
}, - "tipoFrete": "string",
- "status": "string"
}Response samples
- 200
Obtém o(s) pedido(s) de compra de acordo com o STATUS informado.
Obtém o pedido de compra de acordo com o status informado.
Authorizations:
path Parameters
| codigoEmpresa required | string O código da empresa cadastrada. |
query Parameters
| identificadorFornecedor | string O identificador do fornecedor. |
| status | string O status do pedido de compra. |
| dataInicialEmissao | string <date-time> A data inicial de emissão do pedido de compra. |
| dataFinalEmissao | string <date-time> A data final de emissão do pedido de compra. |
Responses
Response samples
- 200
Adiciona um produto.
Authorizations:
Request Body schema:
O produto a ser adicionado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string"
}Response samples
- 200
Altera um produto por identificador, considerando para cada item e pagamento o que foi informado no "TipoCadastro".
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
| tipoCadastro | string or null Tipo de ação a realizar com o cadastro. A - Alteração. E - Exclusão. I - Inclusão. |
Array of objects or null (ProdutoEmpresaAlteracaoContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoAlteracaoContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoAlteracaoContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "tipoCadastro": "string",
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string",
- "tipoCadastro": "string"
}
], - "tipoCadastro": "string"
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true,
- "tipoCadastro": "string"
}
], - "codigos": [
- {
- "identificador": "string",
- "tipoCadastro": "string",
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string"
}Response samples
- 200
Obtém os identificadores dos produtos com versão de registro superior ao valor determinado.
Authorizations:
query Parameters
| versaoRegistro | integer <int64> A versão do registro que será usada para filtro (maior que). |
| itensPorPagina | integer <int32> A quantidade de itens que deverão ser exibidos por página. |
Responses
Response samples
- 200
Adiciona uma grade de produtos.
Authorizations:
Request Body schema:
A grade de produtos a ser adicionada.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação da grade |
| identificadorGradeHorizontal | string or null Retorna ou atribui o identificador da grade horizontal |
| identificadorGradeVertical | string or null Retorna ou atribui o identificador da grade vertical |
Array of objects or null (ProdutoGradeDetalheCadastroContrato) Retorna ou atribui os detalhes da grade |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string",
- "identificadorGradeHorizontal": "string",
- "identificadorGradeVertical": "string",
- "detalhes": [
- {
- "identificadorGradeDetalheHorizontal": "string",
- "identificadorGradeDetalheVertical": "string",
- "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "observacao": "string"
}
]
}Response samples
- 200
Incluir novos itens em uma grade existente.
Authorizations:
path Parameters
| identificadorProdutoMaster required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação da grade |
| identificadorGradeHorizontal | string or null Retorna ou atribui o identificador da grade horizontal |
| identificadorGradeVertical | string or null Retorna ou atribui o identificador da grade vertical |
Array of objects or null (ProdutoGradeDetalheCadastroContrato) Retorna ou atribui os detalhes da grade |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string",
- "identificadorGradeHorizontal": "string",
- "identificadorGradeVertical": "string",
- "detalhes": [
- {
- "identificadorGradeDetalheHorizontal": "string",
- "identificadorGradeDetalheVertical": "string",
- "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "observacao": "string"
}
]
}Response samples
- 200
Alterar uma grade de produtos. Nesse endpoint todos os itens de uma grade serão editados.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
| tipoCadastro | string or null Tipo de ação a realizar com o cadastro. A - Alteração. E - Exclusão. I - Inclusão. |
Array of objects or null (ProdutoEmpresaAlteracaoContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoAlteracaoContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoAlteracaoContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "tipoCadastro": "string",
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string",
- "tipoCadastro": "string"
}
], - "tipoCadastro": "string"
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true,
- "tipoCadastro": "string"
}
], - "codigos": [
- {
- "identificador": "string",
- "tipoCadastro": "string",
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string"
}Response samples
- 200
Adiciona uma requisição de material.
Authorizations:
Request Body schema:
A requisição de material que deverá ser adicionada.
| codigoEmpresa | integer <int32> Código da empresa. |
| data | string <date-time> Obtém ou define a data da requisição de materiais. |
| identificadorCentroDeCusto | string or null Identificador do centro de custos. |
| identificadorSetorRequisitado | string or null Identificador do setor requisitante. |
| identificadorSetorRequisitante | string or null Identificador do setor requisitante. |
Array of objects or null (RequisicaoMaterialItemCadastroContrato) Obtém ou define os itens da requisição. | |
| numeroOrdemProducao | string or null Número da ordem de produção. |
| observacao | string or null Obtém ou define a observação. |
| prioridade | integer <int32> Obtém ou define a prioridade. |
| tipo | string or null Tipo da requisição. Valores permitidos: "R" - Requisicao, "C" - RequisicaoConsumo, "D" - Devolucao, "P" - Perda, "S" - Reposicao, "T" - Transferencia |
| urgente | boolean Obtém ou define um valor que indica se a requisição de material é urgente. |
Responses
Request samples
- Payload
{- "codigoEmpresa": 0,
- "data": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "identificadorSetorRequisitado": "string",
- "identificadorSetorRequisitante": "string",
- "itens": [
- {
- "complementoItem": "string",
- "identificadorProduto": "string",
- "identificadorUnidade": "string",
- "quantidadeRequerida": 0.1,
- "identificadorFuncionario": "string"
}
], - "numeroOrdemProducao": "string",
- "observacao": "string",
- "prioridade": 0,
- "tipo": "string",
- "urgente": true
}Response samples
- 200
Retorna os dados da baixa de itens da requisicao de materiais de acordo com os identificadores informados
Authorizations:
path Parameters
| identificadorRequisicao required | string O identificador da requisicao que se deseja consultar. |
| identificadorRequisicaoItem required | string O identificador do item da requisicao que se deseja consultar. |
Responses
Response samples
- 200
Adiciona um pedido de venda.
Authorizations:
Request Body schema:
O pedido de venda que deve ser adicionado.
| identificador | string or null Identiificador do pedido. Em caso de uma inclusão de pedido este campo deve ser omitido. |
| codigo | string or null Código único do pedido. Em caso de inclusão, se omitido, este valor será gerado automaticamente de acordo com as configurações do sistema. |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
| codigoEmpresa | integer <int32> Código da empresa emitente do pedido. |
| codigoEmpresaEstoque | integer or null <int32> Código da empresa para o estoque. |
| codigoEmpresaFinanceiro | integer or null <int32> Código da empresa para o financeiro. |
| codigoEnderecoCobranca | string or null Código do endereço de cobrança do pedido de venda. Este é o código do endereço dentro do cadastro do cliente. Caso seja omitido, será informado por padrão o endereço principal do cliente. |
| codigoEnderecoEntrega | string or null Código do endereço de entrega do pedido de venda. Este é o código do endereço dentro do cadastro do cliente. Caso seja omitido, será informado por padrão o endereço principal do cliente. |
| codigoPedidoDeCompraCliente | string or null Código do pedido de compra do cliente. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do pedido. |
| dataEntrada | string <date-time> Obtém ou define a data de entrada. |
| dataEntrega | string <date-time> Obtém ou define a data prevista de entrega do pedido. |
| dataCotacaoIndexador | string <date-time> Obtém ou define a data da cotação do indexador. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
| faturamentoParcial | boolean Obtém ou define se o status do faturamento é parcial. |
| identificadorCliente | string or null Identificador do cliente. |
| identificadoresMensagens | Array of strings or null Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). |
| identificadorIndexador | string or null Identificador do indexador. |
| identificadorMeioContato | string or null Identificador do meio de contato que foi utilizado para a geração do pedido. |
| identificadorOperacao | string or null Obtém ou define a operação fiscal utilizada por este pedido. |
| identificadorOperacaoOE | string or null Obtém ou define a operação de ordem de entrega utilizada por este pedido. |
| identificadorSetor | string or null Identificador setor de saída das mercadorias. |
| identificadorTransportador | string or null Identificador do transportador. |
| identificadorPreco | string or null Identificador do preço. |
Array of objects or null (PedidoDeVendaItemCadastroContrato) Obtém ou define a lista de itens do pedido. | |
| nomePessoaContato | string or null Nome da pessoa de contato com a qual se realizou o pedido. No caso de uma empresa, o pedido é gerado com a empresa como cliente, mas o mesmo é negociado com uma pessoa de contato. |
| observacao | string or null Obtém ou define uma observação para o pedido. |
| observacaoDocumento | string or null Obtém ou define uma observação do documento para o pedido. |
Array of objects or null (PedidoDeVendaPagamentoCadastroContrato) Obtém ou define a lista de pagamentos do pedido. | |
object (PrazoContrato) Contrato do prazo. | |
| status | string or null Status do pedido de venda.
|
| tipoFrete | string or null Tipo de frete do pedido de venda.
|
| indicadorAtendimentoPresencial | string or null Obtém ou define a informação de indicação de presença.
|
object (PedidoDeVendaTransportadoraContrato) The transportadora contrato. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "acrescimo": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "codigoEmpresa": 0,
- "codigoEmpresaEstoque": 0,
- "codigoEmpresaFinanceiro": 0,
- "codigoEnderecoCobranca": "string",
- "codigoEnderecoEntrega": "string",
- "codigoPedidoDeCompraCliente": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataEntrada": "2019-08-24T14:15:22Z",
- "dataEntrega": "2019-08-24T14:15:22Z",
- "dataCotacaoIndexador": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "desconto": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "faturamentoParcial": true,
- "identificadorCliente": "string",
- "identificadoresMensagens": [
- "string"
], - "identificadorIndexador": "string",
- "identificadorMeioContato": "string",
- "identificadorOperacao": "string",
- "identificadorOperacaoOE": "string",
- "identificadorSetor": "string",
- "identificadorTransportador": "string",
- "identificadorPreco": "string",
- "itens": [
- {
- "identificador": "string",
- "acrescimo": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "cfop": "string",
- "cofins": {
- "codigoSituacaoTributaria": "string"
}, - "desconto": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "descricaoComplementar": "string",
- "frete": {
- "tipo": "string",
- "valor": 0.1
}, - "icms": {
- "codigoSituacaoTributaria": "string"
}, - "identificadorProduto": "string",
- "identificadorSetorSaida": "string",
- "origemProduto": 0,
- "outros": {
- "valorSeguro": 0.1,
- "valorOutrasDespesas": 0.1
}, - "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "pis": {
- "codigoSituacaoTributaria": "string"
}, - "quantidadePedida": 0.1,
- "repasses": [
- {
- "aliquotaComissao": 0.1,
- "aliquotaComissaoDuplicata": 0.1,
- "aliquotaComissaoFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true,
- "principal": true
}
], - "status": "string",
- "valor": 0.1,
- "valorUnitario": 0.1,
- "posicao": 0
}
], - "nomePessoaContato": "string",
- "observacao": "string",
- "observacaoDocumento": "string",
- "pagamentos": [
- {
- "identificador": "string",
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "atualizaFinanceiro": true,
- "dataReferencia": "2019-08-24T14:15:22Z",
- "diasIntervalo": 0,
- "diasParaPrimeiraParcela": 0,
- "diasRecebimento": 0,
- "entrada": true,
- "identificadorAgencia": "string",
- "identificadorBanco": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTipoCobranca": "string",
- "numeroAgencia": "string",
- "numeroCheque": 0,
- "numeroConta": "string",
- "numeroDeDias": 0,
- "numeroParcelas": 0,
- "numeroTitulo": "string",
- "parcelasRecebimento": 0,
- "valor": 0.1,
- "valorTacConvenio": 0.1,
- "valorTacEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "status": "string",
- "tipoFrete": "string",
- "indicadorAtendimentoPresencial": "string",
- "transportadora": {
- "identificadorTransportadorRedespacho": "string",
- "quantidade": 0,
- "especie": "string",
- "marca": "string",
- "numero": 0,
- "viaTransporte": "string"
}
}Response samples
- 200
Baixa um pedido de venda totalmente ou parcialmente.
Authorizations:
path Parameters
| identificadorPedidoDeVenda required | string O identificador do pedido de venda. |
Request Body schema:
O contrato de baixa do pedido (os itens não são obrigatórios em caso de baixa total).
| criaDocumentoProntoParaSerLiberado | boolean Obtém ou define se o documento deve ser criado pronto para ser liberado. |
Array of objects or null (PedidoDeVendaBaixaItemContrato) Obtém ou define os itens a serem baixados | |
| statusNotaFiscalEletronica | string or null Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro |
Responses
Request samples
- Payload
{- "criaDocumentoProntoParaSerLiberado": true,
- "itens": [
- {
- "identificador": "string",
- "quantidadeAtendida": 0.1,
- "status": "string"
}
], - "statusNotaFiscalEletronica": "string"
}Response samples
- 200
Consulta todos os pedidos de venda usando o status.
Status do pedido de venda:
A - Aberto
L - Liberado
P - Parcialmente Atendimento
T - Totalmente Atendido
X - Atendido com Corte
C - Cancelado
Authorizations:
query Parameters
| empresa | integer <int32> O código da empresa que será utilizado na consulta. (Opcional) |
| cliente | string O identificador do cliente que será usado na consulta. (Opcional) |
| pedidoDeVenda | string O código do pedido de venda. (Opcional) |
| pedidoDeCompraCliente | string O código do pedido de compra do cliente (Opcional) |
| status | string O status do pedido de venda. (OBRIGATÓRIO) |
| emissaoInicial | string <date-time> A data de emissão inicial. (Opcional) |
| emissaoFinal | string <date-time> A data de emissão final. (Opcional) |
| limite | integer <int32> Define a quantidade de registros que serão apresentados. (OBRIGATÓRIO) |
| pagina | integer <int32> Define o índice da página que será apresentada. (OBRIGATÓRIO) |
Responses
Response samples
- 200
Consulta uma agência por seu banco e número
Consultar uma agência cadastrada no Bimer utilizando como parâmetros o número da agência e o identificador do banco.
Authorizations:
query Parameters
| identificadorBanco | string O identificador do banco (Febraban). |
| numeroAgencia | string O número da agência. |
Responses
Response samples
- 200
Obtém uma conta bancária por identificador.
Observação: O identificador é composto por 10 caracteres.
Exemplo de utilização:
http://localhost:8085/api/contas-bancarias/00100001F1
Authorizations:
path Parameters
| identificador required | string O identificador da conta bancária. |
Responses
Response samples
- 200
Adiciona um novo lançamento no conta corrente.
Authorizations:
Request Body schema:
O contrato com o lançamento no conta corrente.
| aliquotaMovimento | number <double> Obtém ou define a alíquota do movimento |
| dataLiberacao | string <date-time> Obtém ou define a data de liberacao. |
| dataMovimento | string <date-time> Obtém ou define a data do movimento |
| codigoEmpresa | integer <int32> Obtém ou define a empresa. |
| historico | string or null Histórico da conta corrente |
| lancamentoCompoeFatura | boolean Obtém ou define se será lançamento compõe a fatura. |
| lancamentoCompoeIRRF | boolean Obtém ou define se o lançamento compõe o IRRF. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lancamento. |
| identificadorPessoa | string or null Identificador da pessoa da conta corrente |
| valorBaseMovimento | number <double> Valor da Base do movimento |
| valorMovimento | number <double> Valor do movimento |
Responses
Request samples
- Payload
{- "aliquotaMovimento": 0.1,
- "dataLiberacao": "2019-08-24T14:15:22Z",
- "dataMovimento": "2019-08-24T14:15:22Z",
- "codigoEmpresa": 0,
- "historico": "string",
- "lancamentoCompoeFatura": true,
- "lancamentoCompoeIRRF": true,
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoa": "string",
- "valorBaseMovimento": 0.1,
- "valorMovimento": 0.1
}Response samples
- 200
Consulta o histórico de carteira por identificador do titulo a receber.
Authorizations:
path Parameters
| identificadorAReceber required | string O identificador do titulo a receber. |
query Parameters
| historicoValido | boolean Default: true O histórico de carteira válido |
Responses
Response samples
- 200
Edita um movimento de cobrança.
Authorizations:
path Parameters
| identificador required | string O identificador do movimento de cobrança a ser editado. |
Request Body schema:
O movimento de cobrança a ser editado.
| codigoContrato | string or null Código do contrato. |
| identificador | string or null Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido. |
Array of objects or null (MovimentoCobrancaPagamentoContrato) Obtém ou define os pagamentos do movimento de cobrança | |
| aglutinaCobrancaEmTitulo | boolean Obtém ou define um valor que indica se aglutina a cobrança em título. |
| cobraTaxaBancaria | boolean Obtém ou define um valor que indica se deverá ser cobrada taxa bancária. |
| codigoEmpresa | string or null Obtém ou define a empresa. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| codigoEnderecoEntrega | string or null Endereço de entrega. |
| contratoLiberado | boolean Obtém ou define um valor que indica se o contrato está liberado. |
| destino | string or null Destino da cobrança. "N": Nota fiscal, "R": Títulos a receber. |
| diaVencimento | integer <int32> Dia do vencimento. |
| dataVencimento | string or null <date-time> Obtém ou define a data do vencimento. |
| identificadorFormaPagamento | string or null Obtém ou define a forma de pagamento do movimento. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do movimento. |
| identificadorOperacaoNotaFiscal | string or null Obtém ou define a operação da nota fiscal que poderá ser gerada pelo movimento caso o destino do mesmo seja nota fiscal. |
| identificadorTipoCobranca | string or null Tipo de cobrança do movimento. |
Array of objects or null (MovimentoCobrancaItemCadastroContrato) Obtém ou define os itens do movimento. | |
| numeroContrato | string or null Número do contrato. |
| identificadorResponsavelFinanceiro | string or null Identificador da responsável pelo financeiro. |
| dataFimVigenciaContrato | string or null <date-time> Obtém ou define a data de fim de vigência do contrato. |
| dataInicialVigenciaContrato | string or null <date-time> Obtém ou define a data de início de vigência do contrato. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorPrazo | string or null Identificador do prazo. |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
| aliquotaRepasseRepresentantePrincipal | number <double> Obtém ou define a aliquota de repasse para o representante principal |
Responses
Request samples
- Payload
{- "codigoContrato": "string",
- "identificador": "string",
- "pagamentos": [
- {
- "aliquotaConvenio": 0.1,
- "aliquotaParcela": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "cartaDeCredito": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "entrada": true,
- "identificador": "string",
- "identificadorBanco": "string",
- "identificadorFormaPagamento": "string",
- "identificadorIndexador": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTipoBaixa": "string",
- "identificadorTipoCobranca": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "recalculaParcela": true,
- "valorParcela": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "valorTitulo": 0.1
}
], - "aglutinaCobrancaEmTitulo": true,
- "cobraTaxaBancaria": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "codigoEnderecoEntrega": "string",
- "contratoLiberado": true,
- "destino": "string",
- "diaVencimento": 0,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorOperacaoNotaFiscal": "string",
- "identificadorTipoCobranca": "string",
- "itens": [
- {
- "ativo": true,
- "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
- "dataFinalCarencia": "2019-08-24T14:15:22Z",
- "dataInicialReajuste": "2019-08-24T14:15:22Z",
- "dataUltimoReajuste": "2019-08-24T14:15:22Z",
- "dataValidoAPartir": "2019-08-24T14:15:22Z",
- "dataValidoAte": "2019-08-24T14:15:22Z",
- "doacao": true,
- "identificador": "string",
- "mesesGeracaoDestinoMovimentoCobranca": [
- "string"
], - "motivoDoacao": "string",
- "observacao": "string",
- "periodoReajusteMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoaRepasse": "string",
- "identificadorCategoriaPessoaRepasse": "string",
- "aliquotaRepasseDuplicata": 0.1,
- "aliquotaRepasseFaturamento": 0.1,
- "quantidadeRepassePermitido": 0,
- "valorBaseRepasse": 0.1
}
], - "informacoesComplementares": [
- {
- "identificador": "string",
- "valor": "string"
}
], - "dataCadastro": "2019-08-24T14:15:22Z",
- "identificadorIndexador": "string",
- "identificadorMotivoCancelamento": "string",
- "identificadorProduto": "string",
- "identificadorProdutoVinculado": "string",
- "identificadorStatusProduto": "string",
- "identificadorTipoMovimentoCobranca": "string"
}
], - "numeroContrato": "string",
- "identificadorResponsavelFinanceiro": "string",
- "dataFimVigenciaContrato": "2019-08-24T14:15:22Z",
- "dataInicialVigenciaContrato": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorPrazo": "string",
- "acrescimo": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "desconto": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "aliquotaRepasseRepresentantePrincipal": 0.1
}Response samples
- 200
Obtém a lista de movimentos de cobrança de uma pessoa com um determinado produto.
Authorizations:
query Parameters
| identificadorPessoa | string O identificador da pessoa. |
| identificadorProduto | string O identificador do produto. |
| tipoMovimento | string O tipo do movimento para filtro: "F" - Fixo; "V" - Variável; "P" - Prazo |
| considerarInativos | boolean Valor que indica se os movimentos inativos devem ser considerados na consulta. |
Responses
Response samples
- 200
Adiciona um movimento de cobrança.
Authorizations:
query Parameters
| incluirComposicaoPadrao | boolean Default: false Indica se os itens do movimento devem ter toda sua composição padrão inserida. |
Request Body schema:
O movimento de cobrança que será adicionado.
| codigoContrato | string or null Código do contrato. |
| identificador | string or null Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido. |
Array of objects or null (MovimentoCobrancaPagamentoContrato) Obtém ou define os pagamentos do movimento de cobrança | |
| aglutinaCobrancaEmTitulo | boolean Obtém ou define um valor que indica se aglutina a cobrança em título. |
| cobraTaxaBancaria | boolean Obtém ou define um valor que indica se deverá ser cobrada taxa bancária. |
| codigoEmpresa | string or null Obtém ou define a empresa. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| codigoEnderecoEntrega | string or null Endereço de entrega. |
| contratoLiberado | boolean Obtém ou define um valor que indica se o contrato está liberado. |
| destino | string or null Destino da cobrança. "N": Nota fiscal, "R": Títulos a receber. |
| diaVencimento | integer <int32> Dia do vencimento. |
| dataVencimento | string or null <date-time> Obtém ou define a data do vencimento. |
| identificadorFormaPagamento | string or null Obtém ou define a forma de pagamento do movimento. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do movimento. |
| identificadorOperacaoNotaFiscal | string or null Obtém ou define a operação da nota fiscal que poderá ser gerada pelo movimento caso o destino do mesmo seja nota fiscal. |
| identificadorTipoCobranca | string or null Tipo de cobrança do movimento. |
Array of objects or null (MovimentoCobrancaItemCadastroContrato) Obtém ou define os itens do movimento. | |
| numeroContrato | string or null Número do contrato. |
| identificadorResponsavelFinanceiro | string or null Identificador da responsável pelo financeiro. |
| dataFimVigenciaContrato | string or null <date-time> Obtém ou define a data de fim de vigência do contrato. |
| dataInicialVigenciaContrato | string or null <date-time> Obtém ou define a data de início de vigência do contrato. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorPrazo | string or null Identificador do prazo. |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
object (AcrescimoDescontoContrato) Contrato de desconto ou acréscimo. | |
| aliquotaRepasseRepresentantePrincipal | number <double> Obtém ou define a aliquota de repasse para o representante principal |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do movimento. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do movimento. |
| identificadorCliente | string or null Define o cliente. |
| identificadorTipoMovimentoCobranca | string or null Identificador do tipo de movimento de cobrança. Este movimento será utilizado para alimentar os itens do movimento de cobrança que não tenham o tipo de movimento de cobrança informado. |
| tipoMovimento | string or null Tipo de movimento. "F": Fixo, "V": Variável, "P": Prazo; |
Responses
Request samples
- Payload
{- "codigoContrato": "string",
- "identificador": "string",
- "pagamentos": [
- {
- "aliquotaConvenio": 0.1,
- "aliquotaParcela": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "cartaDeCredito": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "entrada": true,
- "identificador": "string",
- "identificadorBanco": "string",
- "identificadorFormaPagamento": "string",
- "identificadorIndexador": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorTipoBaixa": "string",
- "identificadorTipoCobranca": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "recalculaParcela": true,
- "valorParcela": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "valorTitulo": 0.1
}
], - "aglutinaCobrancaEmTitulo": true,
- "cobraTaxaBancaria": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "codigoEnderecoEntrega": "string",
- "contratoLiberado": true,
- "destino": "string",
- "diaVencimento": 0,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorOperacaoNotaFiscal": "string",
- "identificadorTipoCobranca": "string",
- "itens": [
- {
- "ativo": true,
- "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
- "dataFinalCarencia": "2019-08-24T14:15:22Z",
- "dataInicialReajuste": "2019-08-24T14:15:22Z",
- "dataUltimoReajuste": "2019-08-24T14:15:22Z",
- "dataValidoAPartir": "2019-08-24T14:15:22Z",
- "dataValidoAte": "2019-08-24T14:15:22Z",
- "doacao": true,
- "identificador": "string",
- "mesesGeracaoDestinoMovimentoCobranca": [
- "string"
], - "motivoDoacao": "string",
- "observacao": "string",
- "periodoReajusteMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoaRepasse": "string",
- "identificadorCategoriaPessoaRepasse": "string",
- "aliquotaRepasseDuplicata": 0.1,
- "aliquotaRepasseFaturamento": 0.1,
- "quantidadeRepassePermitido": 0,
- "valorBaseRepasse": 0.1
}
], - "informacoesComplementares": [
- {
- "identificador": "string",
- "valor": "string"
}
], - "dataCadastro": "2019-08-24T14:15:22Z",
- "identificadorIndexador": "string",
- "identificadorMotivoCancelamento": "string",
- "identificadorProduto": "string",
- "identificadorProdutoVinculado": "string",
- "identificadorStatusProduto": "string",
- "identificadorTipoMovimentoCobranca": "string"
}
], - "numeroContrato": "string",
- "identificadorResponsavelFinanceiro": "string",
- "dataFimVigenciaContrato": "2019-08-24T14:15:22Z",
- "dataInicialVigenciaContrato": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorPrazo": "string",
- "acrescimo": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "desconto": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "aliquotaRepasseRepresentantePrincipal": 0.1,
- "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "identificadorCliente": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "tipoMovimento": "string"
}Response samples
- 200
Obtém todos os contratos do cliente assim como seus respectivos vencimentos.
Exemplo de utilização do endpoint:
http://localhost:8085/api/financeiro/movimentoCobranca/outros-contratos/00100025C3
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador do cliente. |
Responses
Response samples
- 200
Obtém a lista de movimentos de cobrança completa de uma pessoa com um determinado produto.
Authorizations:
query Parameters
| identificadorPessoa | string O identificador da pessoa. |
| identificadorProduto | string O identificador do produto. |
| tipoMovimento | string O tipo do movimento para filtro: "F" - Fixo; "V" - Variável; "P" - Prazo |
| considerarInativos | boolean Valor que indica se os movimentos inativos devem ser considerados na consulta. |
Responses
Response samples
- 200
Adiciona um item no movimento de cobrança
Authorizations:
path Parameters
| identificadorMovimentoCobranca required | string |
Request Body schema:
| ativo | boolean Valor que indica se o item está ativo. |
| dataInicioUtilizacao | string or null <date-time> Obtém ou define a data do início da utilização. |
| dataFinalCarencia | string or null <date-time> Obtém ou define a data final da carência. |
| dataInicialReajuste | string or null <date-time> Obtém ou define a data inicial para reajuste. |
| dataUltimoReajuste | string or null <date-time> Data em que o item foi reajustado pela última vez. |
| dataValidoAPartir | string or null <date-time> Obtém ou define a data de validade a partir. |
| dataValidoAte | string or null <date-time> Obtém ou define a data de validade. |
| doacao | boolean Obtém ou define um valor que indica se o item do movimento é uma doação. |
| identificador | string or null Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido. |
| mesesGeracaoDestinoMovimentoCobranca | Array of strings or null Obtém ou define os meses de geração do destino de movimento de cobrança. Os meses devem ser informados com suas siglas; |
| motivoDoacao | string or null Motivo da doação. |
| observacao | string or null Obtém ou define a observação do item. |
| periodoReajusteMovimentoCobranca | string or null Período de reajuste do item do movimento de cobrança. "ANO", "SEMESTRE", "TRIMESTRE", "BIMESTRE", "MES", "DIA"; |
| valor | number <double> Valor do item. |
Array of objects or null (MovimentoCobrancaItemRepasseContrato) Obtém ou define os repasses do item | |
Array of objects or null (MovimentoCobrancaItemComplementoContrato) Informações complementares do item. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do item. |
| identificadorIndexador | string or null Indexador do item do movimento de cobrança. |
| identificadorMotivoCancelamento | string or null Identificador do motivo de cancelamento/devolução do item do movimento de cobrança. |
| identificadorProduto | string or null Produto do item. |
| identificadorProdutoVinculado | string or null Identificador do produto do item vinculado |
| identificadorStatusProduto | string or null Status do produto. |
| identificadorTipoMovimentoCobranca | string or null Tipo do movimento de cobrança. |
Responses
Request samples
- Payload
{- "ativo": true,
- "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
- "dataFinalCarencia": "2019-08-24T14:15:22Z",
- "dataInicialReajuste": "2019-08-24T14:15:22Z",
- "dataUltimoReajuste": "2019-08-24T14:15:22Z",
- "dataValidoAPartir": "2019-08-24T14:15:22Z",
- "dataValidoAte": "2019-08-24T14:15:22Z",
- "doacao": true,
- "identificador": "string",
- "mesesGeracaoDestinoMovimentoCobranca": [
- "string"
], - "motivoDoacao": "string",
- "observacao": "string",
- "periodoReajusteMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoaRepasse": "string",
- "identificadorCategoriaPessoaRepasse": "string",
- "aliquotaRepasseDuplicata": 0.1,
- "aliquotaRepasseFaturamento": 0.1,
- "quantidadeRepassePermitido": 0,
- "valorBaseRepasse": 0.1
}
], - "informacoesComplementares": [
- {
- "identificador": "string",
- "valor": "string"
}
], - "dataCadastro": "2019-08-24T14:15:22Z",
- "identificadorIndexador": "string",
- "identificadorMotivoCancelamento": "string",
- "identificadorProduto": "string",
- "identificadorProdutoVinculado": "string",
- "identificadorStatusProduto": "string",
- "identificadorTipoMovimentoCobranca": "string"
}Response samples
- 200
Edita um item de movimento de combrança
Authorizations:
path Parameters
| identificadorMovimentoCobranca required | string |
| identificadorMovimentoItem required | string |
Request Body schema:
| ativo | boolean Valor que indica se o item está ativo. |
| dataInicioUtilizacao | string or null <date-time> Obtém ou define a data do início da utilização. |
| dataFinalCarencia | string or null <date-time> Obtém ou define a data final da carência. |
| dataInicialReajuste | string or null <date-time> Obtém ou define a data inicial para reajuste. |
| dataUltimoReajuste | string or null <date-time> Data em que o item foi reajustado pela última vez. |
| dataValidoAPartir | string or null <date-time> Obtém ou define a data de validade a partir. |
| dataValidoAte | string or null <date-time> Obtém ou define a data de validade. |
| doacao | boolean Obtém ou define um valor que indica se o item do movimento é uma doação. |
| identificador | string or null Identificador do movimento de cobrança. Em caso de uma inclusão este campo deve ser omitido. |
| mesesGeracaoDestinoMovimentoCobranca | Array of strings or null Obtém ou define os meses de geração do destino de movimento de cobrança. Os meses devem ser informados com suas siglas; |
| motivoDoacao | string or null Motivo da doação. |
| observacao | string or null Obtém ou define a observação do item. |
| periodoReajusteMovimentoCobranca | string or null Período de reajuste do item do movimento de cobrança. "ANO", "SEMESTRE", "TRIMESTRE", "BIMESTRE", "MES", "DIA"; |
| valor | number <double> Valor do item. |
Array of objects or null (MovimentoCobrancaItemRepasseContrato) Obtém ou define os repasses do item | |
Array of objects or null (MovimentoCobrancaItemComplementoContrato) Informações complementares do item. | |
| identificadorStatusProduto | string or null Identificador do status do produto. |
| identificadorTipoMovimentoCobranca | string or null Identificador do tipo do movimento de cobrança. |
| identificadorProdutoVinculado | string or null Identificador do produto do item vinculado |
| identificadorIndexador | string or null Identificador do indexador do item do movimento de cobrança. |
| identificadorMotivoCancelamento | string or null Identificador do motivo de cancelamento/devolução do item do movimento de cobrança. |
| identificadorAtendimentoVinculadoCancelamento | string or null Identificador do atendimento vinculado ao motivo de cancelamento/devolução do item do movimento de cobrança. |
| tipoProdutoMotivoCancelamento | string or null Tipo de produto relacionado ao motivo de cancelamento/devolução do item do movimento de cobrança (Produto/Todos/NaoInformado). |
| identificadorProdutoMotivoCancelamento | string or null Identificador do produto relacionaldo ao motivo de cancelamento/devolução do item do movimento de cobrança quando o tipo é Produto. |
Responses
Request samples
- Payload
{- "ativo": true,
- "dataInicioUtilizacao": "2019-08-24T14:15:22Z",
- "dataFinalCarencia": "2019-08-24T14:15:22Z",
- "dataInicialReajuste": "2019-08-24T14:15:22Z",
- "dataUltimoReajuste": "2019-08-24T14:15:22Z",
- "dataValidoAPartir": "2019-08-24T14:15:22Z",
- "dataValidoAte": "2019-08-24T14:15:22Z",
- "doacao": true,
- "identificador": "string",
- "mesesGeracaoDestinoMovimentoCobranca": [
- "string"
], - "motivoDoacao": "string",
- "observacao": "string",
- "periodoReajusteMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoaRepasse": "string",
- "identificadorCategoriaPessoaRepasse": "string",
- "aliquotaRepasseDuplicata": 0.1,
- "aliquotaRepasseFaturamento": 0.1,
- "quantidadeRepassePermitido": 0,
- "valorBaseRepasse": 0.1
}
], - "informacoesComplementares": [
- {
- "identificador": "string",
- "valor": "string"
}
], - "identificadorStatusProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "identificadorProdutoVinculado": "string",
- "identificadorIndexador": "string",
- "identificadorMotivoCancelamento": "string",
- "identificadorAtendimentoVinculadoCancelamento": "string",
- "tipoProdutoMotivoCancelamento": "string",
- "identificadorProdutoMotivoCancelamento": "string"
}Response samples
- 200
Edita um título a pagar pelo identificador.
Authorizations:
path Parameters
| identificador required | string O identificador do titulo a pagar a ser alterado. |
Request Body schema:
O titulo com as alterações.
| codigoEmpresa | string or null Código da empresa do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de Vencimento do título. |
| descricao | string or null Obtém ou define a descrição (nome) do título. |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
| identificadorPessoa | string or null Identificador da pessoa. |
| numero | string or null Número do título. |
| numeroAgenciaBancaria | string or null Número da agencia bancária de origem do título. |
| numeroCodigoBarra | string or null Número do código de barra do título. |
| numeroContaBancaria | string or null Número da conta bancária de origem do título. |
| numeroTituloBanco | string or null Número do título no banco. |
| observacao | string or null Obtém ou define a observação. |
| previsao | boolean Valor que indica se este é um título de previsão. |
| tipoLiquidacao | string or null Tipo de liquidacao. Valores aceitos: "B": Bloqueto, "C": Concessionária. |
| dataExclusao | string <date-time> Obtém ou define a data de exclusao do título. |
| identificadorBanco | string or null Identificador do banco. |
| identificadorCategoriaPessoa | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria fornecedor ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorModalidadePagamento | string or null Identificador da modalidade de pagamento. |
| identificadorSituacaoAdministrativa | string or null O identificador da situação administrativa do título. |
| versaoRegistro | integer or null <int64> A versão do registro. |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "desmembramentoCOFINS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoCSLL": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoDesconto": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoINSS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoIRRF": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoISS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoJuros": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoMulta": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoOutros": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoPIS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoPisCofinsCsll": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "identificadorPessoa": "string",
- "numero": "string",
- "numeroAgenciaBancaria": "string",
- "numeroCodigoBarra": "string",
- "numeroContaBancaria": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "previsao": true,
- "tipoLiquidacao": "string",
- "dataExclusao": "2019-08-24T14:15:22Z",
- "identificadorBanco": "string",
- "identificadorCategoriaPessoa": "string",
- "identificadorFormaPagamento": "string",
- "identificadorModalidadePagamento": "string",
- "identificadorSituacaoAdministrativa": "string",
- "versaoRegistro": 0
}Response samples
- 200
Obtém ou define a quantidade de titulos a pagar.
Authorizations:
query Parameters
| identificadorPessoa | string Identificador da Pessoa. |
| titulosEmAberto | boolean Obtém ou define os titulos em aberto. |
| dataInicialVencimento | string <date-time> Obtém ou define a data inicial do vencimento. |
| dataFinalVencimento | string <date-time> Obtém ou define a data final do vencimento. |
| dataInicialEmissao | string <date-time> Obtém ou define a data inicial da emissão. |
| dataFinalEmissao | string <date-time> Obtém ou define a data final da emissão. |
| dataInicialBaixa | string <date-time> Obtém ou define a data inicial da baixa. |
| dataFinalBaixa | string <date-time> Obtém ou define a data final da baixa. |
Responses
Response samples
- 200
Obtém ou define os titulos a pagar encontrados por pessoa a partir de um filtro de datas.
Authorizations:
query Parameters
| identificadorPessoa | string Identificador da Pessoa. |
| titulosEmAberto | boolean Default: false Obtém ou define os titulos em aberto. |
| dataInicialVencimento | string <date-time> Obtém ou define a data inicial do vencimento. |
| dataFinalVencimento | string <date-time> Obtém ou define a data final do vencimento. |
| dataInicialEmissao | string <date-time> Obtém ou define a data inicial da emissão. |
| dataFinalEmissao | string <date-time> Obtém ou define a data final da emissão. |
| dataInicialBaixa | string <date-time> Obtém ou define a data inicial da baixa. |
| dataFinalBaixa | string <date-time> Obtém ou define a data final da baixa. |
Responses
Response samples
- 200
Adiciona um novo título a pagar.
Authorizations:
Request Body schema:
O título a pagar que deverá ser adicionado.
| codigoEmpresa | string or null Código da empresa do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de Vencimento do título. |
| descricao | string or null Obtém ou define a descrição (nome) do título. |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoValoresContrato) The desmembramento valores. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
object (DesmembramentoImpostosContrato) Contrato do desmembramento de impostos. | |
| identificadorPessoa | string or null Identificador da pessoa. |
| numero | string or null Número do título. |
| numeroAgenciaBancaria | string or null Número da agencia bancária de origem do título. |
| numeroCodigoBarra | string or null Número do código de barra do título. |
| numeroContaBancaria | string or null Número da conta bancária de origem do título. |
| numeroTituloBanco | string or null Número do título no banco. |
| observacao | string or null Obtém ou define a observação. |
| previsao | boolean Valor que indica se este é um título de previsão. |
| tipoLiquidacao | string or null Tipo de liquidacao. Valores aceitos: "B": Bloqueto, "C": Concessionária. |
| dataExclusao | string <date-time> Obtém ou define a data de exclusao do título. |
| identificadorBanco | string or null Identificador do banco. |
| identificadorCategoriaPessoa | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria fornecedor ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorModalidadePagamento | string or null Identificador da modalidade de pagamento. |
| identificadorSituacaoAdministrativa | string or null O identificador da situação administrativa do título. |
| versaoRegistro | integer or null <int64> A versão do registro. |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| identificadorNaturezaLancamento | string or null Identificador da natureza de lançamento do título. |
Array of objects or null (APagarItemInclusaoContrato) Obtém ou define os itens do título a pagar. | |
| valor | number <double> Valor do título. |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricao": "string",
- "desmembramentoCOFINS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoCSLL": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoDesconto": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoINSS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoIRRF": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoISS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoJuros": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoMulta": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorEventoBaixa": "string"
}, - "desmembramentoOutros": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoPIS": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "desmembramentoPisCofinsCsll": {
- "identificadorNaturezaLancamento": "string",
- "valor": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string"
}, - "identificadorPessoa": "string",
- "numero": "string",
- "numeroAgenciaBancaria": "string",
- "numeroCodigoBarra": "string",
- "numeroContaBancaria": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "previsao": true,
- "tipoLiquidacao": "string",
- "dataExclusao": "2019-08-24T14:15:22Z",
- "identificadorBanco": "string",
- "identificadorCategoriaPessoa": "string",
- "identificadorFormaPagamento": "string",
- "identificadorModalidadePagamento": "string",
- "identificadorSituacaoAdministrativa": "string",
- "versaoRegistro": 0,
- "dataCadastro": "2019-08-24T14:15:22Z",
- "identificadorNaturezaLancamento": "string",
- "itens": [
- {
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "observacao": "string",
- "valor": 0.1,
- "identificadorNaturezaLancamento": "string"
}
], - "valor": 0.1
}Response samples
- 200
Obtém todos os títulos a pagar por data de cadastro
Authorizations:
query Parameters
| limite | integer <int32> Limite de títulos por consulta. |
| pagina | integer <int32> Página. |
| dataCadastroInicial | string <date-time> Data cadastro inicial. |
| dataCadastroFinal | string <date-time> Data cadastro final. |
| identificadorPessoa | string Obtém ou define o identificador da Pessoa. |
| codigoEmpresa | integer <int32> Obtém ou define o código da empresa. |
| dataVencimentoInicial | string <date-time> Data vencimento inicial. |
| dataVencimentoFinal | string <date-time> Data vencimento final. |
Responses
Response samples
- 200
Obtém os títulos de uma empresa por status
Authorizations:
path Parameters
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| status | integer <int32> (EStatusTitulosAPagar) Enum: 0 1 2 3 O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos excluídos. 2 = Títulos de previsão. |
| dataEmissaoInicial | string <date-time> A data inicial de emissão do filtro. |
| dataEmissaoFinal | string <date-time> A data final de emissão do filtro. |
| limite | integer <int32> Default: 25 A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25. |
| pagina | integer <int32> Default: 1 A página que deseja consultar. Quando não informado, por pardrão será definido 1. |
Responses
Response samples
- 200
Obtem os títulos a pagar pelo Identificador Entidade Origem
Authorizations:
query Parameters
| idEntidadeOrigem | string Default: "" O identificador da entidade origem |
| nomeEntidadeOrigem | string Default: "" O nome da entidade origem |
| limite | integer <int32> Default: 25 A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25. |
| pagina | integer <int32> Default: 1 A página que deseja consultar. Quando não informado, por pardrão será definido 1. |
Responses
Response samples
- 200
Obtém todos os títulos a pagar por data de cadastro
Authorizations:
query Parameters
| limite | integer <int32> Default: 25 Limite de títulos por consulta. |
| pagina | integer <int32> Default: 1 Página. |
| dataCadastroInicial | string <date-time> Data cadastro inicial. |
| dataCadastroFinal | string <date-time> Data cadastro final. |
| identificadorPessoa | string Obtém ou define o identificador da Pessoa. |
| codigoEmpresa | integer <int32> Obtém ou define o código da empresa. |
| dataVencimentoInicial | string <date-time> Data vencimento inicial. |
| dataVencimentoFinal | string <date-time> Data vencimento final. |
| identificadorNaturezaLancamento | string Identificador da Natureza de Lançamento. |
Responses
Response samples
- 200
Cria o lote a pagar e efetua a baixa do mesmo
Authorizations:
Request Body schema:
O contrato de LoteAPagarBaixa
| identificadorTituloAPagar | string or null Identificador do título a pagar |
| identificadorTipoBaixa | string or null Identificador do tipo de baixa |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento |
| identificadorContaBancaria | string or null Identificador da conta bancária |
| valorBaixa | number <double> Valor de baixa |
| descricao | string or null Descrição do lote |
| observacao | string or null Observação da baixa |
| liberacaoAutomatica | boolean Define se o título será liberado via GE |
Responses
Request samples
- Payload
{- "identificadorTituloAPagar": "string",
- "identificadorTipoBaixa": "string",
- "identificadorFormaPagamento": "string",
- "identificadorContaBancaria": "string",
- "valorBaixa": 0.1,
- "descricao": "string",
- "observacao": "string",
- "liberacaoAutomatica": true
}Response samples
- 200
Obtém os títulos de uma empresa por status
Authorizations:
query Parameters
| versaoRegistro | integer <int64> A versão do registro. |
| status | integer <int32> (EStatusTitulosAPagar) Enum: 0 1 2 3 O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos excluídos. 2 = Títulos de previsão. |
| codigoEmpresa | integer <int32> Default: 0 O código da empresa. |
| limite | integer <int32> Default: 25 A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25. |
| pagina | integer <int32> Default: 1 A página que deseja consultar. Quando não informado, por pardrão será definido 1. |
Responses
Response samples
- 200
Obtém a quantidade de títulos a receber da pessoa a partir de um filtro.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa. |
Request Body schema:
Os parametros de consulta de títulos a receber.
| dataFinalBaixa | string or null <date-time> Obtém ou define a data final baixa. |
| dataFinalEmissao | string or null <date-time> Obtém ou define a data final de emissão. |
| dataFinalVencimento | string or null <date-time> Obtém ou define a data final de vencimento. |
| dataInicialBaixa | string or null <date-time> Obtém ou define a data inicial de baixa. |
| dataInicialEmissao | string or null <date-time> Obtém ou define a data inicial de emissão. |
| dataInicialVencimento | string or null <date-time> Obtém ou define a data inicial de vencimento. |
| somenteTitulosEmAberto | boolean Obtém ou define um valor que indica que os filtros deverão filtrar somente os títulos em aberto deverão consultados. |
| identificadoresTiposMovimentoCobranca | Array of strings or null Obtém ou define os identificadores dos tipos de movimento de cobrança para filtro. |
Responses
Request samples
- Payload
{- "dataFinalBaixa": "2019-08-24T14:15:22Z",
- "dataFinalEmissao": "2019-08-24T14:15:22Z",
- "dataFinalVencimento": "2019-08-24T14:15:22Z",
- "dataInicialBaixa": "2019-08-24T14:15:22Z",
- "dataInicialEmissao": "2019-08-24T14:15:22Z",
- "dataInicialVencimento": "2019-08-24T14:15:22Z",
- "somenteTitulosEmAberto": true,
- "identificadoresTiposMovimentoCobranca": [
- "string"
]
}Response samples
- 200
Obtém os títulos a receber da pessoa a partir de um filtro.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa. |
Request Body schema:
Os parametros de consulta de títulos a receber.
| dataFinalBaixa | string or null <date-time> Obtém ou define a data final baixa. |
| dataFinalEmissao | string or null <date-time> Obtém ou define a data final de emissão. |
| dataFinalVencimento | string or null <date-time> Obtém ou define a data final de vencimento. |
| dataInicialBaixa | string or null <date-time> Obtém ou define a data inicial de baixa. |
| dataInicialEmissao | string or null <date-time> Obtém ou define a data inicial de emissão. |
| dataInicialVencimento | string or null <date-time> Obtém ou define a data inicial de vencimento. |
| somenteTitulosEmAberto | boolean Obtém ou define um valor que indica que os filtros deverão filtrar somente os títulos em aberto deverão consultados. |
| identificadoresTiposMovimentoCobranca | Array of strings or null Obtém ou define os identificadores dos tipos de movimento de cobrança para filtro. |
Responses
Request samples
- Payload
{- "dataFinalBaixa": "2019-08-24T14:15:22Z",
- "dataFinalEmissao": "2019-08-24T14:15:22Z",
- "dataFinalVencimento": "2019-08-24T14:15:22Z",
- "dataInicialBaixa": "2019-08-24T14:15:22Z",
- "dataInicialEmissao": "2019-08-24T14:15:22Z",
- "dataInicialVencimento": "2019-08-24T14:15:22Z",
- "somenteTitulosEmAberto": true,
- "identificadoresTiposMovimentoCobranca": [
- "string"
]
}Response samples
- 200
Adiciona um novo título a receber. Deprecated
Authorizations:
Request Body schema:
O título a ser adicionado.
| agrupamento | string or null Obtém ou define a descrição do agrupamento. |
| aliquotaConvenio | number <double> Valor da aliquota do convênio. |
Array of objects or null (LancamentoCentroCustoInclusaoContrato) Obtém ou define os centros de custo do item. | |
object (AReceberCheque) Contrato de cheque a receber. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de vencimento do título. |
| descricaoTitulo | string or null Obtém ou define a descrição do título. |
object (HistoricoCarteiraContrato) Classe de contrato de histórico de carteira. | |
| identificadorContaBancaria | string or null Identificador da conta do banco de cobrança. |
| numeroParcela | integer <int32> Número da parcela do título. |
| numeroTitulo | string or null Número do título. |
| numeroTransacao | string or null Numero da transação. |
| observacao | string or null Obtém ou define a observação do título. |
| previsao | boolean Obtém ou define um valor que indica se o título é de previsão. |
| valorTACConvenio | number <double> Valor do TAC do convenio. |
| valorTACEmpresa | number <double> Valor do TAC da empresa. |
| tituloConciliadoPeloFinConciliare | boolean Obtém ou define se o título está conciliado no FinConciliare. |
| codigoEmpresa | string or null Obtém ou define a empresa do título. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| identificadorAgenciaCobranca | string or null Obtém ou define a agência do banco de cobrança. |
| identificadorBancoCobranca | string or null Identificador do banco. |
| identificadorCategoria | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do título. |
| identificadorNaturezaLancamentoConvenio | string or null Valor do identificador da natureza de lançamento do convênio. |
| identificadorNaturezaLancamentoTACConvenio | string or null Valor do identificador da natureza de lançamento TAC do convênio. |
| identificadorNaturezaLancamentoTACEmpresa | string or null Valor do identificador da natureza de lançamento TAC da empresa. |
| identificadorPessoa | string or null Obtém ou define a pessoa do título. |
| identificadorSituacaoAdministrativa | string or null Obtém ou define a situação administrativa do título. |
| identificadorMotivoExclusao | string or null Motivo de exclusão do título.
(Apenas Para exclusão de um a receber vinculado á documento)
Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda
Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor" |
object (AReceberConvenioContrato) Contrato de convênio de títulos a receber. | |
Array of objects or null (AReceberItemContrato) Obtém ou define os itens do título a receber. | |
| valorTitulo | number <double> Valor do título |
| identificadorContaBancariaBaixa | string or null Identificador da conta bancária de baixa na inclusão. |
Responses
Request samples
- Payload
{- "agrupamento": "string",
- "aliquotaConvenio": 0.1,
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "cheque": {
- "c1C2C3": "string",
- "nomePessoaEmitenteCheque": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroBanco": "string"
}, - "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoTitulo": "string",
- "historicoCarteira": {
- "identificadorTipoCobranca": "string",
- "dataImpressao": "2019-08-24T14:15:22Z",
- "dataReimpressaoBoleto": "2019-08-24T14:15:22Z",
- "descricaoCarteira": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "identificadorContaBancaria": "string",
- "linhaDigitavel": "string",
- "codigoBarras": "string",
- "boletoBancario": "string"
}, - "identificadorContaBancaria": "string",
- "numeroParcela": 0,
- "numeroTitulo": "string",
- "numeroTransacao": "string",
- "observacao": "string",
- "previsao": true,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "tituloConciliadoPeloFinConciliare": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "identificadorAgenciaCobranca": "string",
- "identificadorBancoCobranca": "string",
- "identificadorCategoria": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorNaturezaLancamentoConvenio": "string",
- "identificadorNaturezaLancamentoTACConvenio": "string",
- "identificadorNaturezaLancamentoTACEmpresa": "string",
- "identificadorPessoa": "string",
- "identificadorSituacaoAdministrativa": "string",
- "identificadorMotivoExclusao": "string",
- "convenio": {
- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}, - "itens": [
- {
- "identificador": "string",
- "complemento": "string",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoa": "string",
- "valorBaseRepasse": 0.1,
- "aliquotaRepasse": 0.1,
- "identificadorCategoria": "string"
}
], - "valorCOFINS": 0.1,
- "valorIRRF": 0.1,
- "valorPIS": 0.1,
- "valorCSLL": 0.1,
- "valorINSS": 0.1,
- "valorISS": 0.1,
- "valorPISCOFINSCSLL": 0.1,
- "valorOutros": 0.1,
- "identificadorNaturezaLancamentoCOFINS": "string",
- "identificadorNaturezaLancamentoIRRF": "string",
- "identificadorNaturezaLancamentoPIS": "string",
- "identificadorNaturezaLancamentoCSLL": "string",
- "identificadorNaturezaLancamentoINSS": "string",
- "identificadorNaturezaLancamentoISS": "string",
- "identificadorNaturezaLancamentoPISCOFINSCSLL": "string",
- "identificadorNaturezaLancamentoOutros": "string",
- "identificadorEventoCOFINS": "string",
- "identificadorEventoIRRF": "string",
- "identificadorEventoPIS": "string",
- "identificadorEventoCSLL": "string",
- "identificadorEventoINSS": "string",
- "identificadorEventoISS": "string",
- "identificadorEventoPISCOFINSCSLL": "string",
- "identificadorEventoOutros": "string"
}
], - "valorTitulo": 0.1,
- "identificadorContaBancariaBaixa": "string"
}Response samples
- 200
Obtém todos os títulos a receber por empresa, pessoa, data de cadastro e data de vencimento
Authorizations:
query Parameters
| limite | integer <int32> Limite de títulos por consulta. |
| pagina | integer <int32> Página. |
| dataCadastroInicial | string <date-time> Data cadastro inicial. |
| dataCadastroFinal | string <date-time> Data cadastro final. |
| identificadorPessoa | string Obtém ou define o identificador da Pessoa. |
| codigoEmpresa | integer <int32> Obtém ou define o código da empresa. |
| dataVencimentoInicial | string <date-time> Data vencimento inicial. |
| dataVencimentoFinal | string <date-time> Data vencimento final. |
Responses
Response samples
- 200
Adiciona uma lista de novos títulos a receber. Deprecated
Authorizations:
Request Body schema:
Os títulos a serem adicionados.
| agrupamento | string or null Obtém ou define a descrição do agrupamento. |
| aliquotaConvenio | number <double> Valor da aliquota do convênio. |
Array of objects or null (LancamentoCentroCustoInclusaoContrato) Obtém ou define os centros de custo do item. | |
object (AReceberCheque) Contrato de cheque a receber. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de vencimento do título. |
| descricaoTitulo | string or null Obtém ou define a descrição do título. |
object (HistoricoCarteiraContrato) Classe de contrato de histórico de carteira. | |
| identificadorContaBancaria | string or null Identificador da conta do banco de cobrança. |
| numeroParcela | integer <int32> Número da parcela do título. |
| numeroTitulo | string or null Número do título. |
| numeroTransacao | string or null Numero da transação. |
| observacao | string or null Obtém ou define a observação do título. |
| previsao | boolean Obtém ou define um valor que indica se o título é de previsão. |
| valorTACConvenio | number <double> Valor do TAC do convenio. |
| valorTACEmpresa | number <double> Valor do TAC da empresa. |
| tituloConciliadoPeloFinConciliare | boolean Obtém ou define se o título está conciliado no FinConciliare. |
| codigoEmpresa | string or null Obtém ou define a empresa do título. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| identificadorAgenciaCobranca | string or null Obtém ou define a agência do banco de cobrança. |
| identificadorBancoCobranca | string or null Identificador do banco. |
| identificadorCategoria | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do título. |
| identificadorNaturezaLancamentoConvenio | string or null Valor do identificador da natureza de lançamento do convênio. |
| identificadorNaturezaLancamentoTACConvenio | string or null Valor do identificador da natureza de lançamento TAC do convênio. |
| identificadorNaturezaLancamentoTACEmpresa | string or null Valor do identificador da natureza de lançamento TAC da empresa. |
| identificadorPessoa | string or null Obtém ou define a pessoa do título. |
| identificadorSituacaoAdministrativa | string or null Obtém ou define a situação administrativa do título. |
| identificadorMotivoExclusao | string or null Motivo de exclusão do título.
(Apenas Para exclusão de um a receber vinculado á documento)
Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda
Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor" |
object (AReceberConvenioContrato) Contrato de convênio de títulos a receber. | |
Array of objects or null (AReceberItemContrato) Obtém ou define os itens do título a receber. | |
| valorTitulo | number <double> Valor do título |
| identificadorContaBancariaBaixa | string or null Identificador da conta bancária de baixa na inclusão. |
Responses
Request samples
- Payload
[- {
- "agrupamento": "string",
- "aliquotaConvenio": 0.1,
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "cheque": {
- "c1C2C3": "string",
- "nomePessoaEmitenteCheque": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroBanco": "string"
}, - "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoTitulo": "string",
- "historicoCarteira": {
- "identificadorTipoCobranca": "string",
- "dataImpressao": "2019-08-24T14:15:22Z",
- "dataReimpressaoBoleto": "2019-08-24T14:15:22Z",
- "descricaoCarteira": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "identificadorContaBancaria": "string",
- "linhaDigitavel": "string",
- "codigoBarras": "string",
- "boletoBancario": "string"
}, - "identificadorContaBancaria": "string",
- "numeroParcela": 0,
- "numeroTitulo": "string",
- "numeroTransacao": "string",
- "observacao": "string",
- "previsao": true,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "tituloConciliadoPeloFinConciliare": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "identificadorAgenciaCobranca": "string",
- "identificadorBancoCobranca": "string",
- "identificadorCategoria": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorNaturezaLancamentoConvenio": "string",
- "identificadorNaturezaLancamentoTACConvenio": "string",
- "identificadorNaturezaLancamentoTACEmpresa": "string",
- "identificadorPessoa": "string",
- "identificadorSituacaoAdministrativa": "string",
- "identificadorMotivoExclusao": "string",
- "convenio": {
- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}, - "itens": [
- {
- "identificador": "string",
- "complemento": "string",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoa": "string",
- "valorBaseRepasse": 0.1,
- "aliquotaRepasse": 0.1,
- "identificadorCategoria": "string"
}
], - "valorCOFINS": 0.1,
- "valorIRRF": 0.1,
- "valorPIS": 0.1,
- "valorCSLL": 0.1,
- "valorINSS": 0.1,
- "valorISS": 0.1,
- "valorPISCOFINSCSLL": 0.1,
- "valorOutros": 0.1,
- "identificadorNaturezaLancamentoCOFINS": "string",
- "identificadorNaturezaLancamentoIRRF": "string",
- "identificadorNaturezaLancamentoPIS": "string",
- "identificadorNaturezaLancamentoCSLL": "string",
- "identificadorNaturezaLancamentoINSS": "string",
- "identificadorNaturezaLancamentoISS": "string",
- "identificadorNaturezaLancamentoPISCOFINSCSLL": "string",
- "identificadorNaturezaLancamentoOutros": "string",
- "identificadorEventoCOFINS": "string",
- "identificadorEventoIRRF": "string",
- "identificadorEventoPIS": "string",
- "identificadorEventoCSLL": "string",
- "identificadorEventoINSS": "string",
- "identificadorEventoISS": "string",
- "identificadorEventoPISCOFINSCSLL": "string",
- "identificadorEventoOutros": "string"
}
], - "valorTitulo": 0.1,
- "identificadorContaBancariaBaixa": "string"
}
]Response samples
- 200
Adiciona um novo título a receber.
Authorizations:
Request Body schema:
O título a ser adicionado.
| agrupamento | string or null Obtém ou define a descrição do agrupamento. |
| aliquotaConvenio | number <double> Valor da aliquota do convênio. |
Array of objects or null (LancamentoCentroCustoInclusaoContrato) Obtém ou define os centros de custo do item. | |
object (AReceberCheque) Contrato de cheque a receber. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de vencimento do título. |
| descricaoTitulo | string or null Obtém ou define a descrição do título. |
object (HistoricoCarteiraContrato) Classe de contrato de histórico de carteira. | |
| identificadorContaBancaria | string or null Identificador da conta do banco de cobrança. |
| numeroParcela | integer <int32> Número da parcela do título. |
| numeroTitulo | string or null Número do título. |
| numeroTransacao | string or null Numero da transação. |
| observacao | string or null Obtém ou define a observação do título. |
| previsao | boolean Obtém ou define um valor que indica se o título é de previsão. |
| valorTACConvenio | number <double> Valor do TAC do convenio. |
| valorTACEmpresa | number <double> Valor do TAC da empresa. |
| tituloConciliadoPeloFinConciliare | boolean Obtém ou define se o título está conciliado no FinConciliare. |
| codigoEmpresa | string or null Obtém ou define a empresa do título. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| identificadorAgenciaCobranca | string or null Obtém ou define a agência do banco de cobrança. |
| identificadorBancoCobranca | string or null Identificador do banco. |
| identificadorCategoria | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do título. |
| identificadorNaturezaLancamentoConvenio | string or null Valor do identificador da natureza de lançamento do convênio. |
| identificadorNaturezaLancamentoTACConvenio | string or null Valor do identificador da natureza de lançamento TAC do convênio. |
| identificadorNaturezaLancamentoTACEmpresa | string or null Valor do identificador da natureza de lançamento TAC da empresa. |
| identificadorPessoa | string or null Obtém ou define a pessoa do título. |
| identificadorSituacaoAdministrativa | string or null Obtém ou define a situação administrativa do título. |
| identificadorMotivoExclusao | string or null Motivo de exclusão do título.
(Apenas Para exclusão de um a receber vinculado á documento)
Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda
Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor" |
object (AReceberConvenioContrato) Contrato de convênio de títulos a receber. | |
Array of objects or null (AReceberItemContrato) Obtém ou define os itens do título a receber. | |
| valorTitulo | number <double> Valor do título |
| identificadorContaBancariaBaixa | string or null Identificador da conta bancária de baixa na inclusão. |
Responses
Request samples
- Payload
{- "agrupamento": "string",
- "aliquotaConvenio": 0.1,
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "cheque": {
- "c1C2C3": "string",
- "nomePessoaEmitenteCheque": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroBanco": "string"
}, - "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoTitulo": "string",
- "historicoCarteira": {
- "identificadorTipoCobranca": "string",
- "dataImpressao": "2019-08-24T14:15:22Z",
- "dataReimpressaoBoleto": "2019-08-24T14:15:22Z",
- "descricaoCarteira": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "identificadorContaBancaria": "string",
- "linhaDigitavel": "string",
- "codigoBarras": "string",
- "boletoBancario": "string"
}, - "identificadorContaBancaria": "string",
- "numeroParcela": 0,
- "numeroTitulo": "string",
- "numeroTransacao": "string",
- "observacao": "string",
- "previsao": true,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "tituloConciliadoPeloFinConciliare": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "identificadorAgenciaCobranca": "string",
- "identificadorBancoCobranca": "string",
- "identificadorCategoria": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorNaturezaLancamentoConvenio": "string",
- "identificadorNaturezaLancamentoTACConvenio": "string",
- "identificadorNaturezaLancamentoTACEmpresa": "string",
- "identificadorPessoa": "string",
- "identificadorSituacaoAdministrativa": "string",
- "identificadorMotivoExclusao": "string",
- "convenio": {
- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}, - "itens": [
- {
- "identificador": "string",
- "complemento": "string",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoa": "string",
- "valorBaseRepasse": 0.1,
- "aliquotaRepasse": 0.1,
- "identificadorCategoria": "string"
}
], - "valorCOFINS": 0.1,
- "valorIRRF": 0.1,
- "valorPIS": 0.1,
- "valorCSLL": 0.1,
- "valorINSS": 0.1,
- "valorISS": 0.1,
- "valorPISCOFINSCSLL": 0.1,
- "valorOutros": 0.1,
- "identificadorNaturezaLancamentoCOFINS": "string",
- "identificadorNaturezaLancamentoIRRF": "string",
- "identificadorNaturezaLancamentoPIS": "string",
- "identificadorNaturezaLancamentoCSLL": "string",
- "identificadorNaturezaLancamentoINSS": "string",
- "identificadorNaturezaLancamentoISS": "string",
- "identificadorNaturezaLancamentoPISCOFINSCSLL": "string",
- "identificadorNaturezaLancamentoOutros": "string",
- "identificadorEventoCOFINS": "string",
- "identificadorEventoIRRF": "string",
- "identificadorEventoPIS": "string",
- "identificadorEventoCSLL": "string",
- "identificadorEventoINSS": "string",
- "identificadorEventoISS": "string",
- "identificadorEventoPISCOFINSCSLL": "string",
- "identificadorEventoOutros": "string"
}
], - "valorTitulo": 0.1,
- "identificadorContaBancariaBaixa": "string"
}Response samples
- 200
Adiciona uma lista de novos títulos a receber.
Authorizations:
Request Body schema:
Os títulos a serem adicionados.
| agrupamento | string or null Obtém ou define a descrição do agrupamento. |
| aliquotaConvenio | number <double> Valor da aliquota do convênio. |
Array of objects or null (LancamentoCentroCustoInclusaoContrato) Obtém ou define os centros de custo do item. | |
object (AReceberCheque) Contrato de cheque a receber. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de vencimento do título. |
| descricaoTitulo | string or null Obtém ou define a descrição do título. |
object (HistoricoCarteiraContrato) Classe de contrato de histórico de carteira. | |
| identificadorContaBancaria | string or null Identificador da conta do banco de cobrança. |
| numeroParcela | integer <int32> Número da parcela do título. |
| numeroTitulo | string or null Número do título. |
| numeroTransacao | string or null Numero da transação. |
| observacao | string or null Obtém ou define a observação do título. |
| previsao | boolean Obtém ou define um valor que indica se o título é de previsão. |
| valorTACConvenio | number <double> Valor do TAC do convenio. |
| valorTACEmpresa | number <double> Valor do TAC da empresa. |
| tituloConciliadoPeloFinConciliare | boolean Obtém ou define se o título está conciliado no FinConciliare. |
| codigoEmpresa | string or null Obtém ou define a empresa do título. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| identificadorAgenciaCobranca | string or null Obtém ou define a agência do banco de cobrança. |
| identificadorBancoCobranca | string or null Identificador do banco. |
| identificadorCategoria | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do título. |
| identificadorNaturezaLancamentoConvenio | string or null Valor do identificador da natureza de lançamento do convênio. |
| identificadorNaturezaLancamentoTACConvenio | string or null Valor do identificador da natureza de lançamento TAC do convênio. |
| identificadorNaturezaLancamentoTACEmpresa | string or null Valor do identificador da natureza de lançamento TAC da empresa. |
| identificadorPessoa | string or null Obtém ou define a pessoa do título. |
| identificadorSituacaoAdministrativa | string or null Obtém ou define a situação administrativa do título. |
| identificadorMotivoExclusao | string or null Motivo de exclusão do título.
(Apenas Para exclusão de um a receber vinculado á documento)
Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda
Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor" |
object (AReceberConvenioContrato) Contrato de convênio de títulos a receber. | |
Array of objects or null (AReceberItemContrato) Obtém ou define os itens do título a receber. | |
| valorTitulo | number <double> Valor do título |
| identificadorContaBancariaBaixa | string or null Identificador da conta bancária de baixa na inclusão. |
Responses
Request samples
- Payload
[- {
- "agrupamento": "string",
- "aliquotaConvenio": 0.1,
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "cheque": {
- "c1C2C3": "string",
- "nomePessoaEmitenteCheque": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroBanco": "string"
}, - "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoTitulo": "string",
- "historicoCarteira": {
- "identificadorTipoCobranca": "string",
- "dataImpressao": "2019-08-24T14:15:22Z",
- "dataReimpressaoBoleto": "2019-08-24T14:15:22Z",
- "descricaoCarteira": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "identificadorContaBancaria": "string",
- "linhaDigitavel": "string",
- "codigoBarras": "string",
- "boletoBancario": "string"
}, - "identificadorContaBancaria": "string",
- "numeroParcela": 0,
- "numeroTitulo": "string",
- "numeroTransacao": "string",
- "observacao": "string",
- "previsao": true,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "tituloConciliadoPeloFinConciliare": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "identificadorAgenciaCobranca": "string",
- "identificadorBancoCobranca": "string",
- "identificadorCategoria": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorNaturezaLancamentoConvenio": "string",
- "identificadorNaturezaLancamentoTACConvenio": "string",
- "identificadorNaturezaLancamentoTACEmpresa": "string",
- "identificadorPessoa": "string",
- "identificadorSituacaoAdministrativa": "string",
- "identificadorMotivoExclusao": "string",
- "convenio": {
- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}, - "itens": [
- {
- "identificador": "string",
- "complemento": "string",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoa": "string",
- "valorBaseRepasse": 0.1,
- "aliquotaRepasse": 0.1,
- "identificadorCategoria": "string"
}
], - "valorCOFINS": 0.1,
- "valorIRRF": 0.1,
- "valorPIS": 0.1,
- "valorCSLL": 0.1,
- "valorINSS": 0.1,
- "valorISS": 0.1,
- "valorPISCOFINSCSLL": 0.1,
- "valorOutros": 0.1,
- "identificadorNaturezaLancamentoCOFINS": "string",
- "identificadorNaturezaLancamentoIRRF": "string",
- "identificadorNaturezaLancamentoPIS": "string",
- "identificadorNaturezaLancamentoCSLL": "string",
- "identificadorNaturezaLancamentoINSS": "string",
- "identificadorNaturezaLancamentoISS": "string",
- "identificadorNaturezaLancamentoPISCOFINSCSLL": "string",
- "identificadorNaturezaLancamentoOutros": "string",
- "identificadorEventoCOFINS": "string",
- "identificadorEventoIRRF": "string",
- "identificadorEventoPIS": "string",
- "identificadorEventoCSLL": "string",
- "identificadorEventoINSS": "string",
- "identificadorEventoISS": "string",
- "identificadorEventoPISCOFINSCSLL": "string",
- "identificadorEventoOutros": "string"
}
], - "valorTitulo": 0.1,
- "identificadorContaBancariaBaixa": "string"
}
]Response samples
- 200
Cria um lote de baixa a receber.
Authorizations:
Request Body schema:
O contrato do lote a receber.
| codigoEmpresa | integer <int32> Código da empresa. |
| descricaoLote | string or null Obtém ou define a descrição do lote. |
Array of objects or null (LoteAReceberItemBaixaContrato) Obtém ou define os itens que serão adicionados a baixa. |
Responses
Request samples
- Payload
{- "codigoEmpresa": 0,
- "descricaoLote": "string",
- "loteAReceberItemBaixa": [
- {
- "identificadorTituloAReceber": "string",
- "identificadorFormaPagamento": "string",
- "identificadorTipoBaixa": "string",
- "identificadorContaBancaria": "string",
- "numeroDocumento": "string",
- "dataDeBaixa": "2019-08-24T14:15:22Z",
- "valorAtualizacaoMonetaria": 0.1,
- "valorMulta": 0.1,
- "valorJuros": 0.1,
- "valorDesconto": 0.1,
- "valorBaixa": 0.1,
- "loteAReceberItemBaixaEventos": [
- {
- "identificadorEventoBaixa": "string",
- "identificadorNaturezaLancamento": "string",
- "valorEvento": 0.1
}
]
}
]
}Response samples
- 200
Cria o lote receber e efetua a baixa do mesmo
Authorizations:
Request Body schema:
O contrato de LoteAReceberBaixa
| identificadorTituloAReceber | string or null Identificador do título a receber |
| identificadorFormaPagamento | string or null Identificador forma de pagamento |
| identificadorContaBancaria | string or null Identificador da conta bancária |
| valorBaixa | number <double> Valor de baixa |
object (TipoBaixaConsultaContrato) Contrato de consulta do tipo de baixa. | |
| descricao | string or null Descrição do lote |
| observacao | string or null Observação da baixa |
| liberacaoAutomatica | boolean Define se o título será liberado via GE |
Responses
Request samples
- Payload
{- "identificadorTituloAReceber": "string",
- "identificadorFormaPagamento": "string",
- "identificadorContaBancaria": "string",
- "valorBaixa": 0.1,
- "tipoBaixa": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string",
- "geraNumerario": true,
- "geraComissao": true,
- "baixaFinal": true,
- "ativo": true
}, - "descricao": "string",
- "observacao": "string",
- "liberacaoAutomatica": true
}Response samples
- 200
Adiciona um convênio a um título a receber.
Authorizations:
path Parameters
| identificadorTitulo required | string Identificador do título a receber. |
Request Body schema:
O contrato do convênio.
| nomeAdquirinte | string or null Nome do adquirinte. |
| numeroAutorizacao | string or null Número de autorização. |
| numeroSequencialUnico | string or null Número sequencial único (NSU). |
| quantidadeParcelas | integer <int32> Obtém ou define a quantidade de parcelas. |
| identificadorTransacao | string or null Identificador da transação. |
Responses
Request samples
- Payload
{- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}Response samples
- 200
Edita um título a receber.
Authorizations:
path Parameters
| identificadorTitulo required | string Identificador Titulo. |
Request Body schema:
Contrato do título a ser editado.
| agrupamento | string or null Obtém ou define a descrição do agrupamento. |
| aliquotaConvenio | number <double> Valor da aliquota do convênio. |
Array of objects or null (LancamentoCentroCustoInclusaoContrato) Obtém ou define os centros de custo do item. | |
object (AReceberCheque) Contrato de cheque a receber. | |
| dataCadastro | string <date-time> Obtém ou define a data de cadastro do título. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão do título. |
| dataReferencia | string <date-time> Obtém ou define a data de referencia. |
| dataVencimento | string <date-time> Obtém ou define a data de vencimento do título. |
| descricaoTitulo | string or null Obtém ou define a descrição do título. |
object (HistoricoCarteiraContrato) Classe de contrato de histórico de carteira. | |
| identificadorContaBancaria | string or null Identificador da conta do banco de cobrança. |
| numeroParcela | integer <int32> Número da parcela do título. |
| numeroTitulo | string or null Número do título. |
| numeroTransacao | string or null Numero da transação. |
| observacao | string or null Obtém ou define a observação do título. |
| previsao | boolean Obtém ou define um valor que indica se o título é de previsão. |
| valorTACConvenio | number <double> Valor do TAC do convenio. |
| valorTACEmpresa | number <double> Valor do TAC da empresa. |
| tituloConciliadoPeloFinConciliare | boolean Obtém ou define se o título está conciliado no FinConciliare. |
| codigoEmpresa | string or null Obtém ou define a empresa do título. |
| codigoEnderecoCobranca | string or null Endereço de cobrança. |
| identificadorAgenciaCobranca | string or null Obtém ou define a agência do banco de cobrança. |
| identificadorBancoCobranca | string or null Identificador do banco. |
| identificadorCategoria | string or null Obtém ou define a categoria da pessoa. Caso a pessoa possua mais de uma categoria, esta opção permite identificar a qual das categorias da pessoa o título é destinado. Se omitido será considerada a primeira categoria cliente ou caso não exista será sugerida a primeira categoria da pessoa. |
| identificadorFormaPagamento | string or null Identificador da forma de pagamento do título. |
| identificadorNaturezaLancamento | string or null Obtém ou define a natureza de lançamento do título. |
| identificadorNaturezaLancamentoConvenio | string or null Valor do identificador da natureza de lançamento do convênio. |
| identificadorNaturezaLancamentoTACConvenio | string or null Valor do identificador da natureza de lançamento TAC do convênio. |
| identificadorNaturezaLancamentoTACEmpresa | string or null Valor do identificador da natureza de lançamento TAC da empresa. |
| identificadorPessoa | string or null Obtém ou define a pessoa do título. |
| identificadorSituacaoAdministrativa | string or null Obtém ou define a situação administrativa do título. |
| identificadorMotivoExclusao | string or null Motivo de exclusão do título.
(Apenas Para exclusão de um a receber vinculado á documento)
Consultado através do endpoint /api/configuracoes?nomeSecao=Faturamento.Venda
Objeto com "NomeConfiguracao": "IdMotivoExclusaoTituloPorCancelamentoDocumento", Campo "Valor" |
object (AReceberConvenioContrato) Contrato de convênio de títulos a receber. | |
Array of objects or null (AReceberItemContrato) Obtém ou define os itens do título a receber. | |
| valorTitulo | number <double> Valor do título |
| identificadorContaBancariaBaixa | string or null Identificador da conta bancária de baixa na inclusão. |
Responses
Request samples
- Payload
{- "agrupamento": "string",
- "aliquotaConvenio": 0.1,
- "centrosDeCusto": [
- {
- "aliquotaPorcentagem": 0.1,
- "dataLancamento": "2019-08-24T14:15:22Z",
- "identificadorCentroDeCusto": "string",
- "valorLancamento": 0.1,
- "quantidadeLancamento": 0.1
}
], - "cheque": {
- "c1C2C3": "string",
- "nomePessoaEmitenteCheque": "string",
- "numero": "string",
- "numeroAgencia": "string",
- "numeroBanco": "string"
}, - "dataCadastro": "2019-08-24T14:15:22Z",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoTitulo": "string",
- "historicoCarteira": {
- "identificadorTipoCobranca": "string",
- "dataImpressao": "2019-08-24T14:15:22Z",
- "dataReimpressaoBoleto": "2019-08-24T14:15:22Z",
- "descricaoCarteira": "string",
- "numeroTituloBanco": "string",
- "observacao": "string",
- "identificadorContaBancaria": "string",
- "linhaDigitavel": "string",
- "codigoBarras": "string",
- "boletoBancario": "string"
}, - "identificadorContaBancaria": "string",
- "numeroParcela": 0,
- "numeroTitulo": "string",
- "numeroTransacao": "string",
- "observacao": "string",
- "previsao": true,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1,
- "tituloConciliadoPeloFinConciliare": true,
- "codigoEmpresa": "string",
- "codigoEnderecoCobranca": "string",
- "identificadorAgenciaCobranca": "string",
- "identificadorBancoCobranca": "string",
- "identificadorCategoria": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorNaturezaLancamentoConvenio": "string",
- "identificadorNaturezaLancamentoTACConvenio": "string",
- "identificadorNaturezaLancamentoTACEmpresa": "string",
- "identificadorPessoa": "string",
- "identificadorSituacaoAdministrativa": "string",
- "identificadorMotivoExclusao": "string",
- "convenio": {
- "nomeAdquirinte": "string",
- "numeroAutorizacao": "string",
- "numeroSequencialUnico": "string",
- "quantidadeParcelas": 0,
- "identificadorTransacao": "string"
}, - "itens": [
- {
- "identificador": "string",
- "complemento": "string",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorProduto": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "valor": 0.1,
- "repasses": [
- {
- "identificadorPessoa": "string",
- "valorBaseRepasse": 0.1,
- "aliquotaRepasse": 0.1,
- "identificadorCategoria": "string"
}
], - "valorCOFINS": 0.1,
- "valorIRRF": 0.1,
- "valorPIS": 0.1,
- "valorCSLL": 0.1,
- "valorINSS": 0.1,
- "valorISS": 0.1,
- "valorPISCOFINSCSLL": 0.1,
- "valorOutros": 0.1,
- "identificadorNaturezaLancamentoCOFINS": "string",
- "identificadorNaturezaLancamentoIRRF": "string",
- "identificadorNaturezaLancamentoPIS": "string",
- "identificadorNaturezaLancamentoCSLL": "string",
- "identificadorNaturezaLancamentoINSS": "string",
- "identificadorNaturezaLancamentoISS": "string",
- "identificadorNaturezaLancamentoPISCOFINSCSLL": "string",
- "identificadorNaturezaLancamentoOutros": "string",
- "identificadorEventoCOFINS": "string",
- "identificadorEventoIRRF": "string",
- "identificadorEventoPIS": "string",
- "identificadorEventoCSLL": "string",
- "identificadorEventoINSS": "string",
- "identificadorEventoISS": "string",
- "identificadorEventoPISCOFINSCSLL": "string",
- "identificadorEventoOutros": "string"
}
], - "valorTitulo": 0.1,
- "identificadorContaBancariaBaixa": "string"
}Response samples
- 200
Obtém os títulos de uma empresa por status
Authorizations:
path Parameters
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| status | integer <int32> (EStatusTitulo) Enum: 0 1 2 3 4 O status que que deverá ser consultado. 0 = Títulos baixados. 1 = Títulos baixados sem numerário. 2 = Títulos baixados com numerário. 3 = Títulos excluídos. 4 = Títulos de previsão. |
| dataEmissaoInicial | string <date-time> A data inicial de emissão do filtro. |
| dataEmissaoFinal | string <date-time> A data final de emissão do filtro. |
| dataBaixaInicial | string <date-time> A data inicial de baixa do filtro. |
| dataBaixaFinal | string <date-time> A data final de baixa do filtro. |
| limite | integer <int32> Default: 25 A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25. |
| pagina | integer <int32> Default: 1 A página que deseja consultar. Quando não informado, por pardrão será definido 1. |
Responses
Response samples
- 200
Obtem os títulos a receber pelo Identificador Entidade Origem
Authorizations:
query Parameters
| idEntidadeOrigem | string Default: "" O identificador da entidade origem |
| nomeEntidadeOrigem | string Default: "" O nome da entidade origem |
| limite | integer <int32> Default: 25 A quantidade de títulos para a consulta paginada. Quando não informado, por pardrão será definido 25. |
| pagina | integer <int32> Default: 1 A página que deseja consultar. Quando não informado, por pardrão será definido 1. |
Responses
Response samples
- 200
Simula renegociações um pra um de um título.
Authorizations:
Request Body schema:
O contrato para as simulações.
| identificador | string or null O identificador do titulo a ser renegociado |
| datas | Array of strings or null <date-time> [ items <date-time > ] Datas para as simulações |
Responses
Request samples
- Payload
{- "identificador": "string",
- "datas": [
- "2019-08-24T14:15:22Z"
]
}Response samples
- 200
Gera um novo título e baixa o anterior sem numerário atravez de uma renegociação um pra um.
Authorizations:
Request Body schema:
O contrato para a renegociação.
| identificador | string or null Identificador do título |
| novoVencimento | string <date-time> O novo vencimento |
Responses
Request samples
- Payload
{- "identificador": "string",
- "novoVencimento": "2019-08-24T14:15:22Z"
}Response samples
- 200
Obtém os títulos a receber por data de cadastro
Authorizations:
query Parameters
| identificadorPessoa | string Identificador da Pessoa. |
| titulosEmAberto | boolean Default: false Obtém ou define os titulos em aberto. |
| dataInicialVencimento | string <date-time> Obtém ou define a data inicial do vencimento. |
| dataFinalVencimento | string <date-time> Obtém ou define a data final do vencimento. |
| dataInicialEmissao | string <date-time> Obtém ou define a data inicial da emissão. |
| dataFinalEmissao | string <date-time> Obtém ou define a data final da emissão. |
| limite | integer <int32> Default: 25 Limite de títulos |
| pagina | integer <int32> Default: 1 Página |
Responses
Response samples
- 200
Método responsável por retornar todos os títulos a receber e pode filtrar por empresa, data de cadastro, data de vencimento e natureza de lançamento
Authorizations:
query Parameters
| limite | integer <int32> Default: 25 Limite de titulos. |
| pagina | integer <int32> Default: 1 Pagina. |
| dataCadastroInicial | string <date-time> A data de cadastro Inicial. |
| dataCadastroFinal | string <date-time> A data de cadastro Final. |
| identificadorPessoa | string O identificador da pessoa |
| codigoEmpresa | integer <int32> O código da empresa. |
| dataVencimentoInicial | string <date-time> A data de vencimento Inicial. |
| dataVencimentoFinal | string <date-time> A data de vencimento Final. |
| identificadorNaturezaLancamento | string Identificador da natureza de lançamento. |
Responses
Response samples
- 200
Alterar um agendamento
Realiza a alteração parcial de um agendamento existente.
Authorizations:
path Parameters
| identificador required | string |
Request Body schema:
| identificadorUsuario | string or null Usuário ao qual se refere o agendamento alterado. |
| identificadorTipoAgendamento | string or null Identificador do tipo de agendamento. |
| identificadorPessoa | string or null Identificador da pessoa. |
| observacao | string or null Observação do agendamento. |
| dataInicial | string or null <date-time> Data inicial do agendamento. |
| dataFinal | string or null <date-time> Data final do agendamento. |
| valorVisita | number or null <double> Valor cobrado na visita. |
| aceiteFichaVisita | boolean or null Informa se a ficha de visita foi aceita pelo cliente. |
| dataAutorizacaoFicha | string or null <date-time> Informa a data em que o cliente autorizou a ficha. |
| emailClienteFichaVisita | string or null Informa o e-mail do cliente que autorizou a ficha de visita. |
Responses
Request samples
- Payload
{- "identificadorUsuario": "string",
- "identificadorTipoAgendamento": "string",
- "identificadorPessoa": "string",
- "observacao": "string",
- "dataInicial": "2019-08-24T14:15:22Z",
- "dataFinal": "2019-08-24T14:15:22Z",
- "valorVisita": 0.1,
- "aceiteFichaVisita": true,
- "dataAutorizacaoFicha": "2019-08-24T14:15:22Z",
- "emailClienteFichaVisita": "string"
}Response samples
- 200
Cadastrar um novo agendamento
Cadastra um novo agendamento.
Authorizations:
Request Body schema:
| identificadorTipoAgendamento | string or null O identificador do tipo de agendamento |
| identificadorUsuarioCadastro | string or null Identificador usuário que efetuou cadastro. |
Array of objects or null (AgendaDataContrato) As datas do agendamento. | |
Array of objects or null (AgendaPessoaContrato) As pessoas do contato. | |
| identificadoresUsuarios | Array of strings or null Os identificadores do usuário do agendamento. |
| identificadorAtendimento | string or null Identificador do atendimento vinculado. |
| identificadorProduto | string or null Identificador produto. |
| identificadorLocalAgendamento | string or null Identificador do local do agendamento. |
| identificadorTipoAtendimento | string or null O identificador do tipo de atendimento. |
| valorVisita | number <double> Valor da visita. |
| observacao | string or null Observação do agendamento. |
Responses
Request samples
- Payload
{- "identificadorTipoAgendamento": "string",
- "identificadorUsuarioCadastro": "string",
- "datasAgendamento": [
- {
- "dataInicial": "2019-08-24T14:15:22Z",
- "dataFinal": "2019-08-24T14:15:22Z",
- "diaCheio": true,
- "diaBloqueado": true
}
], - "pessoas": [
- {
- "identificadorPessoa": "string",
- "codigoEndereco": "string",
- "identificadorContatoVenda": "string"
}
], - "identificadoresUsuarios": [
- "string"
], - "identificadorAtendimento": "string",
- "identificadorProduto": "string",
- "identificadorLocalAgendamento": "string",
- "identificadorTipoAtendimento": "string",
- "valorVisita": 0.1,
- "observacao": "string"
}Response samples
- 200
Cadastra anexo
Cadastrar um novo anexo no banco utilizando multipart/form-data.
Authorizations:
path Parameters
| nomeEntidade required | string O nome da entidade de origem. |
| identificadorEntidade required | string O identificador da entidade de origem. |
Responses
Response samples
- 200
Cadastra um bairro
Cadastrar um bairro no Bimer, por ser um cadastro o identificador é desnecessário
Authorizations:
Request Body schema:
O bairro que será adicionado.
| codigo required | string or null Código de chamada. |
| identificador | string or null Identificador do bairro. |
| nome | string or null Nome do bairro. |
Responses
Request samples
- Payload
{- "codigo": "string",
- "identificador": "string",
- "nome": "string"
}Response samples
- 200
Consulta bairros por nome
Consultar um bairro cadastrado no Bimer pelo nome, possibilita busca por trecho
Authorizations:
query Parameters
| nomeBairro | string O nome do bairro a ser consultado. |
| porTrecho | boolean Valor que indica se a consulta deverá ser feita por trecho, ou seja, se haverá consulta
com nome parcial do bairro. |
Responses
Response samples
- 200
Edita um bairro
Editar o cadastro de um bairro no Bimer.
Authorizations:
path Parameters
| identificador required | string O identificador do bairro a ser editado. |
Request Body schema:
O bairro a ser editado.
| codigo required | string or null Código de chamada. |
| identificador | string or null Identificador do bairro. |
| nome | string or null Nome do bairro. |
Responses
Request samples
- Payload
{- "codigo": "string",
- "identificador": "string",
- "nome": "string"
}Response samples
- 200
Cadastra um CEP
Cadastrar um CEP no Bimer.
Authorizations:
Request Body schema:
O CEP que será adicionado
| codigo | string or null Código de chamada |
| identificadorBairro | string or null O identificador do bairro |
| identificadorCidade | string or null O identificador da cidade |
| identificadorUF | string or null O identificador da UF |
| nomeLogradouro | string or null O nome do logradouro |
| tipoLogradouro | string or null O tipo do logradouro |
| identificadorTipoLogradouro | string or null O identificador do tipo do logradouro |
Responses
Request samples
- Payload
{- "codigo": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorUF": "string",
- "nomeLogradouro": "string",
- "tipoLogradouro": "string",
- "identificadorTipoLogradouro": "string"
}Response samples
- 200
Obtém CEPs por logradouro
Consultar os CEPs pelo nome do logradouro.
Authorizations:
path Parameters
| nomeLogradouro required | string O nome do logradouro |
query Parameters
| porTrecho | boolean Default: false Habilita a pesquisa por trecho |
Responses
Response samples
- 200
Cadastra uma cidade
Cadastrar uma cidade no Bimer.
Authorizations:
Request Body schema:
A cidade a ser cadastrada.
| codigoIBGE required | string or null O código IBGE |
| codigo | string or null O código da cidade no Bimer |
| codigoDDD | string or null O código do DDD da cidade |
| nome | string or null O nome da cidade |
| identificadorUF required | string or null O identificador da UF |
Responses
Request samples
- Payload
{- "codigoIBGE": "string",
- "codigo": "string",
- "codigoDDD": "string",
- "nome": "string",
- "identificadorUF": "string"
}Response samples
- 200
Edita uma cidade
Editar uma cidade pelo identificador.
Authorizations:
query Parameters
| identificador | string O identificador da cidade a ser editada. |
Request Body schema:
A cidade a ser editada.
| codigoIBGE required | string or null O código IBGE |
| codigo | string or null O código da cidade no Bimer |
| codigoDDD | string or null O código do DDD da cidade |
| nome | string or null O nome da cidade |
| identificadorUF required | string or null O identificador da UF |
Responses
Request samples
- Payload
{- "codigoIBGE": "string",
- "codigo": "string",
- "codigoDDD": "string",
- "nome": "string",
- "identificadorUF": "string"
}Response samples
- 200
Obtém cidades por nome e UF
Consultar uma cidade pelo nome e pela UF.
Authorizations:
path Parameters
| siglaUF required | string A sigla do estado em que se esta buscando a cidade. |
query Parameters
| nomeCidade | string O nome da cidade que está sendo consultada. |
| nomeCidadePorTrecho | boolean Valor que indica se o nome da cidade será consultado por trecho. |
Responses
Response samples
- 200
Obtém um classificação fiscal por classificação.
Authorizations:
query Parameters
| classificacao | string O código de chamada do classificação fiscal. |
| porTrecho | boolean Default: false Valor que indica se a consulta do nome será utilizada por trecho. |
Responses
Response samples
- 200
Consulta todos os documentos de venda por emitente.
Authorizations:
query Parameters
| codigoEmpresa | integer <int32> Codigo da empresa cadastrada no Bimer. |
| dataInicial | string <date-time> Obtém ou define a data inicial de emissão do documento. |
| dataFinal | string <date-time> Obtém ou define a data final de emissão do documento. |
| limite | integer <int32> Determina o limite de registros que serão apresentados na consulta. |
| pagina | integer <int32> Determina a página onde os registros apresentados estão localizados. |
Responses
Response samples
- 200
Consulta uma lista de documentos pelo identificador do pedido de venda. O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro.
Authorizations:
path Parameters
| identificadorPedido required | string O identificador documento. |
Responses
Response samples
- 200
Consulta uma lista de documentos pelo código do pedido de venda. O pedido de venda deverá estar faturado, caso contrário a consulta retornará erro.
Authorizations:
path Parameters
| codigoPedidoDeVenda required | string O código do pedido de venda documento. |
Responses
Response samples
- 200
Consulta de documentos por pessoa e por período de data de emissão (início e fim).
Authorizations:
query Parameters
| identificadorPessoa | string Obtém o identificador de Pessoa. |
| tipoOperacao | string Obtém tipo de Operacao. |
| dataInicial | string Obtém data Inicial. |
| dataFinal | string Obtém data Final. |
Responses
Response samples
- 200
Consultar o pdf do DANFE por identificador documento.
O retorno da consulta será um PDF em BASE64, necessitando apenas de ser convertido para PDF:
Exemplo:
GET: /00A000001C/DANFE/PDF
{
JVBERi0xLjQNCiW17a77DQoyIDAgb2JqDQo8PCAvTGVuZ3RoIDMgMCBSDQogICAv
VHlwZSAvWE9iamVjdA0KICAgL1N1YnR5cGUgL0Zvcm0NCiAgIC9CQm94IFsgMCAw
IDIxNiA0MDQgXQ0KPj4NCnN0cmVhbQ0KMSAwIDAgLTEgMCA0MDQgY20NCnEgMzYg
...
MjA5OSAwMDAwMCBuDQowMDAwMDIyMjI5IDAwMDAwIG4NCnRyYWlsZXINCjw8IC9T
aXplIDEwDQogICAvUm9vdCA5IDAgUg0KICAgL0luZm8gOCAwIFINCj4+DQpzdGFy
dHhyZWYNCjIyMjg2DQolJUVPRg0K
}
Authorizations:
path Parameters
| identificadorDocumento required | string O identificador documento. |
Responses
Response samples
- 200
Consultar uma lista de xmls por periodo.
Authorizations:
query Parameters
| emissaoInicial | string <date-time> |
| emissaoFinal | string <date-time> |
| limite | integer <int32> Default: 50 |
| pagina | integer <int32> Default: 1 |
| identificadorPessoa | string Default: "" |
| tipoOperacao | string Default: "" |
Responses
Response samples
- 200
Cadastra um novo documento de saída.
Authorizations:
Request Body schema:
O contrato de cadastro do documento de saída. O Campo Identificador do contrato não é necessário e será ignorado, pois é gerado de forma automática.
| codigoEmpresa | string or null Código da empresa. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou define a data de referência. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorOperacao | string or null Identificador da operação. A operação indicará o tipo do documento como sendo de entrada ou saída. |
| identificadorPessoa | string or null Identificador da pessoa. |
Array of objects or null (DocumentoItemCadastroContrato) Obtém ou define os itens do documento. | |
| nomeEntidadeOrigem | string or null Gets or sets the nome entidade origem. |
| identificador | string or null Identificador do documento |
| numero | string or null Número do documento. |
| numeroNFSE | string or null Número da nota fiscal de Serviço Eletrônico do documento. |
| observacao | string or null Obtém ou define a observação do documento. |
Array of objects or null (DocumentoPagamentoCadastroContrato) Obtém ou define os pagamentos do documento. | |
object (PrazoContrato) Contrato do prazo. | |
| codigoContratoCompraCliente | string or null Código do contrato de compra do cliente. |
| criaDocumentoProntoParaSerLiberado | boolean Valor que indica se o documento deve ser criado pronto para ser liberado. |
| tipoDocumento | string or null O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O": Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações. |
| tipoPagamento | string or null Tipo de pagamento: "0": ÀVista | "1": Parcelado. |
Array of objects or null (MensagemContrato) Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). | |
| valorDeducaoBaseISS | number <double> Valor de dedução da base de ISS. |
| statusNotaFiscalEletronica | string or null Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "identificadorPessoa": "string",
- "itens": [
- {
- "cfop": "string",
- "identificador": "string",
- "identificadorProduto": "string",
- "identificadorSetorEntrada": "string",
- "identificadorSetorSaida": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "quantidade": 0.1,
- "valorUnitario": 0.1,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "valorAcrescimo": 0.1,
- "aliquotaAcrescimo": 0.1,
- "tipoAcrescimo": "string",
- "valorDesconto": 0.1,
- "aliquotaDesconto": 0.1,
- "tipoDesconto": "string",
- "lote": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "perecivel": true,
- "dataValidade": "2019-08-24T14:15:22Z"
}, - "serie": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "sequencialInicial": 0,
- "mascara": "string"
}, - "repasses": [
- {
- "aliquotaDuplicata": 0.1,
- "aliquotaFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true
}
]
}
], - "nomeEntidadeOrigem": "string",
- "identificador": "string",
- "numero": "string",
- "numeroNFSE": "string",
- "observacao": "string",
- "pagamentos": [
- {
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoAgrupamento": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaConvenio": "string",
- "identificadorPessoaFinanceiro": "string",
- "identificadorTipoBaixa": "string",
- "nomeAdquirenteCartao": "string",
- "numeroAutorizacaoCartao": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "numeroSequencialUnicoCartao": "string",
- "numeroTitulo": "string",
- "valor": 0.1,
- "valorJurosPrazo": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "codigoContratoCompraCliente": "string",
- "criaDocumentoProntoParaSerLiberado": true,
- "tipoDocumento": "string",
- "tipoPagamento": "string",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "identificador": "string"
}
], - "valorDeducaoBaseISS": 0.1,
- "statusNotaFiscalEletronica": "string"
}Response samples
- 200
Cadastra de forma assíncrona os documentos de saída.
Authorizations:
Request Body schema:
O contrato de cadastro do documento de saída.
| codigoEmpresa | string or null Código da empresa. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou define a data de referência. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorOperacao | string or null Identificador da operação. A operação indicará o tipo do documento como sendo de entrada ou saída. |
| identificadorPessoa | string or null Identificador da pessoa. |
Array of objects or null (DocumentoItemCadastroContrato) Obtém ou define os itens do documento. | |
| nomeEntidadeOrigem | string or null Gets or sets the nome entidade origem. |
| identificador | string or null Identificador do documento |
| numero | string or null Número do documento. |
| numeroNFSE | string or null Número da nota fiscal de Serviço Eletrônico do documento. |
| observacao | string or null Obtém ou define a observação do documento. |
Array of objects or null (DocumentoPagamentoCadastroContrato) Obtém ou define os pagamentos do documento. | |
object (PrazoContrato) Contrato do prazo. | |
| codigoContratoCompraCliente | string or null Código do contrato de compra do cliente. |
| criaDocumentoProntoParaSerLiberado | boolean Valor que indica se o documento deve ser criado pronto para ser liberado. |
| tipoDocumento | string or null O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O": Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações. |
| tipoPagamento | string or null Tipo de pagamento: "0": ÀVista | "1": Parcelado. |
Array of objects or null (MensagemContrato) Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). | |
| valorDeducaoBaseISS | number <double> Valor de dedução da base de ISS. |
| statusNotaFiscalEletronica | string or null Determina o status encontrado na nota fiscal: "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "identificadorPessoa": "string",
- "itens": [
- {
- "cfop": "string",
- "identificador": "string",
- "identificadorProduto": "string",
- "identificadorSetorEntrada": "string",
- "identificadorSetorSaida": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "quantidade": 0.1,
- "valorUnitario": 0.1,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "valorAcrescimo": 0.1,
- "aliquotaAcrescimo": 0.1,
- "tipoAcrescimo": "string",
- "valorDesconto": 0.1,
- "aliquotaDesconto": 0.1,
- "tipoDesconto": "string",
- "lote": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "perecivel": true,
- "dataValidade": "2019-08-24T14:15:22Z"
}, - "serie": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "sequencialInicial": 0,
- "mascara": "string"
}, - "repasses": [
- {
- "aliquotaDuplicata": 0.1,
- "aliquotaFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true
}
]
}
], - "nomeEntidadeOrigem": "string",
- "identificador": "string",
- "numero": "string",
- "numeroNFSE": "string",
- "observacao": "string",
- "pagamentos": [
- {
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoAgrupamento": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaConvenio": "string",
- "identificadorPessoaFinanceiro": "string",
- "identificadorTipoBaixa": "string",
- "nomeAdquirenteCartao": "string",
- "numeroAutorizacaoCartao": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "numeroSequencialUnicoCartao": "string",
- "numeroTitulo": "string",
- "valor": 0.1,
- "valorJurosPrazo": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "codigoContratoCompraCliente": "string",
- "criaDocumentoProntoParaSerLiberado": true,
- "tipoDocumento": "string",
- "tipoPagamento": "string",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "identificador": "string"
}
], - "valorDeducaoBaseISS": 0.1,
- "statusNotaFiscalEletronica": "string"
}Response samples
- 200
Cadastra um novo documento de entrada.
Authorizations:
Request Body schema:
O contrato de cadastro do documento de entrada.
| codigoEmpresa | string or null Código da empresa. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou define a data de referência. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorOperacao | string or null Identificador da operação. A operação indicará o tipo do documento como sendo de entrada ou saída. |
| identificadorPessoa | string or null Identificador da pessoa. |
Array of objects or null (DocumentoItemCadastroContrato) Obtém ou define os itens do documento. | |
| nomeEntidadeOrigem | string or null Gets or sets the nome entidade origem. |
| identificador | string or null Identificador do documento |
| numero | string or null Número do documento. |
| numeroNFSE | string or null Número da nota fiscal de Serviço Eletrônico do documento. |
| observacao | string or null Obtém ou define a observação do documento. |
Array of objects or null (DocumentoPagamentoCadastroContrato) Obtém ou define os pagamentos do documento. | |
object (PrazoContrato) Contrato do prazo. | |
| codigoContratoCompraCliente | string or null Código do contrato de compra do cliente. |
| criaDocumentoProntoParaSerLiberado | boolean Valor que indica se o documento deve ser criado pronto para ser liberado. |
| tipoDocumento | string or null O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O": Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações. |
| tipoPagamento | string or null Tipo de pagamento: "0": ÀVista | "1": Parcelado. |
Array of objects or null (MensagemContrato) Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). | |
| valorDeducaoBaseISS | number <double> Valor de dedução da base de ISS. |
| chaveAcessoNotaFiscalEletronica | string or null Obtém ou define a chave na nota fiscal eletrônica. |
object (DocumentoComplementoISSTomadorContrato) Contrato de dados do ISS Tomador. |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "identificadorPessoa": "string",
- "itens": [
- {
- "cfop": "string",
- "identificador": "string",
- "identificadorProduto": "string",
- "identificadorSetorEntrada": "string",
- "identificadorSetorSaida": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "quantidade": 0.1,
- "valorUnitario": 0.1,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "valorAcrescimo": 0.1,
- "aliquotaAcrescimo": 0.1,
- "tipoAcrescimo": "string",
- "valorDesconto": 0.1,
- "aliquotaDesconto": 0.1,
- "tipoDesconto": "string",
- "lote": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "perecivel": true,
- "dataValidade": "2019-08-24T14:15:22Z"
}, - "serie": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "sequencialInicial": 0,
- "mascara": "string"
}, - "repasses": [
- {
- "aliquotaDuplicata": 0.1,
- "aliquotaFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true
}
]
}
], - "nomeEntidadeOrigem": "string",
- "identificador": "string",
- "numero": "string",
- "numeroNFSE": "string",
- "observacao": "string",
- "pagamentos": [
- {
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoAgrupamento": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaConvenio": "string",
- "identificadorPessoaFinanceiro": "string",
- "identificadorTipoBaixa": "string",
- "nomeAdquirenteCartao": "string",
- "numeroAutorizacaoCartao": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "numeroSequencialUnicoCartao": "string",
- "numeroTitulo": "string",
- "valor": 0.1,
- "valorJurosPrazo": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "codigoContratoCompraCliente": "string",
- "criaDocumentoProntoParaSerLiberado": true,
- "tipoDocumento": "string",
- "tipoPagamento": "string",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "identificador": "string"
}
], - "valorDeducaoBaseISS": 0.1,
- "chaveAcessoNotaFiscalEletronica": "string",
- "issTomador": {
- "codigoBaseCalculoCreditoPISCOFINSSPED": "string",
- "codigoSituacaoTributariaPISSPED": "string",
- "codigoSituacaoTributariaCOFINSSPED": "string"
}
}Response samples
- 200
Cadastra um documento como beneficiamento.
Authorizations:
Request Body schema:
O contrato de cadastro do controle de remessa e retorno para beneficiamento.
| identificador | string or null Identificador do documento a ser incluso como beneficiamento. |
Responses
Request samples
- Payload
{- "identificador": "string"
}Response samples
- 200
Cadastra um documento de telecomunicações.
Authorizations:
Request Body schema:
O contrato de cadastro do documento de entrada.
| codigoEmpresa | string or null Código da empresa. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou define a data de referência. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorOperacao | string or null Identificador da operação. A operação indicará o tipo do documento como sendo de entrada ou saída. |
| identificadorPessoa | string or null Identificador da pessoa. |
Array of objects or null (DocumentoItemCadastroContrato) Obtém ou define os itens do documento. | |
| nomeEntidadeOrigem | string or null Gets or sets the nome entidade origem. |
| identificador | string or null Identificador do documento |
| numero | string or null Número do documento. |
| numeroNFSE | string or null Número da nota fiscal de Serviço Eletrônico do documento. |
| observacao | string or null Obtém ou define a observação do documento. |
Array of objects or null (DocumentoPagamentoCadastroContrato) Obtém ou define os pagamentos do documento. | |
object (PrazoContrato) Contrato do prazo. | |
| codigoContratoCompraCliente | string or null Código do contrato de compra do cliente. |
| criaDocumentoProntoParaSerLiberado | boolean Valor que indica se o documento deve ser criado pronto para ser liberado. |
| tipoDocumento | string or null O tipo do documento. "C": Cupom fiscal, "F": Nota fiscal, "N": Cupom não fiscal, "O": Ordem de entrega e "S": Servico, "T": NotaFiscalTelecomunicações. |
| tipoPagamento | string or null Tipo de pagamento: "0": ÀVista | "1": Parcelado. |
Array of objects or null (MensagemContrato) Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). | |
| valorDeducaoBaseISS | number <double> Valor de dedução da base de ISS. |
| tipoFinalidade | integer <int32> (ETipoFinalidade) Enum: 0 1 2 3 4 5 6 |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "identificadorPessoa": "string",
- "itens": [
- {
- "cfop": "string",
- "identificador": "string",
- "identificadorProduto": "string",
- "identificadorSetorEntrada": "string",
- "identificadorSetorSaida": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "quantidade": 0.1,
- "valorUnitario": 0.1,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "valorAcrescimo": 0.1,
- "aliquotaAcrescimo": 0.1,
- "tipoAcrescimo": "string",
- "valorDesconto": 0.1,
- "aliquotaDesconto": 0.1,
- "tipoDesconto": "string",
- "lote": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "perecivel": true,
- "dataValidade": "2019-08-24T14:15:22Z"
}, - "serie": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "sequencialInicial": 0,
- "mascara": "string"
}, - "repasses": [
- {
- "aliquotaDuplicata": 0.1,
- "aliquotaFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true
}
]
}
], - "nomeEntidadeOrigem": "string",
- "identificador": "string",
- "numero": "string",
- "numeroNFSE": "string",
- "observacao": "string",
- "pagamentos": [
- {
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoAgrupamento": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaConvenio": "string",
- "identificadorPessoaFinanceiro": "string",
- "identificadorTipoBaixa": "string",
- "nomeAdquirenteCartao": "string",
- "numeroAutorizacaoCartao": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "numeroSequencialUnicoCartao": "string",
- "numeroTitulo": "string",
- "valor": 0.1,
- "valorJurosPrazo": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "codigoContratoCompraCliente": "string",
- "criaDocumentoProntoParaSerLiberado": true,
- "tipoDocumento": "string",
- "tipoPagamento": "string",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "identificador": "string"
}
], - "valorDeducaoBaseISS": 0.1,
- "tipoFinalidade": 0
}Response samples
- 200
Cadastra uma nova devolução.
Authorizations:
path Parameters
| identificadorDocumento required | string O identificador do documento a ser devolvido. |
Request Body schema:
O contrato da devolução a ser cadastrada.
| criaDocumentoProntoParaSerLiberado | boolean Valor que indica se o documento deve ser criado pronto para ser liberado. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou definea data refêrencia. |
| identificadorOperacao | string or null Identificador da operação. A operação deverá ser do tipo devolução. |
Array of objects or null (DevolucaoItemCadastroContrato) Obtém ou define os itens da devolução. | |
| numero | string or null Número da devolução. |
| observacao | string or null Obtém ou define a observação da devolução. |
| statusNotaFiscalEletronica | string or null Status da devolução : "N" : NaoEletronica, "A" : Aberta, "C" : Contingência, "D" : Denegada, "I" : Impressa, "R" : Rejeitada, "E" : Enviada, "X" : Erro |
Responses
Request samples
- Payload
{- "criaDocumentoProntoParaSerLiberado": true,
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "itens": [
- {
- "identificadorDocumentoItem": "string",
- "quantidade": 0.1
}
], - "numero": "string",
- "observacao": "string",
- "statusNotaFiscalEletronica": "string"
}Response samples
- 200
Consulta uma lista de documentos inutilizados pelo identificador ou por filtros diversos como (empresa, data inicial, data final, série/subsérie e número do documento).
Authorizations:
query Parameters
| identificadorDocumento | string O identificador do documento inutilizado. |
| identificadorEmpresa | string O identificador da empresa. |
| dataInicial | string <date-time> A data inicial. |
| dataFinal | string <date-time> A data final. |
| codigoSerieSubSerie | string O código de série e sub série. |
| numeroDocumento | string O número do documento. |
Responses
Response samples
- 200
Gera as inutilizações.
Authorizations:
Request Body schema:
O contrato de inutilização a ser cadastrado.
| numeroDocumentoInicial | integer or null <int32> Número do documento inicial. |
| numeroDocumentoFinal | integer or null <int32> Número do documento final. |
| justificativaInutilizacao | string or null Obtém ou define a justificativa da inutilização. |
| codigoEmpresa | string or null Código da empresa. |
| identificadorTipoDocumento | string or null Identificador do tipo de documento. |
Responses
Request samples
- Payload
{- "numeroDocumentoInicial": 0,
- "numeroDocumentoFinal": 0,
- "justificativaInutilizacao": "string",
- "codigoEmpresa": "string",
- "identificadorTipoDocumento": "string"
}Response samples
- 200
Cadastra um novo documento de saída sem recalculo.
Authorizations:
Request Body schema:
O contrato de cadastro do documento de saída. O Campo Identificador do contrato não é necessário e será ignorado, pois é gerado de forma automática.
| codigoEmpresa | string or null Código da empresa. |
| dataEmissao | string <date-time> Obtém ou define a data de emissão. |
| dataReferencia | string <date-time> Obtém ou define a data de referência. |
| dataReferenciaPagamento | string <date-time> Obtém ou define a data de referência do pagamento. |
| identificadorOperacao | string or null Identificador da operação. A operação indicará o tipo do documento como sendo de entrada ou saída. |
| identificadorPessoa | string or null Identificador da pessoa. |
Array of objects or null (DocumentoItemCadastroEmitidoContrato) Obtém ou define os itens do documento. | |
| nomeEntidadeOrigem | string or null Gets or sets the nome entidade origem. |
| identificador | string or null Identificador do documento |
| numero | string or null Número do documento. |
| numeroNFSE | string or null Número da nota fiscal de Serviço Eletrônico do documento. |
| observacao | string or null Obtém ou define a observação do documento. |
Array of objects or null (DocumentoPagamentoCadastroContrato) Obtém ou define os pagamentos do documento. | |
object (PrazoContrato) Contrato do prazo. | |
| codigoContratoCompraCliente | string or null Código do contrato de compra do cliente. |
| tipoPagamento | string or null Tipo de pagamento: "0": ÀVista | "1": Parcelado. |
Array of objects or null (MensagemContrato) Obtém ou define a lista de mensagens definidas para o pedido (No máximo 4 mensagens). | |
| identificadorPreco | string or null Identificador da tabela de preço |
| tipoAcrescimo | string or null Tipo de acréscimo (A = Alíquota; V = Valor) |
| tipoDesconto | string or null Tipo de desconto (A = Alíquota; V = Valor) |
| identificadorPessoaTransportador | string or null Identificador da pessoa que é o transportador |
| tipoFrete | string or null Tipo de frete E = Frete por conta do emitente D = Frete por conta do destinatário T = Frete por conta de terceiros P = Próprio por conta do remetente Q = Próprio por conta do destinatário N = Sem frete |
| quantidadeVolumesTransporte | integer <int32> Descrição de quantos volumes a carga possui |
| descricaoEspecie | string or null Espécie do documento |
| descricaoMarca | string or null Descrição da marca para transporte |
| numeroTransportadora | integer <int32> Número para transporte |
| valorPesoBruto | number <double> Peso bruto |
| valorPesoLiquido | number <double> Peso liquido |
| identificadorPrazo | string or null Identificador do prazo |
| descricaoViaTransporte | string or null Via de transporte |
| valorAcrescimo | number <double> Valor de acréscimo da capa |
| valorDesconto | number <double> Valor desconto da capa |
| valorFrete | number <double> Valor frete da capa |
| valorSeguro | number <double> Valor seguro da capa |
| aliquotaAcrescimo | number <double> Aliquota de acrescimo |
| valorOutrasDespesas | number <double> Valor de outras despesas |
| aliquotaDesconto | number <double> Aliquota de desconto |
| valorComplementoICMS | number <double> Valor de complemento de ICMS |
| valorComplementoIPI | number <double> Valor de complemento de IPI |
| aliquotaBaseINSS | number <double> Aliquota de Base INSS |
| valorPISRetido | number <double> Valor de PIS retido |
| valorCOFINSRetido | number <double> Valor de COFINS retido |
| valorCSLLRetido | number <double> Valor de CSLL retido |
| valorComplementoICMSST | number <double> Valor de complemento de ICMS-ST |
| statusNotaFiscalEletronica | string or null Status da NF-e |
| codigoChaveAcessoNFEletronica | string or null Código da chave de acesso da NF-e |
| numeroProtocoloNFEletronica | string or null Número do protocolo da NF-e |
| dataSaida | string <date-time> Data de saída |
| tipoIndicacaoAtendimentoPresencial | integer <int32> Tipo de indicação do atendimento presencial |
| identificadorUnidadeDeNegocio | integer <int32> Identificador unidade de negocio |
| xmlRetorno | string or null XML de envio |
| xmlAssinado | string or null XML de retorno |
Responses
Request samples
- Payload
{- "codigoEmpresa": "string",
- "dataEmissao": "2019-08-24T14:15:22Z",
- "dataReferencia": "2019-08-24T14:15:22Z",
- "dataReferenciaPagamento": "2019-08-24T14:15:22Z",
- "identificadorOperacao": "string",
- "identificadorPessoa": "string",
- "itens": [
- {
- "cfop": "string",
- "identificador": "string",
- "identificadorProduto": "string",
- "identificadorSetorEntrada": "string",
- "identificadorSetorSaida": "string",
- "identificadorTipoMovimentoCobranca": "string",
- "quantidade": 0.1,
- "valorUnitario": 0.1,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "valorAcrescimo": 0.1,
- "aliquotaAcrescimo": 0.1,
- "tipoAcrescimo": "string",
- "valorDesconto": 0.1,
- "aliquotaDesconto": 0.1,
- "tipoDesconto": "string",
- "lote": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "perecivel": true,
- "dataValidade": "2019-08-24T14:15:22Z"
}, - "serie": {
- "identificador": "string",
- "codigo": "string",
- "dataFabricacao": "2019-08-24T14:15:22Z",
- "observacao": "string",
- "sequencialInicial": 0,
- "mascara": "string"
}, - "repasses": [
- {
- "aliquotaDuplicata": 0.1,
- "aliquotaFaturamento": 0.1,
- "identificadorCategoria": "string",
- "identificadorPessoa": "string",
- "possuiRepasseDuplicata": true,
- "possuiRepasseFaturamento": true
}
], - "identificadorLoteSerie": "string",
- "codigoSituacaoTributaria": "string",
- "desconto": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "acrescimo": {
- "aliquota": 0.1,
- "valor": 0.1,
- "tipo": "string"
}, - "valorItem": 0.1,
- "identificadorPreco": "string",
- "impostos": {
- "icms": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1,
- "codigoSituacaoTributaria": "string",
- "fcp": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}
}, - "icmsDispensado": {
- "valorBase": 0.1,
- "valor": 0.1
}, - "substituicaoTributariaICMS": {
- "valorBase": 0.1,
- "valor": 0.1,
- "fcpSubstituicaoTributariaICMS": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}
}, - "ipi": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1,
- "codigoEnquadramentoLegal": "string",
- "codigoSituacaoTributaria": "string"
}, - "irrf": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}, - "iss": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}, - "pis": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1,
- "codigoSituacaoTributaria": "string"
}, - "cofins": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1,
- "codigoSituacaoTributaria": "string"
}, - "csll": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}, - "inss": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}, - "ii": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}, - "issDestino": {
- "aliquota": 0.1,
- "valor": 0.1,
- "valorBase": 0.1
}
}, - "valorFreteRateado": 0.1,
- "valorOutrasDespesasRateado": 0.1,
- "valorSeguroRateado": 0.1
}
], - "nomeEntidadeOrigem": "string",
- "identificador": "string",
- "numero": "string",
- "numeroNFSE": "string",
- "observacao": "string",
- "pagamentos": [
- {
- "aliquota": 0.1,
- "aliquotaConvenio": 0.1,
- "aliquotaTACConvenio": 0.1,
- "aliquotaTACEmpresa": 0.1,
- "atualizaFinanceiro": true,
- "dataVencimento": "2019-08-24T14:15:22Z",
- "descricaoAgrupamento": "string",
- "identificadorFormaPagamento": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaConvenio": "string",
- "identificadorPessoaFinanceiro": "string",
- "identificadorTipoBaixa": "string",
- "nomeAdquirenteCartao": "string",
- "numeroAutorizacaoCartao": "string",
- "numeroCheque": "string",
- "numeroDias": 0,
- "numeroDiasIntervalo": 0,
- "numeroDiasPrimeiraParcelaVenda": 0,
- "numeroDiasRecebimento": 0,
- "numeroParcelas": 0,
- "numeroParcelasRecebimento": 0,
- "numeroSequencialUnicoCartao": "string",
- "numeroTitulo": "string",
- "valor": 0.1,
- "valorJurosPrazo": 0.1,
- "valorTACConvenio": 0.1,
- "valorTACEmpresa": 0.1
}
], - "prazo": {
- "identificador": "string",
- "identificadorFormaPagamentoEntrada": "string",
- "identificadorFormaPagamentoParcelas": "string",
- "codigo": "string",
- "tipoPrazo": "string",
- "numeroDiasEntrada": 0,
- "numeroDiasEntreParcelas": 0,
- "numeroDiasPrimeiraParcela": 0,
- "numeroParcelas": 0,
- "descricao": "string",
- "ativo": true
}, - "codigoContratoCompraCliente": "string",
- "tipoPagamento": "string",
- "mensagens": [
- {
- "codigo": "string",
- "descricao": "string",
- "identificador": "string"
}
], - "identificadorPreco": "string",
- "tipoAcrescimo": "string",
- "tipoDesconto": "string",
- "identificadorPessoaTransportador": "string",
- "tipoFrete": "string",
- "quantidadeVolumesTransporte": 0,
- "descricaoEspecie": "string",
- "descricaoMarca": "string",
- "numeroTransportadora": 0,
- "valorPesoBruto": 0.1,
- "valorPesoLiquido": 0.1,
- "identificadorPrazo": "string",
- "descricaoViaTransporte": "string",
- "valorAcrescimo": 0.1,
- "valorDesconto": 0.1,
- "valorFrete": 0.1,
- "valorSeguro": 0.1,
- "aliquotaAcrescimo": 0.1,
- "valorOutrasDespesas": 0.1,
- "aliquotaDesconto": 0.1,
- "valorComplementoICMS": 0.1,
- "valorComplementoIPI": 0.1,
- "aliquotaBaseINSS": 0.1,
- "valorPISRetido": 0.1,
- "valorCOFINSRetido": 0.1,
- "valorCSLLRetido": 0.1,
- "valorComplementoICMSST": 0.1,
- "statusNotaFiscalEletronica": "string",
- "codigoChaveAcessoNFEletronica": "string",
- "numeroProtocoloNFEletronica": "string",
- "dataSaida": "2019-08-24T14:15:22Z",
- "tipoIndicacaoAtendimentoPresencial": 0,
- "identificadorUnidadeDeNegocio": 0,
- "xmlRetorno": "string",
- "xmlAssinado": "string"
}Response samples
- 200
Obtém empresas por CNPJ ou nome
Consultar as empresas, permitindo filtrar por nome e CNPJ e a utilização de busca por trecho.
Nota: Caso não sejam informados nenhum parametro,
serão retornadas todas as empresas cadastradas.
Authorizations:
query Parameters
| cnpj | string Default: "" O CNPJ para a consulta. Caso seja informado,
a consulta será apenas pelo CNPJ. |
| nome | string Default: "" O nome da empresa para cosulta |
| nomePorTrecho | boolean Default: true Indica se consulta por nome será por trecho.
Caso não for informado, o valor padrão será true |
Responses
Response samples
- 200
Obtém tipos logradouro por descrição
Consultar os tipos de logradouro pela descrição. Permite busca por trecho.
Authorizations:
query Parameters
| descricao | string A descrição do logradouro. |
| porTrecho | boolean Indica se a localização será por trecho. |
Responses
Response samples
- 200
Localizar regiões pelo bairro e cidade
Consultar região pelo identificador do bairro e cidade.
Authorizations:
query Parameters
| IdentificadorBairro | string O Identificador do Bairro |
| IdentificadorCidade | string O Identiificador da Cidade |
Responses
Response samples
- 200
Remove característica vinculada a pessoa
Remover o vínculo da caracteristica com a pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa. |
| identificadorCaracteristica required | string O identificador da característica. |
Responses
Response samples
- 200
Obtém características vinculadas a pessoa
Consultar todas características ou apenas as vinculadas a pessoa.
Authorizations:
query Parameters
| identificadorPessoa | string O identificador da pessoa. |
| identificadorCaracteristica | string O identificador da característica. |
Responses
Response samples
- 200
Cadastra pessoa como cliente
Cadastrar uma pessoa no Bimer na categoria cliente.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como cliente.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
| identificador | string or null |
object (PessoaDadosCadastroContrato) Classe de contrato de dados do cliente. |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string",
- "identificador": "string",
- "dados": {
- "identificadorOperacao": "string",
- "identificadorOperacaoNFFechamento": "string",
- "identificadorOperacaoOE": "string",
- "identificadorOperacaoOEFechamento": "string",
- "identificadorPessoaTransportador": "string",
- "identificadorPessoaTransportadorRedesp": "string",
- "identificadorPreco": "string",
- "identificadorMensagem": "string",
- "identificadorPrazo": "string",
- "identificadorNaturezaLancamento": "string",
- "identificadorPessoaFinanceiro": "string",
- "aliquotaDesconto": 0.1,
- "aliquotaARLCalculo": 0.1,
- "situacaoEnvioBoletoAutomatico": true,
- "cobraTaxaBancaria": true,
- "dataTaxaBancaria": "2019-08-24T14:15:22Z",
- "identificadorTipoComercializacao": "string",
- "identificadorPessoaConvenio": "string"
}
}Response samples
- 200
Edita um cliente
Editar uma pessoa da categoria cliente no Bimer.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa que está sendo editada |
Request Body schema:
A pessoa a ser editada.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string"
}Response samples
- 200
Vincula transportador a um cliente
Vincular um transportador a um cliente.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa que está sendo editada |
Request Body schema:
O transportador que será vinculado ao cliente.
| identificador | string or null O identificador único da pessoa no Bimer |
Responses
Request samples
- Payload
{- "identificador": "string"
}Response samples
- 200
Cadastra pessoa como fornecedor
Cadastrar um novo fornecedor no Bimer.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como fornecedor.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
| identificador | string or null |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string",
- "identificador": "string"
}Response samples
- 200
Cadastra as versoes de um produto da pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa. |
| identificadorProduto required | string O identificador do Produto. |
Request Body schema:
O contrato das versões que serão cadastradas.
object (VersaoProdutoCadastroContrato) O contrato do cadastro da versão do produto. | |
object (VersaoProdutoCadastroContrato) O contrato do cadastro da versão do produto. | |
object (VersaoProdutoCadastroContrato) O contrato do cadastro da versão do produto. |
Responses
Request samples
- Payload
{- "versao": {
- "data": "2019-08-24T14:15:22Z",
- "identificadorVersao": "string"
}, - "versaoBaixada": {
- "data": "2019-08-24T14:15:22Z",
- "identificadorVersao": "string"
}, - "versaoLiberada": {
- "data": "2019-08-24T14:15:22Z",
- "identificadorVersao": "string"
}
}Response samples
- 200
Cria um relacionamento para a pessoa
Cadastrar um relacionamento para a pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa principal |
Request Body schema:
As informações do relacionamento.
| identificadorCategoriaPessoaPrincipal required | string or null O identificador da categoria da pessoa principal |
| identificadorCaracteristicaPessoaPrincipal | string or null O identificador da característica da pessoa principal |
| identificadorCategoriaPessoaRelacionamento required | string or null O identificador da categoria da pessoa relacionada |
| identificadorCaracteristicaPessoaRelacionamento | string or null O identificador da característica da pessoa relacionada |
| identificadorPessoaRelacionamento required | string or null O identificador da pessoa relacionada |
| pessoaRelacionadaPrincipal required | boolean Define se a pessoa relacionada é a principal. |
Responses
Request samples
- Payload
{- "identificadorCategoriaPessoaPrincipal": "string",
- "identificadorCaracteristicaPessoaPrincipal": "string",
- "identificadorCategoriaPessoaRelacionamento": "string",
- "identificadorCaracteristicaPessoaRelacionamento": "string",
- "identificadorPessoaRelacionamento": "string",
- "pessoaRelacionadaPrincipal": true
}Response samples
- 200
Remove relacionamento entre duas pessoas
Remover um relacionamento da pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa principal |
query Parameters
| identificadorCategoriaPessoa | string O identificador da categoria da pessoa |
| identificadorPessoaRelacionamento | string O identificador da pessoa do relacionamento |
| identificadorCategoriaPessoaRelacionamento | string O identificador da categoria da pessoa do relacionamento |
Responses
Response samples
- 200
Obtém pessoa por CPF/CNPJ ou código externo
Consultar uma pessoa por CPF/CNPJ ou código externo.
Authorizations:
query Parameters
| cpfCnpj | integer <int64> O CPF / CNPJ da pessoa |
| codigoExterno | string O código externo da pessoa |
Responses
Response samples
- 200
Obtém as pessoas por característica
Consultar de forma paginada todas as pessoas com a característica informada.
Authorizations:
query Parameters
| identificadorCaracteristica | string O identificador da característica vinculada a pessoa |
| limite | integer <int32> O limite de registros por pagina |
| pagina | integer <int32> A pagina atual a ser consultada |
Responses
Response samples
- 200
Realiza vinculo de característica a uma pessoa
Vincular uma característica à pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa |
Request Body schema:
A característica que será vinculada.
| identificadorCaracteristica | string or null O identificador da característica |
Responses
Request samples
- Payload
{- "identificadorCaracteristica": "string"
}Response samples
- 200
Realiza vinculo de categoria a pessoa
Vincular uma categoria à pessoa.
Authorizations:
Request Body schema:
Contrato para realizar o vinculo dos identificadores informados.
| identificador | string or null Identificador da pessoa que será utilizada para vincular a categoria |
| identificadorCategoria | string or null Identificador da categoria |
Responses
Request samples
- Payload
{- "identificador": "string",
- "identificadorCategoria": "string"
}Response samples
- 200
Edita uma pessoa
Editar uma pessoa no Bimer.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa a ser editada |
Request Body schema:
A pessoa a ser editada.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string"
}Response samples
- 200
Edita a categoria da pessoa
Editar uma categoria da pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa a ser editada |
| identificadorCategoria required | string O identificador da categoria da pessoa a ser editada |
Request Body schema:
As informações que serão alteradas na categoria.
| identificadorPessoaRelacionada required | string or null O Identificador da pessoa relacionada à pessoa da categoria |
| ativo required | boolean Define se a pessoa está ativa ou inativa na categoria |
| codigoChamadaExterno required | string or null O código de chamada externo da pessoa em sua categoria |
Responses
Request samples
- Payload
{- "identificadorPessoaRelacionada": "string",
- "ativo": true,
- "codigoChamadaExterno": "string"
}Response samples
- 200
Ativar / Inativar a categoria da pessoa
Ativar ou inativar uma categoria da pessoa.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa |
| identificadorCategoria required | string O identificador da categoria da pessoa |
Request Body schema:
As informações que serão alteradas na categoria.
| identificadorPessoaRelacionada | string or null Identificador da pessoa relacionada à pessoa da categoria |
| ativo | boolean Indica se a pessoa está ativa ou inativa na categoria |
| codigoChamadaExterno | string or null Código de chamada externo da pessoa na categoria |
Responses
Request samples
- Payload
{- "identificadorPessoaRelacionada": "string",
- "ativo": true,
- "codigoChamadaExterno": "string"
}Response samples
- 200
Cadastra pessoa como prospectado
Cadastrar uma nova pessoa no sistema como prospectado.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como Prospectado.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
| identificador | string or null |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string",
- "identificador": "string"
}Response samples
- 200
Altera um prospectado para cliente
Alterar um prospectado para a categoria cliente.
Authorizations:
path Parameters
| identificadorPessoa required | string O identificador da pessoa que está sendo editada |
Request Body schema:
A pessoa a ser editada.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string"
}Response samples
- 200
Cadastra pessoa como representante
Cadastrar uma pessoa como representante.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como representante.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
| identificador | string or null |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string",
- "identificador": "string"
}Response samples
- 200
Cadastra pessoa como Suspect
Cadastrar uma pessoa como suspect.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como suspect.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string"
}Response samples
- 200
Cadastra pessoa como transportador
Cadastrar uma pessoa no sistema como transportador.
Authorizations:
Request Body schema:
A pessoa a ser cadastrada como transportador.
| codigo | string or null Código da pessoa |
| cpfCnpj required | integer <int64> CPF ou CNPJ da pessoa |
| dataNascimento | string <date-time> Data de nascimento da pessoa |
| nome required | string or null Nome da pessoa. |
| nomeCurto | string or null Nome curto da pessoa |
| retemTributosContribuicoes | boolean Retenção de tributos e contribuições |
| retemTributosDeQualquerValor | boolean Retenção de tributos de qualquer valor |
| prestadoraServico | boolean Pessoa jurídica prestadora de serviço |
| aliquotaIRRF | number <double> Alíquota de IRRF para pessoa juridica |
| dataInicioAtividades | string <date-time> Data de início das atividades |
| entidadeAdministracaoPublicaFederal | boolean Entidade da administração publíca federal |
Array of objects or null (PessoaEnderecoCadastroContrato) Lista de endereços | |
| identificadorRepresentantePrincipal | string or null Identificador do representante principal |
| tipo | string or null Tipo da pessoa |
| tipoClienteTelecomunicacao | string or null Tipo de cliente para telecomunicação |
| codigoExterno | string or null Código externo da pessoa |
| identificadorCNAE | string or null Identificador do CNAE |
| ramoAtividade | string or null Descrição do ramo de atividade da pessoa |
| identificadorSituacaoCadastralPessoa | string or null Identificador da situação cadastral da pessoa |
| identificador | string or null |
Responses
Request samples
- Payload
{- "codigo": "string",
- "cpfCnpj": 0,
- "dataNascimento": "2019-08-24T14:15:22Z",
- "nome": "string",
- "nomeCurto": "string",
- "retemTributosContribuicoes": true,
- "retemTributosDeQualquerValor": true,
- "prestadoraServico": true,
- "aliquotaIRRF": 0.1,
- "dataInicioAtividades": "2019-08-24T14:15:22Z",
- "entidadeAdministracaoPublicaFederal": true,
- "enderecos": [
- {
- "codigo": "string",
- "cep": "string",
- "codigoSuframa": "string",
- "complemento": "string",
- "identificadorBairro": "string",
- "identificadorCidade": "string",
- "identificadorTipoLogradouro": "string",
- "inscricaoEstadual": "string",
- "nomeLogradouro": "string",
- "numeroLogradouro": "string",
- "observacao": "string",
- "pessoasContato": [
- {
- "contatoPrincipal": true,
- "fax": "string",
- "email": "string",
- "emailNfEletronica": "string",
- "emailCobranca": "string",
- "emailBoleto": "string",
- "identificador": "string",
- "nome": "string",
- "paginaInternet": "string",
- "tipoCadastro": "string",
- "telefoneCelular": "string",
- "telefoneFixo": "string",
- "suporte": "string",
- "contatos": [
- {
- "tipoContato": {
- "identificador": "string",
- "codigo": "string",
- "descricao": "string"
}, - "descricao": "string"
}
]
}
], - "siglaUnidadeFederativa": "string",
- "tipoCadastro": "string",
- "tipos": {
- "cobranca": true,
- "comercial": true,
- "correspondencia": true,
- "entrega": true,
- "principal": true,
- "residencial": true
}, - "tipoContribuicaoICMS": "string",
- "inscricaoMunicipal": "string",
- "latitude": 0.1,
- "longitude": 0.1
}
], - "identificadorRepresentantePrincipal": "string",
- "tipo": "string",
- "tipoClienteTelecomunicacao": "string",
- "codigoExterno": "string",
- "identificadorCNAE": "string",
- "ramoAtividade": "string",
- "identificadorSituacaoCadastralPessoa": "string",
- "identificador": "string"
}Response samples
- 200
Retorna uma lista de características de produto pela descriação.
Authorizations:
query Parameters
| nome | string O nome da característica de produto que se deseja localizar. |
| porTrecho | boolean Default: false Indica se a pesquisa deve ser feita por trecho. |
Responses
Response samples
- 200
Adiciona uma característica de produto.
Authorizations:
Request Body schema:
A característica de produto a ser adicionada.
| identificador | string or null Identificador da Caracteristica de produto. |
| codigo | string or null Código da Caracteristica de produto. |
| descricao | string or null Nome da Caracteristica de produto. |
| tipo | string or null Tipo de Caracteristica de produto (Analítico ou sintético). |
| codigoClassificacao | string or null Código da classificação da Caracteristica de produto. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "descricao": "string",
- "tipo": "string",
- "codigoClassificacao": "string"
}Response samples
- 200
Edita uma característica de produto.
Authorizations:
Request Body schema:
A característica de produto a ser editada.
| identificador | string or null Identificador da Caracteristica de produto. |
| codigo | string or null Código da Caracteristica de produto. |
| descricao | string or null Nome da Caracteristica de produto. |
| tipo | string or null Tipo de Caracteristica de produto (Analítico ou sintético). |
| codigoClassificacao | string or null Código da classificação da Caracteristica de produto. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "descricao": "string",
- "tipo": "string",
- "codigoClassificacao": "string"
}Response samples
- 200
Obtém o estoque de um produto.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto. |
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| identificadorSetor | string O identificador do setor. |
| dataReferencia | string <date-time> A data referência (Se omitido considera-se como data atual). |
Responses
Response samples
- 200
Obtém o estoque de lotes de um produto por setor.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto. |
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| identificadorSetor | string O identificador do setor. |
| dataReferencia | string <date-time> A data referência. |
Responses
Response samples
- 200
Obtém o estoque de série de um produto por setor.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto. |
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| identificadorSetor | string O identificador do setor. |
| dataReferencia | string <date-time> A data referência. |
Responses
Response samples
- 200
Obtém o estoque de um produto por setor sem considerar o cache. Deprecated
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto. |
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| identificadorSetor | string O identificador do setor. |
| dataReferencia | string <date-time> A data referência. |
Responses
Response samples
- 200
Retorna uma lista de familias de um produto pela classificação
Authorizations:
query Parameters
| classificacao | string A classificação dos familias de produto que se deseja localizar. |
| porTrecho | boolean Default: false Indica se a pesquisa deve ser feita por trecho. |
Responses
Response samples
- 200
Adiciona uma família de produto.
Authorizations:
Request Body schema:
A família de produto a ser adicionada.
| identificador | string or null Identificador da família de produtos. |
| codigo | string or null Código da família do produto. |
| nome | string or null Obtém ou define a descrição da família do produto. |
| tipoClassificacao | string or null Tipo de classificação da família (Analítico ou sintético). |
| codigoClassificacao | string or null Obtém ou define a classificação da família. |
| observacao | string or null Obtém ou define a observação da família. |
| markupFixo | boolean Status de Markup fixo. |
| aliquotaMargemLucro | number <double> Obtém ou define a alíquota de margem de lucro. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "tipoClassificacao": "string",
- "codigoClassificacao": "string",
- "observacao": "string",
- "markupFixo": true,
- "aliquotaMargemLucro": 0.1
}Response samples
- 200
Edita uma família de produto.
Authorizations:
Request Body schema:
A família de produto a ser editada.
| identificador | string or null Identificador da família de produtos. |
| codigo | string or null Código da família do produto. |
| nome | string or null Obtém ou define a descrição da família do produto. |
| tipoClassificacao | string or null Tipo de classificação da família (Analítico ou sintético). |
| codigoClassificacao | string or null Obtém ou define a classificação da família. |
| observacao | string or null Obtém ou define a observação da família. |
| markupFixo | boolean Status de Markup fixo. |
| aliquotaMargemLucro | number <double> Obtém ou define a alíquota de margem de lucro. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "tipoClassificacao": "string",
- "codigoClassificacao": "string",
- "observacao": "string",
- "markupFixo": true,
- "aliquotaMargemLucro": 0.1
}Response samples
- 200
Retorna uma lista de grupos de um produto pela classificação
Authorizations:
query Parameters
| classificacao | string A classificação dos grupos de produto que se deseja localizar. |
| porTrecho | boolean Default: false Indica se a pesquisa deve ser feita por trecho. |
Responses
Response samples
- 200
Adiciona um grupo de produto.
Authorizations:
Request Body schema:
O grupo de produto a ser adicionado.
| identificador | string or null Identificador do grupo de produtos. |
| codigo | string or null Código do grupo do produto. |
| nome | string or null Obtém ou define a descrição do grupo do produto. |
| tipoClassificacao | string or null Tipo de classificação do grupo (Analítico ou sintético). |
| codigoClassificacao | string or null Obtém ou define a classificação do grupo. |
| observacao | string or null Obtém ou define a observação do grupo. |
| aliquotaLucroDesejada | number <double> Obtém ou define a alíquota de lucro desejada. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "tipoClassificacao": "string",
- "codigoClassificacao": "string",
- "observacao": "string",
- "aliquotaLucroDesejada": 0.1
}Response samples
- 200
Edita um grupo de produto.
Authorizations:
Request Body schema:
O grupo de produto a ser editado.
| identificador | string or null Identificador do grupo de produtos. |
| codigo | string or null Código do grupo do produto. |
| nome | string or null Obtém ou define a descrição do grupo do produto. |
| tipoClassificacao | string or null Tipo de classificação do grupo (Analítico ou sintético). |
| codigoClassificacao | string or null Obtém ou define a classificação do grupo. |
| observacao | string or null Obtém ou define a observação do grupo. |
| aliquotaLucroDesejada | number <double> Obtém ou define a alíquota de lucro desejada. |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "tipoClassificacao": "string",
- "codigoClassificacao": "string",
- "observacao": "string",
- "aliquotaLucroDesejada": 0.1
}Response samples
- 200
Obtém o último custo de um produto por empresa e data de referência.
Authorizations:
path Parameters
| identificador required | string O identificador do produto. |
| codigoEmpresa required | integer <int32> O código da empresa. |
query Parameters
| dataReferencia | string <date-time> A data de referência. |
Responses
Response samples
- 200
Retorna o preço por empresa e por produto
Authorizations:
path Parameters
| identificadorEmpresa required | string Identificador da empresa que se deseja consultar o preço |
| identificadorProduto required | string Identificador do produto que se deseja consultar o preço |
Responses
Response samples
- 200
Retorna o preço por empresa, produto e tabela de preços
Authorizations:
path Parameters
| identificadorEmpresa required | string Identificador da empresa que se deseja consultar o preço |
| identificadorProduto required | string Identificador do produto que se deseja consultar o preço |
| identificadorPreco required | string Identificador da tabela de preço que se deseja |
Responses
Response samples
- 200
Adiciona um produto.
Authorizations:
Request Body schema:
O produto a ser adicionado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string"
}Response samples
- 200
Altera um produto por identificador, considerando para cada item e pagamento o que foi informado no "TipoCadastro".
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
| tipoCadastro | string or null Tipo de ação a realizar com o cadastro. A - Alteração. E - Exclusão. I - Inclusão. |
Array of objects or null (ProdutoEmpresaAlteracaoContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoAlteracaoContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoAlteracaoContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "tipoCadastro": "string",
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string",
- "tipoCadastro": "string"
}
], - "tipoCadastro": "string"
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true,
- "tipoCadastro": "string"
}
], - "codigos": [
- {
- "identificador": "string",
- "tipoCadastro": "string",
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string"
}Response samples
- 200
Obtém os identificadores dos produtos com versão de registro superior ao valor determinado.
Authorizations:
query Parameters
| versaoRegistro | integer <int64> A versão do registro que será usada para filtro (maior que). |
| itensPorPagina | integer <int32> A quantidade de itens que deverão ser exibidos por página. |
Responses
Response samples
- 200
Adiciona uma grade de produtos.
Authorizations:
Request Body schema:
A grade de produtos a ser adicionada.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação da grade |
| identificadorGradeHorizontal | string or null Retorna ou atribui o identificador da grade horizontal |
| identificadorGradeVertical | string or null Retorna ou atribui o identificador da grade vertical |
Array of objects or null (ProdutoGradeDetalheCadastroContrato) Retorna ou atribui os detalhes da grade |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string",
- "identificadorGradeHorizontal": "string",
- "identificadorGradeVertical": "string",
- "detalhes": [
- {
- "identificadorGradeDetalheHorizontal": "string",
- "identificadorGradeDetalheVertical": "string",
- "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "observacao": "string"
}
]
}Response samples
- 200
Incluir novos itens em uma grade existente.
Authorizations:
path Parameters
| identificadorProdutoMaster required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
Array of objects or null (ProdutoEmpresaCadastroContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoCadastroContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoCadastroContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação da grade |
| identificadorGradeHorizontal | string or null Retorna ou atribui o identificador da grade horizontal |
| identificadorGradeVertical | string or null Retorna ou atribui o identificador da grade vertical |
Array of objects or null (ProdutoGradeDetalheCadastroContrato) Retorna ou atribui os detalhes da grade |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string"
}
]
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true
}
], - "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string",
- "identificadorGradeHorizontal": "string",
- "identificadorGradeVertical": "string",
- "detalhes": [
- {
- "identificadorGradeDetalheHorizontal": "string",
- "identificadorGradeDetalheVertical": "string",
- "codigos": [
- {
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "observacao": "string"
}
]
}Response samples
- 200
Alterar uma grade de produtos. Nesse endpoint todos os itens de uma grade serão editados.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto a ser alterado. |
Request Body schema:
O contrato do produto a ser alterado.
| identificador | string or null Recupera ou atribui o identificador do produto |
| codigo | string or null Recupera ou atribui o código do Produto |
| nome | string or null Recupera ou atribui o nome do produto |
| identificadorProdutoMaster | string or null Recupera ou atribui o identificador do produto master |
| identificadorProdutoOrigem | string or null Identificador do produto origem. |
| fatorConversaoUnidade | number <double> Fator de conversão da unidade. |
| tipoProduto | string or null Tipo do produto. |
| tipoComplementarProduto | string or null Tipo complementar do produto. |
| identificadorUnidade | string or null Obtém ou define a unidade do Produto |
| identificadorClassificacaoFiscal | string or null Obtém ou define a classificação fiscal do produto |
| identificadorCalculoICMS | string or null Cálculo de ICMS do produto |
| pesoBruto | number <double> Retorna ou atribui o peso bruto. |
| pesoLiquido | number <double> Retorna ou atribui o peso líquido. |
| tipoCadastro | string or null Tipo de ação a realizar com o cadastro. A - Alteração. E - Exclusão. I - Inclusão. |
Array of objects or null (ProdutoEmpresaAlteracaoContrato) A lista de empresas vinculadas ao produto | |
Array of objects or null (PessoaProdutoAlteracaoContrato) A lista de fornecedores vinculadas ao produto | |
Array of objects or null (CodigoProdutoAlteracaoContrato) A lista de códigos vinculados ao produto | |
| observacao | string or null Obtém ou define a observação do produto |
| identificadorGrupoProduto | string or null Grupo do Produto |
| identificadorFamiliaProduto | string or null Obtém ou define a família do produto |
| nomeCurto | string or null Nome curto do produto |
| nomeProdutoGrade | string or null Retorna ou atribui o nome do produto |
| classificacaoGrade | string or null Retorna ou atribui a classificação do produto |
Responses
Request samples
- Payload
{- "identificador": "string",
- "codigo": "string",
- "nome": "string",
- "identificadorProdutoMaster": "string",
- "identificadorProdutoOrigem": "string",
- "fatorConversaoUnidade": 0.1,
- "tipoProduto": "string",
- "tipoComplementarProduto": "string",
- "identificadorUnidade": "string",
- "identificadorClassificacaoFiscal": "string",
- "identificadorCalculoICMS": "string",
- "pesoBruto": 0.1,
- "pesoLiquido": 0.1,
- "tipoCadastro": "string",
- "empresas": [
- {
- "codigoEmpresa": 0,
- "ativoCompra": true,
- "ativoVenda": true,
- "dataLimiteCompra": "2019-08-24T14:15:22Z",
- "dataLimiteVenda": "2019-08-24T14:15:22Z",
- "setores": [
- {
- "identificadorSetor": "string",
- "tipoCadastro": "string"
}
], - "tipoCadastro": "string"
}
], - "fornecedores": [
- {
- "identificador": "string",
- "identificadorPessoa": "string",
- "fornecedorPrincipal": true,
- "tipoCadastro": "string"
}
], - "codigos": [
- {
- "identificador": "string",
- "tipoCadastro": "string",
- "codigo": "string",
- "principal": true,
- "identificadorFornecedor": "string",
- "identificadorTipoCodigo": "string"
}
], - "observacao": "string",
- "identificadorGrupoProduto": "string",
- "identificadorFamiliaProduto": "string",
- "nomeCurto": "string",
- "nomeProdutoGrade": "string",
- "classificacaoGrade": "string"
}Response samples
- 200
Cadastra uma versão no produto.
Authorizations:
path Parameters
| identificadorProduto required | string O identificador do produto. |
Request Body schema:
O contrato versoes.
| dataLiberacao | string <date-time> Obtém ou atribui a data liberação da versão. |
| dataProgramada | string <date-time> Obtém ou atribui a data programada da versão. |
| numero | string or null Obtém ou atribui o numero da versão. |
| observacao | string or null Obtém ou atribuí a observação da versão. |
| tipoVersao | integer <int32> (ETipoVersaoProduto) Enum: 0 1 2 3 |
Responses
Request samples
- Payload
{- "dataLiberacao": "2019-08-24T14:15:22Z",
- "dataProgramada": "2019-08-24T14:15:22Z",
- "numero": "string",
- "observacao": "string",
- "tipoVersao": 0
}Response samples
- 200
Atualiza uma versão.
Authorizations:
path Parameters
| identificadorVersao required | string The identificador versao. |
Request Body schema:
The contrato versoes.
| dataLiberacao | string <date-time> Obtém ou atribui a data liberação da versão. |
| dataProgramada | string <date-time> Obtém ou atribui a data programada da versão. |
| numero | string or null Obtém ou atribui o numero da versão. |
| observacao | string or null Obtém ou atribuí a observação da versão. |
| tipoVersao | integer <int32> (ETipoVersaoProduto) Enum: 0 1 2 3 |
Responses
Request samples
- Payload
{- "dataLiberacao": "2019-08-24T14:15:22Z",
- "dataProgramada": "2019-08-24T14:15:22Z",
- "numero": "string",
- "observacao": "string",
- "tipoVersao": 0
}Response samples
- 200