Incluir Nota de Serviço API 2.0

Serviço destinado a fazer inclusão de Notas Fiscais de Serviço.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
nota ⁽¹⁾	-	obrigatório	Dados da nota conforme layout
formato	string	obrigatório	Formato do retorno (json)

(1) - Layout do parâmetro nota

Elemento	Tipo	Tamanho	Ocorrência	Descrição
nota_servico	object	-	obrigatório	Elemento utilizado para representar uma nota de serviço
nota_servico.data_emissao ⁽¹⁾	date	10	opcional	Data de emissão da nota de serviço
nota_servico.cliente	object		obrigatório	Elemento utilizado para representar o cliente
nota_servico.cliente.codigo ⁽³⁾	string	30	opcional	Código do cliente
nota_servico.cliente.nome ⁽³⁾	string	50	obrigatório	Nome do cliente
nota_servico.cliente.tipo_pessoa	string	1	opcional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
nota_servico.cliente.cpf_cnpj ⁽³⁾	string	18	opcional	CPF ou CNPJ do cliente
nota_servico.cliente.ie	string	18	opcional	Inscrição estadual do cliente
nota_servico.cliente.rg	string	10	opcional	RG do cliente
nota_servico.cliente.endereco	string	50	opcional	Endereço do cliente
nota_servico.cliente.numero	string	10	opcional	Número do endereço do cliente
nota_servico.cliente.complemento	string	50	opcional	Complemento do endereço do cliente
nota_servico.cliente.bairro	string	30	opcional	Bairro do cliente
nota_servico.cliente.cep	string	10	opcional	Cep do cliente
nota_servico.cliente.cidade	string	30	opcional	Nome da cidade do cliente conforme a Tabela de Cidades
nota_servico.cliente.uf	string	2	opcional	UF do cliente
nota_servico.cliente.pais	string	50	opcional	Nome do país do cliente conforme Tabela de Países
nota_servico.cliente.fone	string	40	opcional	Telefone do cliente
nota_servico.cliente.email	string	50	opcional	Email do cliente
nota_servico.cliente.atualizar_cliente ⁽⁴⁾	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"
nota_servico.servico	object		obrigatório	Elemento utilizado para representar o serviço
nota_servico.servico.descricao	string	300	obrigatório	Descrição do serviço
nota_servico.servico.valor_servico ⁽²⁾	decimal	-	obrigatório	Valor do serviço
nota_servico.servico.codigo_lista_servico	string	10	opcional	Código de acordo com a lista de serviços
nota_servico.servico.codigo_nbs	string	12	opcional	Código NBS
nota_servico.servico.cidade_prestacao_servico ⁽⁸⁾	string	30	opcional	Nome da cidade do local da prestação do serviço conforme a Tabela de Cidades
nota_servico.servico.uf_prestacao_servico ⁽⁸⁾	string	30	opcional	UF da cidade do local da prestação do serviço conforme a Tabela de Cidades
nota_servico.tributacao	int	-	opcional	Opções de tributação conforme tabela de Tributações das Notas de Serviço
nota_servico.percentual_ir ⁽²⁾	decimal	-	opcional	Percentual de IR
nota_servico.texto_ir	string	150	opcional	Texto do IR
nota_servico.percentual_iss ⁽²⁾	decimal	-	opcional	Percentual do ISS
nota_servico.descontar_iss_total	string	1	obrigatório	ISS Retido(S/N)
nota_servico.forma_pagamento	string	30	opcional	Código da forma de pagamento conforme Tabela de Formas de Pagamento
nota_servico.meio_pagamento	string	100	opcional	Descrição do meio de pagamento
nota_servico.categoria_financeira	string	50	opcional	Descrição da categoria financeira
nota_servico.parcelas[ ]	list		opcional	Lista de parcelas da nota
nota_servico.parcelas[ ].parcela	object		opcional	Elemento utilizado para representar uma parcela
nota_servico.parcelas[ ].parcela.dias	int	20	opcional	Dias de vencimento da parcela
nota_servico.parcelas[ ].parcela.data ⁽¹⁾	date	10	opcional	Data de vencimento da parcela
nota_servico.parcelas[ ].parcela.valor ⁽²⁾	decimal	-	opcional	Valor da parcela
nota_servico.parcelas[ ].parcela.obs	string	100	opcional	Observação da parcela
nota_servico.parcelas[ ].parcela.forma_pagamento	string	30	opcional	Código da forma de pagamento conforme Tabela de Formas de Pagamento
nota_servico.parcelas[ ].parcela.meio_pagamento	string	100	opcional	Descrição do meio de pagamento
nota_servico.id_vendedor ⁽⁵⁾	int	-	opcional	Número de identificação do Vendedor cadastrado no Tiny.
nota_servico.nome_vendedor ⁽⁵⁾ ⁽⁶⁾	string	50	opcional	Nome do Vendedor cadastrado no Tiny
nota_servico.percentual_comissao ⁽²⁾	decimal	-	opcional	Percentual de comissão do vendedor
nota_servico.condicoes	string	30	opcional	Texto contendo as condições da nota
nota_servico.cnae	string	9	opcional	Código do CNAE
nota_servico.crt ⁽⁷⁾	int	1	opcional	Código de regime tributário: 0 - Não informado 1 - Simples Nacional 3 - Regime Normal

(1) - Estes campos dever ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(2) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(3) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja, os demais campos são carregados do cadastro.
(4) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(5) - Estes campos são utilizados para pesquisar se o vendedor está cadastrado, caso o vendedor não seja localizado será apresentado um erro de validação.
(6) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
(7) - Este campo será desconsiderado se o campo "tipo_pessoa" for igual a "F".
(8) - Este campo é considerado somente para as prefeituras com suporte ao envio desta informaçã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 ⁽¹⁾	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[ ]⁽²⁾	list	-	condicional	Lista de resultados da inclusão
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar uma nota de serviço
retorno.registros[ ].registro.sequencia	int	-	condicional	Número sequencial utilizado para identificar cada nota
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[ ]⁽³⁾	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 nota de serviço no Tiny
retorno.registros[ ].registro.serie	string	3	condicional	Série da nota de serviço no Tiny
retorno.registros[ ].registro.numero	int	-	condicional	Número da nota de serviço no Tiny
retorno.registros[ ].registro.numeroRPS	int	-	condicional	Número da RPS 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 nota em JSON

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/nota.servico.incluir.php';
$token = 'coloque aqui a sua chave da api';
$nota = '<nota_servico>...</nota_servico>';
$data = "token=$token&nota=$nota&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;
}

Incluir Nota de Serviço API 2.0

Parâmetros do serviço

(1) - Layout do parâmetro nota

Retorno do serviço

Exemplos do parâmetro nota

Exemplos do parâmetro nota em JSON

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Atendimento

Localização