Pesquisar Contas a Receber API 2.0

Serviço destinado a consultar Contas a Receber.

REST

REST URL

Elemento	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
numero_doc ⁽¹⁾	string	opcional	Número do documento
numero_banco ⁽¹⁾	string	opcional	Número no banco
data_ini_emissao ⁽¹⁾	string	opcional	Data inicial das contas a receber que deseja consultar no formato dd/mm/yyyy
data_fim_emissao ⁽¹⁾	string	opcional	Data final das contas a receber que deseja consultar no formato dd/mm/yyyy
data_ini_vencimento ⁽¹⁾	string	opcional	Data inicial de vencimento das contas a receber que deseja consultar no formato dd/mm/yyyy
data_fim_vencimento ⁽¹⁾	string	opcional	Data final de vencimento das contas a receber que deseja consultar no formato dd/mm/yyyy
situacao ^{(1) (2)}	string	opcional	Situação das contas a receber
id_origem ⁽¹⁾	string	opcional	Identificador do documento de origem (nota fiscal ou pedido de venda) das contas a receber
pagina ⁽³⁾	int	opcional	Número da página

(1) - Ao menos um desses parâmetros deve ser informado.
(2) - Código da situação: aberto, pago, cancelada, parcial.
(3) - Numero da página que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.

Elemento	Tipo	Tamanho	Ocorrência	Descrição
retorno	-	-	obrigatório	Elemento raiz do retorno
retorno.status_processamento	int	-	obrigatório	Conforme tabela "Status de Processamento"
retorno.status	string	-	obrigatório	Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro ⁽¹⁾	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.erros[ ] ^{(1) (3)}	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.pagina	int	-	obrigatório	Número da página que está sendo retornada
retorno.numero_paginas	int	-	obrigatório	Número de paginas do retorno
retorno.contas[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.contas[ ].conta ⁽²⁾	object	-	obrigatório	Elemento utilizado para representar uma conta a receber.
retorno.contas[ ].conta.id	int	-	condicional	Número de identificação da conta a receber no Tiny
retorno.contas[ ].conta.nome_cliente	string	100	condicional	Nome do cliente
retorno.contas[ ].conta.historico	string	300	condicional	Histórico da conta a receber
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 da conta a receber
retorno.contas[ ].conta.data_emissao ⁽⁴⁾	date	10	condicional	Data de emissão da conta a receber
retorno.contas[ ].conta.valor ⁽⁵⁾	decimal	-	condicional	Valor da conta a receber
retorno.contas[ ].conta.saldo ⁽⁵⁾	decimal	-	condicional	Saldo da conta a receber
retorno.contas[ ].conta.situacao	string	30	condicional	Situação da conta a receber: pago, cancelado, aberto, parcial

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Estes campos utilizam o formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/contas.receber.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$nome_cliente = 'henrique teste';
$numero_doc = '000453/01';
$data = "token=$token&nome_cliente=$nome_cliente&numero_doc=$numero_doc&formato=JSON";

enviarREST($url, $data);    

function enviarREST($url, $data, $optional_headers = null) {
	$params = array('http' => array(
		'method' => 'POST',
	    'content' => $data
	));
	
	if ($optional_headers !== null) {
		$params['http']['header'] = $optional_headers;
	}
	
	$ctx = stream_context_create($params);
	$fp = @fopen($url, 'rb', false, $ctx);
	if (!$fp) {
		throw new Exception("Problema com $url, $php_errormsg");
	}
	$response = @stream_get_contents($fp);
	if ($response === false) {
		throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
	}
	
	return $response;
}

Pesquisar Contas a Receber API 2.0

Parâmetros do serviço

Retorno do serviço

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Atendimento

Localização