Class: BlingApi::Client

Inherits:
Ac::Base
  • Object
show all
Defined in:
lib/bling_api/client.rb

Constant Summary collapse

BASE_URL = 
"https://api.bling.com.br/Api/v3"
SAVE_RESPONSES = 
true

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, client_secret:, refresh_token: nil, access_token: nil, token_expires_at: nil) ⇒ Client

Returns a new instance of Client.



6
7
8
9
10
11
12
 
# File 'lib/bling_api/client.rb', line 6

def initialize(client_id:, client_secret:, refresh_token: nil, access_token: nil, token_expires_at: nil)
  @client_id = client_id
  @client_secret = client_secret
  @refresh_token = refresh_token
  @access_token = access_token
  @token_expires_at = token_expires_at
end

Instance Method Details

#authorize(code:) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/bling_api/client.rb', line 34

def authorize(code:)
  headers = {
    "Content-Type" => "application/x-www-form-urlencoded",
    "Authorization" => "Basic #{Base64.strict_encode64("#{@client_id}:#{@client_secret}")}"
  }
  body = "grant_type=authorization_code&code=#{code}"
  response = post("/oauth/token", body:, headers:, skip_authentication: true)
  @access_token = response.access_token
  @refresh_token = response.refresh_token
  @token_expires_at = Time.now + response.expires_in
end

#create_contact(nome:, pessoa_juridica:, numero_documento:, situacao:, codigo: nil, rg: nil, orgao_emissor: nil, id: nil, telefone: nil, celular: "", email: "", endereco: nil, endereco_cep: nil, endereco_bairro: nil, endereco_municipio: nil, endereco_uf: nil, endereco_numero: nil, endereco_complemento: nil, endereco_cob: nil, endereco_cob_cep: nil, endereco_cob_bairro: nil, endereco_cob_municipio: nil, endereco_cob_uf: nil, endereco_cob_numero: nil, endereco_cob_complemento: nil, cod_contribuinte: nil, ie: nil, fantasia: nil, limite_credito: nil, condicao_pagamento: nil, financeiro_categoria_id: nil, pais: nil, tipos_contato: nil, pessoas_contato: nil, vendedor: nil, dados_adicionais: nil) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/bling_api/client.rb', line 199

def create_contact(
  nome:,
  pessoa_juridica:,
  numero_documento:,
  situacao:,
  codigo: nil,
  rg: nil,
  orgao_emissor: nil,
  id: nil,
  telefone: nil,
  celular: "",
  email: "",
  endereco: nil,
  endereco_cep: nil,
  endereco_bairro: nil,
  endereco_municipio: nil,
  endereco_uf: nil,
  endereco_numero: nil,
  endereco_complemento: nil,
  endereco_cob: nil,
  endereco_cob_cep: nil,
  endereco_cob_bairro: nil,
  endereco_cob_municipio: nil,
  endereco_cob_uf: nil,
  endereco_cob_numero: nil,
  endereco_cob_complemento: nil,
  cod_contribuinte: nil,
  ie: nil,
  fantasia: nil,
  limite_credito: nil,
  condicao_pagamento: nil,
  financeiro_categoria_id: nil,
  pais: nil,
  tipos_contato: nil,
  pessoas_contato: nil,
  vendedor: nil,
  dados_adicionais: nil
)
  body = {
    nome: nome,
    tipo: pessoa_juridica ? "J" : "F",
    numeroDocumento: numero_documento,
    situacao: situacao,
    codigo: codigo,
    telefone: telefone.gsub(/^\+55/, ""),
    celular: celular.gsub(/^\+55/, ""),
    indicadorIe: cod_contribuinte,
    ie: ie,
    orgaoEmissor: orgao_emissor,
    rg: rg,
    fantasia: fantasia,
    email: email,
    vendedor: vendedor,
    dadosAdicionais: dados_adicionais,
    pais: pais,
    tiposContato: tipos_contato,
    pessoasContato: pessoas_contato,
    financeiro: {
      limite_credito: limite_credito,
      condicao_pagamento: condicao_pagamento,
      categoria: {
        id: financeiro_categoria_id
      }
    },
    endereco: {
      geral: {
        endereco: endereco,
        cep: endereco_cep,
        bairro: endereco_bairro,
        municipio: endereco_municipio,
        uf: endereco_uf,
        numero: endereco_numero,
        complemento: endereco_complemento
      },
      cobranca: {
        endereco: endereco_cob,
        cep: endereco_cob_cep,
        bairro: endereco_cob_bairro,
        municipio: endereco_cob_municipio,
        uf: endereco_cob_uf,
        numero: endereco_cob_numero,
        complemento: endereco_cob_complemento
      }
    }
  }
  post("/contatos", body: body, timeout: 30) { _1.data }
