Flash - Integrações

Schemas

CompanyResponseDto

idstring
activeboolean
addressobject
legalNamestring
logostring
namestring
registrationNumberstring

CreateOrder

companyIdstring · required
Example: jVZ0hM9pAXh5SPoqIzLxo

CreateOrderDeposit

employeeIdstring · required
Example: ZWB1x6jkPBI2Ac56FRJec
employeeNamestring · required
Example: João da Silva
employeeDocumentstring · required
Example: 99999999999
benefitIdstring · required
Example: 6iKE5def3S3WF6XvE0FvL
benefitNamestring · required
Example: Vale Refeição
amountinteger · required
Example: 950

ConfirmOrder

cnpjstring · required
Example: 12345678901234
paymentMethodstring · enum · required
Enum values:
BILLET
BALANCE
Example: BILLET
adminEmailstring · required
Example: admin@flashapp.com.br
creditDatestring · date-time · required
Example: 2030-12-31T14:03:41.369Z

descriptionstring
namestring

CancelOrder

cancelReasonstring · required

OrderResponse

idstring · required
Example: yvfSepYdwUI4SlUFkCAzQ
companyIdstring · required
Example: BRzfhIEKnyOE4jopUAaXw
statusstring · enum · required
Enum values:
requested
billed
canceled
paid
available
createdAtstring · date-time · required
creditTypestring · enum · required
Enum values:
accumulative

descriptionstring
Example: Descrição para o pedido
billIdstring
Example: UbZ8lwwN9i2OPcCbVGGuS
paymentMethodstring · enum
Enum values:
BILLET
creditDatestring · date-time
totalFeeinteger
Example: 100
totalAmountinteger
Example: 10000

OrderResponseWithName

idstring · required
Example: yvfSepYdwUI4SlUFkCAzQ
companyIdstring · required
Example: BRzfhIEKnyOE4jopUAaXw
statusstring · enum · required
Enum values:
requested
billed
canceled
paid
available
waiting_approval
createdAtstring · date-time · required
creditTypestring · enum · required
Enum values:
accumulative

descriptionstring
Example: Descrição para o pedido
namestring
Example: Nome do pedido
billIdstring
Example: UbZ8lwwN9i2OPcCbVGGuS
paymentMethodstring · enum
Enum values:
BILLET
BALANCE
creditDatestring · date-time
totalFeeinteger
Example: 100
totalAmountinteger
Example: 10000

OrderDepositResponse

idstring · required
Example: DjgJKJvYVBoMR_H94a9eb
orderIdstring · required
Example: yvfSepYdwUI4SlUFkCAzQ
employeeIdstring · required
Example: ZWB1x6jkPBI2Ac56FRJec
employeeNamestring · required
Example: João da Silva
employeeDocumentstring · required
Example: 99999999999
benefitIdstring · required
Example: 6iKE5def3S3WF6XvE0FvL
benefitNamestring · required
Example: Vale Refeição
amountinteger · required
Example: 950
feeinteger · required
statusstring · enum · required
Enum values:
created
canceled
Example: created
createdAtstring · date-time · required
Example: 2025-07-21T10:30:00.000Z

PendingDepositItem

depositIdstring · required
Example: INBmNtsWN0z2sjSxbW_ot
orderIdstring · required
Example: bwfxVpDph98tK8k2t0ecV
employeeIdstring · required
Example: mnZtbdMjIBqVo5sA2rECR
amountinteger · required
Example: 15000
createdAtstring · date-time · required
Example: 2025-12-01T10:30:00.000Z
creditDatestring · date-time · required
Example: 2025-12-20T00:00:00.000Z

PendingDepositsResponse

dataobject[] · required
pageinteger · required
Example: 1
limitinteger · required
Example: 100
countinteger · required
Example: 2

ErrorResponse

httpCodeinteger
Example: 400
messagestring
codestring

EmployeeGroup

idstring
namestring

EmployeeDepartment

idstring

EmployeeRole

idstring

EmployeeResponseDto

idstring · required
companyIdstring · required
groupsobject[] · required

corporateEmailstring
costCenterIdstring
documentNumberstring
emailstring
externalIdstring
invitationDatestring · date-time
managerIdstring
namestring
phoneNumberstring
profilePicturestring
statusstring
departmentsobject[]
rolesobject[]
groupIdsstring[]

CreateEmployeeRequestDTO

companyIdstring · required
documentNumberstring · required
namestring · required

emailstring
externalIdstring
invitationDatestring · date-time
phoneNumberstring
managerIdstring

FindEmployeesViewModel

recordsobject[] · required
metadataobject · required

