Obter Conta a Receber API 2.0

Serviço destinado a obtenção de Contas a Receber.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
id	inteiro	obrigatório	Número de identificação da conta a receber no Tiny
formato	string	obrigatório	Formato do retorno (json)
obter_link_boleto ⁽⁷⁾	string	opcional	Obter link do boleto para impressão

Elemento	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	Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro ⁽¹⁾	int	-	obrigatório	Conforme tabela "Códigos de erro"
retorno.erros[ ] ⁽¹⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.conta⁽²⁾	list	-	condicional	Elemento utilizado para representar uma conta a receber
retorno.conta.id	int	-	obrigatório	Número de identificação da conta a receber no Tiny
retorno.conta.data⁽³⁾	date	10	obrigatório	Data de emissão da conta a receber
retorno.conta.vencimento⁽³⁾	date	10	obrigatório	Vencimento da conta a receber
retorno.conta.valor⁽⁴⁾	decimal	-	obrigatório	Valor da conta a receber
retorno.conta.saldo⁽⁴⁾	decimal	-	obrigatório	Saldo da conta a receber
retorno.conta.link_boleto	string	-	opcional	Link do boleto para impressão. É necessário informar o parâmetro obter_link_boleto
retorno.conta.nro_documento	string	30	opcional	Número do documento
retorno.conta.serie_documento	int	1	opcional	Série do documento
retorno.conta.nro_banco	string	30	opcional	Número no banco
retorno.conta.competencia⁽⁸⁾	date	7	opcional	Competência da conta a receber
retorno.conta.cliente	object		obrigatório	Elemento utilizado para representar o cliente
retorno.conta.cliente.codigo	string	30	opcional	Código do cliente
retorno.conta.cliente.nome	string	50	obrigatório	Nome do cliente
retorno.conta.cliente.tipo_pessoa	string	1	opcional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.conta.cliente.cpf_cnpj	string	18	opcional	CPF ou CNPJ do cliente
retorno.conta.cliente.ie	string	18	opcional	Inscrição estadual do cliente
retorno.conta.cliente.rg	string	10	opcional	RG do cliente
retorno.conta.cliente.endereco	string	50	opcional	Endereço do cliente
retorno.conta.cliente.numero	string	10	opcional	Número do endereço do cliente
retorno.conta.cliente.complemento	string	50	opcional	Complemento do endereço do cliente
retorno.conta.cliente.bairro	string	30	opcional	Bairro do cliente
retorno.conta.cliente.cep	string	10	opcional	Cep do cliente
retorno.conta.cliente.cidade	string	30	opcional	Nome da cidade do cliente conforme a Tabela de Cidades
retorno.conta.cliente.uf	string	2	opcional	UF do cliente
retorno.conta.cliente.pais	string	50	opcional	Nome do país do cliente conforme Tabela de Países
retorno.conta.cliente.fone	string	40	opcional	Telefone do cliente
retorno.conta.cliente.email	string	50	opcional	Email do cliente
retorno.conta.historico	string	300	opcional	Histórico da conta a receber
retorno.conta.categoria	string	100	opcional	Nome da categoria da conta a receber
retorno.conta.forma_pagamento	string	30	opcional	Código da forma de pagamento conforme Tabela de Formas de Pagamento
retorno.conta.portador	string	100	opcional	Nome do meio de pagamento da conta a receber
retorno.conta.situacao⁽⁶⁾	string	50	opcional	Situação da conta a receber
retorno.conta.liquidacao⁽³⁾	date	10	opcional	Data de recebimento da conta a receber
retorno.conta.ocorrencia	string	1	obrigatório	Tipo de ocorrência: "U" (única), "P" (parcelada), "W" (semanal), "M" (mensal), "T" (trimestral), "S" (semestral), "A" (anual)
retorno.conta.dia_vencimento⁽⁵⁾	inteiro	2	opcional	Dia de vencimento da conta a receber
retorno.conta.numero_parcelas	inteiro	3	opcional	Número de parcelas da conta a receber
retorno.conta.dia_vencimento_semanal⁽⁹⁾	inteiro	1	opcional	Dia semanal do vencimento: "0" (domingo), "1" (segunda-feira), "2" (terça-feira), "3" (quarta-feira), "4" (quinta-feira), "5" (sexta-feira), "6" (sábado)

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Este campo tem o formato dd/mm/yyyy, exemplo "01/01/2012".
(4) - Estes campos utilizam "." (ponto) como separador de decimais, exemplo "5.25".
(5) - Campo obrigatório caso ocorrência seja "M" (mensal) ou "P" (parcelada).
(6) - Valores podem ser: aberto, pago, cancelada, parcial
(7) - Valores devem ser: N ou S. Valor padrão é N.
(8) - Competência da conta a receber.
(9) - Campo retornado apenas caso ocorrência seja "W" (semanal).

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/conta.receber.obter.php';
$token = 'coloque aqui a sua chave da api';
$data = "token=$token&id=12341234&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;
}

Obter Conta 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