Skip to Content
DocumentationAPI ReferenceBusiness APIEndpointsEnterprise Api

EnterpriseApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
acceptEnterpriseInvitationPOST /{enterprise_id}/users/accept-invitationAccept enterprise invitation and complete user registration
bulkUpdateEnterpriseSettingsPOST /{enterprise_id}/settings/bulkBulk update enterprise settings
changeBillingPlanPUT /{enterprise_id}/billing/planChange billing plan
createEnterprisePOST /Create a new enterprise
createEnterpriseApplicationPOST /enterprises/onboarding/applicationsCreate a new enterprise application
createEnterpriseInvitationPOST /enterprises/{enterprise_id}/invitationsCreate enterprise invitation
createEnterpriseSettingPOST /{enterprise_id}/settingsCreate enterprise setting
createEnterpriseVoucherPOST /enterprises/{enterprise_id}/vouchersCreate enterprise voucher
createEnterpriseVoucherTemplatePOST /enterprises/{enterprise_id}/voucher-templatesCreate enterprise voucher template
deleteEnterpriseDELETE /{enterprise_id}Delete enterprise
deleteEnterpriseApplicationDELETE /enterprises/onboarding/applications/{business_id}Delete enterprise application (draft only)
deleteEnterpriseSettingDELETE /{enterprise_id}/settings/{setting_id}Delete enterprise setting
deleteEnterpriseVoucherDELETE /enterprises/{enterprise_id}/vouchers/{voucher_id}Delete enterprise voucher
deleteEnterpriseVoucherTemplateDELETE /enterprises/{enterprise_id}/voucher-templates/{template_id}Delete enterprise voucher template
duplicateVoucherTemplatePOST /enterprises/{enterprise_id}/voucher-templates/{template_id}/duplicateDuplicate template (create new template from existing)
enterpriseListUsersGET /{enterprise_id}/usersList enterprise users
enterpriseUpdateUserPUT /{enterprise_id}/users/{user_id}Update enterprise user
generateEnterpriseInvoicePOST /{enterprise_id}/billing/invoices/generateGenerate invoice for current period
generateVoucherFromTemplatePOST /enterprises/{enterprise_id}/vouchers/generate-from-templateGenerate voucher from template
getAuditLogStatsGET /{enterprise_id}/audit-logs/statsGet audit log statistics
getEnterpriseGET /{enterprise_id}Get enterprise by ID
getEnterpriseApplicationGET /enterprises/onboarding/applications/{business_id}Get enterprise application by ID
getEnterpriseApplicationStatusGET /enterprises/onboarding/applications/{business_id}/statusGet enterprise application status
getEnterpriseBillingInfoGET /{enterprise_id}/billing/infoGet enterprise billing information
getEnterpriseDashboardStatsGET /enterprises/{enterprise_id}/dashboard/statsGet enterprise dashboard statistics
getEnterpriseDocumentsGET /enterprises/onboarding/applications/{business_id}/documentsGet documents for enterprise application
getEnterpriseFeeStatusGET /enterprises/onboarding/applications/{business_id}/fee-statusGet fee status for enterprise application
getEnterpriseInvoicesGET /{enterprise_id}/billing/invoicesGet enterprise invoices
getEnterpriseOnboardingConfigGET /enterprises/onboarding/configGet enterprise onboarding configuration
getEnterpriseSettingGET /{enterprise_id}/settings/{setting_id}Get setting by ID
getEnterpriseSettingByKeyGET /{enterprise_id}/settings/key/{key}Get setting by key
getEnterpriseUsageSummaryGET /{enterprise_id}/billing/usageGet enterprise usage summary
getEnterpriseVoucherGET /enterprises/{enterprise_id}/vouchers/{voucher_id}Get voucher by ID
getEnterpriseVoucherTemplateGET /enterprises/{enterprise_id}/voucher-templates/{template_id}Get voucher template by ID
getEntityAuditLogsGET /{enterprise_id}/audit-logs/{entity_type}/{entity_id}Get audit logs for a specific entity
getTemplateUsageStatsGET /enterprises/{enterprise_id}/voucher-templates/{template_id}/statsGet template usage statistics
getVoucherAnalyticsGET /enterprises/{enterprise_id}/vouchers/analyticsGet voucher analytics
getVoucherUsageStatsGET /enterprises/{enterprise_id}/vouchers/{voucher_id}/statsGet voucher usage statistics
inviteEnterpriseUserPOST /{enterprise_id}/users/inviteSend invitation to a user to join enterprise
listEnterpriseAuditLogsGET /{enterprise_id}/audit-logsList enterprise audit logs
listEnterpriseInvitationsGET /enterprises/{enterprise_id}/invitationsList enterprise invitations
listEnterpriseSettingsGET /{enterprise_id}/settingsList enterprise settings
listEnterpriseVoucherTemplatesGET /enterprises/{enterprise_id}/voucher-templatesList enterprise voucher templates
listEnterpriseVouchersGET /enterprises/{enterprise_id}/vouchersList enterprise vouchers
listEnterprisesGET /List all enterprises
removeEnterpriseUserDELETE /{enterprise_id}/users/{user_id}Remove user from enterprise
submitEnterpriseApplicationPOST /enterprises/onboarding/applications/{business_id}/submitSubmit enterprise application for review
updateEnterprisePUT /{enterprise_id}Update enterprise
updateEnterpriseApplicationPATCH /enterprises/onboarding/applications/{business_id}Update enterprise application
updateEnterpriseSettingPUT /{enterprise_id}/settings/{setting_id}Update enterprise setting
updateEnterpriseVoucherPUT /enterprises/{enterprise_id}/vouchers/{voucher_id}Update enterprise voucher
updateEnterpriseVoucherTemplatePUT /enterprises/{enterprise_id}/voucher-templates/{template_id}Update enterprise voucher template

