GoalKpi

Create Goal KPI

POST
http://localhost:3000/api/goal-kpi

Body

application/json
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
namestringrequired
descriptionstringrequired
typestringNumericalPercentageCurrencyrequired
unitstringrequired
operatorstringrequired
currentValuenumberrequired
targetValuenumberrequired
leadEmployeerequired
Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
short_descriptionstring
descriptionstring
startedWorkOnstring<date-time>
endWorkstring<date-time>
payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY
Example
WEEKLY
billRateValuenumber
minimumBillingRatenumber
billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL
Example
USD
reWeeklyLimitnumber
offerDatestring<date-time>
acceptDatestring<date-time>
rejectDatestring<date-time>
employeeLevelstring
anonymousBonusboolean
averageIncomenumberrequired
averageBonusnumberrequired
totalWorkHoursnumberrequired
averageExpensesnumberrequired
show_anonymous_bonusboolean
show_average_bonusboolean
show_average_expensesboolean
show_average_incomeboolean
show_billrateboolean
show_payperiodboolean
show_start_work_onboolean
isJobSearchActiveboolean
linkedInUrlstring
facebookUrlstring
instagramUrlstring
twitterUrlstring
githubUrlstring
gitlabUrlstring
upworkUrlstring
stackoverflowUrlstring
isVerifiedboolean
isVettedboolean
totalJobsnumberrequired
jobSuccessnumberrequired
isTrackingEnabledboolean
isOnlineboolean
isAwaystringfalse
isTrackingTimeboolean
allowScreenshotCaptureboolean
allowManualTimeboolean
allowModifyTimeboolean
allowDeleteTimeboolean
allowAgentAppExitboolean
allowLogoutFromAgentAppboolean
trackKeyboardMouseActivityboolean
trackAllDisplaysboolean
upworkIdstring
linkedInIdstring
userIdstringrequired
contactIdstringrequired
organizationPositionIdstringrequired

Response

200OKGoalKPI

KPI added successfully

Response fields application/json
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
namestringrequired
descriptionstringrequired
typestringNumericalPercentageCurrencyrequired
unitstringrequired
operatorstringrequired
currentValuenumberrequired
targetValuenumberrequired
leadEmployeerequired
Show child attributes
deletedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
createdAtstring<date-time>

The creation timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
updatedAtstring<date-time>

The last update timestamp of the entity.

Example
2018-11-21T06:20:32.232Z
idstring
isActivebooleantrue
isArchivedbooleanfalse
archivedAtstring<date-time>
Example
2018-11-21T06:20:32.232Z
tenantIdstring
organizationIdstring
short_descriptionstring
descriptionstring
startedWorkOnstring<date-time>
endWorkstring<date-time>
payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY
Example
WEEKLY
billRateValuenumber
minimumBillingRatenumber
billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL
Example
USD
reWeeklyLimitnumber
offerDatestring<date-time>
acceptDatestring<date-time>
rejectDatestring<date-time>
employeeLevelstring
anonymousBonusboolean
averageIncomenumberrequired
averageBonusnumberrequired
totalWorkHoursnumberrequired
averageExpensesnumberrequired
show_anonymous_bonusboolean
show_average_bonusboolean
show_average_expensesboolean
show_average_incomeboolean
show_billrateboolean
show_payperiodboolean
show_start_work_onboolean
isJobSearchActiveboolean
linkedInUrlstring
facebookUrlstring
instagramUrlstring
twitterUrlstring
githubUrlstring
gitlabUrlstring
upworkUrlstring
stackoverflowUrlstring
isVerifiedboolean
isVettedboolean
totalJobsnumberrequired
jobSuccessnumberrequired
isTrackingEnabledboolean
isOnlineboolean
isAwaystringfalse
isTrackingTimeboolean
allowScreenshotCaptureboolean
allowManualTimeboolean
allowModifyTimeboolean
allowDeleteTimeboolean
allowAgentAppExitboolean
allowLogoutFromAgentAppboolean
trackKeyboardMouseActivityboolean
trackAllDisplaysboolean
upworkIdstring
linkedInIdstring
userIdstringrequired
contactIdstringrequired
organizationPositionIdstringrequired
leadIdstringrequiredread only
401Unauthorized

Unauthorized

403Forbidden

Forbidden

Authorization

bearerhttp (bearer) in header

Enter JWT token

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey
Stack OverflowWebsiteDemo
↑↓ navigate↵ selectesc close