Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/contas.pagar.pesquisa.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
nome_clientestringopcionalNome do cliente (1)
numero_docstringopcionalNúmero do documento (1)
data_ini_emissaostringopcionalData inicial de emissão (formato dd/mm/yyyy) (1)
data_fim_emissaostringopcionalData final de emissão (formato dd/mm/yyyy) (1)
data_ini_vencimentostringopcionalData inicial de vencimento (formato dd/mm/yyyy) (1)
data_fim_vencimentostringopcionalData final de vencimento (formato dd/mm/yyyy) (1)
situacaostringopcionalSituação das contas (aberto, pago, cancelada, parcial) (1)
paginaintopcionalNúmero da página (padrão: 1; 100 registros/página)
(1) Ao menos um parâmetro entre nome_cliente, numero_doc e datas deve ser informado.

​
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”
retorno.erros[]list-condicionalLista dos erros encontrados [0..n]
retorno.erros[].errostring-condicionalDescrição do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioNúmero de páginas do retorno
retorno.contas[]list-condicionalLista de resultados da pesquisa
retorno.contas[].conta.idint-condicionalIdentificação da conta
retorno.contas[].conta.nome_clientestring100condicionalNome do cliente
retorno.contas[].conta.historicostring300condicionalHistórico da conta a pagar
retorno.contas[].conta.numero_docstring20condicionalNúmero do documento
retorno.contas[].conta.data_vencimentodate10condicionalData de vencimento (dd/mm/yyyy)
retorno.contas[].conta.data_emissaodate10condicionalData de emissão (dd/mm/yyyy)
retorno.contas[].conta.valordecimal-condicionalValor da conta
retorno.contas[].conta.saldodecimal-condicionalSaldo da conta
retorno.contas[].conta.situacaostring30condicionalSituação (pago, cancelado, aberto, parcial)

​
Observações

  • Por padrão, 100 registros são listados por página
  • Utilize o parâmetro “pagina” para navegar entre páginas
  • Datas utilizam formato dd/mm/yyyy (exemplo: “01/01/2012”)
  • Valores decimais usam ”.” (ponto) como separador (exemplo: “5.25”)

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/contas.pagar.pesquisa.php \
  -d "token=SEU_TOKEN&formato=json&nome_cliente=henrique teste&numero_doc=000453/01"

​
Exemplos de retorno

​
Erro - Token inválido

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

​
Erro - Consulta sem registros

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 20,
    "erros": [
      {
        "erro": "A Consulta não retornou registros"
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": 1,
    "numero_paginas": 1,
    "contas": [
      {
        "id": "5489125",
        "nome_cliente": "henrique teste 2",
        "historico": "Ref. a NF número 000453, henrique teste 2 (parcela 1/1)",
        "numero_doc": "000453/01",
        "data_vencimento": "08/07/2015",
        "data_emissao": "10/07/2015",
        "valor": "6.00",
        "saldo": "1.00",
        "situacao": "parcial"
      }
    ]
  }
}