Alterar Contrato API 2.0
Serviço destinado a alteração de Contratos.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| contrato (1) | - | obrigatório | Dados do contrato conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| contrato | object | - | obrigatório | Elemento utilizado para representar um contrato |
| contrato.id (1) | int | obrigatório | Número de identificação do contrato no Tiny | |
| contrato.data (2) | date | 10 | opcional | Data do contrato |
| contrato.descricao | string | 50 | obrigatório | Descrição do contrato |
| contrato.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
| contrato.cliente.codigo (4) | string | 30 | opcional | Código do cliente |
| contrato.cliente.nome (4) | string | 50 | obrigatório | Nome do cliente |
| contrato.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
| contrato.cliente.cpf_cnpj (4) | string | 18 | opcional | CPF ou CNPJ do cliente |
| contrato.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
| contrato.cliente.rg | string | 10 | opcional | RG do cliente |
| contrato.cliente.endereco | string | 50 | opcional | Endereço do cliente |
| contrato.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
| contrato.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
| contrato.cliente.bairro | string | 30 | opcional | Bairro do cliente |
| contrato.cliente.cep | string | 10 | opcional | Cep do cliente |
| contrato.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
| contrato.cliente.uf | string | 2 | opcional | UF do cliente |
| contrato.cliente.pais | string | 50 | opcional | Nome do país do cliente conforme Tabela de Países |
| contrato.cliente.fone | string | 40 | opcional | Telefone do cliente |
| contrato.cliente.email | string | 50 | opcional | Email do cliente |
| contrato.cliente.atualizar_cliente (5) | string | 1 | opcional | ("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S" |
| contrato.dia_vencimento | int | - | obrigatório | Dia de vencimento do contrato |
| contrato.valor (3) | decimal | - | obrigatório | Valor do contrato |
| contrato.vencimento | string | 1 | obrigatório | Mês de referência do vencimento do contrato conforme a tabela de Vencimentos dos Contratos |
| contrato.periodicidade | int | - | obrigatório | Peridiocidade de cobrança do contrato conforme a tabela de Peridiocidades dos Contratos |
| contrato.id_vendedor (7) | int | 50 | opcional | Número de identificação do Vendedor cadastrado no Tiny |
| contrato.nome_vendedor (7) (8) | string | 50 | opcional | Nome do Vendedor cadastrado no Tiny |
| contrato.nro_parcelas | int | - | opcional | Número de parcelas(mensalidades) que vendedorer receberá comissão |
| contrato.percentual_comissao (3) | decimal | - | opcional | Percentual de comissão do vendedor |
| contrato.emite_nota | string | 1 | obrigatório | Indica de o contrato emite nota (S/N) |
| contrato.nota | object | 10 | opcional | Elemento utilizado para inforar os dados para geração da nota fiscal |
| contrato.nota.percentual_iss (3) | decimal | - | opcional | Percentual de iss |
| contrato.nota.descontar_iss | string | 1 | opcional | Descontar o valor do iss do total da nota (S/N) |
| contrato.nota.codigo_lista_servico | string | 8 | opcional | Código de acordo com a lista de serviços |
| contrato.nota.cfop | string | 5 | opcional | Código fiscal de operação |
| contrato.nota.natureza_operacao | string | 50 | opcional | Descrição da natureza de operação da nota |
| contrato.nota.texto_nota | string | 300 | opcional | Texto para a descrição ou observaçõa da nota |
| 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) |
| contrato.nota.nome_produto_servico (6) | string | 50 | opcional | Nome do produto ou serviço ao qual o contrato está vinculado |
| contrato.nota.codigo_produto_servico (6) | string | 10 | opcional | Código do produto ou serviço ao qual o contrato está vinculado |
| contrato.mes_termino | int | - | opcional | Mês de término do contrato |
| contrato.ano_termino | int | - | opcional | Ano de término do contrato |
| contrato.obs | string | 300 | opcional | Observações do contrato |
(1) - Este campo será utilizado para localizar o contrato que será alterado.
(2) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(3) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(4) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja os demais campos são carregados do cadastro.
(5) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(6) - Estes campos são utilizados para pesquisar se o produto ou serviço está cadastrado.
(7) - Estes campos são utilizados para pesquisar se o vendedor está cadastrado.
(8) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
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 um contrato. |
| retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada contrato (1). |
| 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 do contrato 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 contrato
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/contrato.alterar.php';
$token = 'coloque aqui a sua chave da api';
$contrato = '<contrato>...</contrato>';
$data = "token=$token&contrato=$contrato&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;
}