UpdateEmployeeRequestDTO

companyIdstring
corporateEmailstring
emailstring
externalIdstring
invitationDatestring · date-time
namestring
phoneNumberstring
managerIdstring
costCenterIdstring

CreateCandidateBody

namestring · required
emailstring · required
hiringCategorystring · enum · required
Enum values:
clt
internship
pj
companyIdstring · required

legalNamestring
cnpjstring
Example: 67578133000110
nationalitystring · enum
Enum values:
brazilian
foreigner
documentNumberstring
Example: 38193415019
managerIdstring
followerEmployeeIdsstring[]
phonestring
Example: 409928377364
hiringDatestring · date-time
probationFirstDatestring · date-time
probationSecondDatestring · date-time

CreateCandidateResponse

idstring · required
namestring · required
companyIdstring · required
emailstring · required

cnpjstring
nationalitystring · enum
Enum values:
brazilian
foreigner
phonestring

HiringDocumentMultipleValue

labelstring
valuestring

HiringDocument

idstring · required
sectionNamestring · required
fieldNamestring · required
valuerequired

ListCandidatesResponse

metadataobject · required
candidatesobject[] · required

ListAttendancesResponse

successboolean · required
messagestring · required
dataobject[] · required

ListBudgetsResponse

successboolean · required
messagestring · required
dataobject[] · required

ListEventsResponse

successboolean · required
messagestring · required
dataobject[] · required

CreateOrUpdateEventBody

externalIdstring · required
companyIdstring · required

reasonIdnumber
reasonApiIdstring
startDatestring · date-time
endDatestring · date-time

CreateOrUpdateEventResponse

successboolean
messagestring
dataobject

CancelEventsBody

idsnumber[] · required
companyIdstring · required

justificationstring

CancelEventsResponse

successboolean · required
messagestring · required
dataobject[] · required

ListTimetableAllocationsResponse

successboolean · required
messagestring · required
dataobject[] · required

CreateTimetableAllocationsBody

startDatestring · date-time · required
endDatestring · date-time · required
companyIdstring · required

timetableIdnumber
timetableApiIdstring
employeeIdsstring[]
externalIdsstring[]

CreateTimetableAllocationsResponse

successboolean · required
messagestring · required
dataobject[] · required

ListVacationSchedulesResponse

successboolean · required
messagestring · required
dataobject[] · required

CreateOrUpdateVacationScheduleBody

externalIdstring · required
startDatestring · date-time · required
endDatestring · date-time · required
companyIdstring · required

startDateOfAcquisitionPeriodstring · date-time
endDateOfAcquisitionPeriodstring · date-time
advance13Salaryboolean
sellOneThirdboolean
installmentDiscountboolean
managerMessagestring
statusstring

CreateOrUpdateVacationScheduleResponse

successboolean
messagestring
dataobject

UpdateVacationConfirmationBody

companyIdstring · required

vacationSchedulesobject[]
idsnumber[]
confirmationboolean

UpdateVacationConfirmationResponse

successboolean · required
messagestring · required
dataobject[] · required

GetBenefitsResponse

idstring · required
companyIdstring · required
statusstring · enum · required
Enum values:
active
inactive
namestring · required
emojistring · required
descriptionstring · required
descriptionAppstring · required
descriptionDepositstring · required
transactionMethodsstring[] · required
billetCategoriesstring[] · required
depositTimeUnitstring · enum · required
Enum values:
month
day
createdAtstring · required

categoriesobject[]
depositFeesobject[]
topupDepositEnabledboolean

GetExpensesResponse

totalCountinteger · required
totalPagesinteger · required
expensesobject[] · required

BillResponseDto

idstring
paymentsobject[]

Expense

idstring · required
employeeobject · required
companyIdstring · required
amountinteger · required
currencystring · required
datestring · required
statusstring · enum · required
Enum values:
DRAFT
PENDING_APPROVAL
PENDING_ACCOUNTING
FINISHED
REQUIRE_CHANGES
REJECTED
typestring · enum · required
Enum values:
REIMBURSEMENT
CORPORATE_CARD

accountingBystring
accountingCommentsstring
categoryobject
commentsstring
costCenterobject
customFieldsobject[]
establishmentobject
exchangeobject
integrationobject
mileageobject
paymentMethodstring · enum
Enum values:
CASH
PIX
CREDIT_CARD
DEBIT_CARD
FLASH_CARD
projectobject
referenceIdstring
subtypestring · enum
Enum values:
ODOMETER_MILEAGE
PLACES_MILEAGE
tagsobject[]
transactionobject
ocrDataobject

