API para integração com o Bluesoft ERP

O Bluesoft ERP conta com uma API REST pronta para nossos clientes que queiram fazer integração de algum sistema interno com nossas funcionalidades.

Toda a documentação e funcionalidades disponíveis para integração estão em: erp.bluesoft.com.br/api/

A segurança dessa API é feita através de um token que pode ser obtido em: Administração > Segurança > Usuário

 

Esse token deve ser passado no Header da Request. Segue um exemplo de como poderíamos consultar os clientes cadastrados no ERP utilizando jQuery.

var securedToken = '<token-gerado-na-tela-de-usuario>';

$.ajax({
  url: '<tenant>/api/clientes',
  type: 'GET',
  headers: {
    'x-CustomToken':securedToken,
    'Content-Type':'application/json'
  }
}).done(function(result) {
    
    var clientes = result.data;
    //Utilize esses dados em seu sistema
})
.fail(function(result) {
    alert('Não foi possível obter os clientes');
});

API de inclusão de Clientes (POST)

Os campos que deverão ser informados são:

  • “nomeRazao”: “string”,          DATA_TYPE= VARCHAR2(60 BYTE)
  • “cpfCnpj”: “string”,                 DATA_TYPE= NUMBER(15,0)
  • “nomeAbreviado”: “string”,  DATA_TYPE= VARCHAR2(20 BYTE)
  • “rua”: “string”,                         DATA_TYPE= VARCHAR2(255 BYTE)
  • “numero”: “string”,                 DATA_TYPE= VARCHAR2(10 BYTE)
  • “cep”: “string”,                         DATA_TYPE= NUMBER(8,0)
  • “cidade”: “string”,                   DATA_TYPE= VARCHAR2(40 BYTE)
  • “bairro”: “string”,                    DATA_TYPE= VARCHAR2(60 BYTE)
  • “uf”: “string”                             DATA_TYPE=  VARCHAR2(2 BYTE)
  • “estadoCivil”: “string”,           (SOLTEIRO, CASADO,VIUVO, SEPARADO, DIVORCIADO)
  • “sexo”: “string”,                       (M, F)
  • “dataNascimento”: “string”,  DATA_TYPE= DATE
  • “complemento”: “string”,      DATA_TYPE= VARCHAR2(60 BYTE)
  • “dataCadastro”: “string”,       DATA_TYPE= DATE
  • “tipoContato”: “string”,         (TELEFONE_COMERCIAL, TELEFONE_RESIDENCIAL, CELULAR_PARTICULAR, CELULAR_EMPRESA, FAX, SITE, EMAIL_COMERCIAL, EMAIL_PARTICULAR,EMAIL_COBRANCA, TELEFONE_COBRANCA, FAX_COBRANCA, RADIO_NEXTEL, EMAIL_NOTA_FISCAL_ELETRONICA, EMAIL_EDI, EMAIL_NOTA_FISCAL_DE_SERVICO_ELETRONICA, EMAIL_ECOMMERCE, TELEFONE_ECOMMERCE, TELEFONE_REFERENCIA)
  • “valor”:                                      DATA_TYPE= VARCHAR2(20 BYTE)

 

Para a API de inclusão de Fornecedores (POST)

Os campos que deverão ser informados são:

  • “nomeRazao”: “string”,          DATA_TYPE= VARCHAR2(60 BYTE)
  • “cpfCnpj”: “string”,                 DATA_TYPE= NUMBER(15,0)
  • “nomeAbreviado”: “string”,    DATA_TYPE= VARCHAR2(20 BYTE)
  • “rua”: “string”,                        DATA_TYPE= VARCHAR2(255 BYTE)
  • “numero”: “string”,                 DATA_TYPE= VARCHAR2(10 BYTE)
  • “cep”: “string”,                       DATA_TYPE= NUMBER(8,0)
  • “cidade”: “string”,                  DATA_TYPE= VARCHAR2(40 BYTE)
  • “bairro”: “string”,                   DATA_TYPE= VARCHAR2(60 BYTE)
  • “uf”: “string”                          DATA_TYPE=  VARCHAR2(2 BYTE)

API de inclusão de Contratos Financeiro (POST)

 

 

Os campos que deverão ser informados são:

  • “especie”: “string”,                                   (COBRANCA/PAGAMENTO)
  • “cpfCnpj”: “string”,                                   DATA_TYPE= NUMBER(15,0)
  • “lojaKey”: 0,                                              DATA_TYPE= NUMBER(6,0)
  • “descritivo”: “string”,                                DATA_TYPE= VARCHAR2(500 BYTE)
  • “dataVigenciaInicial”: “string”,                  DATA_TYPE= DATE
  • “dataVigenciaFinal”: “string”,                   DATA_TYPE= DATE
  • “contaContabilOrigemKey”: 0,                 DATA_TYPE= NUMBER(9,0)
  • “contaContabilDestinoKey”: 0,                 DATA_TYPE= NUMBER(9,0)
  • “valorMaximo”: 0                                      DATA_TYPE= NUMBER(12,2)

