Fechar
esqueci a minha senha
criar uma conta

Pesquisar Contas a Receber API 2.0

Serviço destinado a consultar Contas a Receber.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json ou xml)
nome_cliente (1)stringopcionalNome do cliente
numero_doc (1)stringopcionalNúmero do documento
numero_banco (1)stringopcionalNúmero no banco
data_ini_emissao (1)stringopcionalData inicial das contas a receber que deseja consultar no formato dd/mm/yyyy
data_fim_emissao (1)stringopcionalData final das contas a receber que deseja consultar no formato dd/mm/yyyy
data_ini_vencimento (1)stringopcionalData inicial de vencimento das contas a receber que deseja consultar no formato dd/mm/yyyy
data_fim_vencimento (1)stringopcionalData final de vencimento das contas a receber que deseja consultar no formato dd/mm/yyyy
situacao (1) (2)stringopcionalSituação das contas a receber
pagina (3)intopcionalNú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 50 registros por página), caso não seja informado o valor padrão é 1.

ElementoTipoTamanhoOcorrênciaDescrição
retorno--obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.paginaint-obrigatórioNúmero da página que está sendo retornada
retorno.numero_paginasint-obrigatórioNúmero de paginas do retorno
retorno.contas[ ] (2)list-condicionalLista de resultados da pesquisa
retorno.contas[ ].conta (2)object-obrigatórioElemento utilizado para representar uma conta a receber.
retorno.contas[ ].conta.idint-condicionalNúmero de identificação da conta a receber no Tiny
retorno.contas[ ].conta.nome_clientestring100condicionalNome do cliente
retorno.contas[ ].conta.historicostring300condicionalHistórico da conta a receber
retorno.contas[ ].conta.numero_bancostring20condicionalNúmero no banco
retorno.contas[ ].conta.numero_docstring20condicionalNúmero do documento
retorno.contas[ ].conta.serie_doc int1condicionalSérie do documento
retorno.contas[ ].conta.data_vencimento (4)date10condicionalData de vencimento da conta a receber
retorno.contas[ ].conta.data_emissao (4)date10condicionalData de emissão da conta a receber
retorno.contas[ ].conta.valor (5)decimal-condicionalValor da conta a receber
retorno.contas[ ].conta.saldo (5)decimal-condicionalSaldo da conta a receber
retorno.contas[ ].conta.situacaostring30condicionalSituaçã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".


$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=XML";

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;
}

$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("pesquisarContasReceberService", array('token' => 'xxxxx','nome_cliente'=>'henrique teste', 'numero_doc' => '000453/01', 'formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>1</status_processamento>
  <status>Erro</status>
  <codigo_erro>2</codigo_erro>
  <erros>
    <erro>token invalido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>2</status_processamento>
  <status>Erro</status>
  <codigo_erro>20</codigo_erro>
  <erros>
    <erro>A Consulta não retornou registros</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <pagina>1</pagina>
  <numero_paginas>1</numero_paginas>
  <contas>
    <id>5489125</id>
    <nome_cliente>henrique teste 2</nome_cliente>
    <historico>Ref. a NF nº 000453, henrique teste 2 (parcela 1/1)</historico>
    <numero_banco>175/00064619-3</numero_banco>
    <numero_doc>000453/01</numero_doc>
    <serie_doc>2</serie_doc>
    <data_vencimento>08/07/2015</data_vencimento>
    <data_emissao>10/07/2015</data_emissao>
    <valor>6.00</valor>
    <saldo>1.00</saldo>
    <situacao>parcial</situacao>
  </contas>
</retorno>