end

#create_nfe(data_operacao:, contato_numero_documento:, itens:, contato_nome: nil, contato_ie: nil, contato_rg: nil, contato_contribuinte: nil, contato_telefone: nil, contato_email: nil, contato_endereco: nil, contato_numero: nil, contato_complemento: nil, contato_bairro: nil, contato_cep: nil, contato_municipio: nil, contato_uf: nil, contato_pais: nil, pessoa_juridica: nil, tipo: nil, id_natureza_operacao: nil, id_loja: nil, numero_loja: nil, finalidade: nil, seguro: nil, despesas: nil, desconto: nil, observacoes: nil, parcelas: [], transporte: nil, intermediador_cnpj: nil, intermediador_nome_usuario: nil) ⇒ Object

Parameters:

  • itens (Array<BlingApi::Item>) —

    Array de objetos Item contendo codigo, id_produto, quantidade, valor, unidade, desconto, aliquota_ipi, descricao, descricao_detalhada, comissao_base, comissao_aliquota, comissao_valor

  • parcelas (Array<BlingApi::Installment>) (defaults to: []) —

    Array de objetos Installment contendo id_forma_pagamento, valor, data_vencimento, observacoes, id

  • transporte (<BlingApi::Shipment>) (defaults to: nil) —

    Objeto Shipment contendo valor_frete, frete_por_conta, quantidade_volumes, nome_transportadora, nome_etiqueta, endereco, numero, complemento, municipio, uf, bairro, cep, pais, nome_servico, codigo_rastreio



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/bling_api/client.rb', line 353

def create_nfe(
  data_operacao:,
  contato_numero_documento:,
  itens:,
  contato_nome: nil,
  contato_ie: nil,
  contato_rg: nil,
  contato_contribuinte: nil,
  contato_telefone: nil,
  contato_email: nil,
  contato_endereco: nil,
  contato_numero: nil,
  contato_complemento: nil,
  contato_bairro: nil,
  contato_cep: nil,
  contato_municipio: nil,
  contato_uf: nil,
  contato_pais: nil,
  pessoa_juridica: nil,
  tipo: nil,
  id_natureza_operacao: nil,
  id_loja: nil,
  numero_loja: nil,
  finalidade: nil,
  seguro: nil,
  despesas: nil,
  desconto: nil,
  observacoes: nil,
  parcelas: [],
  transporte: nil,
  intermediador_cnpj: nil,
  intermediador_nome_usuario: nil
)
  body = {
    dataOperacao: data_operacao,
    itens: itens.map(&:to_api_hash),
    contato: {
      nome: contato_nome,
      numeroDocumento: contato_numero_documento,
      tipoPessoa: pessoa_juridica ? "J" : "F",
      ie: contato_ie,
      rg: contato_rg,
      contribuinte: contato_contribuinte,
      telefone: contato_telefone,
      email: contato_email,
      endereco: {
        endereco: contato_endereco,
        numero: contato_numero,
        complemento: contato_complemento,
        bairro: contato_bairro,
        cep: contato_cep,
        municipio: contato_municipio,
        uf: contato_uf,
        pais: contato_pais
      }
    },
    tipo: tipo,
    naturezaOperacao: {
      id: id_natureza_operacao
    },
    loja: {
      id: id_loja,
      numero: numero_loja
    },
    finalidade: finalidade,
    seguro: seguro,
    despesas: despesas,
    desconto: desconto,
    observacoes: observacoes,
    parcelas: parcelas.map(&:to_api_hash),
    transporte: transporte&.to_api_hash,
    intermediador: {
      cnpj: intermediador_cnpj,
      nomeUsuario: intermediador_nome_usuario
    }
  }
  post("/nfe", body: body, timeout: 30)
