Você está usando um navegador que não é suportado pelo Tiny. Saiba mais

Incluir Conta a Receber API 2.0

Serviço destinado a inclusão de Contas a Receber.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
conta (1)-obrigatórioDados da conta conforme layout
formatostringobrigatórioFormato do retorno (json)
ElementoTipoTamanhoOcorrênciaDescrição
contaobject-obrigatórioElemento utilizado para representar uma conta a receber
conta.data (1)date10opcionalData de emissão da conta a receber
conta.vencimentodate10obrigatórioVencimento da conta a receber
conta.valor (2)decimal-obrigatórioValor da conta a receber
conta.nro_documentostring9opcionalNúmero do documento
conta.clienteobjectobrigatórioElemento utilizado para representar o cliente
conta.cliente.codigo (3)string30opcionalCódigo do cliente
conta.cliente.nome (3)string50obrigatórioNome do cliente
conta.cliente.tipo_pessoastring1opcionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
conta.cliente.cpf_cnpj (3)string18opcionalCPF ou CNPJ do cliente
conta.cliente.iestring18opcionalInscrição estadual do cliente
conta.cliente.rgstring10opcionalRG do cliente
conta.cliente.enderecostring50opcionalEndereço do cliente
conta.cliente.numerostring10opcionalNúmero do endereço do cliente
conta.cliente.complementostring50opcionalComplemento do endereço do cliente
conta.cliente.bairrostring30opcionalBairro do cliente
conta.cliente.cepstring10opcionalCep do cliente
conta.cliente.cidadestring30opcionalNome da cidade do cliente conforme a Tabela de Cidades
conta.cliente.ufstring2opcionalUF do cliente
conta.cliente.paisstring50opcionalNome do país do cliente conforme Tabela de Países
conta.cliente.fonestring40opcionalTelefone do cliente
conta.cliente.emailstring50opcionalEmail do cliente
conta.cliente.atualizar_cliente (4)string1opcional("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S"
conta.historicostring300opcionalHistórico da conta a receber
conta.categoria (5)string100opcionalNome da categoria
conta.competencia (6)string7opcionalCompetência da conta a receber (formato "mm/aaaa")
conta.forma_pagamentostring30opcionalCódigo da forma de pagamento conforme Tabela de Formas de Pagamento
conta.portador (7)string100opcionalNome do portador
conta.ocorrenciastring1opcionalTipo de ocorrência: "U" (única), "P" (parcelada), "W" (semanal), "M" (mensal), "T" (trimestral), "S" (semestral), "A" (anual)
conta.dia_vencimento (8)inteiro2opcionalDia de vencimento da conta a receber
conta.numero_parcelas (9)inteiro3opcionalNúmero de parcelas da conta a receber
conta.dia_semana_vencimento (10)inteiro1opcionalDia semanal do vencimento: "0" (domingo), "1" (segunda-feira), "2" (terça-feira), "3" (quarta-feira), "4" (quinta-feira), "5" (sexta-feira), "6" (sábado)

(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) - Este campo é utilizado para pesquisar a categoria. Caso nenhum resultado seja retornado, a categoria ficará vazia.
(6) - O campo será considerado apenas se a empresa tiver o módulo DRE instalado.
(7) - Este campo é utilizado para pesquisar o portador. Caso nenhum resultado seja retornado, esse campo terá o valor "Sem portador".
(8) - Campo obrigatório caso ocorrência seja "M" (mensal).
(9) - A conta a receber pode ter no máximo 100 parcelas.
(10) - Campo obrigatório caso ocorrência seja "W" (semanal).

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.


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