×
Entrar
Experimente grátis
Top

GET/Contratos

  • Atualizado
Seguir

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 link-externo.png

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 link-externo.png

 

Através deste método é possível buscar todos os contratos cadastrados no sistema. Você pode definir se o output da requisição será no formato JSON ou XML.

Abaixo um exemplo de requisição utilizando a linguagem PHP.

$apikey = "{$apikey}";
$outputType = "json";
$url = 'https://bling.com.br/Api/v2/contratos/' . $outputType;
$result = executeGetContracts($url, $apikey);
echo $result;
function executeGetContracts($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;
}

 

Os filtros abaixo podem ser aplicados no método GET/Contratos

Filtro Descrição  Tipo Predicate
dataCriacao Filtra pela data de criação do contrato no intervalo especificado  DATE (dd/mm/YYYY) TO
dataBase Filtra pela data base do contrato no intervalo especificado  DATE (dd/mm/YYYY) TO
situacao Filtra pela situação do contrato STRING(1)  
idContato Filtra pelo contato INTEGER(20)  
idCliente Filtra pelo cliente INTEGER(20)  

 

Exemplo de retorno de sucesso

{
    "retorno": {
      "contratos": [
        {
          "contrato": {
             "id": "5885327928",
             "nome": "John Tester Testa",
             "descricao": "API POST TESTE 1999",
             "contatoDiferenteCobranca": "0",
             "numeroContrato": "777",
             "idCliente": "5885327927",
             "idContato": "5885327927",
             "situacao": "A",
             "dataCriacao": "2019-08-28",
             "valor": "105.95",
             "dataBase": "2019-08-30",
             "mesVencimento": "C",
             "diaVencimento": "5",
             "periodicidadeCobranca": "1",
             "emiteNota": "S",
             "tipoManutencao": "V",
             "idCategoria": "614413",
             "idPortador": "795094295",
             "desconto": "1.00",
             "mesFimDesconto": "10",
             "anoFimDesconto": "2018",
             "mesTermino": "12",
             "anoTermino": "2025",
             "idVendedor": "49585900",
             "nroParcelasVendedor": "5",
             "percentualVendedor": "4.00",
             "emiteOS": "S",
             "obs": "Apenas um teste",
             "dataUltimoPagamento": "",
             "opcoesNota": {
               "percentualISS": "11.00",
               "descISSTotalNota": "N",
               "descIRTotalNota": "S",
               "codListaServico": "0101",
               "idProdutoVinculado": "49002612",
               "mesNota": "C",
               "textoNota": "Observações da NF-e \/ Descrição do serviço da NFS-e",
               "naturezaOperacao": "Aluguel de outras maquinas e equipamentos 
comerciais",
               "cfop": ""
             },
             "nroContasEmAtraso": "0",
             "anexos": [
               {
                 "nome": "imagemteste.jpg",
                 "link": "aHR0cDovL3Rlc3RlMDUuczMuYW1hem9uYXdzLmNvbS9jMDBhYTE5OGE0OGM3YjQ4YmY4NDIwYWI3Yzk4MjM0MC81NTljMTQ3NDA5ODUzNDUyYTVhZjFhOWZiYjQxYTQ3MT9BV1NBY2Nlc3NLZXlJZD1BS0lBVENMTVNHRlhZWERUWE5HQSZFeHBpcmVzPTE1Njc2MzAyMTAmU2lnbmF0dXJlPUlUNzdkRTFTNVpjSTJCS3FNNjRCSUw0elBydyUzRA=="
               },
               {
                 "nome": "teste.txt",
                 "link": "aHR0cDovL3Rlc3RlMDUuczMuYW1hem9uYXdzLmNvbS9jMDBhYTE5OGE0OGM3YjQ4YmY4NDIwYWI3Yzk4MjM0MC8yN2I5NjZlYjViNGRkOGIxZWViOTMxNWEyNDljYTQwMT9BV1NBY2Nlc3NLZXlJZD1BS0lBVENMTVNHRlhZWERUWE5HQSZFeHBpcmVzPTE1Njc2MzAyMTAmU2lnbmF0dXJlPVY2UTg3SEIlMkJUWmwlMkY5b3NLMFNuUk1NZDd2Q28lM0Q="
               }
             ]
           }
         },{
           "contrato": {
             "id": "5885327938",
             "nome": "John Tester Testa",
             "descricao": "Teste 3 - contrato",
             "contatoDiferenteCobranca": "0",
             "numeroContrato": "777",
             "idCliente": "5885327927",
             "idContato": "5885327927",
             "situacao": "A",
             "dataCriacao": "2019-08-28",
             "valor": "105.95",
             "dataBase": "2019-08-30",
             "mesVencimento": "C",
             "diaVencimento": "5",
             "periodicidadeCobranca": "1",
             "emiteNota": "S",
             "tipoManutencao": "V",
             "idCategoria": "614413",
             "idPortador": "795094295",
             "desconto": "1.00",
             "mesFimDesconto": "10",
             "anoFimDesconto": "2018",
             "mesTermino": "12",
             "anoTermino": "2025",
             "idVendedor": "49585900",
             "nroParcelasVendedor": "5",
             "percentualVendedor": "4.00",
             "emiteOS": "S",
             "obs": "Observação interna do contrato, esta informação não será impressa",
             "dataUltimoPagamento": "",
             "opcoesNota": {
               "percentualISS": "11.00",
               "descISSTotalNota": "N",
               "descIRTotalNota": "S",
               "codListaServico": "0101",
               "idProdutoVinculado": "49002612",
               "mesNota": "C",
               "textoNota": "Observações da NF-e \/ Descrição do serviço da NFS-e",
               "naturezaOperacao": "Aluguel de outras maquinas e equipamentos comerciais",
               "cfop": ""
            },
            "nroContasEmAtraso": "0",
            "anexos": []
           }
         }
      ]
   }
}

 

Artigos relacionados