end

#create_nfe_from_order(order_id) ⇒ Object 



342
343
344
 
# File 'lib/bling_api/client.rb', line 342

def create_nfe_from_order(order_id)
  post("/pedidos/vendas/#{order_id}/gerar-nfe", timeout: 30) { _1.data }
end

#create_order(data:, id_contato:, itens:, numero_venda: nil, numero_pedido: nil, id_loja: nil, id_vendedor: nil, pessoa_juridica: nil, numero_documento: nil, parcelas: [], id_categoria_receita: nil, observacoes: "", observacoes_internas: "", valor_desconto: 0, numero_pedido_compra: nil, transporte: nil) ⇒ Object

Parameters:

  • itens (Array<BlingApi::Item>) —

    Array de objetos Item contendo codigo, id_produto, quantidade, valor, unidade, desconto, aliquota_ipi, descricao, descricao_detalhada, comissao_base, comissao_aliquota, comissao_valor

  • parcelas (Array<BlingApi::Installment>) (defaults to: []) —

    Array de objetos Installment contendo id_forma_pagamento, valor, data_vencimento, observacoes, id

  • transporte (<BlingApi::Shipment>) (defaults to: nil) —

    Objeto Shipment contendo valor_frete, frete_por_conta, quantidade_volumes, nome_transportadora, nome_etiqueta, endereco, numero, complemento, municipio, uf, bairro, cep, pais, nome_servico, codigo_rastreio

  • numero_venda (defaults to: nil) —

    É o número do pedido de venda no Bling

  • numero_pedido (defaults to: nil) —

    É o número do pedido na loja virtual ou marketplace, exemplo: R123456



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/bling_api/client.rb', line 292

def create_order(
  data:,
  id_contato:,
  itens:,
  numero_venda: nil,
  numero_pedido: nil,
  id_loja: nil,
  id_vendedor: nil,
  pessoa_juridica: nil,
  numero_documento: nil,
  parcelas: [],
  id_categoria_receita: nil,
  observacoes: "",
  observacoes_internas: "",
  valor_desconto: 0,
  numero_pedido_compra: nil,
  transporte: nil
)
  body = {
    numero: numero_venda,
    numeroLoja: numero_pedido,
    data: data,
    loja: {
      id: id_loja
    },
    contato: {
      id: id_contato,
      tipoPessoa: pessoa_juridica ? "J" : "F",
      numeroDocumento: numero_documento
    },
    itens: itens.map(&:to_api_hash),
    vendedor: {
      id: id_vendedor
    },
    categoria: {
      id: id_categoria_receita
    },
    parcelas: parcelas.map(&:to_api_hash),
    transporte: transporte&.to_api_hash,
    desconto: {
      valor: valor_desconto,
      unidade: "REAL"
    },
    observacoes: observacoes,
    observacoesInternas: observacoes_internas,
    numeroPedidoCompra: numero_pedido_compra
  }
  post("/pedidos/vendas", body: body, timeout: 30) { _1.data }
end

#create_payments_to_receivable(vencimento:, valor:, contato_id:, forma_pagamento_id:, data_emissao:, numero_documento:, competencia:, historico:, portador_id:, categoria_id:, vendedor_id:, tipo_ocorrencia:) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/bling_api/client.rb', line 432

def create_payments_to_receivable(
   vencimento:,
   valor:,
   contato_id:,
   forma_pagamento_id:,
   data_emissao:,
   numero_documento:,
   competencia:,
   historico:,
   portador_id:,
   categoria_id:,
   vendedor_id:,
   tipo_ocorrencia:
)
  body = {
    vencimento: vencimento,
    valor: valor,
    contato: {
      id: contato_id
    },
    formaPagamento: {
      id: forma_pagamento_id
    },
    dataEmissao: data_emissao,
    numeroDocumento: numero_documento,
    competencia: competencia,
    historico: historico,
    portador: {
      id: portador_id
    },
    categoria: {
      id: categoria_id
    },
    vendedor: {
      id: vendedor_id
    },
    ocorrencia: {
      tipo: tipo_ocorrencia
    }
  }
  post("/contas/receber", body: body, timeout: 30) { _1.data }
