Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/conta.receber.obter.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação da conta a receber
formatostringobrigatórioFormato do retorno (json)
obter_link_boletostringopcionalObter link do boleto para impressão (S/N)

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro” (1)
retorno.erros[]list-condicionalLista dos erros encontrados [0..n] (1)
retorno.erros[].errostring-condicionalDescrição do erro (1)
retorno.contaobject-condicionalDados da conta a receber (2)
retorno.conta.idint-condicionalID da conta a receber
retorno.conta.datadate10condicionalData de emissão (dd/mm/yyyy)
retorno.conta.vencimentodate10condicionalVencimento (dd/mm/yyyy)
retorno.conta.valordecimal-condicionalValor da conta
retorno.conta.saldodecimal-condicionalSaldo da conta
retorno.conta.link_boletostring-condicionalLink para impressão do boleto (3)
retorno.conta.nro_documentostring30condicionalNúmero do documento
retorno.conta.serie_documentoint1condicionalSérie do documento
retorno.conta.competenciadate7condicionalCompetência (mm/yyyy)
retorno.conta.ocorrenciastring-condicionalU/P/W/M/T/S/A (4)
retorno.conta.situacaostring50condicionalaberto, pago, cancelada, parcial
retorno.conta.liquidacaodate10condicionalData de recebimento
retorno.conta.numero_parcelasint3condicionalNúmero de parcelas
retorno.conta.dia_vencimentoint-condicionalDia do vencimento (5)
retorno.conta.historicostring300condicionalHistórico da conta
retorno.conta.categoriastring100condicionalNome da categoria
retorno.conta.portadorstring100condicionalNome do portador
retorno.conta.clienteobject-condicionalDados do cliente
retorno.conta.cliente.codigostring30condicionalCódigo do cliente
retorno.conta.cliente.nomestring50condicionalNome do cliente
retorno.conta.cliente.tipo_pessoastring1condicionalF/J/E
retorno.conta.cliente.cpf_cnpjstring18condicionalCPF ou CNPJ
retorno.conta.cliente.enderecostring50condicionalEndereço
retorno.conta.cliente.numerostring10condicionalNúmero
retorno.conta.cliente.complementostring50condicionalComplemento
retorno.conta.cliente.bairrostring30condicionalBairro
retorno.conta.cliente.cepstring10condicionalCEP
retorno.conta.cliente.cidadestring30condicionalCidade
retorno.conta.cliente.ufstring2condicionalUF
retorno.conta.cliente.fonestring40condicionalTelefone
retorno.conta.cliente.emailstring50condicionalE-mail
(1) Erros e código de erro aparecem apenas quando status for “Erro”
(2) Dados da conta aparecem apenas quando status for “OK”
(3) Campo link_boleto requer parâmetro obter_link_boleto=S
(4) Ocorrência: U (única), P (parcelada), W (semanal), M (mensal), T (trimestral), S (semestral), A (anual)
(5) Campo dia_vencimento obrigatório quando ocorrência é “M” (mensal) ou “P” (parcelada)

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/conta.receber.obter.php \
  -d "token=SEU_TOKEN&id=12341234&formato=json&obter_link_boleto=S"

​
Exemplos de retorno

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Conta não localizada

{
  "retorno": {
    "status_processamento": "2",
    "status": "Erro",
    "codigo_erro": "32",
    "erros": [
      {
        "erro": "Conta a receber não localizada"
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": "3",
    "status": "OK",
    "conta": {
      "id": "433224432",
      "data": "25/11/2015",
      "vencimento": "28/10/2016",
      "valor": "6565.00",
      "nro_documento": "000065205",
      "serie_documento": "0",
      "competencia": "10/2016",
      "cliente": {
        "nome": "Henrique Teste 4100",
        "cpf_cnpj": "54.544.826/0001-40",
        "endereco": "afdsafsd",
        "numero": "2123",
        "bairro": "bababa",
        "cep": "15.200-000",
        "cidade": "José Bonifácio",
        "uf": "SP"
      },
      "historico": "historico - mensal",
      "categoria": "Telecomunicação, internet",
      "portador": "HSBC",
      "situacao": "aberto",
      "ocorrencia": "M",
      "dia_vencimento": "28"
    }
  }
}

​
Observações

  • Datas utilizam formato dd/mm/yyyy
  • Valores decimais usam ”.” (ponto) como separador