ExpenseCategoryReference

nanoIdstring · required
descriptionstring · required

codestring

ExpenseEmployee

idstring · required
namestring · required

ExpenseEstablishment

namestring · required

placeIdstring
descriptionstring
addressobject
sourcestring · enum
Enum values:
PLACES_API
OCR
FREE_TEXT

ExpenseExchange

originalAmountinteger · required
currencystring · required
currencyCodestring · required
ratenumber · required
datestring · date · required

sourcestring

ExpenseMileage

amountinteger · required
pricePerUnitinteger · required

placesobject[]
odometerobject[]

ExpenseOdometerMileage

valueinteger · required
attachmentIndexinteger · required

ExpensePlacesMileage

namestring · required
descriptionstring · required
sourcestring · enum · required
Enum values:
PLACES_API

placeIdstring
latitudenumber
longitudenumber

ExpensePaymentMethod

string · enum

Enum values:

CASH

PIX

CREDIT_CARD

DEBIT_CARD

FLASH_CARD

ExpenseStatus

string · enum

Enum values:

DRAFT

PENDING_APPROVAL

PENDING_ACCOUNTING

FINISHED

REQUIRE_CHANGES

REJECTED

ExpenseIntegration

sourcestring · enum · required
Enum values:
FLASH_API
OMIE

statusstring · enum
Enum values:
PENDING
COMPLETED
ERROR
detailsstring
referencestring

ExpenseIntegrationStatus

string · enum

Enum values:

PENDING

COMPLETED

ERROR

ExpenseSubtype

string · enum

Enum values:

ODOMETER_MILEAGE

PLACES_MILEAGE

ExpenseTag

idstring · required
namestring · required

codestring

ExpenseType

string · enum

Enum values:

REIMBURSEMENT

CORPORATE_CARD

ExpenseCostCenterReference

idstring
namestring
codestring

ExpenseProjectReference

idstring
namestring
codestring

ExpenseCustomFieldReference

idstring
namestring
typestring · enum
Enum values:
CHOICE
MULTI_CHOICE
TEXT
LONG_TEXT
DATE
NUMBER
ATTACHMENT
codestring
value

ExpenseOcrData

datestring
regNumberstring
invoiceKeyinteger

CorporateCardTransaction

idstring · required
amountinteger · required
descriptionstring · required
datestring · date-time · required
movementstring · enum · required
Enum values:
OPEN_LOOP_PAYMENT
PIX_TRANSFER
EMPLOYEE_WITHDRAW
BILLET_PAYMENT
CASH_OUT_TED
statusstring · enum · required
Enum values:
AUTHORIZED
SETTLED
COMPLETED
PROCESSING

amountWithoutFeesinteger
cardLastDigitsstring
cardTypestring · enum
Enum values:
PLASTIC
VIRTUAL
categorystring · enum
Enum values:
MEAL
GROCERY
MOBILITY
HEALTH
WELLBEING
EDUCATION
CULTURE
CONVENIENCE
currencystring
localAmountinteger
localConversionRatenumber
iofAmountinteger
withdrawalFeeAmountinteger

ListDepartmentsResponse

recordsobject[] · required

Department

idstring · required
namestring · required

descriptionstring
externalIdstring
isActiveboolean

CreateDepartmentDTO

namestring · required
companyIdstring · required

descriptionstring
externalIdstring

UpdateDepartmentDTO

namestring
externalIdstring
descriptionstring

InsertEmployeeToDepartmentRequest

employeeIdstring · required

ListGroupsResponse

idstring · required
namestring · required
companyIdstring · required
typestring · enum · required
Enum values:
STATIC

descriptionstring

Group

idstring · required
namestring · required
companyIdstring · required
typestring · enum · required
Enum values:
STATIC

descriptionstring

CreateGroupDTO

namestring · required
typestring · enum · required
Enum values:
STATIC
companyIdstring · required

descriptionstring

UpdateGroupDTO

namestring
descriptionstring

InsertEmployeeToGroupRequest

employeeIdstring · required

EmployeePII

idstring · required

addressobject
bankingobject
birthDatestring · date-time
genderstring
maritalStatusstring
nationalitystring
pisstring
socialNamestring

UpdateEmployeePIIDTO

addressobject
bankingobject
birthDatestring · date-time
genderstring
maritalStatusstring
nationalitystring
pisstring
socialNamestring

EmployeeAddressDTO

citystring
complementstring
districtstring
numberstring
statestring
streetstring
zipCodestring

EmployeeBankingDTO

accountNumberstring
accountTypestring · enum
Enum values:
checking
savings
bankCodestring
bankNamestring
branchstring

