Endpoint
POST https://api.tiny.com.br/api2/conta.receber.obter.php
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| id | int | obrigatório | Número de identificação da conta a receber |
| formato | string | obrigatório | Formato do retorno (json) |
| obter_link_boleto | string | opcional | Obter link do boleto para impressão (S/N) |
Retorno
| Campo | 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 | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Conforme tabela “Códigos de erro” (1) |
| retorno.erros[] | list | - | condicional | Lista dos erros encontrados [0..n] (1) |
| retorno.erros[].erro | string | - | condicional | Descrição do erro (1) |
| retorno.conta | object | - | condicional | Dados da conta a receber (2) |
| retorno.conta.id | int | - | condicional | ID da conta a receber |
| retorno.conta.data | date | 10 | condicional | Data de emissão (dd/mm/yyyy) |
| retorno.conta.vencimento | date | 10 | condicional | Vencimento (dd/mm/yyyy) |
| retorno.conta.valor | decimal | - | condicional | Valor da conta |
| retorno.conta.saldo | decimal | - | condicional | Saldo da conta |
| retorno.conta.link_boleto | string | - | condicional | Link para impressão do boleto (3) |
| retorno.conta.nro_documento | string | 30 | condicional | Número do documento |
| retorno.conta.serie_documento | int | 1 | condicional | Série do documento |
| retorno.conta.competencia | date | 7 | condicional | Competência (mm/yyyy) |
| retorno.conta.ocorrencia | string | - | condicional | U/P/W/M/T/S/A (4) |
| retorno.conta.situacao | string | 50 | condicional | aberto, pago, cancelada, parcial |
| retorno.conta.liquidacao | date | 10 | condicional | Data de recebimento |
| retorno.conta.numero_parcelas | int | 3 | condicional | Número de parcelas |
| retorno.conta.dia_vencimento | int | - | condicional | Dia do vencimento (5) |
| retorno.conta.historico | string | 300 | condicional | Histórico da conta |
| retorno.conta.categoria | string | 100 | condicional | Nome da categoria |
| retorno.conta.portador | string | 100 | condicional | Nome do portador |
| retorno.conta.cliente | object | - | condicional | Dados do cliente |
| retorno.conta.cliente.codigo | string | 30 | condicional | Código do cliente |
| retorno.conta.cliente.nome | string | 50 | condicional | Nome do cliente |
| retorno.conta.cliente.tipo_pessoa | string | 1 | condicional | F/J/E |
| retorno.conta.cliente.cpf_cnpj | string | 18 | condicional | CPF ou CNPJ |
| retorno.conta.cliente.endereco | string | 50 | condicional | Endereço |
| retorno.conta.cliente.numero | string | 10 | condicional | Número |
| retorno.conta.cliente.complemento | string | 50 | condicional | Complemento |
| retorno.conta.cliente.bairro | string | 30 | condicional | Bairro |
| retorno.conta.cliente.cep | string | 10 | condicional | CEP |
| retorno.conta.cliente.cidade | string | 30 | condicional | Cidade |
| retorno.conta.cliente.uf | string | 2 | condicional | UF |
| retorno.conta.cliente.fone | string | 40 | condicional | Telefone |
| retorno.conta.cliente.email | string | 50 | condicional |
(1) Erros e código de erro aparecem apenas quando status for “Erro”
(2) Dados da conta aparecem apenas quando status for “OK”
(3) Campo link_boleto requer parâmetro obter_link_boleto=S
(4) Ocorrência: U (única), P (parcelada), W (semanal), M (mensal), T (trimestral), S (semestral), A (anual)
(5) Campo dia_vencimento obrigatório quando ocorrência é “M” (mensal) ou “P” (parcelada)
Exemplo de chamada
curl -X POST https://api.tiny.com.br/api2/conta.receber.obter.php \
-d "token=SEU_TOKEN&id=12341234&formato=json&obter_link_boleto=S"
Exemplos de retorno
Erro - Token inválido
{
"retorno": {
"status_processamento": 1,
"status": "Erro",
"codigo_erro": 2,
"erros": [
{
"erro": "token invalido"
}
]
}
}
Erro - Conta não localizada
{
"retorno": {
"status_processamento": "2",
"status": "Erro",
"codigo_erro": "32",
"erros": [
{
"erro": "Conta a receber não localizada"
}
]
}
}
Sucesso
{
"retorno": {
"status_processamento": "3",
"status": "OK",
"conta": {
"id": "433224432",
"data": "25/11/2015",
"vencimento": "28/10/2016",
"valor": "6565.00",
"nro_documento": "000065205",
"serie_documento": "0",
"competencia": "10/2016",
"cliente": {
"nome": "Henrique Teste 4100",
"cpf_cnpj": "54.544.826/0001-40",
"endereco": "afdsafsd",
"numero": "2123",
"bairro": "bababa",
"cep": "15.200-000",
"cidade": "José Bonifácio",
"uf": "SP"
},
"historico": "historico - mensal",
"categoria": "Telecomunicação, internet",
"portador": "HSBC",
"situacao": "aberto",
"ocorrencia": "M",
"dia_vencimento": "28"
}
}
}
Observações
- Datas utilizam formato dd/mm/yyyy
- Valores decimais usam ”.” (ponto) como separador