end

#default_options ⇒ Object 



14
15
16
17
18
19
20
 
# File 'lib/bling_api/client.rb', line 14

def default_options
  super.deep_merge({
    headers: {
      "enable-jwt" => "1"
    }
  })
end

#find_contact_by_document_number(document_number) ⇒ Object 



157
158
159
 
# File 'lib/bling_api/client.rb', line 157

def find_contact_by_document_number(document_number)
  get("/contatos?numeroDocumento=#{document_number.gsub(/\D/, "")}", timeout: 30) { _1.data }
end

#find_product_by_sku(sku) ⇒ Object 



161
162
163
 
# File 'lib/bling_api/client.rb', line 161

def find_product_by_sku(sku)
  get("/produtos?codigo=#{sku}", timeout: 30) { _1.data }
end

#get_contact(id) ⇒ Object 



145
146
147
 
# File 'lib/bling_api/client.rb', line 145

def get_contact(id)
  get("/contatos/#{id}", timeout: 30) { _1.data }
end

#get_nfe(id) ⇒ Object 



346
347
348
 
# File 'lib/bling_api/client.rb', line 346

def get_nfe(id)
  get("/nfe/#{id}", timeout: 30) { _1.data }
end

#get_order(id) ⇒ Object 



141
142
143
 
# File 'lib/bling_api/client.rb', line 141

def get_order(id)
  get("/pedidos/vendas/#{id}", timeout: 30) { _1.data }
end

#get_payments_to_receivable(idContato: nil, pagina: 1, limite: 100, situacoes: [], tipoFiltroData: nil, dataInicial: nil, dataFinal: nil, idsCategorias: [], idPortador: nil, idFormaPagamento: nil, boletoGerado: nil) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/bling_api/client.rb', line 165

def get_payments_to_receivable(
  idContato: nil,
  pagina: 1,
  limite: 100,
  situacoes: [],
  tipoFiltroData: nil,
  dataInicial: nil,
  dataFinal: nil,
  idsCategorias: [],
  idPortador: nil,
  idFormaPagamento: nil,
  boletoGerado: nil
  )
  query = build_query(
    {
      idContato: idContato,
      pagina: pagina,
      limite: limite,
      tipoFiltroData: tipoFiltroData,
      dataInicial: dataInicial,
      dataFinal: dataFinal,
      idPortador: idPortador,
      idFormaPagamento: idFormaPagamento,
      boletoGerado: boletoGerado
    },
    {
      situacoes: situacoes,
      idsCategorias: idsCategorias
    }
  )

  get("/contas/receber?#{query}", timeout: 30) { _1.data }
end

#get_refresh_token ⇒ Object 



46
47
48
 
# File 'lib/bling_api/client.rb', line 46

def get_refresh_token
  @refresh_token
end

#get_seller(id) ⇒ Object 



149
150
151
 
# File 'lib/bling_api/client.rb', line 149

def get_seller(id)
  get("/vendedores/#{id}", timeout: 30) { _1.data }
end

#get_sellers(page, limit, situation) ⇒ Object 



153
154
155
 
# File 'lib/bling_api/client.rb', line 153

def get_sellers(page, limit, situation)
  get("/vendedores?pagina=#{page}&limite=#{limit}&situacaoContato=#{situation}", timeout: 30) { _1.data }
end

#refresh_token ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/bling_api/client.rb', line 22

def refresh_token
  headers = {
    "Content-Type" => "application/x-www-form-urlencoded",
    "Authorization" => "Basic #{Base64.strict_encode64("#{@client_id}:#{@client_secret}")}"
  }
  body = "grant_type=refresh_token&refresh_token=#{@refresh_token}"
  response = post("/oauth/token", body:, headers:, skip_authentication: true)
  @access_token = response.access_token
  @refresh_token = response.refresh_token
  @token_expires_at = Time.now + response.expires_in
end

