Manual de integração via API Nimbus - Parceiros : Nimbus ERP

Este documento apresenta um catálogo de endpoints que estão disponíveis para serem implementados por empresas parceiras. Elas permitem permitem a troca de dados entre sistemas, podendo ser utilizadas para acessar, enviar ou receber dados específicos, de acordo com as necessidades e requisitos de cada sistema.

URL:

https://parceiros.nimbuserp.com.br/

Relatórios:

Venda por data
Venda por data com dados de entrega

Venda por data

[get] Relatorios/Venda?chave={chave}&chaveUsuario={chaveUsuario}&cnpjEmpresa={cnpjEmpresa}&dataInicial={dataInicial}&dataFinal={dataFinal}

Parâmetros da URI

Nome	Descrição	Tipo	Formatação	InformaçõesAdicionais
chave	Chave de acesso única para cada parceiro	String	36 caracteres	Requerido
chaveUsuario	Chave de acesso única para cada usuário do sistema, esta chave será utilizada para identificar as bases que estarão disponíveis para consulta. Clique aqui para saber como obter.	String	34 a 61 caracteres	Requerido
cnpjEmpresa	CNPJ da empresa que será realizado a consulta	String	14 caracteres Apenas números	Requerido
dataInicial	Data inicial das vendas	Date	dd/MM/yyyy	Requerido
dataFinal	Data final das vendas	Date	dd/MM/yyyy	Requerido

Tipo de Retorno de Sucesso

application/json, text/json

Modelo

Nome	Descrição	Tipo	Formatação	Informações Adicionais
filtros	Filtros de pesquisa para consulta	String	Empresa: {CNPJ} \| Data Inicial: {dd/MM/yyyy HH:mm:ss} \| Data Final: {dd/MM/yyyy HH:mm:ss}	Não Nulo
vendas	Lista de vendas realizadas	Array<Venda>	-	Não Nulo Vazia

Venda

Nome	Descrição	Tipo	Formatação	Informações Adicionais
numero	Chave de acesso única para cada parceiro	String	36 caracteres	Não Nulo
estabelecimento	Chave de acesso única para cada usuário do sistema, esta chave será utilizada para identificar as bases que estarão disponíveis para consulta	String	34 a 61 caracteres	Não Nulo
data	Data e horário da realização da venda	String	(ISO 8601) - yyyy-MM-ddTHH:mm:ss	Não Nulo
cliente	Nome do cliente que efetuou a compra	String	-	Não Nulo
portador	Nome do portador utilizada para pagamento	String	-	Não Nulo
carteira	Nome da carteira utilizada para pagamento	String	-	Não Nulo
formaRecebimento	Forma que o cliente realizou o pagamento.	String	-	Não Nulo
valor	Valor pago por forma de recebimento	Float	-	Não Nulo
vendedor	Nome do vendedor associado à venda	String	-	Não Nulo
mesa	Número da mesa onde ocorreu a venda (se aplicável)	String	-	Não Nulo
quantidadeDePessoas	Quantidade de clientes na mesa relacionados à venda	Integer	-	Não Nulo
codigoIntegracao	Código de integração relacionado à venda (se aplicável)	String	-	Não Nulo
tipoVenda	Tipo de venda realizada (exemplo: delivery, balcão, mesa)	String	-	Não Nulo
codigoVendedor	Código do vendedor responsável pela venda.	String	-	Não Nulo
taxa	Taxa associada à venda	Float	-	Não Nulo
cancelado	Indicador de cancelamento da venda	Boolean	-	true se cancelado false caso contrário
motivoDoCancelamento	Motivo do cancelamento da venda (se aplicável)	String	-	Não Nulo

Exemplo

statusCode 200

