Obter Contrato API 2.0
Serviço destinado a obter um Contrato.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação do contrato no Tiny |
formato | string | obrigatório | Formato do retorno (json) |
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) (5) | list | - | condicional [0..n] | Contém a lista dos erros encontrados |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.contrato (2) | object | - | condicional | Elemento utilizado para representar um contrato |
retorno.contrato.id | int | - | obrigatório | Número de identificação do contrato no Tiny |
retorno.contrato.descricao | string | 50 | obrigatório | Descrição do contrato |
retorno.contrato.data (3) | date | 10 | obrigatório | Data do contrato |
retorno.contrato.cliente | object | 10 | opcional | Elemento utilizado para representar o cliente |
retorno.contrato.cliente.nome | string | 30 | obrigatório | Nome do cliente |
retorno.contrato.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.contrato.cliente.cpf_cnpj | string | 18 | opcional | CPF ou CNPJ do cliente |
retorno.contrato.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
retorno.contrato.cliente.endereco | string | 50 | opcional | Endereço do cliente |
retorno.contrato.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
retorno.contrato.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
retorno.contrato.cliente.bairro | string | 30 | opcional | Bairro do cliente |
retorno.contrato.cliente.cep | string | 10 | opcional | Cep do cliente |
retorno.contrato.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
retorno.contrato.cliente.uf | string | 30 | opcional | UF do cliente |
retorno.contrato.cliente.fone | string | 40 | opcional | Telefone do cliente |
retorno.contrato.cliente.email | string | 40 | opcional | E-mail do cliente |
retorno.contrato.dia_vencimento | int | - | obrigatório | Dia de vencimento do contrato |
retorno.contrato.valor (4) | decimal | - | obrigatório | Valor do contrato |
retorno.contrato.vencimento | string | 1 | obrigatório | Mês de vencimento do contrato conforme a tabela de Vencimentos dos Contratos |
retorno.contrato.periodicidade | int | - | obrigatório | Peridiocidade de cobrança do contrato conforme a tabela de Peridiocidades dos Contratos |
retorno.contrato.id_vendedor | int | - | condicional | Número de identificação do Vendedor associado ao contrato. |
retorno.contrato.nome_vendedor | string | 50 | opcional | Nome do vendedor associado ao contrato |
retorno.contrato.nro_parcelas (4) | decimal | - | opcional | Número de parcelas(mensalidades) que vendedorer receberá comissão |
retorno.contrato.percentual_comissao (4) | decimal | - | opcional | Percentual de comissão do vendedor |
retorno.contrato.emite_nota | string | 1 | obrigatório | Indica de o contrato emite nota (S/N) |
retorno.contrato.nota | object | 10 | opcional | Elemento utilizado para inforar os dados para geração da nota fiscal |
retorno.contrato.nota.percentual_iss (4) | decimal | - | opcional | Percentual de iss |
retorno.contrato.nota.retorno.contrato.nota.descontar_iss | string | 1 | opcional | Descontar o valor do iss do total da nota (S/N) |
retorno.contrato.nota.codigo_lista_servico | string | 8 | opcional | Código de acordo com a lista de serviços |
retorno.contrato.nota.cfop | string | 5 | opcional | Código fiscal de operação |
retorno.contrato.nota.natureza_operacao | string | 50 | opcional | Descrição da natureza de operação da nota |
retorno.contrato.nota.texto_nota | string | 300 | opcional | Texto para a descrição ou observaçõa da nota |
retorno.contrato.nota.periodo_referencia | string | 1 | opcional | Período de referência da cobrança que será incluído nas observações das notas fiscais. Valores aceitos N (Não imprime), C (Mês atual), A (Mês anterior) |
retorno.contrato.nota.nome_produto_servico | string | 50 | opcional | Nome do produto ou serviço ao qual o contrato está vinculado |
retorno.contrato.nota.codigo_produto_servico | string | 10 | opcional | Código do produto ou serviço ao qual o contrato está vinculado |
retorno.contrato.mes_termino | int | - | opcional | Mês de término do contrato |
retorno.contrato.ano_termino | int | - | opcional | Ano de término do contrato |
retorno.contrato.obs | string | 300 | opcional | Observações do contrato |
retorno.contrato.situacao | int | - | opcional | Código conforme tabela de Situações dos Contratos |
retorno.contrato.descricao_situacao | string | 30 | opcional | Descrição conforme tabela de Situações dos Contratos |
(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 devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(4) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(5) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/contrato.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$data = "token=$token&id=$id&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;
}