API de inclusão de Duplicatas de Migração, duplicatas que não geram contabilização (POST)

Os campos que deverão ser informados são:

  • “especie”: “string”,                                 (COBRANCA/PAGAMENTO)
  • “cpfCnpj”: “string”,                                 DATA_TYPE= NUMBER(15,0)
  • “lojaKey”: 0,                                            DATA_TYPE= NUMBER(6,0)
  • “descritivo”: “string”,                              DATA_TYPE= VARCHAR2(500 BYTE)
  • “dataVencimento”: “string”,                    DATA_TYPE= DATE
  • “valorNominal”: 0,                                   DATA_TYPE= NUMBER(11,2)
  • “numeroDocumento”: “string”,               DATA_TYPE= NUMBER(14,0)
  • “nossoNumero”: “string”,                       DATA_TYPE= VARCHAR2(50 BYTE)
  • “codigoBarras”: “string”                         DATA_TYPE= VARCHAR2(44 BYTE)

 

API de inclusão de Duplicatas (POST)

Os campos que deverão ser informados são:

  • “especie”: “string”,                                 (COBRANCA/PAGAMENTO)
  • “cpfCnpj”: “string”,                                 DATA_TYPE= NUMBER(15,0)
  • “lojaKey”: 0,                                            DATA_TYPE= NUMBER(6,0)
  • “descritivo”: “string”,                              DATA_TYPE= VARCHAR2(500 BYTE)
  • “dataVencimento”: “string”,                    DATA_TYPE= DATE
  • “valorNominal”: 0,                                   DATA_TYPE= NUMBER(11,2)
  • “numeroDocumento”: “string”,               DATA_TYPE= NUMBER(14,0)
  • “nossoNumero”: “string”,                       DATA_TYPE= VARCHAR2(50 BYTE)
  • “codigoBarras”: “string”                         DATA_TYPE= VARCHAR2(44 BYTE)

API de quitação de Duplicatas (POST)

Os campos que deverão ser informados são:

  • “dataPagamento”: “string”,                        DATA_TYPE= DATE
  • “duplicataFiltro”: {
  • “numeroDocumento”: 0,                             DATA_TYPE= NUMBER(14,0)
  • “cpfCnpjFavorecido”: “string”,                   DATA_TYPE= NUMBER(15,0)
  • “parcela”: 0,                                                DATA_TYPE= NUMBER(3,0)
  • “totalParcelas”: 0,                                       DATA_TYPE= NUMBER(3,0)
  • “valorNominal”: 0,                                       DATA_TYPE= NUMBER(11,2)
  • “dataEmissao”: “string”,                             DATA_TYPE= DATE
  • “dataVencimento”: “string”,                        DATA_TYPE= DATE
  • “numeroNotaFiscal”: 0,                               DATA_TYPE= NUMBER(14,0)
  • “cpfCnpjFornecedor”: “string”                    DATA_TYPE= NUMBER(15,0)

“pagamento”: {

“dinheiro”: 0,
“cheque”: {

  • “numeroCheque”: 0,                                   DATA_TYPE= NUMBER(6,0)
  • “numeroBanco”: 0,                                     DATA_TYPE= NUMBER(4,0)
  • “numeroConta”: 0,                                      DATA_TYPE= NUMBER(8,0)
  • “numeroAgencia”: 0,                                  DATA_TYPE=  NUMBER(6,0)
  • “cpfCnpj”: “string”,                                     DATA_TYPE= NUMBER(15,0)
  • “dataMovimento”: “string”,                        DATA_TYPE= DATE
  • “dataDeposito”: “string”,                            DATA_TYPE= DATE
  • “valor”: 0                                                     DATA_TYPE= NUMBER(11,2)
  • “contaBancaria”: {                                      DATA_TYPE= NUMBER(6,0)
  • “valor”: 0,                                                   DATA_TYPE= NUMBER(11,2)
  • “codigoBanco”: 0,                                     DATA_TYPE=  NUMBER(3,0)
  • “numeroConta”: 0,                                     DATA_TYPE= NUMBER(11,0)
  • “digitoConta”: 0,                                        DATA_TYPE= VARCHAR2(2 BYTE)
  • “numeroAgencia”: 0,                                  DATA_TYPE= NUMBER(5,0)
  • “digitoAgencia”: 0                                      DATA_TYPE= NUMBER(1,0)

 

Para os campos de valor utilizar ponto como separador ao invés de vírgula. Ex. 110.99 

ismael

Responder