Info
Welcome to the generated API reference. Get Postman Collection
Entidade
Cadastrar
Requires authentication
Recebe um JSON contendo os dados da entidade e retorna a entidade criada com seu ID.
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade" \
-H "Content-Type: application/json" \
-d '{"st_cnpj":"15784622000125","st_nomeentidade":"ENTIDADE CRIADA PELA API","st_razaosocial":"CRIADA PELA API","nu_inscricaoestadual":"6143129823800","st_urlsite":"http:\/\/www.teste.com.br","st_siglaentidade":"CPA","st_urlportal":"null","st_urlnovoportal":"null","st_apelido":"CRIADA API","st_urllogoutportal":"null","id_usuariosecretariado":0,"st_mantenedora":"Mantenedora","st_cnpjmantenedora":"73600983000170","st_emecmantenedora":"e-mec","st_instituicaoensinosuperior":"IES","st_emecinstituicaoensinosuperior":"E-MECIES","st_iesregistradoradiploma":"REGISTROIES","st_emeciesregistradoradiploma":"E-MECNOVAMENTE","id_usuariocadastro":5004,"endereco":{"sg_uf":"MG","st_cep":"35661209","st_endereco":"Rua Maria Lina de Oliveira","st_bairro":"S\u00e3o Luiz","st_complemento":"AP 208","nu_numero":320,"st_cidade":"PAR\u00c1 DE MINAS","bl_ativo":true,"id_pais":22,"id_municipio":3147105,"id_tipoendereco":"3","bl_padrao":true}}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"st_cnpj": "15784622000125",
"st_nomeentidade": "ENTIDADE CRIADA PELA API",
"st_razaosocial": "CRIADA PELA API",
"nu_inscricaoestadual": "6143129823800",
"st_urlsite": "http:\/\/www.teste.com.br",
"st_siglaentidade": "CPA",
"st_urlportal": "null",
"st_urlnovoportal": "null",
"st_apelido": "CRIADA API",
"st_urllogoutportal": "null",
"id_usuariosecretariado": 0,
"st_mantenedora": "Mantenedora",
"st_cnpjmantenedora": "73600983000170",
"st_emecmantenedora": "e-mec",
"st_instituicaoensinosuperior": "IES",
"st_emecinstituicaoensinosuperior": "E-MECIES",
"st_iesregistradoradiploma": "REGISTROIES",
"st_emeciesregistradoradiploma": "E-MECNOVAMENTE",
"id_usuariocadastro": 5004,
"endereco": {
"sg_uf": "MG",
"st_cep": "35661209",
"st_endereco": "Rua Maria Lina de Oliveira",
"st_bairro": "S\u00e3o Luiz",
"st_complemento": "AP 208",
"nu_numero": 320,
"st_cidade": "PAR\u00c1 DE MINAS",
"bl_ativo": true,
"id_pais": 22,
"id_municipio": 3147105,
"id_tipoendereco": "3",
"bl_padrao": true
}
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_entidade": 2566,
"st_cnpj": "15784622000125",
"st_nomeentidade": "ENTIDADE CRIADA PELA API",
"st_razaosocial": "CRIADA PELA API",
"nu_inscricaoestadual": "6143129823800",
"st_urlsite": "http:\/\/www.teste.com.br",
"st_siglaentidade": "CPA",
"st_urlportal": null,
"st_urlnovoportal": null,
"st_apelido": "CRIADA API",
"st_urllogoutportal": null,
"id_usuariosecretariado": null,
"st_mantenedora": "Mantenedora",
"st_cnpjmantenedora": "73600983000170",
"st_emecmantenedora": "e-mec",
"st_instituicaoensinosuperior": "IES",
"st_emecinstituicaoensinosuperior": "E-MECIES",
"st_iesregistradoradiploma": "REGISTROIES",
"st_emeciesregistradoradiploma": "E-MECNOVAMENTE",
"id_usuariocadastro": "5004",
"endereco": {
"id_endereco": "1317821",
"sg_uf": "MG",
"st_cep": "35661209",
"st_endereco": "Rua Maria Lina de Oliveira",
"st_bairro": "São Luiz",
"st_complemento": "AP 208",
"nu_numero": 320,
"st_cidade": "PARÁ DE MINAS",
"bl_ativo": 1,
"id_pais": 22,
"id_municipio": 3147105,
"id_tipoendereco": "3",
"bl_padrao": 1
}
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_cnpj": [
"The st cnpj must be at least 15 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
POST api/g2/entidade/{id_entidadecadastro}/entidade
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
st_cnpj |
string | required | CNPJ da entidade. |
st_nomeentidade |
string | required | Nome da entidade. |
st_razaosocial |
string | required | Razão social da entidade. |
nu_inscricaoestadual |
string | optional | Número da inscrição estadual. |
st_urlsite |
string | optional | URL do site da entidade. |
st_siglaentidade |
string | optional | Sigla da entidade. |
st_urlportal |
string | optional | URL do portal da entidade. |
st_urlnovoportal |
string | optional | URL do novo portal da entidade. |
st_apelido |
string | optional | Apelido da entidade. |
st_urllogoutportal |
string | optional | URL de logout do portal. |
id_usuariosecretariado |
integer | optional | ID do usuário secretariado. |
st_mantenedora |
string | optional | Nome da mantenedora. |
st_cnpjmantenedora |
string | optional | CNPJ da mantenedora. |
st_emecmantenedora |
string | optional | Código e-MEC da mantenedora. |
st_instituicaoensinosuperior |
string | optional | Nome da instituição de ensino superior. |
st_emecinstituicaoensinosuperior |
string | optional | Código e-MEC da instituição de ensino superior. |
st_iesregistradoradiploma |
string | optional | Nome da IES registradora do diploma. |
st_emeciesregistradoradiploma |
string | optional | Código e-MEC da IES registradora do diploma. |
id_usuariocadastro |
integer | required | ID do usuário que está cadastrando a entidade. |
endereco |
object | required | Objeto contendo as informações do endereço. |
endereco.sg_uf |
string | required | Estado (UF). |
endereco.st_cep |
string | required | CEP sem máscara. |
endereco.st_endereco |
string | required | Nome da rua. |
endereco.st_bairro |
string | required | Nome do bairro. |
endereco.st_complemento |
string | optional | Complemento do endereço. |
endereco.nu_numero |
integer | required | Número do endereço. |
endereco.st_cidade |
string | required | Nome da cidade. |
endereco.bl_ativo |
boolean | required | Se o endereço está ativo. |
endereco.id_pais |
integer | optional | ID do país. |
endereco.id_municipio |
integer | optional | ID do município conforme IBGE. |
endereco.id_tipoendereco |
string | optional | Tipo do endereço. |
endereco.bl_padrao |
boolean | optional | Se o endereço é o padrão. |
Atualizar
Requires authentication
Recebe um JSON contendo os dados da entidade e retorna a entidade criada com seu ID.
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade/2564" \
-H "Content-Type: application/json" \
-d '{"st_cnpj":"15784622000125","st_nomeentidade":"ENTIDADE CRIADA PELA API","st_razaosocial":"CRIADA PELA API","nu_inscricaoestadual":"6143129823800","st_urlsite":"http:\/\/www.teste.com.br","st_siglaentidade":"CPA","st_urlportal":"null","st_urlnovoportal":"null","st_apelido":"CRIADA API","st_urllogoutportal":"null","id_usuariosecretariado":0,"st_mantenedora":"Mantenedora","st_cnpjmantenedora":"73600983000170","st_emecmantenedora":"e-mec","st_instituicaoensinosuperior":"IES","st_emecinstituicaoensinosuperior":"E-MECIES","st_iesregistradoradiploma":"REGISTROIES","st_emeciesregistradoradiploma":"E-MECNOVAMENTE","id_usuariocadastro":5004,"endereco":{"sg_uf":"MG","st_cep":"35661209","st_endereco":"Rua Maria Lina de Oliveira","st_bairro":"S\u00e3o Luiz","st_complemento":"AP 208","nu_numero":320,"st_cidade":"PAR\u00c1 DE MINAS","bl_ativo":true,"id_pais":22,"id_municipio":3147105,"id_tipoendereco":"3","bl_padrao":true}}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade/2564"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"st_cnpj": "15784622000125",
"st_nomeentidade": "ENTIDADE CRIADA PELA API",
"st_razaosocial": "CRIADA PELA API",
"nu_inscricaoestadual": "6143129823800",
"st_urlsite": "http:\/\/www.teste.com.br",
"st_siglaentidade": "CPA",
"st_urlportal": "null",
"st_urlnovoportal": "null",
"st_apelido": "CRIADA API",
"st_urllogoutportal": "null",
"id_usuariosecretariado": 0,
"st_mantenedora": "Mantenedora",
"st_cnpjmantenedora": "73600983000170",
"st_emecmantenedora": "e-mec",
"st_instituicaoensinosuperior": "IES",
"st_emecinstituicaoensinosuperior": "E-MECIES",
"st_iesregistradoradiploma": "REGISTROIES",
"st_emeciesregistradoradiploma": "E-MECNOVAMENTE",
"id_usuariocadastro": 5004,
"endereco": {
"sg_uf": "MG",
"st_cep": "35661209",
"st_endereco": "Rua Maria Lina de Oliveira",
"st_bairro": "S\u00e3o Luiz",
"st_complemento": "AP 208",
"nu_numero": 320,
"st_cidade": "PAR\u00c1 DE MINAS",
"bl_ativo": true,
"id_pais": 22,
"id_municipio": 3147105,
"id_tipoendereco": "3",
"bl_padrao": true
}
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_entidade": 2566,
"st_cnpj": "15784622000125",
"st_nomeentidade": "ENTIDADE CRIADA PELA API",
"st_razaosocial": "CRIADA PELA API",
"nu_inscricaoestadual": "6143129823800",
"st_urlsite": "http:\/\/www.teste.com.br",
"st_siglaentidade": "CPA",
"st_urlportal": null,
"st_urlnovoportal": null,
"st_apelido": "CRIADA API",
"st_urllogoutportal": null,
"id_usuariosecretariado": null,
"st_mantenedora": "Mantenedora",
"st_cnpjmantenedora": "73600983000170",
"st_emecmantenedora": "e-mec",
"st_instituicaoensinosuperior": "IES",
"st_emecinstituicaoensinosuperior": "E-MECIES",
"st_iesregistradoradiploma": "REGISTROIES",
"st_emeciesregistradoradiploma": "E-MECNOVAMENTE",
"id_usuariocadastro": "5004",
"endereco": {
"id_endereco": "1317821",
"sg_uf": "MG",
"st_cep": "35661209",
"st_endereco": "Rua Maria Lina de Oliveira",
"st_bairro": "São Luiz",
"st_complemento": "AP 208",
"nu_numero": 320,
"st_cidade": "PARÁ DE MINAS",
"bl_ativo": 1,
"id_pais": 22,
"id_municipio": 3147105,
"id_tipoendereco": "3",
"bl_padrao": 1
}
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_cnpj": [
"The st cnpj must be at least 15 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
PUT api/g2/entidade/{id_entidadecadastro}/entidade/{id_entidade}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_entidade |
required | O ID da entidade a ser alterada. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
st_cnpj |
string | required | CNPJ da entidade. |
st_nomeentidade |
string | required | Nome da entidade. |
st_razaosocial |
string | required | Razão social da entidade. |
nu_inscricaoestadual |
string | optional | Número da inscrição estadual. |
st_urlsite |
string | optional | URL do site da entidade. |
st_siglaentidade |
string | optional | Sigla da entidade. |
st_urlportal |
string | optional | URL do portal da entidade. |
st_urlnovoportal |
string | optional | URL do novo portal da entidade. |
st_apelido |
string | optional | Apelido da entidade. |
st_urllogoutportal |
string | optional | URL de logout do portal. |
id_usuariosecretariado |
integer | optional | ID do usuário secretariado. |
st_mantenedora |
string | optional | Nome da mantenedora. |
st_cnpjmantenedora |
string | optional | CNPJ da mantenedora. |
st_emecmantenedora |
string | optional | Código e-MEC da mantenedora. |
st_instituicaoensinosuperior |
string | optional | Nome da instituição de ensino superior. |
st_emecinstituicaoensinosuperior |
string | optional | Código e-MEC da instituição de ensino superior. |
st_iesregistradoradiploma |
string | optional | Nome da IES registradora do diploma. |
st_emeciesregistradoradiploma |
string | optional | Código e-MEC da IES registradora do diploma. |
id_usuariocadastro |
integer | required | ID do usuário que está cadastrando a entidade. |
endereco |
object | required | Objeto contendo as informações do endereço. |
endereco.sg_uf |
string | required | Estado (UF). |
endereco.st_cep |
string | required | CEP sem máscara. |
endereco.st_endereco |
string | required | Nome da rua. |
endereco.st_bairro |
string | required | Nome do bairro. |
endereco.st_complemento |
string | optional | Complemento do endereço. |
endereco.nu_numero |
integer | required | Número do endereço. |
endereco.st_cidade |
string | required | Nome da cidade. |
endereco.bl_ativo |
boolean | required | Se o endereço está ativo. |
endereco.id_pais |
integer | optional | ID do país. |
endereco.id_municipio |
integer | optional | ID do município conforme IBGE. |
endereco.id_tipoendereco |
string | optional | Tipo do endereço. |
endereco.bl_padrao |
boolean | optional | Se o endereço é o padrão. |
Retornar
Requires authentication
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade/2564"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/entidade/2564"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_entidade": 2566,
"st_cnpj": "15784622000125",
"st_nomeentidade": "ENTIDADE CRIADA PELA API",
"st_razaosocial": "CRIADA PELA API",
"nu_inscricaoestadual": "6143129823800",
"st_urlsite": "http:\/\/www.teste.com.br",
"st_siglaentidade": "CPA",
"st_urlportal": null,
"st_urlnovoportal": null,
"st_apelido": "CRIADA API",
"st_urllogoutportal": null,
"id_usuariosecretariado": null,
"st_mantenedora": "Mantenedora",
"st_cnpjmantenedora": "73600983000170",
"st_emecmantenedora": "e-mec",
"st_instituicaoensinosuperior": "IES",
"st_emecinstituicaoensinosuperior": "E-MECIES",
"st_iesregistradoradiploma": "REGISTROIES",
"st_emeciesregistradoradiploma": "E-MECNOVAMENTE",
"id_usuariocadastro": "5004",
"endereco": {
"id_endereco": "1317821",
"sg_uf": "MG",
"st_cep": "35661209",
"st_endereco": "Rua Maria Lina de Oliveira",
"st_bairro": "São Luiz",
"st_complemento": "AP 208",
"nu_numero": 320,
"st_cidade": "PARÁ DE MINAS",
"bl_ativo": 1,
"id_pais": 22,
"id_municipio": 3147105,
"id_tipoendereco": "3",
"bl_padrao": 1
}
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_cnpj": [
"The st cnpj must be at least 15 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/entidade/{id_entidade}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_entidade |
required | O ID da entidade a ser retornada. |
Lançamento
api/fluxus/responsavel-financeiro/salvar
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/responsavel-financeiro/salvar"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/responsavel-financeiro/salvar"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/responsavel-financeiro/salvar
POST api/fluxus/responsavel-financeiro/salvar
Atualiza os vencimentos seguintes ao id_lancamentoinicial
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos-recorrentes/1/atualizar-vencimentos"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos-recorrentes/1/atualizar-vencimentos"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/lancamentos-recorrentes/{id_lancamento}/atualizar-vencimentos
POST api/fluxus/lancamentos-recorrentes/{id_lancamento}/atualizar-vencimentos
api/fluxus/lancamentos-cc/{id_lancamento}/atualizar-vencimentos
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos-cc/1/atualizar-vencimentos"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos-cc/1/atualizar-vencimentos"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/lancamentos-cc/{id_lancamento}/atualizar-vencimentos
POST api/fluxus/lancamentos-cc/{id_lancamento}/atualizar-vencimentos
Atualiza a data de vencimento no RM de um lançamento específico.
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos/1/atualizar-vencimento"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/lancamentos/1/atualizar-vencimento"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/lancamentos/{id_lancamento}/atualizar-vencimento
POST api/fluxus/lancamentos/{id_lancamento}/atualizar-vencimento
Atualiza o meio de pagamento da parcela no Fluxus
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/meio-pagamento/atualizar"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/meio-pagamento/atualizar"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/meio-pagamento/atualizar
POST api/fluxus/meio-pagamento/atualizar
api/fluxus/atualizar-info-cartao-lancamento
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/atualizar-info-cartao-lancamento"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/atualizar-info-cartao-lancamento"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/atualizar-info-cartao-lancamento
POST api/fluxus/atualizar-info-cartao-lancamento
Sincronizar Venda Fluxus X G2
[Realiza a sincronização da venda do Fluxus no G2 e as suas parcelas.]
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/lancamento/sincronizar-fluxus-g2-receiv" \
-H "Content-Type: application/json" \
-d '{"venda":6}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/lancamento/sincronizar-fluxus-g2-receiv"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"venda": 6
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"tipo": 1,
"titulo": "Sucesso",
"mensagem": {
"sucesso": [
{
"mensagem": "Parcelas atualizadas com sucesso!"
}
],
"erro": [
{
"mensagem": "Nenhuma parcela foi encontrada para atualização."
}
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Mensagem de erro"
}
HTTP Request
POST api/lancamento/sincronizar-fluxus-g2-receiv
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
venda |
integer | required | ID da venda para sincronizar |
Meios de pagamentos disponíveis pela entidade do lançamento
[Recupera os meios de pagamento disponíveis a partir da entidade do lançamento informado]
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/lancamento/consultar-meio-pagamento-diponivel-entidade" \
-H "Content-Type: application/json" \
-d '{"lancamento":8}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/lancamento/consultar-meio-pagamento-diponivel-entidade"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"lancamento": 8
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"tipo": 1,
"titulo": "Sucesso",
"mensagem": {
"id_meiopagamento": "1",
"st_meiopagamento": "CARTÃO DE CRÉDITO",
"id_codcoligada": "123456",
"st_codsistema": "0001",
"st_cartaobandeira": "VISA"
}
}
Example response (418):
{
"tipo": 2,
"titulo": "Aviso",
"mensagem": "Informe o id do Lancamento."
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Mensagem de erro"
}
HTTP Request
POST api/lancamento/consultar-meio-pagamento-diponivel-entidade
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
lancamento |
integer | required | ID do lancamento que deseja recuperar os meios de pagamento |
api/lancamento/webhook-quebra-acordo
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/lancamento/webhook-quebra-acordo"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/lancamento/webhook-quebra-acordo"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/lancamento/webhook-quebra-acordo
Lançamentos
Requires authentication
Lista os lançamentos ( parcelas ) de uma venda. Você pode usar filtros opcionais.
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamentos?bl_quitado=1&id_lancamento=0000"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamentos"
);
let params = {
"bl_quitado": "1",
"id_lancamento": "0000",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id_venda": "0000000",
"id_lancamento": "0000000",
"nu_ordem": "1",
"bl_entrada": "1",
"st_tiporesponsavelfinanceiro": "PF",
"id_responsavelfinanceiro": "0000",
"st_responsavelfinanceiro": "Um Usuário Qualquer",
"id_usuariolancamento": "0000",
"id_entidadelancamento": null,
"dt_vencimento": "2025-02-10",
"dt_cadastro": "2025-02-07 15:07:21.3530000",
"nu_valor": "000.00",
"nu_quitado": null,
"dt_quitado": null,
"bl_quitado": "0",
"id_usuariovenda": "0000",
"st_nomecompleto": "Um Usuário Qualquer",
"st_nomeusuario": "Um Usuário Qualquer",
"id_meiopagamento": "11",
"st_meiopagamento": "Cartão Recorrente",
"st_urlpagamento": "https:\/\/algum-link-de-pagamento"
}
]
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}/lancamentos
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_venda |
required | O ID da venda. |
Query Parameters
Parameter | Status | Description |
---|---|---|
bl_quitado |
optional | Status de pagamento, pode ser 0 ou 1. |
id_lancamento |
optional | ID de um lançamento. |
Lançamento
Requires authentication
Retorna um lançamento
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamento/121312"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamento/121312"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id_venda": "0000000",
"id_lancamento": "0000000",
"nu_ordem": "1",
"bl_entrada": "1",
"st_tiporesponsavelfinanceiro": "PF",
"id_responsavelfinanceiro": "0000",
"st_responsavelfinanceiro": "Um Usuário Qualquer",
"id_usuariolancamento": "0000",
"id_entidadelancamento": null,
"dt_vencimento": "2025-02-10",
"dt_cadastro": "2025-02-07 15:07:21.3530000",
"nu_valor": "000.00",
"nu_quitado": null,
"dt_quitado": null,
"bl_quitado": "0",
"id_usuariovenda": "0000",
"st_nomecompleto": "Um Usuário Qualquer",
"st_nomeusuario": "Um Usuário Qualquer",
"id_meiopagamento": "11",
"st_meiopagamento": "Cartão Recorrente",
"st_urlpagamento": "https:\/\/algum-link-de-pagamento"
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}/lancamento/{id_lancamento}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_venda |
required | O ID da venda. |
id_lancamento |
required | O ID do lançamento. |
Lançamento
Requires authentication
Atualiza um lançamento
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamento/121312"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312/lancamento/121312"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id_venda": "0000000",
"id_lancamento": "0000000",
"nu_ordem": "1",
"bl_entrada": "1",
"st_tiporesponsavelfinanceiro": "PF",
"id_responsavelfinanceiro": "0000",
"st_responsavelfinanceiro": "Um Usuário Qualquer",
"id_usuariolancamento": "0000",
"id_entidadelancamento": null,
"dt_vencimento": "2025-02-10",
"dt_cadastro": "2025-02-07 15:07:21.3530000",
"nu_valor": "000.00",
"nu_quitado": null,
"dt_quitado": null,
"bl_quitado": "0",
"id_usuariovenda": "0000",
"st_nomecompleto": "Um Usuário Qualquer",
"st_nomeusuario": "Um Usuário Qualquer",
"id_meiopagamento": "11",
"st_meiopagamento": "Cartão Recorrente",
"st_urlpagamento": "https:\/\/algum-link-de-pagamento"
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
PUT api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}/lancamento/{id_lancamento}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_venda |
required | O ID da venda. |
id_lancamento |
required | O ID do lançamento. |
Loja
Entidade
[Buscar informações básicas da entidade para a loja]
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/loja/entidade?id_entidade=1408"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/loja/entidade"
);
let params = {
"id_entidade": "1408",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"tipo": 1,
"titulo": "Sucesso",
"mensagem": {
"id_entidade": "14",
"st_nomeentidade": "FACULDADE UNYLEYA",
"st_urlportal": "http:\/\/portal.unyleya.edu.br",
"st_urlnovoportal": "https:\/\/portalaluno.unyleya.edu.br"
}
}
Example response (418):
{
"tipo": 2,
"titulo": "Aviso",
"mensagem": "Informe a entidade"
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Mensagem de erro"
}
HTTP Request
GET api/loja/entidade
Query Parameters
Parameter | Status | Description |
---|---|---|
id_entidade |
optional | integer ID da entidade. |
Produto
[Buscar informações básicas do produto para a loja]
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/loja/produto?id_produto=19187&id_entidade=1408"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/loja/produto"
);
let params = {
"id_produto": "19187",
"id_entidade": "1408",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
Example response (418):
{
"tipo": 2,
"titulo": "Aviso",
"mensagem": "Informe o produto"
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Mensagem de erro"
}
HTTP Request
GET api/loja/produto
Query Parameters
Parameter | Status | Description |
---|---|---|
id_produto |
optional | integer ID do produto. |
id_entidade |
optional | integer ID do produto. |
Salvar Venda
[Buscar informações básicas do produto para a loja]
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/loja/venda" \
-H "Content-Type: application/json" \
-d '{"id_entidadelogin":14,"id_entidadevenda":1408,"id_usuario":9999999,"produtos":"[19187]"}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/loja/venda"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"id_entidadelogin": 14,
"id_entidadevenda": 1408,
"id_usuario": 9999999,
"produtos": "[19187]"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"tipo": 1,
"titulo": "Sucesso",
"mensagem": {
"bl_confirmado": true,
"id_venda": 1141941
}
}
Example response (418):
{
"tipo": 2,
"titulo": "Aviso",
"mensagem": "Informe o produto"
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Mensagem de erro"
}
HTTP Request
POST api/loja/venda
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
id_entidadelogin |
integer | required | ID da entidade que será COPIADO os dados de acesso. |
id_entidadevenda |
integer | required | ID da entidade que será COLADO os dados de acesso e também salvar a venda. |
id_usuario |
integer | required | ID do usuário. |
produtos |
integer[] | required | Listar somente os IDs dos produtos para a nova venda. |
Usuario
Cadastrar
Requires authentication
Registra um novo usuário no sistema com os dados fornecidos.
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario" \
-H "Content-Type: application/json" \
-d '{"id_usuario":16,"st_cpf":"est","st_email":"quae","id_pais":2,"id_tiposanguineo":5,"sg_fatorrh":"impedit","id_municipionascimento":20,"id_titulacao":9,"id_estadocivil":6,"id_nivelensino":1,"st_nomeinstituicao":"nam","st_curso":"voluptate","bl_alunoestrangeiro":11,"st_nomecompleto":"et","st_sexo":"maxime","st_nomeexibicao":"itaque","dt_nascimento":"doloribus","st_rg":"dolore","st_orgaoexpeditor":"culpa","dt_dataexpedicao":"inventore","st_nomepai":"voluptatum","st_nomemae":"quam","st_passaporte":"nisi","st_nomesocial":"ea","bl_nomesocialdocumentos":14,"telefones":[{"bl_padrao":11,"id_tipotelefone":18,"nu_ddi":"vel","nu_ddd":"saepe","nu_telefone":"vel"}],"enderecos":[{"id_pais":3,"id_municipio":16,"id_tipoendereco":5,"bl_padrao":5,"sg_uf":"ipsum","st_cep":"non","st_endereco":"odit","st_bairro":"quasi","st_complemento":"optio","nu_numero":7,"st_cidade":"cum"}]}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"id_usuario": 16,
"st_cpf": "est",
"st_email": "quae",
"id_pais": 2,
"id_tiposanguineo": 5,
"sg_fatorrh": "impedit",
"id_municipionascimento": 20,
"id_titulacao": 9,
"id_estadocivil": 6,
"id_nivelensino": 1,
"st_nomeinstituicao": "nam",
"st_curso": "voluptate",
"bl_alunoestrangeiro": 11,
"st_nomecompleto": "et",
"st_sexo": "maxime",
"st_nomeexibicao": "itaque",
"dt_nascimento": "doloribus",
"st_rg": "dolore",
"st_orgaoexpeditor": "culpa",
"dt_dataexpedicao": "inventore",
"st_nomepai": "voluptatum",
"st_nomemae": "quam",
"st_passaporte": "nisi",
"st_nomesocial": "ea",
"bl_nomesocialdocumentos": 14,
"telefones": [
{
"bl_padrao": 11,
"id_tipotelefone": 18,
"nu_ddi": "vel",
"nu_ddd": "saepe",
"nu_telefone": "vel"
}
],
"enderecos": [
{
"id_pais": 3,
"id_municipio": 16,
"id_tipoendereco": 5,
"bl_padrao": 5,
"sg_uf": "ipsum",
"st_cep": "non",
"st_endereco": "odit",
"st_bairro": "quasi",
"st_complemento": "optio",
"nu_numero": 7,
"st_cidade": "cum"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_usuario": "0",
"st_cpf": "000.000.000-00",
"st_nomecompleto": "Nome Completo",
"dt_atualizado": "2025-02-14 16:47:54.4670000",
"bl_alunoestrangeiro": "1",
"st_email": "jonhunyflow@testefake.com",
"id_nivelensino": "16",
"st_curso": "Direito",
"st_nomeinstituicao": "FAPAM",
"st_rg": "0000000",
"st_orgaoexpeditor": "SSP\/DF",
"dt_dataexpedicao": "2002-12-05",
"st_sexo": "M",
"id_pais": "10",
"id_estadocivil": "1",
"id_tiposanguineo": "1",
"sg_fatorrh": "P",
"st_nomeexibicao": "Jonh",
"st_nomesocial": "Jonh E",
"bl_nomesocialdocumentos": "1",
"st_nomemae": "Nome da Mãe",
"st_nomepai": "Nome do Pai",
"st_passaporte": "FA123456",
"dt_nascimento": "1979-08-28",
"telefones": [
{
"id_telefone": "0",
"nu_ddi": "55",
"nu_ddd": "37",
"nu_telefone": "000000000",
"id_tipotelefone": "3",
"st_tipotelefone": "Celular",
"bl_padrao": "1",
"dt_atualizado": "2025-02-14 16:46:52.3070000"
}
],
"enderecos": [
{
"id_endereco": "0",
"id_pais": "22",
"sg_uf": "MG",
"id_municipio": "3147105",
"id_tipoendereco": "1",
"st_cep": "00000000",
"st_endereco": "Rua Qualquer",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 208",
"nu_numero": "000",
"st_cidade": "Cidade",
"bl_ativo": "1",
"dt_atualizado": "2025-02-14 16:46:52.0710000",
"bl_padrao": "1"
}
]
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_cpf": [
"The st cpf may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
POST api/g2/entidade/{id_entidadecadastro}/usuario
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
id_usuario |
integer | optional | optional ID do usuário. Exemplo: 1 |
st_cpf |
string | optional | nullable CPF do usuário. Deve ter entre 11 e 14 caracteres. Obrigatório se id_usuario e st_email não forem fornecidos. Exemplo: "12345678901" |
st_email |
string | optional | nullable E-mail do usuário. Deve ser um e-mail válido com até 255 caracteres. Obrigatório se id_usuario e st_cpf não forem fornecidos. Exemplo: "usuario@example.com" |
id_pais |
integer | optional | nullable ID do país. Exemplo: 1 |
id_tiposanguineo |
integer | optional | nullable ID do tipo sanguíneo. Exemplo: 2 |
sg_fatorrh |
string | optional | nullable Fator RH. Deve ser 'P' ou 'N'. Exemplo: "P" |
id_municipionascimento |
integer | optional | nullable ID do município de nascimento. Exemplo: 123 |
id_titulacao |
integer | optional | nullable ID da titulação. Exemplo: 4 |
id_estadocivil |
integer | optional | nullable ID do estado civil. Exemplo: 1 |
id_nivelensino |
integer | optional | nullable ID do nível de ensino. Exemplo: 3 |
st_nomeinstituicao |
string | optional | nullable Nome da instituição. Máximo de 255 caracteres. Exemplo: "Universidade XYZ" |
st_curso |
string | optional | nullable Nome do curso. Máximo de 255 caracteres. Exemplo: "Ciência da Computação" |
bl_alunoestrangeiro |
integer | optional | nullable Indicador de aluno estrangeiro. Deve ser 0 ou 1. Exemplo: 0 |
st_nomecompleto |
string | required | Nome completo. Obrigatório se id_usuario não for fornecido. Máximo de 300 caracteres. Exemplo: "João Silva" |
st_sexo |
string | optional | nullable Sexo. Deve ser 'M', 'F' ou 'O'. Exemplo: "M" |
st_nomeexibicao |
string | optional | nullable Nome de exibição. Máximo de 255 caracteres. Exemplo: "João S." |
dt_nascimento |
string | optional | nullable Data de nascimento no formato 'YYYY-MM-DD'. Deve ser anterior a hoje. Exemplo: "1990-05-15" |
st_rg |
string | optional | nullable RG. Máximo de 20 caracteres. Exemplo: "12345678" |
st_orgaoexpeditor |
string | optional | nullable Órgão expedidor do RG. Máximo de 80 caracteres. Exemplo: "SSP" |
dt_dataexpedicao |
string | optional | nullable Data de expedição no formato 'YYYY-MM-DD'. Deve ser anterior a hoje. Exemplo: "2010-03-20" |
st_nomepai |
string | optional | nullable Nome do pai. Máximo de 255 caracteres. Exemplo: "José Silva" |
st_nomemae |
string | optional | nullable Nome da mãe. Máximo de 100 caracteres. Exemplo: "Maria Silva" |
st_passaporte |
string | optional | nullable Passaporte. Máximo de 255 caracteres. Exemplo: "AB123456" |
st_nomesocial |
string | optional | nullable Nome social. Máximo de 255 caracteres. Exemplo: "Joana Silva" |
bl_nomesocialdocumentos |
integer | optional | nullable Indica se o nome social foi confirmado por documentos. Deve ser 0 ou 1. Exemplo: 0 |
telefones |
array | optional | nullable Lista de telefones do usuário. |
telefones[].bl_padrao |
integer | required | Indicador de telefone padrão. Deve ser 0 ou 1. Exemplo: 1 |
telefones[].id_tipotelefone |
integer | required | ID do tipo de telefone. Exemplo: 1 |
telefones[].nu_ddi |
string | optional | nullable DDI do telefone. Deve ter 2 dígitos. Exemplo: "55" |
telefones[].nu_ddd |
string | optional | nullable DDD do telefone. Deve ter 2 dígitos. Exemplo: "11" |
telefones[].nu_telefone |
string | optional | nullable Número do telefone. Deve ter entre 8 e 9 dígitos. Exemplo: "987654321" |
enderecos |
array | optional | nullable Lista de endereços do usuário. |
enderecos[].id_pais |
integer | required | ID do país do endereço. Exemplo: 1 |
enderecos[].id_municipio |
integer | optional | nullable ID do município do endereço. Exemplo: 123 |
enderecos[].id_tipoendereco |
integer | required | ID do tipo de endereço. Exemplo: 2 |
enderecos[].bl_padrao |
integer | required | Indicador de endereço padrão. Deve ser 0 ou 1. Exemplo: 1 |
enderecos[].sg_uf |
string | optional | nullable Sigla da UF. Deve ter 2 caracteres. Exemplo: "SP" |
enderecos[].st_cep |
string | required | CEP do endereço. Máximo de 10 caracteres. Exemplo: "12345-678" |
enderecos[].st_endereco |
string | required | Endereço completo. Máximo de 255 caracteres. Exemplo: "Rua das Flores" |
enderecos[].st_bairro |
string | required | Bairro. Máximo de 255 caracteres. Exemplo: "Centro" |
enderecos[].st_complemento |
string | optional | nullable Complemento do endereço. Máximo de 255 caracteres. Exemplo: "Apto 101" |
enderecos[].nu_numero |
integer | optional | nullable Número do endereço. Exemplo: 123 |
enderecos[].st_cidade |
string | optional | nullable Nome da cidade. Máximo de 255 caracteres. Exemplo: "São Paulo" |
Atualizar
Requires authentication
Altera os dados de um usuário.
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario/14121" \
-H "Content-Type: application/json" \
-d '{"bl_alunoestrangeiro":0,"st_cpf":"000.000.000-00","id_pais":10,"st_nomecompleto":"Nome Completo","st_email":"jonhunyflow@testefake.com","st_passaporte":"FA123456","st_sexo":"M","st_nomeexibicao":"Jonh","dt_nascimento":"1979-08-28","st_nomepai":"Nome do Pai","st_nomemae":"Nome da M\u00e3e","st_nomesocial":"Jonh E","bl_nomesocialdocumentos":4,"id_estadocivil":1,"id_nivelensino":16,"st_nomeinstituicao":"FAPAM","st_curso":"Direito","id_titulacao":1,"id_tiposanguineo":1,"sg_fatorrh":"P","dt_dataexpedicao":"2002-12-05","st_orgaoexpeditor":"SSP\/DF","st_rg":"0000000","id_municipionascimento":3147105,"telefones":[{"nu_ddi":"55","nu_ddd":"37","nu_telefone":"32367979","id_tipotelefone":1,"bl_padrao":false}],"enderecos":[{"id_pais":22,"id_municipio":3147105,"st_cep":"00000000","st_endereco":"Rua Qualquer","st_bairro":"Bairro","st_complemento":"Apartamento 208","nu_numero":"000","id_tipoendereco":1,"bl_padrao":true}]}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario/14121"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"bl_alunoestrangeiro": 0,
"st_cpf": "000.000.000-00",
"id_pais": 10,
"st_nomecompleto": "Nome Completo",
"st_email": "jonhunyflow@testefake.com",
"st_passaporte": "FA123456",
"st_sexo": "M",
"st_nomeexibicao": "Jonh",
"dt_nascimento": "1979-08-28",
"st_nomepai": "Nome do Pai",
"st_nomemae": "Nome da M\u00e3e",
"st_nomesocial": "Jonh E",
"bl_nomesocialdocumentos": 4,
"id_estadocivil": 1,
"id_nivelensino": 16,
"st_nomeinstituicao": "FAPAM",
"st_curso": "Direito",
"id_titulacao": 1,
"id_tiposanguineo": 1,
"sg_fatorrh": "P",
"dt_dataexpedicao": "2002-12-05",
"st_orgaoexpeditor": "SSP\/DF",
"st_rg": "0000000",
"id_municipionascimento": 3147105,
"telefones": [
{
"nu_ddi": "55",
"nu_ddd": "37",
"nu_telefone": "32367979",
"id_tipotelefone": 1,
"bl_padrao": false
}
],
"enderecos": [
{
"id_pais": 22,
"id_municipio": 3147105,
"st_cep": "00000000",
"st_endereco": "Rua Qualquer",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 208",
"nu_numero": "000",
"id_tipoendereco": 1,
"bl_padrao": true
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_usuario": "0",
"st_cpf": "000.000.000-00",
"st_nomecompleto": "Nome Completo",
"dt_atualizado": "2025-02-14 16:47:54.4670000",
"bl_alunoestrangeiro": "0",
"st_email": "jonhunyflow@teste.com",
"id_nivelensino": "16",
"st_curso": "Direito",
"st_nomeinstituicao": "FAPAM",
"st_rg": "0000000",
"st_orgaoexpeditor": "SSP\/DF",
"dt_dataexpedicao": "2002-12-05",
"st_sexo": "M",
"id_pais": "10",
"id_estadocivil": "1",
"id_tiposanguineo": "1",
"sg_fatorrh": "P",
"st_nomeexibicao": "Jonh",
"st_nomesocial": "Jonh E",
"bl_nomesocialdocumentos": "1",
"st_nomemae": "Nome da Mãe",
"st_nomepai": "Nome do Pai",
"st_passaporte": "FA123456",
"dt_nascimento": "1979-08-28",
"telefones": [
{
"id_telefone": "0",
"nu_ddi": "55",
"nu_ddd": "37",
"nu_telefone": "000000000",
"id_tipotelefone": "3",
"st_tipotelefone": "Celular",
"bl_padrao": "1",
"dt_atualizado": "2025-02-14 16:46:52.3070000"
}
],
"enderecos": [
{
"id_endereco": "0",
"id_pais": "22",
"sg_uf": "MG",
"id_municipio": "3147105",
"id_tipoendereco": "1",
"st_cep": "00000000",
"st_endereco": "Rua Qualquer",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 208",
"nu_numero": "000",
"st_cidade": "Cidade",
"bl_ativo": "1",
"dt_atualizado": "2025-02-14 16:46:52.0710000",
"bl_padrao": "1"
}
]
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_cpf": [
"The st cpf may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
PUT api/g2/entidade/{id_entidadecadastro}/usuario/{id_usuario}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_usuario |
required | O ID do usuário a ser alterado. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
bl_alunoestrangeiro |
integer | required | Indica se o usuário é estrangeiro. |
st_cpf |
string | required | CPF do usuário. |
id_pais |
integer | required | ID do país de origem. |
st_nomecompleto |
string | required | Nome completo do usuário. |
st_email |
string | required | Email do usuário. |
st_passaporte |
string | optional | Opcional. Número do passaporte se for estrangeiro. |
st_sexo |
string | required | Gênero do usuário. |
st_nomeexibicao |
string | required | Nome para exibição. |
dt_nascimento |
date | required | Data de nascimento. |
st_nomepai |
string | optional | Opcional. Nome do pai. |
st_nomemae |
string | optional | Opcional. Nome da mãe. |
st_nomesocial |
string | optional | Opcional. Nome social do usuário. |
bl_nomesocialdocumentos |
integer | optional | nullable Indica se o nome social foi confirmado por documentos. Deve ser 0 ou 1. Exemplo: 0 |
id_estadocivil |
integer | optional | Opcional. ID do estado civil. |
id_nivelensino |
integer | required | ID do nível de ensino. |
st_nomeinstituicao |
string | optional | Opcional. Nome da instituição de ensino. |
st_curso |
string | optional | Opcional. Nome do curso. |
id_titulacao |
integer | optional | Opcional. ID da titulação. |
id_tiposanguineo |
integer | optional | Opcional. ID do tipo sanguíneo. |
sg_fatorrh |
string | optional | Opcional. Fator RH. |
dt_dataexpedicao |
date | optional | Opcional. Data de expedição do RG. |
st_orgaoexpeditor |
string | optional | Opcional. Órgão expedidor do RG. |
st_rg |
string | optional | Opcional. Número do RG. |
id_municipionascimento |
integer | optional | Opcional. ID do município de nascimento. |
telefones |
array | required | Lista de telefones. |
telefones[].nu_ddi |
string | required | Código DDI. |
telefones[].nu_ddd |
string | required | Código DDD. |
telefones[].nu_telefone |
string | required | Número de telefone. |
telefones[].id_tipotelefone |
integer | required | Tipo do telefone. |
telefones[].bl_padrao |
boolean | required | Indica se é o telefone principal. |
enderecos |
array | required | Lista de endereços. |
enderecos[].id_pais |
integer | required | ID do país. |
enderecos[].id_municipio |
integer | required | ID do município. |
enderecos[].st_cep |
string | required | CEP do endereço. |
enderecos[].st_endereco |
string | required | Nome da rua. |
enderecos[].st_bairro |
string | required | Bairro. |
enderecos[].st_complemento |
string | optional | Opcional. Complemento do endereço. |
enderecos[].nu_numero |
string | required | Número da residência. |
enderecos[].id_tipoendereco |
integer | required | Tipo do endereço. |
enderecos[].bl_padrao |
boolean | required | Indica se é o endereço principal. |
Retornar
Requires authentication
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario/14121"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/usuario/14121"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (201):
{
"id_usuario": "0",
"st_cpf": "000.000.000-00",
"st_nomecompleto": "Nome Completo",
"dt_atualizado": "2025-02-14 16:47:54.4670000",
"bl_alunoestrangeiro": "1",
"st_email": "jonhunyflow@testefake.com",
"id_nivelensino": "16",
"st_curso": "Direito",
"st_nomeinstituicao": "FAPAM",
"st_rg": "0000000",
"st_orgaoexpeditor": "SSP\/DF",
"dt_dataexpedicao": "2002-12-05",
"st_sexo": "M",
"id_pais": "10",
"id_estadocivil": "1",
"id_tiposanguineo": "1",
"sg_fatorrh": "P",
"st_nomeexibicao": "Jonh",
"st_nomesocial": "Jonh E",
"st_nomemae": "Nome da Mãe",
"st_nomepai": "Nome do Pai",
"st_passaporte": "FA123456",
"dt_nascimento": "1979-08-28",
"telefones": [
{
"id_telefone": "0",
"nu_ddi": "55",
"nu_ddd": "37",
"nu_telefone": "000000000",
"id_tipotelefone": "3",
"st_tipotelefone": "Celular",
"bl_padrao": "1",
"dt_atualizado": "2025-02-14 16:46:52.3070000"
}
],
"enderecos": [
{
"id_endereco": "0",
"id_pais": "22",
"sg_uf": "MG",
"id_municipio": "3147105",
"id_tipoendereco": "1",
"st_cep": "00000000",
"st_endereco": "Rua Qualquer",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 208",
"nu_numero": "000",
"st_cidade": "Cidade",
"bl_ativo": "1",
"dt_atualizado": "2025-02-14 16:46:52.0710000",
"bl_padrao": "1"
}
]
}
Example response (400):
{
"tipo": 2,
"titulo": "Atenção",
"mensagem": "Usuário não encontrado!",
"resultado": "Usuário não encontrado!"
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/usuario/{id_usuario}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_usuario |
required | O ID do usuário a ser alterado. |
Util
Lista os países
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/util/paises"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/util/paises"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id_pais": "22",
"st_nomepais": "Brasil",
"st_nacionalidade": "BRASILEIRA",
"sg_pais": "BRA"
},
{
"id_pais": "23",
"st_nomepais": "Bulgária",
"st_nacionalidade": "BÚLGARA",
"sg_pais": "BGR"
}
]
Example response (400):
null
HTTP Request
GET api/util/paises
Lista os municícpios
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/util/municipios?sg_uf=MG"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/util/municipios"
);
let params = {
"sg_uf": "MG",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id_municipio": "3100104",
"st_nomemunicipio": "ABADIA DOS DOURADOS",
"nu_codigoibge": "3100104",
"sg_uf": "MG",
"dt_atualizado": null
},
{
"id_municipio": "3100203",
"st_nomemunicipio": "ABAETÉ",
"nu_codigoibge": "3100203",
"sg_uf": "MG",
"dt_atualizado": null
}
]
Example response (400):
null
HTTP Request
GET api/util/municipios
Query Parameters
Parameter | Status | Description |
---|---|---|
sg_uf |
optional | optional UF |
Venda
Pesquisar
Requires authentication
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/vendas?dt_cadastroinicio=consequuntur&dt_cadastrofim=blanditiis&id_usuario=illo&st_nome=et&st_cpf=facilis&id_sitema=molestiae&page=1&per_page=10"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/vendas"
);
let params = {
"dt_cadastroinicio": "consequuntur",
"dt_cadastrofim": "blanditiis",
"id_usuario": "illo",
"st_nome": "et",
"st_cpf": "facilis",
"id_sitema": "molestiae",
"page": "1",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"current_page": 1,
"data": [
{
"id_venda": "000000",
"id_entidade": "00",
"id_polo": "000",
"id_usuario": "0000000",
"st_cpf": "00000000000",
"st_nomecompleto": "Tony Stark",
"id_usuariocadastro": "0000000",
"id_atendente": "0",
"id_afiliado": 0,
"st_afiliado": "Afiliado",
"id_campanhacomercial": 0,
"id_situacao": "00",
"st_situacao": "Ativo",
"id_evolucao": "0",
"st_evolucao": "Aguardando Recebimento",
"dt_atualizado": "1060-01-01 00:00:00.0000000",
"dt_cadastro": "1060-01-01 00:00:00.0000000",
"id_formapagamento": "000",
"dt_confirmacao": "1060-01-01 00:00:00.0000000",
"nu_valorliquido": "100.50",
"nu_valorbruto": "200.00",
"id_codcoligada": "23",
"id_sistema": "0",
"st_sistema": "CRM Educacional - Wakeme",
"st_vendaexterna": "0000",
"st_urlnotificacao": "https:\/\/[url-de-notificacao-de-pagamentos]"
}
],
"first_page_url": "http:\/\/[APIURL]\/api\/g2\/entidade\/14\/vendas?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/[APIURL]\/api\/g2\/entidade\/14\/vendas?page=1",
"next_page_url": null,
"path": "http:\/\/[APIURL]\/api\/g2\/entidade\/14\/vendas",
"per_page": 10,
"prev_page_url": null,
"to": 8,
"total": 8
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/vendas
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
Query Parameters
Parameter | Status | Description |
---|---|---|
dt_cadastroinicio |
required | Data inicial para pesquisda baseada na data de cadastro da venda no formato YYYY-MM-DD |
dt_cadastrofim |
required | Data final para pesquisda baseada na data de cadastro da venda no formato YYYY-MM-DD |
id_usuario |
optional | ID do cliente |
st_nome |
optional | Nome do cliente |
st_cpf |
optional | CPF do cliente |
id_sitema |
optional | ID do sistema externo usado no cadastro da venda |
page |
optional | A página, |
per_page |
optional | Quantidade de registros por página, |
Cadastrar
Requires authentication
Este endpoint permite criar uma venda com informações do usuário, produtos e lançamentos financeiros.
Inclui validações para garantir que valores líquidos sejam consistentes com valores brutos e que os dados do usuário sejam fornecidos corretamente.
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda" \
-H "Content-Type: application/json" \
-d '{"id_usuariocadastro":1,"id_polo":2,"id_localidade":3,"id_afiliado":4,"id_sistema":5,"id_evolucao":6,"st_vendaexterna":"Venda Externa","st_urlnotificacao":"https:\/\/example.com\/notify","id_atendente":7,"st_codigocupom":"DESCONTO10","utm_source":"google","utm_term":"promo\u00e7\u00e3o","utm_medium":"cpc","utm_content":"banner","utm_campaign":"verao2025","id_campanhacomercial":8,"usuario":{"id_usuario":1,"st_cpf":"12345678001","id_pais":1,"id_tiposanguineo":2,"sg_fatorrh":"P","id_municipionascimento":3,"id_titulacao":4,"id_estadocivil":5,"id_nivelensino":6,"st_nomeinstituicao":"Universidade X","st_curso":"Engenharia","bl_alunoestrangeiro":0,"st_nomecompleto":"Jo\u00e3o Silva","st_email":"joao@example.com","st_sexo":"M","st_nomeexibicao":"Jo\u00e3o S.","dt_nascimento":"1000-01-01","st_rg":"12345678","st_orgaoexpeditor":"SSP","dt_dataexpedicao":"2010-01-01","st_nomepai":"Jos\u00e9 Silva","st_nomemae":"Maria Silva","st_passaporte":"AB123456","st_nomesocial":"Jo\u00e3ozinho","telefones":[{"bl_padrao":1,"id_tipotelefone":1,"nu_ddi":"55","nu_ddd":"11","nu_telefone":"087654321"}],"enderecos":[{"id_pais":1,"id_municipio":2,"id_tipoendereco":1,"bl_padrao":1,"sg_uf":"SP","st_cep":"12345-678","st_endereco":"Rua Example","st_bairro":"Centro","st_complemento":"Apto 101","nu_numero":123,"st_cidade":"S\u00e3o Paulo"}]},"produtos":[{"id_produto":2,"id_tiposelecao":3,"nu_valorliquido":5,"nu_valorbruto":10,"id_turma":4,"id_campanhacomercial":5}],"lancamentos":[{"id_meiopagamento":2,"id_usuariolancamento":3,"id_entidadelancamento":4,"nu_cartao":12345,"nu_valor":10,"dt_vencimento":"2025-03-01"}]}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"id_usuariocadastro": 1,
"id_polo": 2,
"id_localidade": 3,
"id_afiliado": 4,
"id_sistema": 5,
"id_evolucao": 6,
"st_vendaexterna": "Venda Externa",
"st_urlnotificacao": "https:\/\/example.com\/notify",
"id_atendente": 7,
"st_codigocupom": "DESCONTO10",
"utm_source": "google",
"utm_term": "promo\u00e7\u00e3o",
"utm_medium": "cpc",
"utm_content": "banner",
"utm_campaign": "verao2025",
"id_campanhacomercial": 8,
"usuario": {
"id_usuario": 1,
"st_cpf": "12345678001",
"id_pais": 1,
"id_tiposanguineo": 2,
"sg_fatorrh": "P",
"id_municipionascimento": 3,
"id_titulacao": 4,
"id_estadocivil": 5,
"id_nivelensino": 6,
"st_nomeinstituicao": "Universidade X",
"st_curso": "Engenharia",
"bl_alunoestrangeiro": 0,
"st_nomecompleto": "Jo\u00e3o Silva",
"st_email": "joao@example.com",
"st_sexo": "M",
"st_nomeexibicao": "Jo\u00e3o S.",
"dt_nascimento": "1000-01-01",
"st_rg": "12345678",
"st_orgaoexpeditor": "SSP",
"dt_dataexpedicao": "2010-01-01",
"st_nomepai": "Jos\u00e9 Silva",
"st_nomemae": "Maria Silva",
"st_passaporte": "AB123456",
"st_nomesocial": "Jo\u00e3ozinho",
"telefones": [
{
"bl_padrao": 1,
"id_tipotelefone": 1,
"nu_ddi": "55",
"nu_ddd": "11",
"nu_telefone": "087654321"
}
],
"enderecos": [
{
"id_pais": 1,
"id_municipio": 2,
"id_tipoendereco": 1,
"bl_padrao": 1,
"sg_uf": "SP",
"st_cep": "12345-678",
"st_endereco": "Rua Example",
"st_bairro": "Centro",
"st_complemento": "Apto 101",
"nu_numero": 123,
"st_cidade": "S\u00e3o Paulo"
}
]
},
"produtos": [
{
"id_produto": 2,
"id_tiposelecao": 3,
"nu_valorliquido": 5,
"nu_valorbruto": 10,
"id_turma": 4,
"id_campanhacomercial": 5
}
],
"lancamentos": [
{
"id_meiopagamento": 2,
"id_usuariolancamento": 3,
"id_entidadelancamento": 4,
"nu_cartao": 12345,
"nu_valor": 10,
"dt_vencimento": "2025-03-01"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id_venda": "000000",
"id_entidade": "00",
"id_polo": "0",
"id_usuariocadastro": "0",
"id_atendente": "0",
"id_campanhacomercial": null,
"id_situacao": "0",
"id_evolucao": "0",
"dt_atualizado": "2025-02-17 14:15:45.2070000",
"dt_cadastro": "2025-02-17 14:14:20.2570000",
"id_formapagamento": "723",
"dt_confirmacao": null,
"nu_valorliquido": "2800.50",
"nu_valorbruto": "6644.00",
"id_codcoligada": "23",
"id_sistema": "0",
"st_vendaexterna": "0000",
"st_urlnotificacao": "https:\/\/dev13-g2.unyleya.xyz\/teste\/confirma",
"usuario": {
"id_usuario": "0",
"st_cpf": "000.000.000.-00",
"st_nomecompleto": "Jonh UnyFlow 1702",
"dt_atualizado": "2025-02-17 14:15:44.8070000",
"bl_alunoestrangeiro": "0",
"st_email": "jonhunyflow1702@testefake.com",
"id_nivelensino": "16",
"st_curso": "Direito",
"st_nomeinstituicao": "FACULDADE",
"st_rg": "0000000",
"st_orgaoexpeditor": "SSP\/DF",
"dt_dataexpedicao": "2002-12-05",
"st_sexo": "M",
"id_pais": "10",
"id_estadocivil": "1",
"id_tiposanguineo": "1",
"sg_fatorrh": "N",
"st_nomeexibicao": "JonhU",
"st_nomesocial": "Jonh U",
"st_nomemae": "Nome da Mãe",
"st_nomepai": "Nome do Pai",
"st_passaporte": "FA123456",
"dt_nascimento": "1070-08-28",
"telefones": [
{
"id_telefone": "3534431",
"nu_ddi": "55",
"nu_ddd": "00",
"nu_telefone": "000000000",
"id_tipotelefone": "3",
"st_tipotelefone": "Celular",
"bl_padrao": "1",
"dt_atualizado": "2025-02-17 14:14:20.2030000"
}
],
"enderecos": [
{
"id_endereco": "0",
"id_pais": "22",
"sg_uf": "MG",
"id_municipio": "3147105",
"id_tipoendereco": "1",
"st_cep": "00000000",
"st_endereco": "Rua Example",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 000",
"nu_numero": "000",
"st_estadoprovincia": null,
"st_cidade": "Cidade",
"bl_ativo": "1",
"dt_atualizado": "2025-02-17 14:14:20.1330000",
"bl_padrao": "1"
}
]
},
"produtos": [
{
"id_produto": "2041",
"st_produto": " CV100 - ENFERMAGEM EM CARDIOLOGIA CLÍNICA E INTERVENCIONISTA",
"id_tipoproduto": "1",
"id_situacao": "45",
"st_subtitulo": null,
"st_slug": null,
"id_modelovenda": "1",
"st_cargahoraria": null,
"st_codigoavaliacao": "1",
"st_codigoprodutoexterno": null,
"id_subtipoproduto": null,
"id_vendaproduto": "1022524",
"nu_desconto": "3843.50",
"id_venda": "000000",
"id_campanhacomercial": "0",
"nu_valorliquido": "2800.50",
"nu_valorbruto": "6644.00",
"id_matricula": null,
"id_turma": "0",
"id_produtocombo": null,
"id_tiposelecao": "1"
}
],
"lancamentos": [
{
"id_venda": "000000",
"id_lancamento": "110033",
"nu_ordem": "1",
"bl_entrada": "1",
"st_tiporesponsavelfinanceiro": "PF",
"id_responsavelfinanceiro": "0",
"st_responsavelfinanceiro": "Jonh UnyFlow Estrangeiro",
"id_usuariolancamento": "0",
"id_entidadelancamento": null,
"dt_vencimento": "2025-02-25",
"dt_cadastro": "2025-02-17 14:15:45.1770000",
"nu_valor": "033.50",
"nu_quitado": null,
"dt_quitado": null,
"bl_quitado": "0",
"id_usuariovenda": "0",
"st_nomecompleto": "Jonh UnyFlow Estrangeiro",
"st_nomeusuario": "Jonh UnyFlow 1702",
"id_meiopagamento": "17",
"st_meiopagamento": "PIX",
"st_urlpagamento": "https:\/\/url-pagamento"
}
]
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
POST api/g2/entidade/{id_entidadecadastro}/venda
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
id_usuariocadastro |
integer | required | O ID do usuário que está cadastrando a venda. |
id_polo |
integer | optional | O ID do polo associado à venda, se aplicável. |
id_localidade |
integer | optional | O ID da localidade associada à venda, se aplicável. |
id_afiliado |
integer | optional | O ID do afiliado associado à venda, se aplicável. |
id_sistema |
integer | required | O ID do sistema relacionado à venda. |
id_evolucao |
integer | optional | O ID da evolução associada à venda, se aplicável. |
st_vendaexterna |
string | optional | Uma descrição da venda externa, máximo 50 caracteres. |
st_urlnotificacao |
string | optional | URL de notificação, máximo 250 caracteres. |
id_atendente |
integer | optional | O ID do atendente associado à venda, se aplicável. |
st_codigocupom |
string | optional | Código do cupom, máximo 255 caracteres. |
utm_source |
string | optional | Origem da campanha UTM, máximo 120 caracteres. |
utm_term |
string | optional | Termo da campanha UTM, máximo 120 caracteres. |
utm_medium |
string | optional | Meio da campanha UTM, máximo 120 caracteres. |
utm_content |
string | optional | Conteúdo da campanha UTM, máximo 120 caracteres. |
utm_campaign |
string | optional | Nome da campanha UTM, máximo 120 caracteres. |
id_campanhacomercial |
integer | optional | O ID da campanha comercial associada, se aplicável. |
usuario |
object | required | Dados do usuário associado à venda (obrigatório se não houver CPF ou vice-versa). |
usuario.id_usuario |
integer | optional | O ID do usuário, requerido se CPF não for fornecido. |
usuario.st_cpf |
string | optional | O CPF do usuário, requerido se ID não for fornecido, entre 11 e 14 caracteres. |
usuario.id_pais |
integer | optional | O ID do país do usuário. |
usuario.id_tiposanguineo |
integer | optional | O ID do tipo sanguíneo do usuário. |
usuario.sg_fatorrh |
string | optional | O fator RH do usuário, deve ser P ou N. |
usuario.id_municipionascimento |
integer | optional | O ID do município de nascimento do usuário. |
usuario.id_titulacao |
integer | optional | O ID da titulação do usuário. |
usuario.id_estadocivil |
integer | optional | O ID do estado civil do usuário. |
usuario.id_nivelensino |
integer | optional | O ID do nível de ensino do usuário. |
usuario.st_nomeinstituicao |
string | optional | Nome da instituição do usuário, máximo 255 caracteres. |
usuario.st_curso |
string | optional | Curso do usuário, máximo 255 caracteres. |
usuario.bl_alunoestrangeiro |
integer | optional | Indica se é aluno estrangeiro (0 ou 1). |
usuario.st_nomecompleto |
string | optional | Nome completo do usuário, requerido se ID não for fornecido, máximo 300 caracteres. |
usuario.st_email |
string | optional | E-mail do usuário, requerido se ID não for fornecido, máximo 255 caracteres. |
usuario.st_sexo |
string | optional | Sexo do usuário, deve ser M, F ou O. |
usuario.st_nomeexibicao |
string | optional | Nome de exibição do usuário, máximo 255 caracteres. |
usuario.dt_nascimento |
string | optional | Data de nascimento no formato Y-m-d, anterior a hoje. |
usuario.st_rg |
string | optional | RG do usuário, máximo 20 caracteres. |
usuario.st_orgaoexpeditor |
string | optional | Órgão expedidor do RG, máximo 80 caracteres. |
usuario.dt_dataexpedicao |
string | optional | Data de expedição do RG no formato Y-m-d, anterior a hoje. |
usuario.st_nomepai |
string | optional | Nome do pai, máximo 255 caracteres. |
usuario.st_nomemae |
string | optional | Nome da mãe, máximo 100 caracteres. |
usuario.st_passaporte |
string | optional | Passaporte, máximo 255 caracteres. |
usuario.st_nomesocial |
string | optional | Nome social, máximo 255 caracteres. |
usuario.telefones |
array | optional | Lista de telefones do usuário. |
usuario.telefones[].bl_padrao |
integer | optional | Indica se é o telefone padrão (0 ou 1). |
usuario.telefones[].id_tipotelefone |
integer | optional | Tipo de telefone. |
usuario.telefones[].nu_ddi |
string | optional | DDI do telefone, 2 dígitos. |
usuario.telefones[].nu_ddd |
string | optional | DDD do telefone, 2 dígitos. |
usuario.telefones[].nu_telefone |
string | optional | Número do telefone, 8 ou 0 dígitos. |
usuario.enderecos |
array | optional | Lista de endereços do usuário. |
usuario.enderecos[].id_pais |
integer | required | O ID do país do endereço. |
usuario.enderecos[].id_municipio |
integer | optional | O ID do município do endereço. |
usuario.enderecos[].id_tipoendereco |
integer | required | O tipo de endereço. |
usuario.enderecos[].bl_padrao |
integer | optional | Indica se é o endereço padrão (0 ou 1). |
usuario.enderecos[].sg_uf |
string | optional | UF do endereço, 2 caracteres. |
usuario.enderecos[].st_cep |
string | required | CEP do endereço, máximo 10 caracteres. |
usuario.enderecos[].st_endereco |
string | required | Logradouro do endereço, máximo 255 caracteres. |
usuario.enderecos[].st_bairro |
string | required | Bairro do endereço, máximo 255 caracteres. |
usuario.enderecos[].st_complemento |
string | optional | Complemento do endereço, máximo 255 caracteres. |
usuario.enderecos[].nu_numero |
integer | optional | Número do endereço. |
usuario.enderecos[].st_cidade |
string | optional | Cidade do endereço, máximo 255 caracteres. |
produtos |
array | required | Lista de produtos da venda (mínimo 1 item). |
produtos[].id_produto |
integer | required | O ID do produto. |
produtos[].id_tiposelecao |
integer | optional | O ID do tipo de seleção do produto. |
produtos[].nu_valorliquido |
float | required | O valor líquido do produto, mínimo 0.01. |
produtos[].nu_valorbruto |
float | required | O valor bruto do produto, mínimo 0.01. |
produtos[].id_turma |
integer | optional | O ID da turma associada ao produto. |
produtos[].id_campanhacomercial |
integer | optional | O ID da campanha comercial do produto. |
lancamentos |
array | required | Lista de lançamentos financeiros da venda (mínimo 1 item). |
lancamentos[].id_meiopagamento |
integer | required | O ID do meio de pagamento. |
lancamentos[].id_usuariolancamento |
integer | optional | O ID do usuário que fez o lançamento. |
lancamentos[].id_entidadelancamento |
integer | optional | O ID da entidade do lançamento. |
lancamentos[].nu_cartao |
integer | optional | Número do cartão (máximo 5 dígitos). |
lancamentos[].nu_valor |
float | required | O valor do lançamento, mínimo 0.01. |
lancamentos[].dt_vencimento |
string | required | Data de vencimento no formato Y-m-d. |
Alterar
Requires authentication
Altera uma venda com os dados do usuário, produtos e lançamentos no sistema.
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312" \
-H "Content-Type: application/json" \
-d '{"id_usuariocadastro":1,"id_polo":2,"id_localidade":3,"id_afiliado":4,"id_sistema":5,"id_evolucao":6,"st_vendaexterna":"Venda Externa","st_urlnotificacao":"https:\/\/example.com\/notify","id_atendente":7,"st_codigocupom":"DESCONTO10","utm_source":"google","utm_term":"promo\u00e7\u00e3o","utm_medium":"cpc","utm_content":"banner","utm_campaign":"verao2025","id_campanhacomercial":8,"usuario":{"id_usuario":1,"st_cpf":"12345678001","id_pais":1,"id_tiposanguineo":2,"sg_fatorrh":"P","id_municipionascimento":3,"id_titulacao":4,"id_estadocivil":5,"id_nivelensino":6,"st_nomeinstituicao":"Universidade X","st_curso":"Engenharia","bl_alunoestrangeiro":0,"st_nomecompleto":"Jo\u00e3o Silva","st_email":"joao@example.com","st_sexo":"M","st_nomeexibicao":"Jo\u00e3o S.","dt_nascimento":"1000-01-01","st_rg":"12345678","st_orgaoexpeditor":"SSP","dt_dataexpedicao":"2010-01-01","st_nomepai":"Jos\u00e9 Silva","st_nomemae":"Maria Silva","st_passaporte":"AB123456","st_nomesocial":"Jo\u00e3ozinho","telefones":[{"bl_padrao":1,"id_tipotelefone":1,"nu_ddi":"55","nu_ddd":"11","nu_telefone":"087654321"}],"enderecos":[{"id_pais":1,"id_municipio":2,"id_tipoendereco":1,"bl_padrao":1,"sg_uf":"SP","st_cep":"12345-678","st_endereco":"Rua Example","st_bairro":"Centro","st_complemento":"Apto 101","nu_numero":123,"st_cidade":"S\u00e3o Paulo"}]},"produtos":[{"id_vendaproduto":1,"id_produto":2,"id_tiposelecao":3,"nu_valorliquido":5,"nu_valorbruto":10,"id_turma":4,"id_campanhacomercial":5}],"lancamentos":[{"id_lancamento":1,"id_meiopagamento":2,"id_usuariolancamento":3,"id_entidadelancamento":4,"nu_cartao":12345,"nu_valor":10,"dt_vencimento":"2025-03-01"}]}'
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/121312"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"id_usuariocadastro": 1,
"id_polo": 2,
"id_localidade": 3,
"id_afiliado": 4,
"id_sistema": 5,
"id_evolucao": 6,
"st_vendaexterna": "Venda Externa",
"st_urlnotificacao": "https:\/\/example.com\/notify",
"id_atendente": 7,
"st_codigocupom": "DESCONTO10",
"utm_source": "google",
"utm_term": "promo\u00e7\u00e3o",
"utm_medium": "cpc",
"utm_content": "banner",
"utm_campaign": "verao2025",
"id_campanhacomercial": 8,
"usuario": {
"id_usuario": 1,
"st_cpf": "12345678001",
"id_pais": 1,
"id_tiposanguineo": 2,
"sg_fatorrh": "P",
"id_municipionascimento": 3,
"id_titulacao": 4,
"id_estadocivil": 5,
"id_nivelensino": 6,
"st_nomeinstituicao": "Universidade X",
"st_curso": "Engenharia",
"bl_alunoestrangeiro": 0,
"st_nomecompleto": "Jo\u00e3o Silva",
"st_email": "joao@example.com",
"st_sexo": "M",
"st_nomeexibicao": "Jo\u00e3o S.",
"dt_nascimento": "1000-01-01",
"st_rg": "12345678",
"st_orgaoexpeditor": "SSP",
"dt_dataexpedicao": "2010-01-01",
"st_nomepai": "Jos\u00e9 Silva",
"st_nomemae": "Maria Silva",
"st_passaporte": "AB123456",
"st_nomesocial": "Jo\u00e3ozinho",
"telefones": [
{
"bl_padrao": 1,
"id_tipotelefone": 1,
"nu_ddi": "55",
"nu_ddd": "11",
"nu_telefone": "087654321"
}
],
"enderecos": [
{
"id_pais": 1,
"id_municipio": 2,
"id_tipoendereco": 1,
"bl_padrao": 1,
"sg_uf": "SP",
"st_cep": "12345-678",
"st_endereco": "Rua Example",
"st_bairro": "Centro",
"st_complemento": "Apto 101",
"nu_numero": 123,
"st_cidade": "S\u00e3o Paulo"
}
]
},
"produtos": [
{
"id_vendaproduto": 1,
"id_produto": 2,
"id_tiposelecao": 3,
"nu_valorliquido": 5,
"nu_valorbruto": 10,
"id_turma": 4,
"id_campanhacomercial": 5
}
],
"lancamentos": [
{
"id_lancamento": 1,
"id_meiopagamento": 2,
"id_usuariolancamento": 3,
"id_entidadelancamento": 4,
"nu_cartao": 12345,
"nu_valor": 10,
"dt_vencimento": "2025-03-01"
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
PUT api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_venda |
required | O ID da venda. |
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
id_usuariocadastro |
integer | required | O ID do usuário que está cadastrando a venda. |
id_polo |
integer | optional | O ID do polo associado à venda, se aplicável. |
id_localidade |
integer | optional | O ID da localidade associada à venda, se aplicável. |
id_afiliado |
integer | optional | O ID do afiliado associado à venda, se aplicável. |
id_sistema |
integer | required | O ID do sistema relacionado à venda. |
id_evolucao |
integer | optional | O ID da evolução associada à venda, se aplicável. |
st_vendaexterna |
string | optional | Uma descrição da venda externa, máximo 50 caracteres. |
st_urlnotificacao |
string | optional | URL de notificação, máximo 250 caracteres. |
id_atendente |
integer | optional | O ID do atendente associado à venda, se aplicável. |
st_codigocupom |
string | optional | Código do cupom, máximo 255 caracteres. |
utm_source |
string | optional | Origem da campanha UTM, máximo 120 caracteres. |
utm_term |
string | optional | Termo da campanha UTM, máximo 120 caracteres. |
utm_medium |
string | optional | Meio da campanha UTM, máximo 120 caracteres. |
utm_content |
string | optional | Conteúdo da campanha UTM, máximo 120 caracteres. |
utm_campaign |
string | optional | Nome da campanha UTM, máximo 120 caracteres. |
id_campanhacomercial |
integer | optional | O ID da campanha comercial associada, se aplicável. |
usuario |
object | required | Dados do usuário associado à venda (obrigatório se não houver CPF ou vice-versa). |
usuario.id_usuario |
integer | optional | O ID do usuário, requerido se CPF não for fornecido. |
usuario.st_cpf |
string | optional | O CPF do usuário, requerido se ID não for fornecido, entre 11 e 14 caracteres. |
usuario.id_pais |
integer | optional | O ID do país do usuário. |
usuario.id_tiposanguineo |
integer | optional | O ID do tipo sanguíneo do usuário. |
usuario.sg_fatorrh |
string | optional | O fator RH do usuário, deve ser P ou N. |
usuario.id_municipionascimento |
integer | optional | O ID do município de nascimento do usuário. |
usuario.id_titulacao |
integer | optional | O ID da titulação do usuário. |
usuario.id_estadocivil |
integer | optional | O ID do estado civil do usuário. |
usuario.id_nivelensino |
integer | optional | O ID do nível de ensino do usuário. |
usuario.st_nomeinstituicao |
string | optional | Nome da instituição do usuário, máximo 255 caracteres. |
usuario.st_curso |
string | optional | Curso do usuário, máximo 255 caracteres. |
usuario.bl_alunoestrangeiro |
integer | optional | Indica se é aluno estrangeiro (0 ou 1). |
usuario.st_nomecompleto |
string | optional | Nome completo do usuário, requerido se ID não for fornecido, máximo 300 caracteres. |
usuario.st_email |
string | optional | E-mail do usuário, requerido se ID não for fornecido, máximo 255 caracteres. |
usuario.st_sexo |
string | optional | Sexo do usuário, deve ser M, F ou O. |
usuario.st_nomeexibicao |
string | optional | Nome de exibição do usuário, máximo 255 caracteres. |
usuario.dt_nascimento |
string | optional | Data de nascimento no formato Y-m-d, anterior a hoje. |
usuario.st_rg |
string | optional | RG do usuário, máximo 20 caracteres. |
usuario.st_orgaoexpeditor |
string | optional | Órgão expedidor do RG, máximo 80 caracteres. |
usuario.dt_dataexpedicao |
string | optional | Data de expedição do RG no formato Y-m-d, anterior a hoje. |
usuario.st_nomepai |
string | optional | Nome do pai, máximo 255 caracteres. |
usuario.st_nomemae |
string | optional | Nome da mãe, máximo 100 caracteres. |
usuario.st_passaporte |
string | optional | Passaporte, máximo 255 caracteres. |
usuario.st_nomesocial |
string | optional | Nome social, máximo 255 caracteres. |
usuario.telefones |
array | optional | Lista de telefones do usuário. |
usuario.telefones[].bl_padrao |
integer | optional | Indica se é o telefone padrão (0 ou 1). |
usuario.telefones[].id_tipotelefone |
integer | optional | Tipo de telefone. |
usuario.telefones[].nu_ddi |
string | optional | DDI do telefone, 2 dígitos. |
usuario.telefones[].nu_ddd |
string | optional | DDD do telefone, 2 dígitos. |
usuario.telefones[].nu_telefone |
string | optional | Número do telefone, 8 ou 0 dígitos. |
usuario.enderecos |
array | optional | Lista de endereços do usuário. |
usuario.enderecos[].id_pais |
integer | required | O ID do país do endereço. |
usuario.enderecos[].id_municipio |
integer | optional | O ID do município do endereço. |
usuario.enderecos[].id_tipoendereco |
integer | required | O tipo de endereço. |
usuario.enderecos[].bl_padrao |
integer | optional | Indica se é o endereço padrão (0 ou 1). |
usuario.enderecos[].sg_uf |
string | optional | UF do endereço, 2 caracteres. |
usuario.enderecos[].st_cep |
string | required | CEP do endereço, máximo 10 caracteres. |
usuario.enderecos[].st_endereco |
string | required | Logradouro do endereço, máximo 255 caracteres. |
usuario.enderecos[].st_bairro |
string | required | Bairro do endereço, máximo 255 caracteres. |
usuario.enderecos[].st_complemento |
string | optional | Complemento do endereço, máximo 255 caracteres. |
usuario.enderecos[].nu_numero |
integer | optional | Número do endereço. |
usuario.enderecos[].st_cidade |
string | optional | Cidade do endereço, máximo 255 caracteres. |
produtos |
array | required | Lista de produtos da venda (mínimo 1 item). |
produtos[].id_vendaproduto |
integer | optional | O ID da venda-produto, se existente. OBRIGATÓRIO no caso de alterações pois na ausência irá adicionar o produto e não alterar. |
produtos[].id_produto |
integer | required | O ID do produto. |
produtos[].id_tiposelecao |
integer | optional | O ID do tipo de seleção do produto. |
produtos[].nu_valorliquido |
float | required | O valor líquido do produto, mínimo 0.01. |
produtos[].nu_valorbruto |
float | required | O valor bruto do produto, mínimo 0.01. |
produtos[].id_turma |
integer | optional | O ID da turma associada ao produto. |
produtos[].id_campanhacomercial |
integer | optional | O ID da campanha comercial do produto. |
lancamentos |
array | required | Lista de lançamentos financeiros da venda (mínimo 1 item). |
lancamentos[].id_lancamento |
integer | optional | O ID do lançamento, se existente. |
lancamentos[].id_meiopagamento |
integer | required | O ID do meio de pagamento. |
lancamentos[].id_usuariolancamento |
integer | optional | O ID do usuário que fez o lançamento. |
lancamentos[].id_entidadelancamento |
integer | optional | O ID da entidade do lançamento. |
lancamentos[].nu_cartao |
integer | optional | Número do cartão (máximo 5 dígitos). |
lancamentos[].nu_valor |
float | required | O valor do lançamento, mínimo 0.01. |
lancamentos[].dt_vencimento |
string | required | Data de vencimento no formato Y-m-d. |
Retornar
Requires authentication
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/14"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/14/venda/14"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id_venda": "000000",
"id_entidade": "00",
"id_polo": "0",
"id_usuariocadastro": "0",
"id_atendente": "0",
"id_campanhacomercial": null,
"id_situacao": "0",
"id_evolucao": "0",
"dt_atualizado": "2025-02-17 14:15:45.2070000",
"dt_cadastro": "2025-02-17 14:14:20.2570000",
"id_formapagamento": "723",
"dt_confirmacao": null,
"nu_valorliquido": "2800.50",
"nu_valorbruto": "6644.00",
"id_codcoligada": "23",
"id_sistema": "0",
"st_vendaexterna": "0000",
"st_urlnotificacao": "https:\/\/dev13-g2.unyleya.xyz\/teste\/confirma",
"usuario": {
"id_usuario": "0",
"st_cpf": "000.000.000.-00",
"st_nomecompleto": "Jonh UnyFlow 1702",
"dt_atualizado": "2025-02-17 14:15:44.8070000",
"bl_alunoestrangeiro": "0",
"st_email": "jonhunyflow1702@teste.com",
"id_nivelensino": "16",
"st_curso": "Direito",
"st_nomeinstituicao": "FACULDADE",
"st_rg": "0000000",
"st_orgaoexpeditor": "SSP\/DF",
"dt_dataexpedicao": "2002-12-05",
"st_sexo": "M",
"id_pais": "10",
"id_estadocivil": "1",
"id_tiposanguineo": "1",
"sg_fatorrh": "N",
"st_nomeexibicao": "JonhU",
"st_nomesocial": "Jonh U",
"st_nomemae": "Nome da Mãe",
"st_nomepai": "Nome do Pai",
"st_passaporte": "FA123456",
"dt_nascimento": "1070-08-28",
"telefones": [
{
"id_telefone": "3534431",
"nu_ddi": "55",
"nu_ddd": "00",
"nu_telefone": "000000000",
"id_tipotelefone": "3",
"st_tipotelefone": "Celular",
"bl_padrao": "1",
"dt_atualizado": "2025-02-17 14:14:20.2030000"
}
],
"enderecos": [
{
"id_endereco": "0",
"id_pais": "22",
"sg_uf": "MG",
"id_municipio": "3147105",
"id_tipoendereco": "1",
"st_cep": "00000000",
"st_endereco": "Rua Example",
"st_bairro": "Bairro",
"st_complemento": "Apartamento 000",
"nu_numero": "000",
"st_estadoprovincia": null,
"st_cidade": "Cidade",
"bl_ativo": "1",
"dt_atualizado": "2025-02-17 14:14:20.1330000",
"bl_padrao": "1"
}
]
},
"produtos": [
{
"id_produto": "2041",
"st_produto": " CV100 - ENFERMAGEM EM CARDIOLOGIA CLÍNICA E INTERVENCIONISTA",
"id_tipoproduto": "1",
"id_situacao": "45",
"st_subtitulo": null,
"st_slug": null,
"id_modelovenda": "1",
"st_cargahoraria": null,
"st_codigoavaliacao": "1",
"st_codigoprodutoexterno": null,
"id_subtipoproduto": null,
"id_vendaproduto": "1022524",
"nu_desconto": "3843.50",
"id_venda": "000000",
"id_campanhacomercial": "0",
"nu_valorliquido": "2800.50",
"nu_valorbruto": "6644.00",
"id_matricula": null,
"id_turma": "0",
"id_produtocombo": null,
"id_tiposelecao": "1"
}
],
"lancamentos": [
{
"id_venda": "000000",
"id_lancamento": "110033",
"nu_ordem": "1",
"bl_entrada": "1",
"st_tiporesponsavelfinanceiro": "PF",
"id_responsavelfinanceiro": "0",
"st_responsavelfinanceiro": "Jonh UnyFlow Estrangeiro",
"id_usuariolancamento": "0",
"id_entidadelancamento": null,
"dt_vencimento": "2025-02-25",
"dt_cadastro": "2025-02-17 14:15:45.1770000",
"nu_valor": "033.50",
"nu_quitado": null,
"dt_quitado": null,
"bl_quitado": "0",
"id_usuariovenda": "0",
"st_nomecompleto": "Jonh UnyFlow Estrangeiro",
"st_nomeusuario": "Jonh UnyFlow 1702",
"id_meiopagamento": "17",
"st_meiopagamento": "PIX",
"st_urlpagamento": "https:\/\/url-pagamento"
}
]
}
Example response (400):
{
"tipo": 2,
"titulo": "Requisição inválida.",
"mensagem": "Não foi possível executar a ação, verifique os dados enviados.",
"dados": {
"st_dado": [
"The st_dado may not be greater than 14 characters."
]
}
}
Example response (503):
{
"tipo": 0,
"titulo": "Erro",
"mensagem": "Erro interno",
"resultado": "Erro interno"
}
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}
URL Parameters
Parameter | Status | Description |
---|---|---|
id_entidadecadastro |
required | O ID da entidade que é a dona do cadastro. |
id_venda |
required | O ID da venda. |
api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}/confirmar-e-matricular
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/g2/entidade/1/venda/1/confirmar-e-matricular"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/g2/entidade/1/venda/1/confirmar-e-matricular"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (500):
null
HTTP Request
GET api/g2/entidade/{id_entidadecadastro}/venda/{id_venda}/confirmar-e-matricular
general
api/btg/executar-baixas
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/btg/executar-baixas"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/btg/executar-baixas"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/btg/executar-baixas
api/btg/executar-baixas
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/btg/executar-baixas"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/btg/executar-baixas"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
[
{
"id_postbackbtg": "3643352",
"nu_tentativas": 1,
"id_venda": "1743382",
"id_lancamento": "11949289",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "384.64",
"dt_lastupdatetimestamp": "2025-06-10 22:37:29.8465798",
"st_transactionidentification": "11949289a1743382a1749592461aG2",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "384.64",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17131102",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "384.64",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772588593",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "17",
"st_tempoexecucao": "0.551 Segundos"
},
{
"id_postbackbtg": "3643351",
"nu_tentativas": 1,
"id_venda": "1897192",
"id_lancamento": "11738638",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "172.32",
"dt_lastupdatetimestamp": "2025-06-10 22:36:51.7937319",
"st_transactionidentification": "d18c0722-6f95-4dc4-9ed1-aba7cad8a66b",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "172.32",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso BOLEPIX-PIX id: 17075997",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "172.32",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5124098",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5124098",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "1.257 Segundos"
},
{
"id_postbackbtg": "3643349",
"nu_tentativas": 1,
"id_venda": "1897192",
"id_lancamento": "11738638",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "172.32",
"dt_lastupdatetimestamp": "2025-06-10 22:36:44.7737267",
"st_transactionidentification": "d18c07226f954dc49ed1aba7cad8a66b",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "172.32",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17075997",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "172.32",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772585278",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5124098",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5124098",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.559 Segundos"
},
{
"id_postbackbtg": "3643348",
"nu_tentativas": 1,
"id_venda": "1649444",
"id_lancamento": "9925584",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "209.09",
"dt_lastupdatetimestamp": "2025-06-10 22:36:43.0400217",
"st_transactionidentification": "696ff3f9-427a-46d6-8715-e95c575d4e0a",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "209.09",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso BOLEPIX-PIX id: 17060515",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "209.09",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "3792073",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "3792073",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.558 Segundos"
},
{
"id_postbackbtg": "3643346",
"nu_tentativas": 1,
"id_venda": "1649444",
"id_lancamento": "9925584",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "209.09",
"dt_lastupdatetimestamp": "2025-06-10 22:36:35.8820379",
"st_transactionidentification": "696ff3f9427a46d68715e95c575d4e0a",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "209.09",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17060515",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "209.09",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772584628",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "3792073",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "3792073",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.46 Segundos"
},
{
"id_postbackbtg": "3643340",
"nu_tentativas": 1,
"id_venda": "1673132",
"id_lancamento": "11949327",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "191.22",
"dt_lastupdatetimestamp": "2025-06-10 22:35:21.3454121",
"st_transactionidentification": "292693a6-47c8-451d-993d-b1b97d18e2f7",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "191.22",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso BOLEPIX-PIX id: 17131121",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "191.22",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5265320",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5265320",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.637 Segundos"
},
{
"id_postbackbtg": "3643338",
"nu_tentativas": 1,
"id_venda": "1890141",
"id_lancamento": "11688357",
"st_entity": "PaymentSlip",
"st_status": "PROCESSING_PAYMENT",
"nu_amount": "164.09",
"dt_lastupdatetimestamp": "2025-06-10 22:35:13.8366715",
"st_transactionidentification": "f9d9f5a8-93fc-437d-afcd-7b307d025122",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "164.09",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17075035",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "164.09",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_tempoexecucao": "0.329 Segundos"
},
{
"id_postbackbtg": "3643339",
"nu_tentativas": 1,
"id_venda": "1673132",
"id_lancamento": "11949327",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "191.22",
"dt_lastupdatetimestamp": "2025-06-10 22:35:13.2834962",
"st_transactionidentification": "292693a647c8451d993db1b97d18e2f7",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "191.22",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17131121",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "191.22",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772578596",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5265320",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5265320",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.496 Segundos"
},
{
"id_postbackbtg": "3643337",
"nu_tentativas": 1,
"id_venda": "1894957",
"id_lancamento": "11724006",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "99.08",
"dt_lastupdatetimestamp": "2025-06-10 22:35:11.5623145",
"st_transactionidentification": "85be9bcd-d0d7-40a4-8b03-fa7416ef8a13",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "99.08",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso BOLEPIX-PIX id: 17075618",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "99.08",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5132563",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5132563",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.598 Segundos"
},
{
"id_postbackbtg": "3643335",
"nu_tentativas": 1,
"id_venda": "1894957",
"id_lancamento": "11724006",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "99.08",
"dt_lastupdatetimestamp": "2025-06-10 22:35:03.6300615",
"st_transactionidentification": "85be9bcdd0d740a48b03fa7416ef8a13",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "99.08",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17075618",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "99.08",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772577903",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5132563",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5132563",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.444 Segundos"
},
{
"id_postbackbtg": "3643327",
"nu_tentativas": 1,
"id_venda": "1880735",
"id_lancamento": "11621526",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "166.41",
"dt_lastupdatetimestamp": "2025-06-10 22:33:57.9743775",
"st_transactionidentification": "68917e73-5bc8-4a57-8653-061eed30424a",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "166.41",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso BOLEPIX-PIX id: 17074140",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "166.41",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5037342",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5037342",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.661 Segundos"
},
{
"id_postbackbtg": "3643325",
"nu_tentativas": 1,
"id_venda": "1880735",
"id_lancamento": "11621526",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "166.41",
"dt_lastupdatetimestamp": "2025-06-10 22:33:51.0433863",
"st_transactionidentification": "68917e735bc84a578653061eed30424a",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "166.41",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17074140",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "166.41",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": "1000772572591",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_fluxus": {
"Mensagem": "Sucesso ao alterar o meio de pagamento",
"IDLAN": "5037342",
"CODTB2FLX": "0029",
"CODCOLIGADA": "23",
"st_codlancamento": "5037342",
"id_cartaobandeira": null,
"st_cartaobandeira": null,
"id_meiopagamentofluxus": "0029",
"id_codcoligada": "23"
},
"st_tempoexecucao": "0.546 Segundos"
},
{
"id_postbackbtg": "3643324",
"nu_tentativas": 1,
"id_venda": "1520687",
"id_lancamento": "11949127",
"st_entity": "PaymentSlip",
"st_status": "PROCESSING_PAYMENT",
"nu_amount": "206.22",
"dt_lastupdatetimestamp": "2025-06-10 22:33:34.5958099",
"st_transactionidentification": "56da7653-3815-4b64-b83b-3edb152af6ea",
"dt_movementdate": "2025-06-10",
"nu_amountpaid": "206.22",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Transacao quitada com sucesso: id: 17131034",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "206.22",
"bl_quitado": 1,
"st_autorizacao": null,
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "2",
"st_tempoexecucao": "2.149 Segundos"
},
{
"id_postbackbtg": "3643323",
"nu_tentativas": "1",
"id_venda": "1924762",
"id_lancamento": "11944822",
"st_entity": "PixPaymentInbound",
"st_status": "CONFIRMED",
"nu_amount": "200.00",
"dt_lastupdatetimestamp": "2025-06-10 22:32:42.6043175",
"st_transactionidentification": "11944822a1924762a1749573885aG2",
"dt_movementdate": "2025-06-10 22:32:42.6043175",
"nu_amountpaid": "200.00",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Possivelmente este registro já foi baixado por este robô neste momento.",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "200.00000",
"bl_quitado": "1",
"st_autorizacao": "1000772567575",
"id_movementid": "1000772567575",
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "17",
"st_tempoexecucao": "0.029 Segundos"
},
{
"id_postbackbtg": "3643316",
"nu_tentativas": "1",
"id_venda": "1925238",
"id_lancamento": "11949028",
"st_entity": "PaymentSlipPix",
"st_status": "PAID",
"nu_amount": "160.00",
"dt_lastupdatetimestamp": "2025-06-10 22:29:01.1250717",
"st_transactionidentification": "20b64c02-9025-4fda-8e74-f09905d61a10",
"dt_movementdate": "2025-06-10 00:00:00.0000000",
"nu_amountpaid": "160.00",
"id_codboleto": null,
"id_codboletoparcela": null,
"st_retornobaixa": "Possivelmente este registro já foi baixado por este robô neste momento.",
"st_sistema": "G2",
"dt_quitado": "2025-06-10",
"nu_quitado": "160.00000",
"bl_quitado": "1",
"st_autorizacao": "1000772550725",
"id_movementid": null,
"st_nfe": null,
"st_nfeservico": null,
"id_meiopagamento": "17",
"st_tempoexecucao": "0.034 Segundos"
}
]
HTTP Request
GET api/btg/executar-baixas
api/danfe/gerar-movimento
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/danfe/gerar-movimento"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/gerar-movimento"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/danfe/gerar-movimento
api/danfe/cancelar-movimento
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/danfe/cancelar-movimento"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/cancelar-movimento"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/danfe/cancelar-movimento
api/danfe/obterIDLANeColigada
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/danfe/obterIDLANeColigada"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/obterIDLANeColigada"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/danfe/obterIDLANeColigada
api/danfe/roboNFE
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/danfe/roboNFE"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/roboNFE"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/danfe/roboNFE
api/danfe/servico/{protocolo}
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/danfe/servico/1"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/servico/1"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
GET api/danfe/servico/{protocolo}
Gera PDF do XML (DANFE).
Example request:
curl -X GET \
-G "https://api-financeiro.unyleya.com.br/api/danfe/1"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe/1"
);
fetch(url, {
method: "GET",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
GET api/danfe/{xml}
Consulta Chave de Acesso pelo ID do Lançamento (IDLAN) e codigo da coligada (CODCOLIGADA).
Example request:
curl -X POST \
"https://api-financeiro.unyleya.com.br/api/danfe"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/danfe"
);
fetch(url, {
method: "POST",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/danfe
api/fluxus/sincronizar/fluxus/g2
Example request:
curl -X PUT \
"https://api-financeiro.unyleya.com.br/api/fluxus/sincronizar/fluxus/g2"
const url = new URL(
"https://api-financeiro.unyleya.com.br/api/fluxus/sincronizar/fluxus/g2"
);
fetch(url, {
method: "PUT",
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
PUT api/fluxus/sincronizar/fluxus/g2
POST api/fluxus/sincronizar/fluxus/g2
GET api/fluxus/sincronizar/fluxus/g2