Fechar
esqueci a minha senha
criar uma conta

Alterar Contrato API 2.0

Serviço destinado a alteração de Contratos.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
contrato (1)-obrigatórioDados do contrato conforme layout
formatostringobrigatórioFormato do retorno (json ou xml)
ElementoTipoTamanhoOcorrênciaDescrição
contratoobject-obrigatórioElemento utilizado para representar um contrato
contrato.id (1)intobrigatórioNúmero de identificação do contrato no Tiny
contrato.data (2)date10opcionalData do contrato
contrato.descricao string50obrigatórioDescrição do contrato
contrato.clienteobjectobrigatórioElemento utilizado para representar o cliente
contrato.cliente.codigo (4)string30opcionalCódigo do cliente
contrato.cliente.nome (4)string50obrigatórioNome do cliente
contrato.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
contrato.cliente.cpf_cnpj (4)string18opcionalCPF ou CNPJ do cliente
contrato.cliente.iestring18opcionalInscrição estadual do cliente
contrato.cliente.rgstring10opcionalRG do cliente
contrato.cliente.enderecostring50opcionalEndereço do cliente
contrato.cliente.numerostring10opcionalNúmero do endereço do cliente
contrato.cliente.complementostring50opcionalComplemento do endereço do cliente
contrato.cliente.bairrostring30opcionalBairro do cliente
contrato.cliente.cepstring10opcionalCep do cliente
contrato.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
contrato.cliente.ufstring2opcionalUF do cliente
contrato.cliente.paisstring50opcionalNome do país do cliente conforme Tabela de Países
contrato.cliente.fonestring40opcionalTelefone do cliente
contrato.cliente.emailstring50opcionalEmail do cliente
contrato.cliente.atualizar_cliente (5)string1opcional("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S"
contrato.dia_vencimentoint-obrigatórioDia de vencimento do contrato
contrato.valor (3)decimal-obrigatórioValor do contrato
contrato.vencimentostring1obrigatórioMês de referência do vencimento do contrato conforme a tabela de Vencimentos dos Contratos
contrato.periodicidadeint-obrigatórioPeridiocidade de cobrança do contrato conforme a tabela de Peridiocidades dos Contratos
contrato.id_vendedor (7)int50opcionalNúmero de identificação do Vendedor cadastrado no Tiny
contrato.nome_vendedor (7) (8)string50opcionalNome do Vendedor cadastrado no Tiny
contrato.nro_parcelasint-opcionalNúmero de parcelas(mensalidades) que vendedorer receberá comissão
contrato.percentual_comissao (3)decimal-opcionalPercentual de comissão do vendedor
contrato.emite_notastring1obrigatórioIndica de o contrato emite nota (S/N)
contrato.nota object10opcionalElemento utilizado para inforar os dados para geração da nota fiscal
contrato.nota.percentual_iss (3)decimal-opcionalPercentual de iss
contrato.nota.descontar_issstring1opcionalDescontar o valor do iss do total da nota (S/N)
contrato.nota.codigo_lista_servico string8opcionalCódigo de acordo com a lista de serviços
contrato.nota.cfop string5opcionalCódigo fiscal de operação
contrato.nota.natureza_operacao string50opcionalDescrição da natureza de operação da nota
contrato.nota.texto_nota string300opcionalTexto para a descrição ou observaçõa da nota
contrato.nota.periodo_referencia string1opcionalPerí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)string50opcionalNome do produto ou serviço ao qual o contrato está vinculado
contrato.nota.codigo_produto_servico (6)string10opcionalCódigo do produto ou serviço ao qual o contrato está vinculado
contrato.mes_terminoint-opcionalMês de término do contrato
contrato.ano_terminoint-opcionalAno de término do contrato
contrato.obsstring300opcionalObservaçõ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.

ElementoTipoTamanhoOcorrênciaDescrição
retorno-objectobrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioConté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órioConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ],errostring-condicionalMensagem contendo a descrição do erro
retorno.registros[ ] (2)list-condicionalLista de resultados da inclusão
retorno.registros[ ].registro (2)object-condicionalElemento utilizado para representar um contrato.
retorno.registros[ ].registro.sequenciaint-condicionalNúmero sequencial utilizado para identificar cada contrato (1).
retorno.registros[ ].registro.statusstring-condicionalContém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erroint-condicionalConforme 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[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.registros[ ].registro.idint-condicionalNú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.

<?xml version="1.0" encoding="UTF-8"?>
<contrato>
  <id>49644545</id>
  <data>14/02/2013</data>
  <descricao>Contrato Teste</descricao>
  <cliente>
    <codigo>1235</codigo>
    <nome>Contato Teste 2</nome>
    <tipo_pessoa>F</tipo_pessoa>
    <cpf_cnpj>22755777850</cpf_cnpj>
    <ie/>
    <rg>1234567890</rg>
    <endereco>Rua Teste</endereco>
    <numero>123</numero>
    <complemento>sala 2</complemento>
    <bairro>Teste</bairro>
    <cep>95700000</cep>
    <cidade>Bento Gonçalves</cidade>
    <uf>RS</uf>
    <fone>5430553808</fone>
    <email>teste@teste.com.br</email>
  </cliente>
  <dia_vencimento>10</dia_vencimento>
  <valor>150.96</valor>
  <vencimento>C</vencimento>
  <periodicidade>1</periodicidade>
  <nome_vendedor>Vendedor Teste</nome_vendedor>
  <nro_parcelas>5</nro_parcelas>
  <percentual_comissao>5.00</percentual_comissao>
  <emite_nota>S</emite_nota>
  <nota>
    <percentual_iss>3.0</percentual_iss>
    <descontar_iss_total>N</descontar_iss_total>
    <codigo_lista_servico>1.02.01</codigo_lista_servico>
  </nota>
  <mes_termino>05</mes_termino>
  <ano_termino>2014</ano_termino>
  <obs>obs teste</obs>
</contrato>

$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=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("alterarContratoService", array('token' => 'xxxxx','contrato'=>'<contrato>...</contrato>','formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}
<?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>32</codigo_erro>
      <erros>
        <erro>Contrato não localizado</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>49644545</id>
    </registro>
  </registros>
</retorno>