{
  "filtros": "Empresa: 12345678901234 | Data Inicial: 21/01/2023 00:00:00 | Data Final: 21/01/2023 23:59:59",
  "vendas": [
    {
      "numero": 1,
      "estabelecimento": 1,
      "data": "2023-01-21T00:01:05",
      "cliente": "CLIENTE TESTE",
      "portador": "ITAÚ",
      "carteira": "CRÉDITO",
      "formaRecebimento": "MASTER CRÉDITO",
      "valor": 173.00,
      "vendedor": "GERENTE",
      "mesa": "14",
      "quantidadeDePessoas": 1,
      "codigoIntegracao": "",
      "tipoVenda": "MESA",
      "codigoVendedor": "6",
      "taxa": 0.00,
      "cancelado": false,
      "motivoDoCancelamento": ""
    },
    ...
  ]
}

Tipo de Retorno de Falha

application/json, text/json

Modelo

Nome	Descrição	Tipo	Formatação	Informações Adicionais
title	String	String	-	Não nulo
errors	Lista de erros	Array<String>	-	Não nulo Vazia

Lista de erros

Status Code	Titulo	Erros	Motivo
400	Dados de autenticação inválidos	-	Chave, chave de usuário, CNPJ empresa com formatação inválida
400	Dados do filtro inválidos	-	Data inicial, data final, CNPJ empresa com formatação inválida
400	Chave do parceiro não localizada	-	-
400	Parceiro inativo	-	-
400	Chave do usuário não localizada	-	-
400	Chave do usuário sem acesso à empresa solicitada	-	-
400	Data inicial superior a data final	-	-
400	Intervalo de dias solicitados é superior a 7 dias	-	-

Exemplo de falha

statusCode 400

{
  "title": "Chave do parceiro não localizado.",
  "errors": []
}

statusCode 500

{
  "title": "Internal Server Error"
  "errors": []
}

Venda por data com dados de entrega

[get] Relatorios/VendaComDadosDeEntrega?chave={chave}&chaveUsuario={chaveUsuario}&cnpjEmpresa={cnpjEmpresa}&dataInicial={dataInicial}&dataFinal={dataFinal}

Parâmetros da URI

Nome	Descrição	Tipo	Formatação	InformaçõesAdicionais
chave	Chave de acesso única para cada parceiro	String	36 caracteres	Requerido
chaveUsuario	Chave de acesso única para cada usuário do sistema, esta chave será utilizada para identificar as bases que estarão disponíveis para consulta. Clique aqui para saber como obter.	String	34 a 61 caracteres	Requerido
cnpjEmpresa	CNPJ da empresa que será realizado a consulta	String	14 caracteres Apenas números	Requerido
dataInicial	Data inicial das vendas	Date	dd/MM/yyyy	Requerido
dataFinal	Data final das vendas	Date	dd/MM/yyyy	Requerido

Tipo de Retorno de Sucesso

application/json, text/json

Modelo

Nome	Descrição	Tipo	Formatação	Informações Adicionais
filtros	Filtros de pesquisa para consulta	String	Empresa: {CNPJ} \| Data Inicial: {dd/MM/yyyy HH:mm:ss} \| Data Final: {dd/MM/yyyy HH:mm:ss}	Não Nulo
vendas	Lista de vendas realizadas	Array<Venda>	-	Não Nulo Vazia

Venda

Nome	Descrição	Tipo	Formatação	Informações Adicionais
numero	Chave de acesso única para cada parceiro	String	36 caracteres	Não Nulo
estabelecimento	Chave de acesso única para cada usuário do sistema, esta chave será utilizada para identificar as bases que estarão disponíveis para consulta	String	34 a 61 caracteres	Não Nulo
data	Data e horário da realização da venda	String	(ISO 8601) - yyyy-MM-ddTHH:mm:ss	Não Nulo
cliente	Nome do cliente que efetuou a compra	String	-	Não Nulo
portador	Nome do portador utilizada para pagamento	String	-	Não Nulo
carteira	Nome da carteira utilizada para pagamento	String	-	Não Nulo
formaRecebimento	Forma que o cliente realizou o pagamento.	String	-	Não Nulo
valor	Valor pago por forma de recebimento	Float	-	Não Nulo
vendedor	Nome do vendedor associado à venda	String	-	Não Nulo
mesa	Número da mesa onde ocorreu a venda (se aplicável)	String	-	Não Nulo
quantidadeDePessoas	Quantidade de clientes na mesa relacionados à venda	Integer	-	Não Nulo
codigoIntegracao	Código de integração relacionado à venda (se aplicável)	String	-	Não Nulo
tipoVenda	Tipo de venda realizada (exemplo: delivery, balcão, mesa)	String	-	Não Nulo
codigoVendedor	Código do vendedor responsável pela venda.	String	-	Não Nulo
taxa	Taxa associada à venda	Float	-	Não Nulo
cancelado	Indicador de cancelamento da venda	Boolean	-	true se cancelado false caso contrário
motivoDoCancelamento	Motivo do cancelamento da venda (se aplicável)	String	-	Não Nulo
dadosDeEntrega	Endereço de entrega	dadosDeEntrega	-	Nulo

