Endpoint
POST https://api.tiny.com.br/api2/contas.receber.pesquisa.php
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| formato | string | obrigatório | Formato do retorno (json) |
| nome_cliente | string | opcional | Nome do cliente (1) |
| numero_doc | string | opcional | Número do documento (1) |
| numero_banco | string | opcional | Número no banco (1) |
| data_ini_emissao | string | opcional | Data inicial de emissão (formato dd/mm/yyyy) (1) |
| data_fim_emissao | string | opcional | Data final de emissão (formato dd/mm/yyyy) (1) |
| data_ini_vencimento | string | opcional | Data inicial de vencimento (formato dd/mm/yyyy) (1) |
| data_fim_vencimento | string | opcional | Data final de vencimento (formato dd/mm/yyyy) (1) |
| situacao | string | opcional | Situação das contas (aberto, pago, cancelada, parcial) (1) |
| id_origem | string | opcional | Identificador do documento de origem (NF ou pedido) (1) |
| pagina | int | opcional | Número da página (padrão: 1; 100 registros/página) |
(1) Ao menos um parâmetro entre nome_cliente, numero_doc, numero_banco, datas, situacao ou id_origem deve ser informado.
Retorno
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela “Status de Processamento” |
| retorno.status | string | - | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Conforme tabela “Códigos de erro” |
| retorno.erros[] | list | - | condicional | Lista dos erros encontrados [0..n] |
| retorno.erros[].erro | string | - | condicional | Descrição do erro |
| retorno.pagina | int | - | obrigatório | Número da página retornada |
| retorno.numero_paginas | int | - | obrigatório | Quantidade total de páginas |
| retorno.contas[] | list | - | condicional | Lista de resultados da pesquisa |
| retorno.contas[].conta.id | int | - | condicional | Identificação da conta na Olist |
| retorno.contas[].conta.nome_cliente | string | 100 | condicional | Nome do cliente |
| retorno.contas[].conta.historico | string | 300 | condicional | Histórico da conta |
| retorno.contas[].conta.numero_banco | string | 20 | condicional | Número no banco |
| retorno.contas[].conta.numero_doc | string | 20 | condicional | Número do documento |
| retorno.contas[].conta.serie_doc | int | 1 | condicional | Série do documento |
| retorno.contas[].conta.data_vencimento | date | 10 | condicional | Data de vencimento (dd/mm/yyyy) |
| retorno.contas[].conta.data_emissao | date | 10 | condicional | Data de emissão (dd/mm/yyyy) |
| retorno.contas[].conta.valor | decimal | - | condicional | Valor da conta |
| retorno.contas[].conta.saldo | decimal | - | condicional | Saldo da conta |
| retorno.contas[].conta.situacao | string | 30 | condicional | Situaçã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.receber.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 - Nenhum registro encontrado
{
"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_banco": "175/00064619-3",
"numero_doc": "000453/01",
"serie_doc": "2",
"data_vencimento": "08/07/2015",
"data_emissao": "10/07/2015",
"valor": "6.00",
"saldo": "1.00",
"situacao": "parcial"
}
]
}
}