#update_contact(id:, nome: nil, pessoa_juridica: nil, numero_documento: nil, situacao: nil, codigo: nil, rg: nil, orgao_emissor: nil, telefone: nil, celular: nil, email: nil, endereco: nil, endereco_cep: nil, endereco_bairro: nil, endereco_municipio: nil, endereco_uf: nil, endereco_numero: nil, endereco_complemento: nil, endereco_cob: nil, endereco_cob_cep: nil, endereco_cob_bairro: nil, endereco_cob_municipio: nil, endereco_cob_uf: nil, endereco_cob_numero: nil, endereco_cob_complemento: nil, cod_contribuinte: nil, ie: nil, fantasia: nil, limite_credito: nil, condicao_pagamento: nil, financeiro_categoria_id: nil, pais: nil, tipos_contato: nil, pessoas_contato: nil, id_vendedor: nil, dados_adicionais: nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/bling_api/client.rb', line 50

def update_contact(
  id:,
  nome: nil,
  pessoa_juridica: nil,
  numero_documento: nil,
  situacao: nil,
  codigo: nil,
  rg: nil,
  orgao_emissor: nil,
  telefone: nil,
  celular: nil,
  email: nil,
  endereco: nil,
  endereco_cep: nil,
  endereco_bairro: nil,
  endereco_municipio: nil,
  endereco_uf: nil,
  endereco_numero: nil,
  endereco_complemento: nil,
  endereco_cob: nil,
  endereco_cob_cep: nil,
  endereco_cob_bairro: nil,
  endereco_cob_municipio: nil,
  endereco_cob_uf: nil,
  endereco_cob_numero: nil,
  endereco_cob_complemento: nil,
  cod_contribuinte: nil,
  ie: nil,
  fantasia: nil,
  limite_credito: nil,
  condicao_pagamento: nil,
  financeiro_categoria_id: nil,
  pais: nil,
  tipos_contato: nil,
  pessoas_contato: nil,
  id_vendedor: nil,
  dados_adicionais: nil
)
  contact = get_contact(id).data
  body = {
    nome: nome || contact.nome,
    telefone: telefone ? telefone.gsub(/^\+55/, "") : contact.telefone,
    celular: celular ? celular.gsub(/^\+55/, "") : contact.celular,
    codigo: codigo || contact.codigo,
    tipo: pessoa_juridica ? pessoa_juridica ? "J" : "F" : contact.tipo,
    indicadorIe: cod_contribuinte || contact.indicadorIe,
    ie: ie || contact.ie,
    numeroDocumento: numero_documento || contact.numeroDocumento,
    orgaoEmissor: orgao_emissor || contact.orgaoEmissor,
    rg: rg || contact.rg,
    fantasia: fantasia || contact.fantasia,
    email: email || contact.email,
    situacao: situacao || contact.situacao,
    vendedor: {
      id: id_vendedor || contact.vendedor.id,
    },
    dadosAdicionais: dados_adicionais || contact.dadosAdicionais,
    pais: pais || contact.pais,
    tiposContato: tipos_contato || contact.tiposContato,
    pessoasContato: pessoas_contato || contact.pessoasContato,
    financeiro: {
      limite_credito: limite_credito || contact.financeiro.limiteCredito,
      condicao_pagamento: condicao_pagamento || contact.financeiro.condicaoPagamento,
      categoria: {
        id: financeiro_categoria_id || contact.financeiro.categoria.id
      }
    },
    endereco: {
      geral: {
        endereco: endereco || contact.endereco.geral.endereco,
        cep: endereco_cep || contact.endereco.geral.cep,
        bairro: endereco_bairro || contact.endereco.geral.bairro,
        municipio: endereco_municipio || contact.endereco.geral.municipio,
        uf: endereco_uf || contact.endereco.geral.uf,
        numero: endereco_numero || contact.endereco.geral.numero,
        complemento: endereco_complemento || contact.endereco.geral.complemento
      },
      cobranca: {
        endereco: endereco_cob || contact.endereco.geral.endereco,
        cep: endereco_cob_cep || contact.endereco.geral.cep,
        bairro: endereco_cob_bairro || contact.endereco.geral.bairro,
        municipio: endereco_cob_municipio || contact.endereco.geral.municipio,
        uf: endereco_cob_uf || contact.endereco.geral.uf,
        numero: endereco_cob_numero || contact.endereco.geral.numero,
        complemento: endereco_cob_complemento || contact.endereco.geral.complemento
      }
    }
  }
  put("/contatos/#{id}", body: body, timeout: 30)
end