PDV - Cancelar Nota via XML API 2.0
Serviço destinado a cancelar notas fiscais via XML.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar a empresa |
xml | string | obrigatório | XML da nota fiscal |
numeroNota (1) | string | obrigatório | Número da nota fiscal no Tiny |
serieNota (1) | string | obrigatório | Série da nota fiscal no Tiny |
modeloNota (1) | string | obrigatório | Modelo da nota fiscal no Tiny |
estornarContas (2) | string | opcional | Estornar contas da nota fiscal (S - Sim, N - Não) |
estornarEstoque (2) | string | opcional | Estornar estoque dos itens da nota fiscal (S - Sim, N - Não) |
(1) - Este dado será utilizado apenas para buscar as informações da nota fiscal no Tiny.
(2) - Ao não informar este parâmetro o Tiny realizará o estorno automaticamente para a nota fiscal.
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 | - | condicional | Conforme tabela "Códigos de erro" |
retorno.erros[] (1) | list | [0..n] | condicional | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.idNotaFiscal (2) | int | - | condicional | Número de identificação da nota fiscal 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 "OK".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/pdv.cancelar.nota.xml.php';
$token = 'coloque aqui a sua chave da api';
$xml = 'xxxxx';
$numeroNota = 'yyyyyy';
$serieNota = 'xxxxxx';
$modeloNota = 'zzzzzz';
$data = "token=$token&xml=$xml&numeroNota=$numeroNota&serieNota=$serieNota&modeloNota=$modeloNota";
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;
}