Dados de entrega

Nome	Descrição	Tipo	Formatação	Informações Adicionais
logradouro	Endereço de entrega	String	-	Não Nulo Vazia
numero	Número da residência ou estabelecimento	String	-	Não Nulo Vazia
complemento	Detalhe adicional do endereço	String	-	Não Nulo Vazia
cep	Código de Endereçamento Postal	String	-	Não Nulo Vazia
bairro	Bairro de entrega	String	-	Não Nulo Vazia
cidade	Cidade de entrega	String	-	Não Nulo Vazia
uf	Estado	String	-	Não Nulo Vazia
ddd	DDD do contato para a entrega	String	-	Não Nulo Vazia
telefone	Número do contato para a entrega	String	-	Não Nulo Vazia
nomeEntregador	Identificação do responsável pela entrega	String	-	Não Nulo Vazia

Exemplo

statusCode 200

{
  "filtros": "Empresa: 12345678901234 | Data Inicial: 21/01/2023 00:00:00 | Data Final: 21/01/2023 23:59:59",
  "vendas": [
    {
      "numero": 1,
      "estabelecimento": 1,
      "data": "2023-01-21T00:01:05",
      "cliente": "CLIENTE TESTE",
      "portador": "ITAÚ",
      "carteira": "CRÉDITO",
      "formaRecebimento": "MASTER CRÉDITO",
      "valor": 173.00,
      "vendedor": "GERENTE",
      "mesa": "14",
      "quantidadeDePessoas": 1,
      "codigoIntegracao": "",
      "tipoVenda": "MESA",
      "codigoVendedor": "6",
      "taxa": 0.00,
      "cancelado": false,
      "motivoDoCancelamento": "",
      "dadosDeEntrega": {
            "logradouro": "Rua Carolina",
            "numero": "8125",
            "complemento": "",
            "cep": "19060000",
            "bairro": "Jd Campo Belo",
            "cidade": "PRESIDENTE PRUDENTE",
            "uf": "SP",
            "ddd": "18",
            "telefone": "999999999",
            "nomeEntregador": "JOÃO"
      }
    },
    ...
  ]
}

Tipo de Retorno de Falha

application/json, text/json

Modelo

Nome	Descrição	Tipo	Formatação	Informações Adicionais
title	String	String	-	Não nulo
errors	Lista de erros	Array<String>	-	Não nulo Vazia

Lista de erros

Status Code	Titulo	Erros	Motivo
400	Dados de autenticação inválidos	-	Chave, chave de usuário, CNPJ empresa com formatação inválida
400	Dados do filtro inválidos	-	Data inicial, data final, CNPJ empresa com formatação inválida
400	Chave do parceiro não localizada	-	-
400	Parceiro inativo	-	-
400	Chave do usuário não localizada	-	-
400	Chave do usuário sem acesso à empresa solicitada	-	-
400	Data inicial superior a data final	-	-
400	Intervalo de dias solicitados é superior a 1 dias	-	-

Exemplo de falha

statusCode 400

{
  "title": "Chave do parceiro não localizado.",
  "errors": []
}

statusCode 500

{
  "title": "Internal Server Error"
  "errors": []
}

Manual de integração via API Nimbus - Parceiros Imprimir

Artigos relacionados