GET /contaspagar – Bling!

A API V3 JÁ ESTÁ DISPONÍVEL

A API v2 foi descontinuada e não receberá mais atualizações.

Acesse a documentação da API v3

Info- icon-P.png As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente.
Realize a migração para a nova versão o mais breve possível. Consulte o calendário

Busca todas as contas a pagar

Recupera todas as contas a pagar cadastradas no sistema. Para mais informações, vide exemplo de retorno abaixo.

curl

curl -X GET "https://bling.com.br/b/Api/v2/contaspagar/json/"
     -G
     -d "apikey={apikey}"

PHP

$apikey = "{apikey}";
$orderNumber = 12;
$outputType = "json";
$url = 'https://bling.com.br/Api/v2/contaspagar/ . $outputType;
$retorno = executeGetOrder($url, $apikey);
echo $retorno;
function executeGetOrder($url, $apikey){
    $curl_handle = curl_init();
    curl_setopt($curl_handle, CURLOPT_URL, $url . '&apikey=' . $apikey);
    curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, TRUE);
    $response = curl_exec($curl_handle);
    curl_close($curl_handle);
    return $response;
}

C#

public static void ExecuteGetOrder() {
    var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/contaspagar/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

Alias	Descrição
`pago`	Paga
`cancelada`	Cancelada
`aberto`	Aberta
`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 pagar no intercalo especificado	date (dd/mm/YYYY)	TO
`dataVencimento`	Filtra por data de alteração da conta a pagar no intervalo especificado	date (dd/mm/YYYY HH:ii:ss)	TO
`situacao`	Filtra pela situação da conta a pagar	string (segundo tabela de situações acima)
`cnpj`	Filtra pelo cnpj do fornecedor	string (00.000.000/0000-00 com caracteres obrigatórios)

curl -X GET "https://bling.com.br/b/Api/v2/contaspagar/json/"
     -G
     -d "filters=dataEmissao[12/12/2013 TO 05/02/2014]; situacao[aberto]"
     -d "apikey={apikey}"

Retorno

Em caso de sucesso, retornará todas as contas a pagar 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": {
          "contaspagar": [{
               "contapagar": {
                    "id": 12345678,
                    "situacao": "aberto", 
                    "dataEmissao": "2017-04-13",
                    "vencimentoOriginal": "2017-04-20",
                    "vencimento": "2017-04-20",
                    "competencia":"2017-04-01",
                    "nroDocumento": "0123456",
                    "valor": 15.00,
                    "saldo": 0.00,
                    "historico": "Boleto referente nf 01",  
                    "categoria": "Vendas",
                    "portador": "CEF",
                    "pagamento": {
                         "totalPago": 15.00,
                         "totalJuro": 0,
                         "totalDesconto": 0,
                         "totalAcrescimo": 0,
                         "totalTarifa": 0,
                         "data": "2017-04-20"
                    },
                    "ocorrencia": "Unica",
                    "fornecedor": {
                        "nome": "Organisys Software",
                        "cpf_cnpj": "00.000.000/0000-1",
                        "ie_rg": "0000000000",
                        "endereco": "Rua Visconde de São Gabriel",
                        "numero": "000",
                        "complemento": "Sala 000",
                        "cidade": "Bento Gonçalves",
                        "bairro": "Cidade Alta",
                        "cep": "95.700-000",
                        "uf": "RS",
                        "email": "teste@organisys.com.br"
                    },
               }
          }]
     }
}