Baixar Conta a PagarAPI 2.0

Serviço destinado a baixa de Conta a Pagar.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
conta ⁽¹⁾	-	obrigatório	Dados da conta conforme layout
formato	string	obrigatório	Formato do retorno (json)

(1) - Layout do parâmetro conta

Elemento	Tipo	Tamanho	Ocorrência	Descrição
conta	object	-	obrigatório	Elemento utilizado para representar a baixa de uma conta a pagar
conta.id	inteiro	-	obrigatório	Identificador da conta a pagar
conta.contaOrigem ⁽³⁾	string	100	opcional	Nome da conta origem da baixa.
conta.data ⁽¹⁾	date	10	opcional	Data de baixa da conta a pagar.
conta.categoria ⁽³⁾	string	100	opcional	Nome da categoria.
conta.historico ⁽³⁾	string	300	opcional	Histórico da conta a pagar.
conta.valorTaxas ⁽²⁾⁽⁴⁾	decimal	-	opcional	Valor de taxas.
conta.valorJuros ⁽²⁾⁽⁴⁾	decimal	-	opcional	Valor de juros.
conta.valorDesconto ⁽²⁾⁽⁴⁾	decimal	-	opcional	Valor de desconto.
conta.valorAcrescimo ⁽²⁾⁽⁴⁾	decimal	-	opcional	Valor de acréscimo.
conta.valorPago ⁽²⁾⁽³⁾	decimal	-	opcional	Valor pago da conta a pagar.

(1) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(2) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(3) - Caso esses campos não sejam informados, serão considerados os valores cadastrados na conta.
(4) - Caso esses campos não sejam informados, será considerado o valor 0.

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[ ] ^{(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.registros[ ] ⁽²⁾	list	-	condicional	Lista de resultados da inclusão
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar uma conta a pagar.
retorno.registros[ ].registro.sequencia	int	-	condicional	Número sequencial utilizado para identificar cada conta a pagar.
retorno.registros[ ].registro.status	string	-	condicional	Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erro	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ] ⁽³⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.registros[ ].registro.id	int	-	condicional	Número de identificação da conta a pagar no Tiny

(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) - Estes campos somente serão informados caso o retorno contenha erros.

Exemplos do parâmetro conta em JSON

Exemplos da chamada em REST


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

Baixar Conta a PagarAPI 2.0

Parâmetros do serviço

(1) - Layout do parâmetro conta

Retorno do serviço

Exemplos do parâmetro conta

Exemplos do parâmetro conta em JSON

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