API

Boleto Bancário

Exibir

Retorna informações de um boleto bancário.

GET /bank_billets/#{id}.#{format}

 
$ curl -i -u $TOKEN:X -X GET \
https://app.cobregratis.com.br/bank_billets/1873.xml

HTTP/1.1 200 OK
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/xml; charset=utf-8
...

<?xml version="1.0" encoding="UTF-8"?>
<bank-billet>
  <address>Rua Teodoro da Fonseca</address>
  <city>Niteroi</city>
  <cnpj-cpf>99.999.999/0001-99</cnpj-cpf>
  <created-by-api type="boolean">false</created-by-api>
  <name>Nome do Sacado</name>
  <created-at type="datetime">2010-09-26T03:58:11Z</created-at>
  <query-string nil="true"></query-string>
  <comments nil="true"></comments>
  <guarantor></guarantor>
  <line>35691.33147 00338.050008 00000.002063 1 45500000001000</line>
  <paid-amount type="float" nil="true"></paid-amount>
  <percent-fines></percent-fines>
  <quantity nil="true"></quantity>
  <acceptance nil="true"></acceptance>
  <deleted-at type="datetime" nil="true"></deleted-at>
  <generated-at type="datetime">2010-09-25T23:58:18Z</generated-at>
  <our-number-prefix></our-number-prefix>
  <pdf-created-at type="datetime" nil="true"></pdf-created-at>
  <updated-at type="datetime">2010-10-24T16:04:36Z</updated-at>
  <zipcode nil="true"></zipcode>
  <account-id type="integer">7</account-id>
  <amount type="float">10.0</amount>
  <discount-amount></discount-amount>
  <document-number>1</document-number>
  <decimal-character>,</decimal-character>
  <email-sent-at type="datetime" nil="true"></email-sent-at>
  <hashcode>35cfd0353282daa5db2ca3d0cc76f43d3cc4ec7a</hashcode>
  <html-state type="integer">1</html-state>
  <id type="integer">1873</id>
  <meta type="binary" encoding="base64" nil="true"></meta>
  <percent-interest-day></percent-interest-day>
  <service-id type="integer">12</service-id>
  <html-delayed-at type="datetime" nil="true"></html-delayed-at>
  <our-number>0000000000206</our-number>
  <pdf-state type="integer" nil="true"></pdf-state>
  <document-date type="date">2010-02-11</document-date>
  <due-date-business-day></due-date-business-day>
  <neighborhood>Centro</neighborhood>
  <currency>R$</currency>
  <description>Demostrativo do boleto</description>
  <document-amount>10</document-amount>
  <document-type nil="true"></document-type>
  <paid-at type="date" nil="true"></paid-at>
  <instructions></instructions>
  <pdf-delayed-at type="datetime" nil="true"></pdf-delayed-at>
  <status>o</status>
  <bank-billet-account-id type="integer">1</bank-billet-account-id>
  <expire-at type="date">2010-03-23</expire-at>
  <html-created-at type="datetime">2010-10-24T16:04:36Z</html-created-at>
  <other-amount-to-add></other-amount-to-add>
  <state>RJ</state>
  <thousand-character>.</thousand-character>
  <external-link>https://app.cobregratis.com.br/boleto/35cfd...4ec7a</external-link>
</bank-billet>

Listar

Retorna a listagem paginada de boletos.

GET /bank_billets.#{format}?page=#{page}

$ curl -i -u $TOKEN:X -X GET \
https://app.cobregratis.com.br/bank_billets.xml?page=1

HTTP/1.1 200 OK
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/xml; charset=utf-8
...

<?xml version="1.0" encoding="UTF-8"?>
<bank-billets>
  <bank-billet>
    ...
  </bank-billet>
  <bank-billet>
    ...
  </bank-billet>
</bank-billets>

Criar

Cria um novo boleto bancário.

POST /bank_billets.#{format}

Atualizar

Atualiza dados de um boleto bancário.

Somente para boletos em rascunho.

PUT /bank_billets/#{id}.#{format}

Excluir

Exclui um boleto bancário.

DELETE /bank_billets/#{id}.#{format}