Baixar Conta a ReceberAPI 2.0
Serviço destinado a baixa de Conta a Receber.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
conta (1) | - | obrigatório | Dados da conta conforme layout |
formato | string | obrigatório | Formato do retorno (json ou xml) |
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
conta | object | - | obrigatório | Elemento utilizado para representar a baixa de uma conta a receber |
conta.id | inteiro | - | obrigatório | Identificador da conta a receber |
conta.contaDestino (3) | string | 100 | opcional | Nome da conta destino da baixa. |
conta.data (1) | date | 10 | opcional | Data de baixa da conta a receber. |
conta.categoria (3) | string | 100 | opcional | Nome da categoria. |
conta.historico (3) | string | 300 | opcional | Histórico da conta a receber. |
conta.valorTaxas (2)(4) | decimal | - | opcional | Valor de taxas. |
conta.valorJuros (2)(4) | decimal | - | opcional | Valor de juros. |
conta.valorDesconto (2)(4) | decimal | - | opcional | Valor de desconto. |
conta.valorAcrescimo (2)(4) | decimal | - | opcional | Valor de acréscimo. |
conta.valorPago (2)(3) | decimal | - | opcional | Valor pago da conta a receber. |
(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.
Retorno do serviç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 (1) | 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[ ] (2) | list | - | condicional | Lista de resultados da inclusão |
retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar uma conta a receber. |
retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada conta a receber. |
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[ ] (3) | 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 receber 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
<?xml version="1.0" encoding="UTF-8"?>
<conta>
<id>350187089</id>
<contaDestino>Bradesco</contaDestino>
<data>10/10/2016</data>
<categoria>Água, Luz</categoria>
<historico>historico de teste</historico>
<valorTaxas>4.3</valorTaxas>
<valorJuros>3.5</valorJuros>
<valorDesconto>6.4</valorDesconto>
<valorAcrescimo>3.3</valorAcrescimo>
<valorPago>35.5</valorPago>
</conta>
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/conta.receber.baixar.php';
$token = 'coloque aqui a sua chave da api';
$conta = '<conta>...</conta>';
$data = "token=$atoken&conta=$conta&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("baixarContaReceberService", array('token' => 'xxxxx','conta'=>'<conta>...</conta>','formato'=>'XML'));
$res = array();
if ($client->fault) {
$retorno = $result['faultstring'];
} else {
$err = $client->getError();
if ($err) {
$retorno = $err;
} else {
$retorno = $result;
}
}
Exemplos de retorno da API
<?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>
<registros>
<registro>
<sequencia>1</sequencia>
<status>Erro</status>
<codigo_erro>31</codigo_erro>
<erros>
<erro>Essa conta já foi paga.</erro>
</erros>
</registro>
</registros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<registros>
<registro>
<sequencia>1</sequencia>
<status>OK</status>
<id>37644545</id>
</registro>
</registros>
</retorno>