Skip to content

Instantly share code, notes, and snippets.

@phsantiago32

phsantiago32/api.yaml

Last active July 31, 2024 19:29
Show Gist options
  • Save phsantiago32/c46ececb3256280b162997185c156a90 to your computer and use it in GitHub Desktop.
Save phsantiago32/c46ececb3256280b162997185c156a90 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
api.yaml
openapi: 3.0.0
paths:
/api/auth/sign-up:
post:
operationId: AuthController_signUp
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignUpDto'
responses:
'200':
description: Returns a message saying that the user was created
content:
application/json:
schema:
$ref: '#/components/schemas/UserDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth/users:
get:
operationId: AuthController_getUsers
parameters: []
responses:
'200':
description: Returns a an array of users and their infos
schema:
type: AuthUserDTO
properties:
created_at:
type: string
example: '2023-08-04 01:15:54-03'
display_name:
type: string
example: Dev O2
businessPhones:
type: array
example: '[11 91234-5678]'
email:
type: string
example: [email protected]
email_verified:
type: boolean
example: 'false'
family_name:
type: string
example: Almeida
given_name:
type: string
example: Antonio
identities:
type: Identities[]
example: "\n {\n provider: 'windowslive',\n \
\ access_token: 'hash1234hash',\n expires_in: 86400,\n\
\ user_id: user12345,\n connection: 'windows',\n\
\ isSocial: true,\n }\n "
locale:
type: string
example: pt-BR
name:
type: string
example: ANtonio
nickname:
type: string
example: A. ALmeida
picture:
type: string
example: https://someurlhere
preferredLanguage:
type: string
example: BR
strategy_version:
type: number
example: '1'
updated_at:
type: string
example: '2023-07-42 12:23:12-03'
userPrincipalName:
type: string
example: Antonio
user_metadata:
type: User_metadata
example: "\n {\n cliente: \"o2\",\n phoneNumber:\
\ \"11 91234-5678\",\n givenName: \"Antonio\",\n \
\ familyName: \"Almeida\",\n name: \"Antonio ALmeida\"\
\n }\n "
last_login:
type: string
example: '2023-07-12T23:12:13.955Z'
last_ip:
type: string
example: 1234.1234.12c.b123.122.a123.b123.c123
logins_count:
type: number
example: '3'
app_metadata:
type: string
example: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuthUserDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth/users/v2:
get:
operationId: AuthController_getUsersV2
parameters: []
responses:
'200':
description: Returns a an array of users and their infos
schema:
type: AuthUserDTO
properties:
created_at:
type: string
example: '2023-08-04 01:15:54-03'
display_name:
type: string
example: Dev O2
businessPhones:
type: array
example: '[11 91234-5678]'
email:
type: string
example: [email protected]
email_verified:
type: boolean
example: 'false'
family_name:
type: string
example: Almeida
given_name:
type: string
example: Antonio
identities:
type: Identities[]
example: "\n {\n provider: 'windowslive',\n \
\ access_token: 'hash1234hash',\n expires_in: 86400,\n\
\ user_id: user12345,\n connection: 'windows',\n\
\ isSocial: true,\n }\n "
locale:
type: string
example: pt-BR
name:
type: string
example: ANtonio
nickname:
type: string
example: A. ALmeida
picture:
type: string
example: https://someurlhere
preferredLanguage:
type: string
example: BR
strategy_version:
type: number
example: '1'
updated_at:
type: string
example: '2023-07-42 12:23:12-03'
userPrincipalName:
type: string
example: Antonio
user_metadata:
type: User_metadata
example: "\n {\n cliente: \"o2\",\n phoneNumber:\
\ \"11 91234-5678\",\n givenName: \"Antonio\",\n \
\ familyName: \"Almeida\",\n name: \"Antonio ALmeida\"\
\n }\n "
last_login:
type: string
example: '2023-07-12T23:12:13.955Z'
last_ip:
type: string
example: 1234.1234.12c.b123.122.a123.b123.c123
logins_count:
type: number
example: '3'
app_metadata:
type: string
example: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuthUserDTO'
'400':
description: Something is invalid during the request body
tags:
- Auth
/api/auth/client/{client}:
get:
operationId: AuthController_getUsersByClientName
parameters:
- description: The name of the client
example: Alquilon
name: name
in: query
required: true
schema:
type: string
- description: The email of the user
example: [email protected]
name: email
in: query
required: true
schema:
type: string
responses:
'200':
description: Returns users filtered by the client name and their infos
schema:
type: AuthUserDTO
properties:
created_at:
type: string
example: '2023-08-04 01:15:54-03'
display_name:
type: string
example: Dev O2
businessPhones:
type: array
example: '[11 91234-5678]'
email:
type: string
example: [email protected]
email_verified:
type: boolean
example: 'false'
family_name:
type: string
example: Almeida
given_name:
type: string
example: Antonio
identities:
type: Identities[]
example: "\n {\n provider: 'windowslive',\n \
\ access_token: 'hash1234hash',\n expires_in: 86400,\n\
\ user_id: user12345,\n connection: 'windows',\n\
\ isSocial: true,\n }\n "
locale:
type: string
example: pt-BR
name:
type: string
example: ANtonio
nickname:
type: string
example: A. ALmeida
picture:
type: string
example: https://someurlhere
preferredLanguage:
type: string
example: BR
strategy_version:
type: number
example: '1'
updated_at:
type: string
example: '2023-07-42 12:23:12-03'
userPrincipalName:
type: string
example: Antonio
user_metadata:
type: User_metadata
example: "\n {\n cliente: \"o2\",\n phoneNumber:\
\ \"11 91234-5678\",\n givenName: \"Antonio\",\n \
\ familyName: \"Almeida\",\n name: \"Antonio ALmeida\"\
\n }\n "
last_login:
type: string
example: '2023-07-12T23:12:13.955Z'
last_ip:
type: string
example: 1234.1234.12c.b123.122.a123.b123.c123
logins_count:
type: number
example: '3'
app_metadata:
type: string
example: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUserDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth/user/{id}:
delete:
operationId: AuthController_deleteUsersById
parameters:
- name: id
required: true
in: path
description: It will delete the user related to the ID
schema:
type: string
responses:
'200':
description: ''
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
patch:
operationId: AuthController_updateUserRole
parameters:
- name: id
required: true
in: path
description: User id to make the update
schema:
type: string
requestBody:
required: true
description: New role of the user
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserDto'
responses:
'200':
description: Returns a user updated
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUserDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth:
delete:
operationId: AuthController_deleteUsersByEmail
parameters:
- description: The name of the client
example: Alquilon
name: name
in: query
required: true
schema:
type: string
- description: The email of the user
example: [email protected]
name: email
in: query
required: true
schema:
type: string
responses:
'200':
description: Return user filtered by the email with his/her info
schema:
type: AuthUserDTO
properties:
created_at:
type: string
example: '2023-08-04 01:15:54-03'
display_name:
type: string
example: Dev O2
businessPhones:
type: array
example: '[11 91234-5678]'
email:
type: string
example: [email protected]
email_verified:
type: boolean
example: 'false'
family_name:
type: string
example: Almeida
given_name:
type: string
example: Antonio
identities:
type: Identities[]
example: "\n {\n provider: 'windowslive',\n \
\ access_token: 'hash1234hash',\n expires_in: 86400,\n\
\ user_id: user12345,\n connection: 'windows',\n\
\ isSocial: true,\n }\n "
locale:
type: string
example: pt-BR
name:
type: string
example: ANtonio
nickname:
type: string
example: A. ALmeida
picture:
type: string
example: https://someurlhere
preferredLanguage:
type: string
example: BR
strategy_version:
type: number
example: '1'
updated_at:
type: string
example: '2023-07-42 12:23:12-03'
userPrincipalName:
type: string
example: Antonio
user_metadata:
type: User_metadata
example: "\n {\n cliente: \"o2\",\n phoneNumber:\
\ \"11 91234-5678\",\n givenName: \"Antonio\",\n \
\ familyName: \"Almeida\",\n name: \"Antonio ALmeida\"\
\n }\n "
last_login:
type: string
example: '2023-07-12T23:12:13.955Z'
last_ip:
type: string
example: 1234.1234.12c.b123.122.a123.b123.c123
logins_count:
type: number
example: '3'
app_metadata:
type: string
example: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUserDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth/user/is_invited:
get:
operationId: AuthController_isInvited
parameters:
- name: email
required: true
in: query
schema:
type: string
- description: The email of the user trying to login
example: [email protected]
name: email
in: query
required: true
schema:
type: string
responses:
'200':
description: Returns if an attempt of login is valid
content:
application/json:
schema:
type: boolean
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/auth/user/is_duplicated:
get:
operationId: AuthController_isDuplicated
parameters:
- name: email
required: true
in: query
schema:
type: string
- description: The email of the user trying to login
example: [email protected]
name: email
in: query
required: true
schema:
type: string
responses:
'200':
description: Returns if an attempt of login is valid
content:
application/json:
schema:
type: boolean
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Auth
/api/companies/company:
post:
operationId: CompanyController_createClient
parameters: []
requestBody:
required: true
description: The company cnpj that we will query the data from Gov APIs and
the email of the admin which will be assigned to the client
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCompanyDto'
responses:
'200':
description: Client will be created.
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
get:
operationId: CompanyController_getClientByCnpj
parameters: []
requestBody:
required: true
description: The company cnpj that we will be fetching!
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyDTO'
responses:
'200':
description: Client data
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/user:
get:
operationId: CompanyController_getEngineersCompaniesByEmail
parameters: []
responses:
'200':
description: A combination of small data from the user and the companies
he is assigned with
content:
application/json:
schema:
$ref: '#/components/schemas/EngineersCompaniesResponseMapper'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/user/{id}:
get:
operationId: CompanyController_getEngineersCompanies
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: A combination of small data from the user and the companies
he is assigned with
content:
application/json:
schema:
$ref: '#/components/schemas/EngineersCompaniesResponseMapper'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/company/{cnpj}:
get:
operationId: CompanyController_getCompanyData
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
requestBody:
required: true
description: Returns the data from a specific company
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyParams'
responses:
'200':
description: Client Data
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies:
get:
operationId: CompanyController_listCompanies
parameters: []
responses:
'200':
description: Return all companies
content:
application/json:
schema:
type: array
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
patch:
operationId: CompanyController_updateCompany
parameters: []
requestBody:
required: true
description: Updates companies keys
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCompanyDTO'
responses:
'200':
description: Client Data updated
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/iframes:
get:
operationId: CompanyController_getCompaniesIframes
parameters: []
responses:
'200':
description: A dictionary list of all iframes and their respectives companies
content:
application/json:
schema:
$ref: '#/components/schemas/GetIframesDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/{cnpj}:
delete:
operationId: CompanyController_removeCompany
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/{cnpj}/users:
get:
operationId: CompanyController_getUsersFromCompany
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
responses:
'200':
description: Response will be consisted of a list of users from a specific
company
content:
application/json:
schema:
type: array
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/assign:
patch:
operationId: CompanyController_assignUserToCompany
parameters: []
requestBody:
required: true
description: A body containing the company cnpj and user's email
content:
application/json:
schema:
$ref: '#/components/schemas/AssignUserToCompanyDTO'
responses:
'200':
description: Response will have data from the user and company that it is
associated with
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersCompany'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/companies/{cnpj}/group:
post:
operationId: CompanyController_addCompanyToAGroup
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
requestBody:
required: true
description: A body containing the companies cnpj
content:
application/json:
schema:
$ref: '#/components/schemas/AddCompanyToGroup'
responses:
'200':
description: Response will be consisted of a list of companies from a specific
company header
content:
application/json:
schema:
type: array
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
get:
operationId: CompanyController_getCompaniesFromCompanyGroup
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
responses:
'200':
description: Response will be consisted of a list of companies from a specific
company header
content:
application/json:
schema:
type: array
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
delete:
operationId: CompanyController_deleteCompaniesFromGroup
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
requestBody:
required: true
description: A body containing the companies cnpj
content:
application/json:
schema:
$ref: '#/components/schemas/AddCompanyToGroup'
responses:
'200':
description: ''
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Company
/api/widgets/cards:
post:
operationId: WidgetsController_getFaturamento
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CardsWidgetsDTO'
responses:
'200':
description: Returns a float value
content:
application/json:
schema:
$ref: '#/components/schemas/CardsDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/charts:
post:
operationId: WidgetsController_getCharts
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WidgetsDTO'
responses:
'200':
description: Returns an object ChartsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/ChartsDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/dre/table:
post:
operationId: WidgetsController_getDreTable
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREWidgetDTO'
responses:
'200':
description: Returns an object DRETablwDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DRETableDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/dre/details-category:
post:
operationId: WidgetsController_getDreDetails
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsWidgetDTO'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/dre/details-subcategory:
post:
operationId: WidgetsController_getDreDetailsSubCategory
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsWidgetDTO'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsSubcategoryDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/dre/posting:
post:
operationId: WidgetsController_getDrePosting
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsPostingWidgetDTO'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsPostingDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/fluxo-caixa/details:
post:
operationId: WidgetsController_getDRECashFlowTemp
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREWidgetDTO'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DRETableDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/cashflow/details:
post:
operationId: WidgetsController_getDRECashFlow
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREWidgetDTO'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DRETableDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/ciclo-financeiro/detalhamento:
post:
operationId: WidgetsController_getFinancialCycleDetail
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialCyclePostingDto'
responses:
'200':
description: Returns an object DREDetailsDTO
content:
application/json:
schema:
$ref: '#/components/schemas/DREDetailsPostingDTO'
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/widgets/budget:
post:
operationId: WidgetsController_getBudget
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DREWidgetDTO'
responses:
'400':
description: Something is invalid during the request body
'401':
description: Api request is not authorized to perform this action`
tags:
- Widgets
/api/assets/{cnpj}:
post:
operationId: AssetsController_uploadBudget
parameters:
- name: cnpj
required: true
in: path
schema:
type: string
responses:
'201':
description: ''
info:
title: O2 account
description: This is a microservice that is gonna handle all the authentication
between the O2 hub and other microservices
version: 0.0.1
contact: {}
tags:
- name: Authentication API
description: ''
servers:
- url: https://app-51409.dc-sp-1.absamcloud.com/
components:
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
schemas:
SignUpDto:
type: object
properties:
name:
type: string
description: Name of the user
example: Jose da Silva
email:
type: string
description: Email of the user
role:
type: string
description: Role of the user
enum:
- admin_o2
- admin_client
- admin_engineer
- o2_user
- o2_financial
- o2_support
- o2_demo
- client_financial
- client_user
phoneNumber:
type: string
description: Phone number of the user
example: +55DD9xxxxxxxx
cnpj:
type: string
description: Company cnpj that user is part of.
required:
- name
- email
- role
- phoneNumber
- cnpj
UserDTO:
type: object
properties:
id:
type: string
description: User id
name:
type: string
description: User name
email:
type: string
description: User email
password:
type: string
description: User password
is_admin:
type: boolean
description: If user is an admin or not
phoneNumber:
type: string
description: User phone number
required:
- id
- name
- email
- password
- is_admin
- phoneNumber
UserMetadataDTO:
type: object
properties:
cliente:
type: string
description: Name of the cliente the user is from
phoneNumber:
type: string
description: Phone number for this user when using SMS connections.
givenName:
type: string
description: Given name/first name/forename of this user.
familyName:
type: string
description: Family name/first name/forename of this user.
name:
type: string
description: Name of this user
required:
- cliente
- phoneNumber
- givenName
- familyName
- name
AuthUserDTO:
type: object
properties:
created_at:
type: string
description: When the user was created.
displayName:
type: string
description: Display name of the user from the provider.
businessPhones:
description: Businnes phones from the user from windowslive provider.
type: array
items:
type: string
email:
type: string
description: Email of the user.
email_verified:
type: boolean
description: If the email has been verified by Auth0.
family_name:
type: string
description: Family name/last name/surname of this user..
given_name:
type: string
description: Given name/last name/surname of this user.
identities:
description: Identities Object .
type: array
items:
type: string
locale:
type: string
description: Locale information from windowslive type user.
name:
type: string
description: Name of the user.
nickname:
type: string
description: Nickname of the user.
picture:
type: string
description: Picture URL.
preferredLanguage:
type: string
description: Preferred Language from the windowslive type user.
strategy_version:
type: number
description: Strategy version from the windowslive type user
updated_at:
type: string
description: Last updated time.
userPrincipalName:
type: string
description: User principal name from the windowslive type user
user_id:
type: string
description: User Id from Auth0.
user_metadata:
description: User metadata object
allOf:
- $ref: '#/components/schemas/UserMetadataDTO'
last_login:
type: string
description: Last login time.
last_ip:
type: string
description: Last ip user was connected with.
logins_count:
type: string
description: How many logins users has.
app_metadata:
type: string
description: App Metadata object.
required:
- created_at
- displayName
- businessPhones
- email
- email_verified
- family_name
- given_name
- identities
- locale
- name
- nickname
- picture
- preferredLanguage
- strategy_version
- updated_at
- userPrincipalName
- user_id
- user_metadata
- last_login
- last_ip
- logins_count
- app_metadata
Enum:
type: object
properties: {}
UpdateUserDto:
type: object
properties:
name:
type: string
description: The name of the user
example: Dev 2inc
phone:
type: string
description: User phone number
example: 7591234-5678
role:
description: New Role
allOf:
- $ref: '#/components/schemas/Enum'
cnpj:
type: string
description: Company cnpj
auth0UserId:
type: string
description: Auth0 user id
required:
- name
- role
- cnpj
- auth0UserId
CreateCompanyDto:
type: object
properties:
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
required:
- cnpj
AddressEntity:
type: object
properties: {}
CompanyDTO:
type: object
properties:
id:
type: number
description: Company's id
example: '1'
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
nomeEmpresarial:
type: string
description: Company name
example: O2 inc SA
dataAbertura:
format: date-time
type: string
description: Company open date
example: 08-10-2021
telefone1:
type: string
description: Company main phone number
example: '+5571912345678'
telefone2:
type: string
description: Company second phone number (if it has)
example: '+5571912345678'
telefone3:
type: string
description: Company third phone number (if it has)
example: '+5571912345678'
email:
type: string
description: Company admin email
example: [email protected]
website:
type: string
description: Company website (if it has)
example: o2inc.com.br
tipoRP:
type: string
description: Type of the client's RP
example:
- Omie
- ContaAzul
clientIdRP:
type: string
description: Client ID RP that is used for integrations
example: 1d28hf30-f18hf31-f31fh8h3
clientSecretRP:
type: string
description: Client Secret RP that is used for integrations
example: ash1fh1f8h1f-f18h2fh12f81f2h-f81hf28h1f1-81hf82hf1f-8f1h28h1
biFrame:
type: string
description: HTML IFrame for client BI Report
example: <iframe"></iframe>
nomeFantasia:
type: string
description: Company fantasy name
example: O2 inc
porte:
type: string
description: Company type size
example: ME
codigoAtvPrincipal:
type: string
description: Company main activity code
example: 70.20-4-00
descricaoAtvPrincipal:
type: string
description: Company main activity description
example: "Atividades de consultoria em gest\xE3o empresarial, exceto consultoria\
\ t\xE9cnica espec\xEDfica"
atividadesSecundarias:
description: Company sub activities object
example: "[{\n code: 64.62-0-00,\n text: Holdings de institui\xE7\
\xF5es n\xE3o-financeiras\n }]"
type: array
items:
type: string
naturezaJuridica:
type: string
description: Company legal nature
example: "Sociedade Empres\xE1ria Limitada"
situacaoCadastral:
type: string
description: Company registry situation
example: ATIVA
dataSituacaoCadastral:
format: date-time
type: string
description: Company registry date
example: '2015-12-08'
endereco:
description: Company address
allOf:
- $ref: '#/components/schemas/AddressEntity'
required:
- id
- cnpj
- nomeEmpresarial
- dataAbertura
- telefone1
- telefone2
- telefone3
- email
- website
- tipoRP
- clientIdRP
- clientSecretRP
- biFrame
- nomeFantasia
- porte
- codigoAtvPrincipal
- descricaoAtvPrincipal
- atividadesSecundarias
- naturezaJuridica
- situacaoCadastral
- dataSituacaoCadastral
- endereco
GetCompanyDTO:
type: object
properties:
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
required:
- cnpj
EngineersCompaniesResponseMapper:
type: object
properties:
userId:
type: number
description: User's id
email:
type: string
description: User's email
phoneNumber:
type: string
description: User's phone number
companiesAssignedComplete:
description: An array of data from the companies the user is assigned with
type: array
items:
type: string
required:
- userId
- email
- phoneNumber
- companiesAssignedComplete
GetCompanyParams:
type: object
properties:
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
required:
- cnpj
UpdateCompanyDTO:
type: object
properties:
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
tipo:
type: string
description: Type of the RP integration
examples:
- conta_azul
- omie
clientId:
type: string
description: ClientId of the RP integration
clientSecret:
type: string
description: Client secret of the RP integration
biFrame:
type: string
description: BI iframe of the client
telefone2:
type: string
telefone3:
type: string
description: ''
email:
type: string
description: ''
website:
type: string
description: ''
required:
- cnpj
- tipo
- clientId
- clientSecret
- biFrame
- telefone2
- telefone3
- email
- website
GetIframesDTO:
type: object
properties:
response:
description: An array with company cnpj and their iframe
type: array
items:
type: string
required:
- response
AssignUserToCompanyDTO:
type: object
properties:
cnpj:
type: string
description: Company's CNPJ
example: 12.345.678/0001-90
email:
type: string
description: User email
required:
- cnpj
- email
GetUsersCompany:
type: object
properties:
userId:
type: number
description: User id
email:
type: string
description: User's email
phoneNumber:
type: string
description: User's phone number
isAdmin:
type: boolean
description: If user is an admin or not.
name:
type: string
description: Users name.
createdAt:
type: string
description: User createdAt
companyName:
type: string
description: Company name
companyCnpj:
type: string
description: Company cnpj
required:
- userId
- email
- phoneNumber
- isAdmin
- name
- createdAt
- companyName
- companyCnpj
AddCompanyToGroup:
type: object
properties:
subCnpjs:
description: Sub company's CNPJ
example: '[''12.345.678/0001-90'', ''12.663.122/0001-23'']'
type: array
items:
type: string
required:
- subCnpjs
CardsWidgetsDTO:
type: object
properties:
cardsNames:
description: Array with the cards names to return the valor
example:
- runrate
- cashburn
- cac
- ltv
- roi
- recebido
- pago
- a-pagar
- a-receber
- a-pagar-atraso
- ciclo-financeiro
- pmp
- pme
- pmr
- ciclo-operacional
type: array
items:
type: string
section:
type: string
description: 'The name of the section. '
example: dre
startDate:
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
type: string
description: End date to filter the data
example: '2023-12-31'
cnpj:
type: string
description: 'Main company cnpj to fetch widgets '
example: '''23813779000160'''
tipoChart:
type: string
description: Type of chart
examples:
- horizontal
- barline
tipo:
type: string
description: Type of data
examples:
- REVENUES
- EXPENSES
tipoDfc:
type: string
description: Type of data
examples:
- Saldo
- Runway
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- cardsNames
- section
- startDate
- endDate
- cnpj
- tipoChart
- tipo
- tipoDfc
- cnpjs
CardsDTO:
type: object
properties:
cards:
description: Array with the cards names and values
example:
- items:
- card: runrate
valor: 0
- card: cashburn
valor: 0
- card: cac
valor: 0
- card: ltv
valor: 0
- card: roi
valor: 0
- card: pme
valor: 0
- card: faturamento
valor: 460724.7
- card: ciclo-operacional
valor: 1279.2864751934508
- card: pmp
valor: 606.3924573796388
- card: recebido
valor: 439626.23
- card: pago
valor: 358271.46
- card: pmr
valor: 1279.2864751934508
- card: a-pagar
valor: 0
- card: a-pagar-atraso
valor: 10000
- card: a-receber
valor: 0
- card: ciclo-financeiro
valor: 672.894017813812
- card: margem-contribuicao
- card: ebitda
valor: 0.648800661219162
- card: resultado-liquido
valor: 0.644451990527098
- card: resultado-final
valor: 0.47424166752943797
type: array
items:
type: string
required:
- cards
WidgetsDTO:
type: object
properties:
cardsNames:
description: Array with the cards names to return the valor
example:
- waterfall
- operacao-direta
- nao-operacional
- operacao-indireta
- entradas-saidas
- saldo-acumulado
- fluxo-caixa
- dfc-acumulado
- evolucao
- faturamento
- margem-contribuicao
- ebitda
- resultado-liquido
- resultado-final
- runrate
- cashburn
- cac
- ltv
- roi
- recebido
- pago
- a-pagar
- a-receber
- a-pagar-atraso
- ciclo-financeiro
- pmp
- pme
- pmr
- ciclo-operacional
type: array
items:
type: string
section:
type: string
description: 'The name of the section. '
example: dre
startDate:
format: date-time
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
format: date-time
type: string
description: End date to filter the data
example: '2023-12-31'
cnpj:
type: string
description: 'Company cnpj to fetch widgets '
example: '23813779000160'
tipoChart:
type: string
description: Type of chart
examples:
- horizontal
- barline
tipo:
type: string
description: Type of data
examples:
- REVENUES
- EXPENSES
tipoDfc:
type: string
description: Type of data
examples:
- Saldo
- Runway
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- cardsNames
- section
- startDate
- endDate
- cnpj
- tipoChart
- tipo
- tipoDfc
- cnpjs
ChartsDTO:
type: object
properties:
cards:
description: Array with the charts names and values
example:
- items:
- name: saldo-acumulado
chart:
- - period: 2023-11
items:
- label: entradas
value: 131853.58
type: bar
- label: saldo
value: 0
type: line
- name: fluxo-caixa
chart:
- - month: 2023-11
values:
- label: Entradas
value: 131853.58
type: bar
- label: "Sa\xEDdas"
value: 167307.42
type: line
- label: Saldo
value: 0
type: line
- name: dfc-acumulado
chart:
- - label: Entradas
value: 252623.68
type: bar
- label: "Sa\xEDdas"
value: 245438.11
type: bar
- label: Saldo
type: line
value:
- 4.343471390966908
- 4.219926687149791
- name: operacao-direta
chart:
- - month: 2023-11
values:
- label: Receita Bruta
value: 253394.73
type: bar
- label: "Dedu\xE7\xF5es"
value: 13175.3
type: bar
- label: "Custos Vari\xE1veis"
value: 20304.01
type: bar
- label: Lucro Bruto
value: 219915.42
type: bar
- label: "Margem de Contribui\xE7\xE3o"
value: 0.8678768496882315
type: line
- name: entradas-saidas
chart:
- - label: "Receita de Vendas de Produtos e Servi\xE7os"
value: 294964.81
type: bar
- label: "Outras Receitas N\xE3o Operacionais"
value: 0
type: bar
- label: Receitas e Rendimentos Financeiros
value: 0
type: bar
- label: '% Acumulado'
value:
- 1
- 0
- 0
type: line
- name: operacao-indireta
chart:
- - month: 2023-11
values:
- label: Despesas Administrativas
value: 18304.17
type: bar
- label: Despesas Comerciais
value: 0
type: bar
- label: Despesas Pessoal
value: 0
type: bar
- label: Despesas Marketing
value: 3976.78
type: bar
- label: EBITDA
value: 0.7799470415189771
type: line
- name: evolucao
chart:
- - month: 2023-11
values:
- label: Faturamento
value: 253394.73
type: bar
- label: Despesas
value: 23455.53
type: bar
- label: Lucro Bruto
value: 209635.19
type: bar
- label: "Margem de contribui\xE7\xE3o"
value: 0.827306826783651
type: line
- name: waterfall
chart:
- receita: 294964.81
receitaDiff: 0
deducoes: 26432.56
deducoesDiff: 268532.25
despesasAdministrativas: 873.6
despesasAdministrativasDiff: 267658.65
despesasComerciais: 0
despesasComerciaisDiff: 267658.65
despesasPessoal: 4218
despesasPessoalDiff: 263440.65
despesasMarketing: 5643.24
despesasMarketingDiff: 257797.41000000003
despesasFinanceiras: 873.6
despesasFinanceirasDiff: 256923.81000000003
amortizacao: 25444.78
amortizacaoDiff: 231479.03000000003
investimentos: 93080.87999999999
investimentosDiff: 138398.15000000002
- name: nao-operacional
chart:
- - label: Despesas Financeiras
value: 873.6
type: bar
- label: IRPJ/CSLL
value: 13500
type: bar
- label: Investimentos
value: 24188.61
type: bar
- label: "Amortiza\xE7\xE3o da Divida"
value: 25444.78
type: bar
- label: Resultado liquido
value: 93080.87999999999
type: bar
- label: Resultado final
value: 43447.48999999999
type: bar
type: array
items:
type: string
required:
- cards
DREWidgetDTO:
type: object
properties:
startDate:
format: date-time
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
format: date-time
type: string
description: End date to filter the data
example: '2023-12-31'
cnpj:
type: string
description: 'Company cnpj to fetch widgets '
example: '23813779000160'
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- startDate
- endDate
- cnpj
- cnpjs
DRETableDTO:
type: object
properties:
cards:
description: Array with the dre table adata
example:
- period: 2023-09
mainCategory: 01.Receita Bruta
totalCategory: 209584.74
subCategories:
- name: 1.01. Receita recorrentes (Contratos)
value: 0
- name: "1.02. Receitas pontuais (Servi\xE7os)"
value: 0
- period: 2023-09
mainCategory: "02. Dedu\xE7\xF5es"
totalCategory: 0
subCategories:
- name: 2.01. ISS
value: 0
- name: '2.02. PIS '
value: 0
- name: 2.03. COFINS
value: 0
- name: "2.04. Devolu\xE7\xF5es"
value: 0
- name: 2.05. Conta em branco
value: 0
- name: 2.06. Conta em branco
value: 0
- name: 2.07. Conta em branco
value: 0
- name: 2.08. Conta em branco
value: 0
- name: 2.09. Conta em branco
value: 0
- period: 2023-09
mainCategory: "RECEITA L\xCDQUIDA"
totalCategory: 209584.74
subCategories: []
- period: 2023-09
mainCategory: "03.Custos Vari\xE1veis "
totalCategory: 111727.71
subCategories:
- name: "3.01. Remunera\xE7\xE3o Equipes PJ"
value: 0
- name: '3.02. Custos com Deslocamento '
value: 0
- name: "3.03. Custos com Alimenta\xE7\xE3o "
value: 0
- name: 3.04. Custos com Hospedagem
value: 0
- name: "3.05. Remunera\xE7\xE3o vari\xE1vel equipes PJ"
value: 0
- name: "3.06. Sal\xE1rios"
value: 0
- name: "3.07. Sal\xE1rios - Remunera\xE7\xE3o Vari\xE1vel"
value: 0
- name: "3.08. Benef\xEDcios"
value: 0
- name: 3.09. FGTS
value: 0
- name: 3.10. INSS
value: 0
- name: "3.11. Remunera\xE7\xE3o de Estagi\xE1rios"
value: 0
- name: "3.12. Remunera\xE7\xE3o Menor Aprendiz"
value: 0
- name: 3.13. Conta em branco
value: 0
- name: 3.14. Conta em branco
value: 0
- name: 3.15. Conta em branco
value: 0
- name: 3.16. Conta em branco
value: 0
- period: 2023-09
mainCategory: LUCRO BRUTO
totalCategory: 97857.02999999998
subCategories: []
- period: 2023-09
mainCategory: 04. Despesas Administrativas
totalCategory: 27707.91
subCategories:
- name: "4.01. \xC1gua e Esgoto"
value: 0
- name: "4.02. Energia El\xE9trica"
value: 0
- name: 4.03. Internet/ Telefone
value: 0
- name: 4.04. Aluguel
value: 0
- name: "4.05. Condom\xEDnio"
value: 0
- name: 4.06. IPTU
value: 0
- name: 4.07. Materiais de Uso e Consumo
value: 0
- name: "4.08. Servi\xE7o de Higiene e Limpeza"
value: 0
- name: "4.09. Manuten\xE7\xF5es e Reparos"
value: 0
- name: "4.10. Loca\xE7\xE3o de Maquinas e Equip"
value: 0
- name: "4.11. Assessoria Cont\xE1bil"
value: 0
- name: 4.12. Assessoria Financeira
value: 0
- name: "4.13. Assessoria Jur\xEDdica"
value: 0
- name: 4.14. Assessoria RH
value: 0
- name: 4.15. Seguros
value: 0
- name: 4.16. Taxas e emolumentos
value: 0
- name: 4.17. Custas Judiciais ou Processuais
value: 0
- name: 4.18. Eventos Internos
value: 0
- name: "4.19. Reten\xE7\xF5es IRRF de servi\xE7os de terceiros"
value: 0
- name: "4.20. Reten\xE7\xF5es PIS/COFINS/CSLL de servi\xE7os de terceiros"
value: 0
- name: 4.21. Assessoria T.I
value: 0
- name: 4.22. Conta em branco
value: 0
- name: 4.23. Conta em branco
value: 0
- name: 4.24. Conta em branco
value: 0
- name: 4.25. Conta em branco
value: 0
- period: 2023-09
mainCategory: 05. Despesas com Pessoal
totalCategory: 4218
subCategories:
- name: "5.01. Remunera\xE7\xE3o Equipe Interna"
value: 0
- name: "5.02. Sal\xE1rios"
value: 0
- name: "5.03. Benef\xEDcios"
value: 0
- name: 5.04. FGTS
value: 0
- name: 5.05. INSS
value: 0
- name: "5.06. Remunera\xE7\xE3o de Estagi\xE1rios"
value: 0
- name: "5.06. Rescis\xF5es"
value: 0
- name: "5.07. Pr\xF3-labore s\xF3cios"
value: 0
- name: "5.08. Distribui\xE7\xE3o de Lucros"
value: 0
- name: 5.09. Cursos e Treinamentos
value: 0
- name: "5.10. Remunera\xE7\xE3o Menor Aprendiz"
value: 0
- name: 5.11. Conta em branco
value: 0
- name: 5.12. Conta em branco
value: 0
- name: 5.13. Conta em branco
value: 0
- name: 5.14. Conta em branco
value: 0
- period: 2023-09
mainCategory: 06.Despesas Comerciais
totalCategory: 125
subCategories:
- name: 6.01. Eventos Comerciais
value: 0
- name: 6.03. Softwares e Ferramentas - Comercial
value: 0
- name: "6.04. Alimenta\xE7\xE3o - Comercial"
value: 0
- name: 6.05. Deslocamento - Comercial
value: 0
- name: 6.06. Hospedagem - Comercial
value: 0
- name: "6.07. Comissionamentos e premia\xE7\xF5es"
value: 0
- name: 6.08. Assessoria Comercial
value: 0
- name: 6.09. Conta em branco
value: 0
- name: 6.10. Conta em branco
value: 0
- name: 6.11. Conta em branco
value: 0
- name: 6.12. Conta em branco
value: 0
- period: 2023-09
mainCategory: 07.Despesas de Marketing
totalCategory: 3833.45
subCategories:
- name: "7.01. An\xFAncios m\xEDdias digitais"
value: 0
- name: "7.02. An\xFAncios m\xEDdias offline"
value: 0
- name: 7.03. Assessoria Marketing
value: 0
- name: 7.04. Softwares e Ferramentas - Marketing
value: 0
- name: 7.05. Conta em branco
value: 0
- name: 7.06. Conta em branco
value: 0
- name: 7.07. Conta em branco
value: 0
- name: 7.08. Conta em branco
value: 0
- name: 7.09. Conta em branco
value: 0
- period: 2023-09
mainCategory: EBITDA
totalCategory: 61972.669999999984
subCategories: []
- period: 2023-09
mainCategory: 08.Despesas Financeiras
totalCategory: 1522.68
subCategories:
- name: 8.01. Juros Sobre Cheque especial/Conta Garantida
value: 0
- name: "8.02. Tarifas e Taxas Banc\xE1rias"
value: 0
- name: 8.03. IOF
value: 0
- name: "8.04. Juros sobre Empr\xE9stimos e Financiamentos"
value: 0
- name: 8.05. Tarifa de boletos sobre Recebimentos
value: 0
- name: 8.06. Tarifa de PIX sobre Recebimentos
value: 0
- name: "8.07. Tarifa de Adquir\xEAncia sobre Recebimentos"
value: 0
- name: "8.08. Juros e taxas sobre antecipa\xE7\xE3o de receb\xEDveis "
value: 0
- name: "8.09. Receita Financeira de rendimentos de aplica\xE7\xF5es"
value: 0
- name: 8.10. Receita Financeira de Multa e Juros por atraso de clientes
value: 0
- name: 8.11. Conta em branco
value: 0
- name: 8.12. Conta em branco
value: 0
- name: 8.13. Conta em branco
value: 0
- period: 2023-09
mainCategory: "09. Receitas/Despesas N\xE3o operacionais"
totalCategory: 0
subCategories:
- name: "09.01. Despesa n\xE3o operacional"
value: 0
- period: 2023-09
mainCategory: "10. Provis\xE3o IRPJ/CSLL sobre Lucro"
totalCategory: 0
subCategories:
- name: 10.01. IRPJ
value: 0
- name: 10.02. CSLL
value: 0
- period: 2023-09
mainCategory: "RESULTADO L\xCDQUIDO"
totalCategory: 60449.98999999998
subCategories: []
- period: 2023-09
mainCategory: 11. Endividamento
totalCategory: 21527.6
subCategories:
- name: "11.01. Pagamento de Empr\xE9stimos e Financiamentos"
value: 0
- name: 11.02. Pagamento de Tributos parcelado
value: 0
- name: "11.03. Pagamento de D\xEDvida com Fornecedores Parcelado"
value: 0
- name: 11.04. Compra de cotas
value: 0
- name: 11.05. Conta em branco
value: 0
- name: 11.06. Conta em branco
value: 0
- name: 11.07. Conta em branco
value: 0
- name: 11.08. Conta em branco
value: 0
- period: 2023-09
mainCategory: 12.Investimentos
totalCategory: 21840.02
subCategories:
- name: "12.01. M\xE1quinas e Equipamentos"
value: 0
- name: "12.02. M\xF3veis e Utens\xEDlios"
value: 0
- name: 12.03. Software e Tecnologia
value: 0
- name: "12.04. Im\xF3veis"
value: 0
- name: "12.05. Ve\xEDculos"
value: 0
- name: 12.06. Reserva de caixa - Renda fixa
value: 0
- name: 12.07. Conta em branco
value: 0
- name: 12.08. Conta em branco
value: 0
- name: 12.09. Conta em branco
value: 0
- name: 12.10. Conta em branco
value: 0
- name: 12.12. Conta em branco
value: 0
- period: 2023-09
mainCategory: RESULTADO FINAL
totalCategory: 17082.369999999988
subCategories: []
type: array
items:
type: string
required:
- cards
DREDetailsWidgetDTO:
type: object
properties:
category:
type: string
description: Name of the category
example: Receita Bruta
startDate:
format: date-time
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
format: date-time
type: string
description: End date to filter the data
example: '2023-12-31'
cnpj:
type: string
description: 'Company cnpj to fetch widgets '
example: '23813779000160'
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- category
- startDate
- endDate
- cnpj
- cnpjs
DREDetailsDTO:
type: object
properties:
details:
description: Array with list details of a category
example:
- descricao: Venda 8
valor: '15223.66'
data: '2023-02-15T03:00:00.000Z'
clienteFornecedor: 9c67a233-b713-45c8-b978-3bc0328e871a
- descricao: Venda 11
valor: '18174.4'
data: '2023-03-10T03:00:00.000Z'
clienteFornecedor: af5e4a29-7bc8-47b7-921d-e74cfafa2f0c
- descricao: Venda 3
valor: '47560.42'
data: '2023-03-02T03:00:00.000Z'
clienteFornecedor: 842dac58-6fd0-4418-9b6f-834acba8e63a
- descricao: Venda 5
valor: '35181.59'
data: '2023-02-28T03:00:00.000Z'
clienteFornecedor: ee59918b-84bb-4f6a-be21-8cc7fb388e6e
- descricao: Venda 9
valor: '44368.85'
data: '2023-03-02T03:00:00.000Z'
clienteFornecedor: ee59918b-84bb-4f6a-be21-8cc7fb388e6e
- descricao: Venda 2
valor: '23730.39'
data: '2023-03-02T03:00:00.000Z'
clienteFornecedor: af5e4a29-7bc8-47b7-921d-e74cfafa2f0c
- descricao: Venda 6
valor: '11569.5'
data: '2023-03-02T03:00:00.000Z'
clienteFornecedor: b9a566b2-3906-4032-9a8a-a3636d39dea3
- descricao: Venda 20
valor: '47560.42'
data: '2023-04-05T04:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 18
valor: '44368.85'
data: '2023-04-05T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 17
valor: '11569.5'
data: '2023-04-05T04:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 16
valor: '34694.16'
data: '2023-03-31T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 19
valor: '23730.39'
data: '2023-04-05T04:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 14
valor: '32847.5'
data: '2023-03-30T04:00:00.000Z'
clienteFornecedor: 6a37af2b-8552-43b8-bc86-be79d3709488
- descricao: Venda 24
valor: '25000'
data: '2023-04-24T04:00:00.000Z'
clienteFornecedor: 0e293a28-1fc8-4295-9a1c-c42c33e23397
- descricao: Venda 25
valor: '11569.5'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 27
valor: '47560.42'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 29
valor: '26485.09'
data: '2023-04-28T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 32
valor: '25000'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: cbb7a06e-68da-4d84-8ca4-53248c407727
- descricao: Venda 30
valor: '44368.85'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 49
valor: '14761.82'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 26
valor: '23730.39'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 47
valor: '15570.1'
data: '2023-05-01T04:00:00.000Z'
clienteFornecedor: b6da490c-0034-4885-96f9-e433d2ce11be
- descricao: Venda 51
valor: '47560.42'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 62
valor: '25000'
data: '2023-06-13T04:00:00.000Z'
clienteFornecedor: 9c46a97b-1ee8-4ae9-ac6a-7c80a79da799
- descricao: Venda 52
valor: '44368.85'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 53
valor: '8570'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 56
valor: '15570.1'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: b6da490c-0034-4885-96f9-e433d2ce11be
- descricao: Venda 50
valor: '23730.39'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 60
valor: '27594.35'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: d9872d26-4bd7-40d1-bbfe-bf2926027461
- descricao: Venda 63
valor: '13952.85'
data: '2023-06-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 73
valor: '19594.36'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: d9872d26-4bd7-40d1-bbfe-bf2926027461
- descricao: Venda 74
valor: '8570'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 75
valor: '25000'
data: '2023-07-06T04:00:00.000Z'
clienteFornecedor: cbb7a06e-68da-4d84-8ca4-53248c407727
- descricao: Venda 66
valor: '23730.39'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 68
valor: '15570.1'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: b6da490c-0034-4885-96f9-e433d2ce11be
- descricao: Venda 67
valor: '44368.85'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 65
valor: '47560.42'
data: '2023-07-01T04:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 80
valor: '15570.1'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: b6da490c-0034-4885-96f9-e433d2ce11be
- descricao: Venda 104
valor: '2359.99'
data: '2023-07-15T04:00:00.000Z'
clienteFornecedor: 1c2917da-c012-4bb2-b4be-e6d443e29ba4
- descricao: Venda 83
valor: '47560.42'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 76
valor: '9570.19'
data: '2023-07-31T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 86
valor: '3900'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 78
valor: '44368.85'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 85
valor: '15124.34'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 77
valor: '23730.39'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 81
valor: '19594.36'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: d9872d26-4bd7-40d1-bbfe-bf2926027461
- descricao: Venda 84
valor: '8333.33'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 0e293a28-1fc8-4295-9a1c-c42c33e23397
- descricao: Venda 87
valor: '8333.33'
data: '2023-08-06T04:00:00.000Z'
clienteFornecedor: cbb7a06e-68da-4d84-8ca4-53248c407727
- descricao: Venda 105
valor: '2359.99'
data: '2023-08-15T04:00:00.000Z'
clienteFornecedor: 1c2917da-c012-4bb2-b4be-e6d443e29ba4
- descricao: Venda 88
valor: '6570.1'
data: '2023-08-09T04:00:00.000Z'
clienteFornecedor: e807c4ca-6a6a-4a46-b6b1-84899599916a
- descricao: Venda 82
valor: '8333.33'
data: '2023-08-01T04:00:00.000Z'
clienteFornecedor: 9c46a97b-1ee8-4ae9-ac6a-7c80a79da799
- descricao: Venda 89
valor: '17999.99'
data: '2023-08-30T04:00:00.000Z'
clienteFornecedor: 25818d82-5b24-4606-a76e-26a1f30e5bdc
- descricao: Venda 44
valor: '6000'
data: '2023-01-06T03:00:00.000Z'
clienteFornecedor: 2fc97c8d-3a12-4594-9f21-0e73cc5225eb
- descricao: Venda 39
valor: '44368.85'
data: '2023-01-06T03:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 46
valor: '47560.42'
data: '2023-01-06T03:00:00.000Z'
clienteFornecedor: 4096e091-9efe-4bd8-8495-4075fe2956c3
- descricao: Venda 43
valor: '23730.39'
data: '2023-01-06T03:00:00.000Z'
clienteFornecedor: 737cc076-699b-40b4-b733-f0782a885246
- descricao: Venda 45
valor: '15850.22'
data: '2023-01-06T03:00:00.000Z'
clienteFornecedor: 6ee879f9-b965-4b33-a22c-0a476ce83436
- descricao: Venda 37
valor: '4750'
data: '2023-01-18T03:00:00.000Z'
clienteFornecedor: 6146d9ec-72e8-4a1d-bf05-f2e6a0f0470e
- descricao: Venda 41
valor: '11570'
data: '2023-01-18T03:00:00.000Z'
clienteFornecedor: 5dd42f6b-e949-4b38-808b-b8d34d037201
- descricao: Venda 4
valor: '11569.5'
data: '2023-02-01T03:00:00.000Z'
clienteFornecedor: b9a566b2-3906-4032-9a8a-a3636d39dea3
- descricao: Venda 13
valor: '47560.42'
data: '2023-02-01T03:00:00.000Z'
clienteFornecedor: 842dac58-6fd0-4418-9b6f-834acba8e63a
- descricao: Venda 38
valor: '2858.98'
data: '2023-01-13T03:00:00.000Z'
clienteFornecedor: 6146d9ec-72e8-4a1d-bf05-f2e6a0f0470e
- descricao: Venda 10
valor: '6000'
data: '2023-02-01T03:00:00.000Z'
clienteFornecedor: b981856e-de19-426f-9984-8d8b019b59c1
- descricao: Venda 40
valor: '21118.07'
data: '2023-01-18T03:00:00.000Z'
clienteFornecedor: 55d91750-8d51-4f19-8e4e-4a1e438ba020
- descricao: Venda 12
valor: '44368.85'
data: '2023-02-01T03:00:00.000Z'
clienteFornecedor: ee59918b-84bb-4f6a-be21-8cc7fb388e6e
- descricao: Venda 42
valor: '3336.14'
data: '2023-01-13T03:00:00.000Z'
clienteFornecedor: 5dd42f6b-e949-4b38-808b-b8d34d037201
- descricao: Venda 7
valor: '23730.39'
data: '2023-02-01T03:00:00.000Z'
clienteFornecedor: af5e4a29-7bc8-47b7-921d-e74cfafa2f0c
type: array
items:
type: string
required:
- details
DREDetailsSubcategoryDTO:
type: object
properties:
details:
description: Array with list details of a category
example:
- month: 2023-07
values:
- item: Venda 100
value: 0
- item: Venda 101
value: 0
- item: Venda 102
value: 0
- item: Venda 103
value: 0
- item: Venda 104
value: 2359.99
- item: Venda 105
value: 0
- item: Venda 106
value: 0
- item: Venda 107
value: 0
- item: Venda 108
value: 0
- item: Venda 109
value: 0
- item: Venda 110
value: 0
- item: Venda 111
value: 0
- item: Venda 113
value: 0
- item: Venda 114
value: 0
- item: Venda 65
value: 47560.42
- item: Venda 66
value: 23730.39
- item: Venda 67
value: 44368.85
- item: Venda 68
value: 15570.1
- item: Venda 73
value: 19594.36
- item: Venda 74
value: 8570
- item: Venda 75
value: 25000
- item: Venda 77
value: 0
- item: Venda 78
value: 0
- item: Venda 80
value: 0
- item: Venda 81
value: 0
- item: Venda 82
value: 0
- item: Venda 83
value: 0
- item: Venda 84
value: 0
- item: Venda 86
value: 0
- item: Venda 87
value: 0
- item: Venda 88
value: 0
- item: Venda 89
value: 0
- item: Venda 90
value: 0
- item: Venda 91
value: 0
- item: Venda 93
value: 0
- item: Venda 94
value: 0
- item: Venda 95
value: 0
- item: Venda 96
value: 0
- item: Venda 97
value: 0
- item: Venda 99
value: 0
- month: 2023-08
values:
- item: Venda 100
value: 0
- item: Venda 101
value: 0
- item: Venda 102
value: 0
- item: Venda 103
value: 0
- item: Venda 104
value: 0
- item: Venda 105
value: 2359.99
- item: Venda 106
value: 0
- item: Venda 107
value: 0
- item: Venda 108
value: 0
- item: Venda 109
value: 0
- item: Venda 110
value: 0
- item: Venda 111
value: 0
- item: Venda 113
value: 0
- item: Venda 114
value: 0
- item: Venda 65
value: 0
- item: Venda 66
value: 0
- item: Venda 67
value: 0
- item: Venda 68
value: 0
- item: Venda 73
value: 0
- item: Venda 74
value: 0
- item: Venda 75
value: 0
- item: Venda 77
value: 23730.39
- item: Venda 78
value: 44368.85
- item: Venda 80
value: 15570.1
- item: Venda 81
value: 19594.36
- item: Venda 82
value: 8333.33
- item: Venda 83
value: 47560.42
- item: Venda 84
value: 8333.33
- item: Venda 86
value: 3900
- item: Venda 87
value: 8333.33
- item: Venda 88
value: 6570.1
- item: Venda 89
value: 17999.99
- item: Venda 90
value: 0
- item: Venda 91
value: 0
- item: Venda 93
value: 0
- item: Venda 94
value: 0
- item: Venda 95
value: 0
- item: Venda 96
value: 0
- item: Venda 97
value: 0
- item: Venda 99
value: 0
- month: 2023-09
values:
- item: Venda 100
value: 6570.1
- item: Venda 101
value: 8333.33
- item: Venda 102
value: 4500
- item: Venda 103
value: 2950
- item: Venda 104
value: 0
- item: Venda 105
value: 0
- item: Venda 106
value: 2359.99
- item: Venda 107
value: 0
- item: Venda 108
value: 0
- item: Venda 109
value: 0
- item: Venda 110
value: 0
- item: Venda 111
value: 0
- item: Venda 113
value: 0
- item: Venda 114
value: 0
- item: Venda 65
value: 0
- item: Venda 66
value: 0
- item: Venda 67
value: 0
- item: Venda 68
value: 0
- item: Venda 73
value: 0
- item: Venda 74
value: 0
- item: Venda 75
value: 0
- item: Venda 77
value: 0
- item: Venda 78
value: 0
- item: Venda 80
value: 0
- item: Venda 81
value: 0
- item: Venda 82
value: 0
- item: Venda 83
value: 0
- item: Venda 84
value: 0
- item: Venda 86
value: 0
- item: Venda 87
value: 0
- item: Venda 88
value: 0
- item: Venda 89
value: 0
- item: Venda 90
value: 5999.99
- item: Venda 91
value: 8333.33
- item: Venda 93
value: 19594.36
- item: Venda 94
value: 44368.85
- item: Venda 95
value: 23730.39
- item: Venda 96
value: 47560.42
- item: Venda 97
value: 8333.33
- item: Venda 99
value: 13800
type: array
items:
type: string
required:
- details
DREDetailsPostingWidgetDTO:
type: object
properties:
posting:
type: string
description: Name of the cash entry
example: Posto Shell
subcategory:
type: string
description: Subcategory name
example: 3.02. Custos com Deslocamento
subCategory:
type: string
description: Subcategory name
example: 3.02. Custos com Deslocamento
startDate:
format: date-time
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
format: date-time
type: string
description: End date to filter the data
example: '2023-12-31'
cnpj:
type: string
description: 'Company cnpj to fetch widgets '
example: '23813779000160'
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- posting
- subcategory
- subCategory
- startDate
- endDate
- cnpj
- cnpjs
DREDetailsPostingDTO:
type: object
properties:
details:
description: Array with list details of a category
example:
- date: '2023-01-16T03:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-02-15T03:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-04-20T04:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-05-15T04:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-03-21T03:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-06-23T04:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
- date: '2023-07-19T04:00:00.000Z'
descricao: "Anuidade Cart\xE3o Caixa Elo"
valor: 12.5
type: array
items:
type: string
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- details
- cnpjs
FinancialCyclePostingDto:
type: object
properties:
startDate:
format: date-time
type: string
description: Start date to filter the data
example: '2023-12-01'
endDate:
format: date-time
type: string
description: End date to filter the data
example: '2023-12-31'
name:
type: string
description: Client/Supplier name
example: CEF Matriz
type:
type: string
description: PMP or PMR
example: PMP
cnpj:
type: string
description: 'Company cnpj to fetch widgets '
example: '23813779000160'
cnpjs:
description: 'Main company cnpj to fetch widgets '
example: '[''23813779000160'']'
type: array
items:
type: string
required:
- startDate
- endDate
- name
- type
- cnpj
- cnpjs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment