Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação da conta a pagar
formatostringobrigatórioFormato do retorno (json)

​
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 pagar (2)
retorno.conta.idint-obrigatórioID da conta a pagar
retorno.conta.datadate10obrigatórioData de emissão (dd/mm/yyyy)
retorno.conta.vencimentodate10obrigatórioData de vencimento (dd/mm/yyyy)
retorno.conta.valordecimal-obrigatórioValor da conta
retorno.conta.saldodecimal-obrigatórioSaldo da conta
retorno.conta.nro_documentostring30opcionalNúmero do documento
retorno.conta.competenciadate7opcionalCompetência da conta
retorno.conta.historicostring300opcionalHistórico da conta
retorno.conta.categoriastring100opcionalCategoria da conta
retorno.conta.situacaostring50opcionalSituação (aberto/pago/cancelada/parcial)
retorno.conta.ocorrenciastring1obrigatórioTipo: U/P/W/M/T/S/A (3)
retorno.conta.dia_vencimentoint2opcionalDia de vencimento (4)
retorno.conta.numero_parcelasint3opcionalNúmero de parcelas
retorno.conta.dia_semana_vencimentoint1opcionalDia semanal (0-6) (5)
retorno.conta.clienteobject-obrigatórioDados do cliente
retorno.conta.cliente.codigostring30opcionalCódigo do cliente
retorno.conta.cliente.nomestring50obrigatórioNome do cliente
retorno.conta.cliente.tipo_pessoastring1opcionalTipo (F/J/E)
retorno.conta.cliente.cpf_cnpjstring18opcionalCPF ou CNPJ
retorno.conta.cliente.iestring18opcionalInscrição estadual
retorno.conta.cliente.rgstring10opcionalRG
retorno.conta.cliente.enderecostring50opcionalEndereço
retorno.conta.cliente.numerostring10opcionalNúmero do endereço
retorno.conta.cliente.complementostring50opcionalComplemento
retorno.conta.cliente.bairrostring30opcionalBairro
retorno.conta.cliente.cepstring10opcionalCEP
retorno.conta.cliente.cidadestring30opcionalCidade
retorno.conta.cliente.ufstring2opcionalUF
retorno.conta.cliente.paisstring50opcionalPaís
retorno.conta.cliente.fonestring40opcionalTelefone
retorno.conta.cliente.emailstring50opcionalEmail
(1) Erros e código de erro aparecem apenas quando status for “Erro”
(2) Dados da conta aparecem apenas quando status for “OK”
(3) Ocorrência: U (única), P (parcelada), W (semanal), M (mensal), T (trimestral), S (semestral), A (anual)
(4) Campo dia_vencimento é obrigatório quando ocorrência for “M” (mensal) ou “P” (parcelada)
(5) Campo dia_semana_vencimento retorna apenas quando ocorrência for “W” (semanal), com valores 0-6 representando domingo a sábado

​
Exemplo de chamada

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

​
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 pagar 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",
      "competencia": "10/2016",
      "cliente": {
        "codigo": "",
        "nome": "Henrique Teste 4100",
        "tipo_pessoa": "J",
        "cpf_cnpj": "54.544.826/0001-40",
        "ie": "ISENTO",
        "rg": "",
        "endereco": "afdsafsd",
        "numero": "2123",
        "complemento": "213213",
        "bairro": "bababa",
        "cep": "15.200-000",
        "cidade": "José Bonifácio",
        "uf": "SP",
        "pais": null,
        "fone": "",
        "email": ""
      },
      "historico": "historico - mensal - henrique teste 4100",
      "categoria": "Telecomunicação, internet",
      "situacao": "aberto",
      "ocorrencia": "M",
      "dia_vencimento": "28"
    }
  }
}

​
Observações

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