InsertEmployeeToRoleRequest

employeeIdstring · required

ListRolesResponse

recordsobject[] · required

Role

idstring · required
namestring · required

descriptionstring
externalIdstring

CreateRoleDTO

namestring · required
companyIdstring · required

descriptionstring
externalIdstring
cbostring

UpdateRoleDTO

namestring
externalIdstring
descriptionstring
cbostring

ExpenseCategory

idstring · required
namestring · required

companyIdstring
statusstring · enum
Enum values:
ACTIVE
INACTIVE
externalIdstring
isDefaultboolean

ExpenseCategoryStatus

string · enum

Enum values:

ACTIVE

INACTIVE

ListExpenseCategoriesResponse

idstring · required
namestring · required

companyIdstring
statusstring · enum
Enum values:
ACTIVE
INACTIVE
externalIdstring
isDefaultboolean

CreateExpenseCategoryRequest

companyIdstring · required
namestring · required

externalIdstring

UpdateExpenseCategoryRequest

statusstring · enum · required
Enum values:
ACTIVE
INACTIVE
namestring · required

externalIdstring

ExpenseProject

idstring
companyIdstring
namestring
codestring
assigneeobject
dateRangeobject
activeboolean
createdByobject
updatedByobject

ExpenseProjectCreateRequest

companyIdstring · required
activeboolean · required
namestring · required

codestring
assigneeobject
dateRangeobject

ExpenseProjectUpdateRequest

companyIdstring · required

namestring
activeboolean
codestring
assigneeobject
dateRangeobject

ExpenseProjectListResponse

recordsobject[] · required
metadataobject · required

ExpenseProjectActivationRequest

companyIdstring · required

ExpenseProjectErrorResponse

codestring
statusCodeinteger
messagestring
timestampstring

ExpenseCustomField

idstring
companyIdstring
fieldstring · enum
Enum values:
CATEGORY
COMMENT
ATTACHMENT
COST_CENTER
PROJECT
CUSTOM
customPropsobject
usageobject
audiencestring · enum
Enum values:
EVERYONE
MANAGERS
requiredboolean
activeboolean
createdByobject
updatedByobject

ExpenseCustomFieldOption

idstring
companyIdstring
fieldIdstring
codestring
namestring
activeboolean
createdByobject
updatedByobject

ExpenseCustomFieldOptionListResponse

recordsobject[] · required
metadataobject · required

ExpenseCustomFieldOptionCreateRequest

companyIdstring · required
fieldIdstring · required
activeboolean · required
namestring · required
codestring · required

ExpenseCustomFieldOptionUpdateRequest

companyIdstring · required

activeboolean
namestring
codestring

ExpenseCustomFieldOptionActivationRequest

companyIdstring · required

ExpenseCustomFieldErrorResponse

codestring
statusCodeinteger
messagestring
timestampstring

ExpenseLifecycleErrorResponse

codestring
statusCodeinteger
messagestring
timestampstring

FinishExpensesRequest

employeeIdstring · required

expenseIdsstring[]
tagCodesstring[]

RejectExpensesRequest

accountingCommentsstring · required
employeeIdstring · required

expenseIdsstring[]
tagCodesstring[]

RequestChangesExpensesRequest

accountingCommentsstring · required
employeeIdstring · required

expenseIdsstring[]
tagCodesstring[]

AcknowledgeExpenseIntegrationRequest

statusstring · enum · required
Enum values:
COMPLETED
ERROR

detailsstring
referencestring

CostCenter

idstring · required
activeboolean · required
companyIdstring · required
namestring · required

codestring
responsibleEmployeeIdstring

CostCenterCreateRequest

namestring · required
codestring · required
companyIdstring · required
responsibleEmployeeIdstring · required

CostCenterUpdateRequest

namestring
codestring
responsibleEmployeeIdstring

CostCenterListResponse

recordsobject[] · required
metadataobject · required

CostCenterErrorResponse

messagestring
validationErrors
codestring
timestampstring

GenerateExpenseReportRequest

companyIdstring · required
filterobject · required

GenerateExpenseReportResponse

jobIdstring · required

ExpenseReportProgressStatus

string · enum

Enum values:

FETCHING_DATA

GENERATING_PDF

UPLOADING

COMPLETED

ERROR

ExpenseReportProgressResponse

statusstring · enum · required
Enum values:
FETCHING_DATA
GENERATING_PDF
UPLOADING
COMPLETED
ERROR

progressnumber
messagestring
downloadUrlstring
errorstring

​Schemas

​CompanyResponseDto

