Neste artigo, traremos o significado das palavras contidas em requisições feitas para a API do VExpenses, para consultar relatórios através de seus status (Endpoint: Report By Status).
Sumário
1. Informações sobre o relatório
2. Informações das despesas contidas no relatório
3. Dados do projeto vinculado à despesa
4. Informações do tipo de despesa vinculado à despesa
5. Informações do centro de custo vinculado à despesa
6. Informações da forma de pagamento vinculado à despesa
INFORMAÇÕES SOBRE O RELATÓRIO |
|
id |
ID VExpenses do relatório |
|
external_id |
Código de integração do usuário (ID desse usuário em seu ERP ou sistema de gestão |
|
user_id |
ID VExpenses do usuário
|
|
description |
Nome do relatório |
|
status |
Status do relatório |
|
approval_stage_id |
ID VExpenses da etapa de aprovação que o relatório está |
|
approval_user_id |
ID do usuário aprovador do relatório |
| approval_date | Data de aprovação do relatório |
|
payment_date |
Data de pagamento do relatório |
| payment_method_id | ID VExpenses do método de pagamento padrão do relatório |
|
observation |
Observação deixada pelo usuário no relatório |
|
paying_company_id |
Centro de Custos padrão do relatório |
|
on |
Relatório foi excluído? True = Não, False = Sim |
|
justification |
Justificativa inserida na despesa |
|
pdf_link |
Link em pdf do relatório |
|
created_at |
Data de criação do relatório |
|
updated_at |
Data da última alteração do relatório |
INFORMAÇÕES DAS DESPESAS CONTIDAS NO RELATÓRIO |
| expenses | Informações da despesas vinculadas ao relatório |
| id | ID VExpenses da despesa |
| user_id | ID do usuário que criou o relatório |
| mileage | Valor de Quilometragem (em casos de percursos) |
| date | Data da despesa |
| expense_type_id | ID VExpenses do tipo de despesa |
| payment_method_id | ID VExpenses do método de pagamento da despesa |
| paying_company_id | ID VExpenses do centro de custos adicionado na despesa |
| value | Valor da despesa |
| title | Nome da despesa |
| reimbursable | Reembolsável ou não |
| observation | Observação da despesa |
| on | A despesa foi excluída? True = Não, False = Sim |
| mileage_value | Valor reembolsado por KM |
| original_currency_iso | Moeda |
| exchange_rate | Taxa de câmbio (exclusivo para despesas estrangeiras) |
| converted_value | Valor convertido (exclusivo para despesas estrangeiras) |
| converted_currency_iso |
Moeda do valor convertido (exclusivo para despesas estrangeiras) |
| created_at | Data de criação da despesa |
| updated_at |
Data da última alteração na despesa |
DADOS DO PROJETO VINCULADO À DESPESA |
| id | ID VExpenses do projeto |
| integration_id | ID de integração do projeto (ID deste projeto no seu ERP ou sistema de gestão |
| expense_id | ID VExpenses da Despesa que ele está vinculado |
| description | Nome do projeto |
| percentage | Porcentagem de rateio |
| created_at | Data de criação do projeto |
| updated_at | Data de mudança do projeto |
| On | O tipo de despesa foi excluído? True = Não, False = Sim |
INFORMAÇÕES DO TIPO DE DESPESA VINCULADO À DESPESA |
| id | D VExpenses do tipo de despesa |
| integration_id" | ID de integração do tipo de despesa (ID deste tipo de despesa no seu ERP ou sistema de gestão) |
| description | Nome do tipo de despesa |
| On | O tipo de despesa foi excluído? True = Não, False = Sim |
INFORMAÇÕES DO CENTRO DE CUSTOS VINCULADO À DESPESA |
| id | ID VExpenses do Centro de Custos |
| integration_id | ID de integração do tipo de despesa (ID deste tipo de despesa no seu ERP ou sistema de gestão) |
| name | Nome do Centro de Custos |
| On | O centro de custo foi excluído? True = Não, False = Sim |
INFORMAÇÕES DA FORMA DE PAGAMENTO VINCULADA À DESPESA |
| id | ID VExpenses do método de pagamento |
| description | Nome da forma de pagamento |
| reimbursable | É reembolsável? True = Sim / False = Não |
| affects_advance | Vai abater no adiantamento? True = Sim / False = Não |
INFORMAÇÕES DO USUÁRIO QUE CRIOU A DESPESA |
| id | ID VExpenses do usuário |
| integration_id | D de integração do usuário (ID deste usuário no seu ERP ou sistema de gestão) |
| company_id" | ID VExpenses da empresa que ele faz parte |
| approval_flow_id" | ID VExpenses do fluxo de aprovação que ele faz parte |
| expense_limit_policy_id | ID VExpenses da política de despesa que ele faz |
| user_type | Tipo de usuário |
| name | Nome do usuário |
| Email do usuário | |
| cpf | CPF do usuário |
| phone1 e phone 2 | telefone do usuário |
| birth_date | Data de nascimento |
| bank | Banco cadastrado |
| agency | Agência cadastrada |
| account | Conta cadastrada |
| active | Está ativado? True = Sim/ False = Não |
| created_at | Data de criação da conta do usuário |
| updated_at |
Data da última alteração no cadastro do usuário |
INFORMAÇÕES DO ADIANTAMENTO VINCULADO AO RELATÓRIO |
| description | Nome do adiantamento cadastrado |
| advance_user_id" | ID VExpenses do usuário que criou o adiantamento |
| registration_user_id | ID VExpenses do usuário que recebeu |
| release_date | Data em que o adiantamento ficou disponível para o usuário |
| value | Valor total do relatório |
| created_at | Data de criação do adiantamento |
| updated_at | Data de última alteração feita no adiantamento |
Caso tenha dúvidas ou dificuldades com o uso, entre em contato conosco pelo chat de suporte ou pelo e-mail: suporte@vexpenses.com, teremos o prazer de te ajudar!