API

Documentação APIs de integração TagOne

PRIMEIRO PASSO

Solicite acesso ao ambiente de treinamento atendimento@nerdworking.com.br

Autenticação

POST: https://[empresa].treina.tagone.com.br/api/token

Nossas APIs OData/RESTFull permitem autenticação com login e senha, o token retornado na autenticação deve ser enviado no cabeçalho das chamadas seguintes. Segue exemplo de autenticação:

C#
JavaScript
C#
var client = new RestClient("https://[empresa].treina.tagone.com.br/api/token");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("UserName", "nome_usuario");
request.AddParameter("Password", "senha");
request.AddParameter("grant_type", "password");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
JavaScript
var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/x-www-form-urlencoded");
var urlencoded = new URLSearchParams();
urlencoded.append("UserName", "nome_usuario");
urlencoded.append("Password", "senha");
urlencoded.append("grant_type", "password");
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: urlencoded,
redirect: 'follow'
};
fetch("https://[empresa].treina.tagone.com.br/api/token", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
{
"access_token": "token_autenticado",
"token_type": "bearer",
"expires_in": 2591999,
"CodigoPessoa": "000000000213934",
"NomePessoa": "Nome da pessoa cadastrada",
"IsAdmin": false
}

Toda requisição subsequente deve conter o token retornado no header da chamada.

C#
JavaScript
C#
var client = new RestClient("https://[empresa].treina.tagone.com.br/odata/Acordo");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer token_autenticado");
JavaScript
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer token_autenticado");

Cobrança

API desenvolvida para facilitar a comunicação com as assessorias de cobrança externas, Cada novo acordo gerado pode ser enviado ao TagOne facilmente

Criando um novo acordo

POST: https://[empresa].treina.tagone.com.br/odata/Acordo

{
"CodigoPessoa": "000000000000000",
"QuantidadeParcelas": 0,
"DataEntrada": "YYYY-MM-DD",
"PrimeiroVencimento": "YYYY-MM-DD",
"ValorEntrada": 0.00,
"ValorDesconto": 0.00,
"ValorAcrescimo": 0.00,
"ValorMulta": 0.00,
"ValorJuros": 0.00,
"ValorAcordo": 0.00,
"ValorJurosAcordo": 0.00,
"JurosParcelamento": 0,
"ValorDocumentos": 334.92,
"CodigoAcordoTipo": 2, //FIXO 2
"Faturar" : false,
"Parcelas": [
{
"NumeroParcela": 1,
"ValorParcela": 0,
"DataVencimento": "YYYY-MM-DDZ"
}
],
"Documentos": [
{
"CodigoAcordoDocumento": 0,
"CodigoDocumento": "000000000000000",
"ValorDocumento": 0.00,
"ValorJuros": 0.00,
"ValorMulta": 0.00
}
]
}

RESPONSE 200: SUCESSO

Devolve um objeto com todos os dados no novo acordo, Incluindo códigos dos novos documentos e link para a fatura

{
"CodigoPessoa": "000000000000000",
"QuantidadeParcelas": 0,
"DataEntrada": "YYYY-MM-DD",
"PrimeiroVencimento": "YYYY-MM-DD",
"ValorEntrada": 0.00,
"ValorDesconto": 0.00,
"ValorAcrescimo": 0.00,
"ValorMulta": 0.00,
"ValorJuros": 0.00,
"ValorAcordo": 0.00,
"ValorJurosAcordo": 0.00,
"JurosParcelamento": 0,
"ValorDocumentos": 334.92,
"CodigoAcordoTipo": 2,
"Parcelas": [
{
"NumeroParcela": 1,
"ValorParcela": 0,
"DataVencimento": "YYYY-MM-DDZ"
}
],
"Documentos": [
{
"CodigoAcordoDocumento": 0,
"CodigoDocumento": "000000000000000",
"ValorDocumento": 0.00,
"ValorJuros": 0.00,
"ValorMulta": 0.00
}
]
}

RESPONSE 500: Qualquer tipo de falha

{
"title": "Internal Server Error",
"status": 500,
"detail": "Mensagem de erro"
}

Criando uma fatura

Criando uma nova fatura de um ou mais documentos sem a criação de um novo acordo.

POST: https://[empresa].treina.tagone.com.br/odata/Fatura

{
"CodigoPessoa": "000000000000000",
"QuantidadeParcelas": 0,
"DataEntrada": "YYYY-MM-DD",
"PrimeiroVencimento": "YYYY-MM-DD",
"ValorEntrada": 0.00,
"ValorDesconto": 0.00,
"ValorAcrescimo": 0.00,
"ValorMulta": 0.00,
"ValorJuros": 0.00,
"ValorAcordo": 0.00,
"ValorJurosAcordo": 0.00,
"JurosParcelamento": 0,
"ValorDocumentos": 334.92,
"Parcelas": [
{
"NumeroParcela": 1,
"ValorParcela": 0,
"DataVencimento": "YYYY-MM-DDZ"
}
],
"Documentos": [
{
"CodigoAcordoDocumento": 0,
"CodigoDocumento": "000000000000000",
"ValorDocumento": 0.00,
"ValorJuros": 0.00,
"ValorMulta": 0.00
}
]
}

RESPONSE 200: SUCESSO

Devolve um objeto com todos os dados no novo acordo, Incluindo códigos dos novos documentos e link para a fatura

{
"CodigoPessoa": "000000000000000",
"QuantidadeParcelas": 0,
"DataEntrada": "YYYY-MM-DD",
"PrimeiroVencimento": "YYYY-MM-DD",
"ValorEntrada": 0.00,
"ValorDesconto": 0.00,
"ValorAcrescimo": 0.00,
"ValorMulta": 0.00,
"ValorJuros": 0.00,
"ValorAcordo": 0.00,
"ValorJurosAcordo": 0.00,
"JurosParcelamento": 0,
"ValorDocumentos": 334.92,
"Parcelas": [
{
"NumeroParcela": 1,
"ValorParcela": 0,
"DataVencimento": "YYYY-MM-DDZ"
}
],
"Documentos": [
{
"CodigoAcordoDocumento": 0,
"CodigoDocumento": "000000000000000",
"ValorDocumento": 0.00,
"ValorJuros": 0.00,
"ValorMulta": 0.00
}
]
}

RESPONSE 500: Qualquer tipo de falha

{
"title": "Internal Server Error",
"status": 500,
"detail": "Mensagem de erro"
}