A API V3 JÁ ESTÁ DISPONÍVEL
|
Busca todas as contas a receber
Recupera todas as contas a receber cadastradas no sistema. Para mais informações, vide exemplo de retorno abaixo.
curl |
curl -X GET "https://bling.com.br/b/Api/v2/contasreceber/json/" |
PHP |
$apikey = "{apikey}"; |
C# |
public static void ExecuteGetOrder() { var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/contasreceber/json&apikey={apikey}"); request.ContentType = "application/json"; request.Method = "GET"; using (HttpWebResponse response = request.GetResponse() as HttpWebResponse) { if (response.StatusCode != HttpStatusCode.OK) Console.Out.WriteLine("Error. Server returned status code: {0}", response.StatusCode); using (StreamReader reader = new StreamReader(response.GetResponseStream())) { var content = reader.ReadToEnd(); if(string.IsNullOrWhiteSpace(content)) Console.Out.WriteLine("Empty Response"); else Console.Out.WriteLine("Response Body: \r\n {0}", content); } } } |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
Situações da conta a receber
Alias | Descrição |
pago |
Paga |
cancelada |
Cancelada |
aberto |
Em aberto |
parcial |
Parcial |
Filtros
Pode-se utilizar filtros para restringir o retorno de dados. Observe a tabela de possíveis filtros abaixo.
Filtro | Descrição | Tipo | Predicate |
dataEmissao |
Filtra por data de emissão da conta a receber no intervalo especificado | date (dd/mm/YYYY) | TO |
dataVencimento |
Filtra por data de vencimento da conta a receber no intervalo especificado | date (dd/mm/YYYY HH:ii:ss) | TO |
situacao |
Filtra pela situação da conta a receber | string (segundo tabela de situações acima) | |
cnpj |
Filtra pelo cnpj do cliente | string (00.000.000/0000-00 com caracteres obrigatórios) | |
dataPagamento |
Filtra por data de pagamento da conta a receber no intervalo especificado | date (dd/mm/YYYY) | TO |
curl -X GET "https://bling.com.br/b/Api/v2/contasreceber/json/"
-G
-d "filters=dataEmissao[01/01/2016 TO 05/02/2017]; situacao[aberto]"
-d "apikey={apikey}"
Retorno
Em caso de sucesso, retornará todas as contas a receber registradas, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Exemplo de retorno
{ "retorno":{ "contasreceber":[ { "contareceber":{ "id":"13123121",
"situacao": "aberto", "dataEmissao":"2017-03-09", "vencimentoOriginal":"2017-03-09", "vencimento":"2017-03-09",
"competencia":"2017-03-01", "nroDocumento":"0123456", "valor":15.00, "saldo":0.00, "historico":"Referente ao pedido de venda nº 423", "categoria":"Vendas", "idFormaPagamento": "123", "portador":"CEF", "nroNoBanco":"00100358-56", "vendedor":"Vendedor exemplo", "pagamento": { "totalPago": 15.00, "totalJuro": 0, "totalDesconto": 0, "totalAcrescimo": 0, "totalTarifa": 0, "data": "2017-03-09" }, "ocorrencia":"Unica", "linkBoleto":"https://www.bling.com.br/doc.view.php?132", "cliente":{ "nome":"Organisys Software", "cpf_cnpj":"00.000.000/0000-1", "tipoPessoa":"J", "ie_rg":"0000000000", "endereco":"Rua Barão do Rio Branco", "numero":"000", "complemento":"Sala 000", "cidade":"Bento Gonçalves", "bairro":"Centro", "cep":"00.000-000", "uf":"RS", "email":"teste@organisys.com.br" } } } ] } }