acceptEnterpriseInvitation

EnterpriseUserResponse acceptEnterpriseInvitation(enterprise_id, AcceptEnterpriseInvitationRequest)

Accept enterprise invitation and complete user registration

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
AcceptEnterpriseInvitationRequestAcceptEnterpriseInvitationRequest

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

bulkUpdateEnterpriseSettings

MessageResponse bulkUpdateEnterpriseSettings(enterprise_id, BulkUpdateSettingsRequest)

Bulk update enterprise settings

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
BulkUpdateSettingsRequestBulkUpdateSettingsRequest

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

changeBillingPlan

EnterpriseBillingInfo changeBillingPlan(enterprise_id, BillingPlanChangeRequest)

Change billing plan

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
BillingPlanChangeRequestBillingPlanChangeRequest

Return type

EnterpriseBillingInfo

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterprise

EnterpriseResponse createEnterprise(CreateEnterpriseRequest)

Create a new enterprise

Parameters

NameTypeDescriptionNotes
CreateEnterpriseRequestCreateEnterpriseRequest

Return type

EnterpriseResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseApplication

CreateEnterpriseApplicationResponse createEnterpriseApplication(CreateEnterpriseApplicationRequest)

Create a new enterprise application

Parameters

NameTypeDescriptionNotes
CreateEnterpriseApplicationRequestCreateEnterpriseApplicationRequest

Return type

CreateEnterpriseApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseInvitation

InvitationResponse createEnterpriseInvitation(enterprise_id, CreateInvitationRequest)

Create enterprise invitation

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateInvitationRequestCreateInvitationRequest

Return type

InvitationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseSetting

EnterpriseSettingsResponse createEnterpriseSetting(enterprise_id, CreateEnterpriseSettingsRequest)

Create enterprise setting

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateEnterpriseSettingsRequestCreateEnterpriseSettingsRequest

Return type

EnterpriseSettingsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseVoucher

EnterpriseVoucherResponse createEnterpriseVoucher(enterprise_id, CreateEnterpriseVoucherRequest)

Create enterprise voucher

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateEnterpriseVoucherRequestCreateEnterpriseVoucherRequest

Return type

EnterpriseVoucherResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseVoucherTemplate

VoucherTemplateResponse createEnterpriseVoucherTemplate(enterprise_id, CreateVoucherTemplateRequest)

Create enterprise voucher template

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateVoucherTemplateRequestCreateVoucherTemplateRequest

Return type

VoucherTemplateResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

deleteEnterprise

EnterpriseResponse deleteEnterprise(enterprise_id)

Delete enterprise

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]

Return type

EnterpriseResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseApplication

DeleteEnterpriseApplicationResponse deleteEnterpriseApplication(business_id)

Delete enterprise application (draft only)

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

DeleteEnterpriseApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseSetting

DeleteResponse deleteEnterpriseSetting(enterprise_id, setting_id)

Delete enterprise setting

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
setting_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseVoucher

DeleteResponse deleteEnterpriseVoucher(enterprise_id, voucher_id)

Delete enterprise voucher

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
voucher_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseVoucherTemplate

DeleteResponse deleteEnterpriseVoucherTemplate(enterprise_id, template_id)

Delete enterprise voucher template

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
template_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

duplicateVoucherTemplate

VoucherTemplateResponse duplicateVoucherTemplate(enterprise_id, template_id, body)

Duplicate template (create new template from existing)

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
template_idLong[default to null]
bodyString

Return type

VoucherTemplateResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

enterpriseListUsers

PaginatedResponse_EnterpriseUserResponse enterpriseListUsers(enterprise_id, page, per_page, search, is_active)

List enterprise users

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]
searchString[optional] [default to null]
is_activeBoolean[optional] [default to null]

Return type

PaginatedResponse_EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

enterpriseUpdateUser

EnterpriseUserResponse enterpriseUpdateUser(enterprise_id, user_id, UpdateEnterpriseUserRequest)

Update enterprise user

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
user_idLong[default to null]
UpdateEnterpriseUserRequestUpdateEnterpriseUserRequest

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

generateEnterpriseInvoice

BillingInvoice generateEnterpriseInvoice(enterprise_id, period_start, period_end)

Generate invoice for current period

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
period_startString[optional] [default to null]
period_endString[optional] [default to null]

Return type

BillingInvoice

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

generateVoucherFromTemplate

EnterpriseVoucherResponse generateVoucherFromTemplate(enterprise_id, GenerateVoucherFromTemplateRequest)

Generate voucher from template

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
GenerateVoucherFromTemplateRequestGenerateVoucherFromTemplateRequest

Return type

EnterpriseVoucherResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

getAuditLogStats

AuditStatistics getAuditLogStats(enterprise_id, days)

Get audit log statistics

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
daysInteger[optional] [default to null]

Return type

AuditStatistics

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterprise

EnterpriseResponse getEnterprise(enterprise_id)

Get enterprise by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]

Return type

EnterpriseResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseApplication

EnterpriseApplicationResponse getEnterpriseApplication(business_id)

Get enterprise application by ID

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

EnterpriseApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseApplicationStatus

EnterpriseApplicationStatusResponse getEnterpriseApplicationStatus(business_id)

Get enterprise application status

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

EnterpriseApplicationStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseBillingInfo

EnterpriseBillingInfo getEnterpriseBillingInfo(enterprise_id)

Get enterprise billing information

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]

Return type

EnterpriseBillingInfo

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseDashboardStats

EnterpriseDashboardStats getEnterpriseDashboardStats(enterprise_id)

Get enterprise dashboard statistics

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]

Return type

EnterpriseDashboardStats

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseDocuments

EnterpriseDocumentsResponse getEnterpriseDocuments(business_id)

Get documents for enterprise application

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

EnterpriseDocumentsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseFeeStatus

EnterpriseFeeStatusResponse getEnterpriseFeeStatus(business_id)

Get fee status for enterprise application

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

EnterpriseFeeStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseInvoices

PaginatedResponse_BillingInvoice getEnterpriseInvoices(enterprise_id, page, per_page)

Get enterprise invoices

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_BillingInvoice

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseOnboardingConfig

EnterpriseOnboardingConfigResponse getEnterpriseOnboardingConfig(country_code, city_id)

Get enterprise onboarding configuration

Parameters

NameTypeDescriptionNotes
country_codeString[default to null]
city_idLong[default to null]

Return type

EnterpriseOnboardingConfigResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseSetting

EnterpriseSettingsResponse getEnterpriseSetting(enterprise_id, setting_id)

Get setting by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
setting_idLong[default to null]

Return type

EnterpriseSettingsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseSettingByKey

EnterpriseSettingsResponse getEnterpriseSettingByKey(enterprise_id, key)

Get setting by key

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
keyString[default to null]

Return type

EnterpriseSettingsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseUsageSummary

BillingUsageSummary getEnterpriseUsageSummary(enterprise_id, period_start, period_end)

Get enterprise usage summary

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
period_startString[optional] [default to null]
period_endString[optional] [default to null]

Return type

BillingUsageSummary

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseVoucher

EnterpriseVoucherResponse getEnterpriseVoucher(enterprise_id, voucher_id)

Get voucher by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
voucher_idLong[default to null]

Return type

EnterpriseVoucherResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseVoucherTemplate

VoucherTemplateResponse getEnterpriseVoucherTemplate(enterprise_id, template_id)

Get voucher template by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
template_idLong[default to null]

Return type

VoucherTemplateResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEntityAuditLogs

PaginatedResponse_AuditLogEntry getEntityAuditLogs(enterprise_id, entity_type, entity_id, page, per_page)

Get audit logs for a specific entity

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
entity_typeString[default to null]
entity_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_AuditLogEntry

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getTemplateUsageStats

TemplateUsageStats getTemplateUsageStats(enterprise_id, template_id)

Get template usage statistics

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
template_idLong[default to null]

Return type

TemplateUsageStats

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getVoucherAnalytics

VoucherAnalyticsResponse getVoucherAnalytics(enterprise_id, start_date, end_date)

