Incluir Conta a Receber API 2.0
Serviço destinado a inclusão de Contas a Receber.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| conta (1) | - | obrigatório | Dados da conta conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| conta | object | - | obrigatório | Elemento utilizado para representar uma conta a receber |
| conta.data (1) | date | 10 | opcional | Data de emissão da conta a receber |
| conta.vencimento | date | 10 | obrigatório | Vencimento da conta a receber |
| conta.valor (2) | decimal | - | obrigatório | Valor da conta a receber |
| conta.nro_documento | string | 9 | opcional | Número do documento |
| conta.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
| conta.cliente.codigo (3) | string | 30 | opcional | Código do cliente |
| conta.cliente.nome (3) | string | 50 | obrigatório | Nome do cliente |
| conta.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
| conta.cliente.cpf_cnpj (3) | string | 18 | opcional | CPF ou CNPJ do cliente |
| conta.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
| conta.cliente.rg | string | 10 | opcional | RG do cliente |
| conta.cliente.endereco | string | 50 | opcional | Endereço do cliente |
| conta.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
| conta.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
| conta.cliente.bairro | string | 30 | opcional | Bairro do cliente |
| conta.cliente.cep | string | 10 | opcional | Cep do cliente |
| conta.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
| conta.cliente.uf | string | 2 | opcional | UF do cliente |
| conta.cliente.pais | string | 50 | opcional | Nome do país do cliente conforme Tabela de Países |
| conta.cliente.fone | string | 40 | opcional | Telefone do cliente |
| conta.cliente.email | string | 50 | opcional | Email do cliente |
| conta.cliente.atualizar_cliente (4) | 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" |
| conta.historico | string | 300 | opcional | Histórico da conta a receber |
| conta.categoria (5) | string | 100 | opcional | Nome da categoria |
| conta.competencia (6) | string | 7 | opcional | Competência da conta a receber (formato "mm/aaaa") |
| conta.forma_pagamento | string | 30 | opcional | Código da forma de pagamento conforme Tabela de Formas de Pagamento |
| conta.portador (7) | string | 100 | opcional | Nome do portador |
| conta.ocorrencia | string | 1 | opcional | Tipo de ocorrência: "U" (única), "P" (parcelada), "W" (semanal), "M" (mensal), "T" (trimestral), "S" (semestral), "A" (anual) |
| conta.dia_vencimento (8) | inteiro | 2 | opcional | Dia de vencimento da conta a receber |
| conta.numero_parcelas (9) | inteiro | 3 | opcional | Número de parcelas da conta a receber |
| conta.dia_semana_vencimento (10) | inteiro | 1 | opcional | Dia 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).
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 conta
Exemplos de chamada da API
$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;
}