​CreateOrder

​CreateOrderDeposit

​ConfirmOrder

​CancelOrder

​OrderResponse

​OrderResponseWithName

​OrderDepositResponse

​PendingDepositItem

​PendingDepositsResponse

​ErrorResponse

​EmployeeGroup

​EmployeeDepartment

​EmployeeRole

​EmployeeResponseDto

​CreateEmployeeRequestDTO

​FindEmployeesViewModel

​UpdateEmployeeRequestDTO

​CreateCandidateBody

​CreateCandidateResponse

​HiringDocumentMultipleValue

​HiringDocument

​ListCandidatesResponse

​ListAttendancesResponse

​ListBudgetsResponse

​ListEventsResponse

​CreateOrUpdateEventBody

​CreateOrUpdateEventResponse

​CancelEventsBody

​CancelEventsResponse

​ListTimetableAllocationsResponse

​CreateTimetableAllocationsBody

​CreateTimetableAllocationsResponse

​ListVacationSchedulesResponse

​CreateOrUpdateVacationScheduleBody

​CreateOrUpdateVacationScheduleResponse

​UpdateVacationConfirmationBody

​UpdateVacationConfirmationResponse

​GetBenefitsResponse

​GetExpensesResponse

​BillResponseDto

​Expense

​ExpenseCategoryReference

​ExpenseEmployee

​ExpenseEstablishment

​ExpenseExchange

​ExpenseMileage

​ExpenseOdometerMileage

​ExpensePlacesMileage

​ExpensePaymentMethod

​ExpenseStatus

​ExpenseIntegration

​ExpenseIntegrationStatus

​ExpenseSubtype

​ExpenseTag

​ExpenseType

​ExpenseCostCenterReference

​ExpenseProjectReference

​ExpenseCustomFieldReference

​ExpenseOcrData

​CorporateCardTransaction

​ListDepartmentsResponse

​Department

​CreateDepartmentDTO

​UpdateDepartmentDTO

​InsertEmployeeToDepartmentRequest

​ListGroupsResponse

​Group

​CreateGroupDTO

​UpdateGroupDTO

​InsertEmployeeToGroupRequest

​EmployeePII

​UpdateEmployeePIIDTO

​EmployeeAddressDTO

​EmployeeBankingDTO

​InsertEmployeeToRoleRequest

​ListRolesResponse

​Role

​CreateRoleDTO

Schemas

CompanyResponseDto

CreateOrder

CreateOrderDeposit

ConfirmOrder

CancelOrder

OrderResponse

OrderResponseWithName

OrderDepositResponse

PendingDepositItem

PendingDepositsResponse

ErrorResponse

EmployeeGroup

EmployeeDepartment

EmployeeRole

EmployeeResponseDto

CreateEmployeeRequestDTO

FindEmployeesViewModel

UpdateEmployeeRequestDTO

CreateCandidateBody

CreateCandidateResponse

HiringDocumentMultipleValue

HiringDocument

ListCandidatesResponse

ListAttendancesResponse

ListBudgetsResponse

ListEventsResponse

CreateOrUpdateEventBody

CreateOrUpdateEventResponse

CancelEventsBody

CancelEventsResponse

ListTimetableAllocationsResponse

CreateTimetableAllocationsBody

CreateTimetableAllocationsResponse

ListVacationSchedulesResponse

CreateOrUpdateVacationScheduleBody

CreateOrUpdateVacationScheduleResponse

UpdateVacationConfirmationBody

UpdateVacationConfirmationResponse

GetBenefitsResponse

GetExpensesResponse

BillResponseDto

Expense

ExpenseCategoryReference

ExpenseEmployee

ExpenseEstablishment

ExpenseExchange

ExpenseMileage

ExpenseOdometerMileage

ExpensePlacesMileage

ExpensePaymentMethod

ExpenseStatus

ExpenseIntegration

ExpenseIntegrationStatus

ExpenseSubtype

ExpenseTag

ExpenseType

ExpenseCostCenterReference

ExpenseProjectReference

ExpenseCustomFieldReference

ExpenseOcrData

CorporateCardTransaction

ListDepartmentsResponse

Department

CreateDepartmentDTO

UpdateDepartmentDTO

InsertEmployeeToDepartmentRequest

ListGroupsResponse

Group

CreateGroupDTO

UpdateGroupDTO

InsertEmployeeToGroupRequest

EmployeePII

UpdateEmployeePIIDTO

EmployeeAddressDTO

EmployeeBankingDTO

InsertEmployeeToRoleRequest

ListRolesResponse

Role

CreateRoleDTO