Get voucher analytics

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
start_dateString[optional] [default to null]
end_dateString[optional] [default to null]

Return type

VoucherAnalyticsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getVoucherUsageStats

VoucherUsageStats getVoucherUsageStats(enterprise_id, voucher_id)

Get voucher usage statistics

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
voucher_idLong[default to null]

Return type

VoucherUsageStats

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

inviteEnterpriseUser

EnterpriseInvitationResponse inviteEnterpriseUser(enterprise_id, InviteEnterpriseUserRequest)

Send invitation to a user to join enterprise

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
InviteEnterpriseUserRequestInviteEnterpriseUserRequest

Return type

EnterpriseInvitationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

listEnterpriseAuditLogs

PaginatedResponse_AuditLogEntry listEnterpriseAuditLogs(enterprise_id, page, per_page, entity_type, user_id, action)

List enterprise audit logs

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]
entity_typeString[optional] [default to null]
user_idLong[optional] [default to null]
actionString[optional] [default to null]

Return type

PaginatedResponse_AuditLogEntry

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseInvitations

PaginatedResponse_InvitationResponse listEnterpriseInvitations(enterprise_id, status, page, per_page)

List enterprise invitations

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
statusString[optional] [default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_InvitationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseSettings

PaginatedResponse_EnterpriseSettingsResponse listEnterpriseSettings(enterprise_id, page, per_page, is_active)

List enterprise settings

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]
is_activeBoolean[optional] [default to null]

Return type

PaginatedResponse_EnterpriseSettingsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseVoucherTemplates

PaginatedResponse_VoucherTemplateResponse listEnterpriseVoucherTemplates(enterprise_id, page, per_page, is_active, voucher_type)

List enterprise voucher templates

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageLong[optional] [default to null]
per_pageLong[optional] [default to null]
is_activeBoolean[optional] [default to null]
voucher_typeString[optional] [default to null]

Return type

PaginatedResponse_VoucherTemplateResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseVouchers

PaginatedResponse_EnterpriseVoucherResponse listEnterpriseVouchers(enterprise_id, page, per_page, search, is_active)

List enterprise vouchers

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageLong[optional] [default to null]
per_pageLong[optional] [default to null]
searchString[optional] [default to null]
is_activeBoolean[optional] [default to null]

Return type

PaginatedResponse_EnterpriseVoucherResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterprises

PaginatedResponse_EnterpriseResponse listEnterprises(page, per_page, search, is_active)

List all enterprises

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]
searchString[optional] [default to null]
is_activeBoolean[optional] [default to null]

Return type

PaginatedResponse_EnterpriseResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

removeEnterpriseUser

DeleteResponse removeEnterpriseUser(enterprise_id, user_id)

Remove user from enterprise

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
user_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

submitEnterpriseApplication

EnterpriseSubmitApplicationResponse submitEnterpriseApplication(business_id)

Submit enterprise application for review

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]

Return type

EnterpriseSubmitApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

updateEnterprise

EnterpriseResponse updateEnterprise(enterprise_id, UpdateEnterpriseRequest)

Update enterprise

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
UpdateEnterpriseRequestUpdateEnterpriseRequest

Return type

EnterpriseResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseApplication

UpdateEnterpriseApplicationResponse updateEnterpriseApplication(business_id, UpdateEnterpriseApplicationRequest)

Update enterprise application

Parameters

NameTypeDescriptionNotes
business_idLong[default to null]
UpdateEnterpriseApplicationRequestUpdateEnterpriseApplicationRequest

Return type

UpdateEnterpriseApplicationResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseSetting

EnterpriseSettingsResponse updateEnterpriseSetting(enterprise_id, setting_id, UpdateEnterpriseSettingsRequest)

Update enterprise setting

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
setting_idLong[default to null]
UpdateEnterpriseSettingsRequestUpdateEnterpriseSettingsRequest

Return type

EnterpriseSettingsResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseVoucher

EnterpriseVoucherResponse updateEnterpriseVoucher(enterprise_id, voucher_id, UpdateEnterpriseVoucherRequest)

Update enterprise voucher

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
voucher_idLong[default to null]
UpdateEnterpriseVoucherRequestUpdateEnterpriseVoucherRequest

Return type

EnterpriseVoucherResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseVoucherTemplate

VoucherTemplateResponse updateEnterpriseVoucherTemplate(enterprise_id, template_id, UpdateVoucherTemplateRequest)

Update enterprise voucher template

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
template_idLong[default to null]
UpdateVoucherTemplateRequestUpdateVoucherTemplateRequest

Return type

VoucherTemplateResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8
Earnings ApiEnterprise Business Management Api