Expense

Find all expense for the logged in employee, including split expenses.

GET
http://localhost:3000/api/expense/me

Response

200OKExpense

Found expense

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
amountnumberrequired
typeOfExpensestring
notesstring
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired
valueDatestring<date-time>
purposestring
taxTypestring
taxLabelstring
rateValuenumberrequired
receiptstring
splitExpensebooleanrequired
referencestring
statusstringINVOICEDUNINVOICEDPAIDNOT_BILLABLE
employeeEmployeerequired
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
employeeIdstringrequiredread only
vendorOrganizationVendorrequired
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
namestringrequired
emailstringrequired
phonestringrequired
websitestringrequired

Same fields as Expense

Same fields as tags

vendorIdstringrequiredread only
categoryExpenseCategoryrequired
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
namestringrequired

Same fields as Expense

Same fields as tags

categoryIdstringrequiredread only
projectOrganizationProjectrequired
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
namestringrequired
startDatestring
endDatestring
billingstringRATEFLAT_FEEMILESTONES
Example
FLAT_FEE
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL
Example
USD
publicboolean
ownerstringCLIENTINTERNAL
Example
CLIENT
taskListTypestringGRIDSPRINTrequired
Example
GRID
codestring
descriptionstring
colorstring
billableboolean
billingFlatboolean
openSourceboolean
projectUrlstring
openSourceProjectUrlstring
budgetnumber
budgetTypestringhourscost
imageUrlstring
iconstring
statusstringopenin-progresscompletedcancelledcustomopen
isTasksAutoSyncboolean
isTasksAutoSyncOnLabelboolean
syncTagstring
archiveTasksInnumber
closeTasksInnumber
organizationContactIdstring
imageIdstring
defaultAssigneeIdstring
projectIdstring
organizationContactOrganizationContactrequired
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
namestringrequired
primaryEmailstring
primaryPhonestring
inviteStatusstringNOT_INVITEDINVITEDACCEPTED
notesstring
contactTypestringCLIENTCUSTOMERLEAD
imageUrlstring
budgetnumber
budgetTypestring
contactContactrequired
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
namestringrequired
firstNamestringrequired
lastNamestringrequired
countrystringrequired
citystringrequired
addressstringrequired
address2stringrequired
postcodestring
latitudenumber
longitudenumber
regionCodestringrequired
faxstring
fiscalInformationstring
websitestring
contactIdstring
imageIdstring

Same fields as project

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
invoiceDatestring<date-time>required
invoiceNumbernumberrequired
dueDatestring<date-time>required
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired
discountValuenumberrequired
paidbooleanrequired
taxnumberrequired
tax2numberrequired
termsstring
totalValuenumber
statusstring
isEstimateboolean
isAcceptedboolean
discountTypestringPERCENTFLATrequired
taxTypestringPERCENTFLATrequired
tax2TypestringPERCENTFLATrequired
invoiceTypestringBY_EMPLOYEE_HOURSBY_PROJECT_HOURSBY_TASK_HOURSBY_PRODUCTSBY_EXPENSESDETAILED_ITEMS
sentTostring
organizationContactIdstring
internalNotestring
alreadyPaidnumber
amountDuenumber
hasRemainingAmountInvoicedboolean
tokenstring
fromOrganizationschemas
Show child attributes
selectobject
relationsobject
whereobjectrequired
orderobject
withDeletedboolean
takenumber[0, 100]
skipnumber>= 0
fromOrganizationIdstringrequired
toContactschemas

Same fields as organizationContact.invoices.fromOrganization

toContactIdstringrequired
invoiceItemsArray<InvoiceItem>

Same fields as invoiceItems

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
actionstringrequired
titlestring
userUserrequired
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
thirdPartyIdstring
firstNamestring
lastNamestring
emailstring
phoneNumberstring
usernamestring
timeZonestring
timeFormatstring1224
hashstring
refreshTokenstring
imageUrlstring
preferredLanguagestringenbgherufreszhdeptitnlplar
preferredComponentLayoutstringCARDS_GRIDTABLE
uiPreferencesobject
codestring
codeExpireAtstring<date-time>
emailVerifiedAtstring<date-time>
lastLoginAtstring<date-time>
emailTokenstring
roleIdstring
imageIdstring
defaultTeamIdstring
lastTeamIdstring
defaultOrganizationIdstring
lastOrganizationIdstring
userIdstringrequired
invoiceInvoicerequired

Same fields as organizationContact.invoices

invoiceIdstringrequired
tagsTagrequired

Same fields as tags

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
paymentDatestring<date-time>
amountnumberrequired
notestring
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL
paymentMethodstringBANK_TRANSFERCASHCHEQUECREDIT_CARDDEBITONLINE
overdueboolean
employeeIdstringrequired
invoiceIdstring

Same fields as project

projectIdstring
organizationContactOrganizationContact

Same fields as organizationContact

organizationContactIdstring
tagsArray<array>

Same fields as Expense

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
amountnumberrequired
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired
valueDatestring<date-time>
notesstring
isBonusbooleanrequired
referencestring
employeeEmployeerequired

Same fields as employee

employeeIdstringrequiredread only
clientIdstringrequired
tagsArray<schemas>required

Same fields as organizationContact.invoices.fromOrganization

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
startedAttimestamptzrequired
stoppedAttimestamptzrequired
logTypestringTRACKEDMANUALIDLERESUMEDTRACKEDrequired
sourcestringMOBILEBROWSERDESKTOPBROWSER_EXTENSIONHUBSTAFFUPWORKTEAMSCLOCBROWSERrequired
descriptionstring
reasonstring
isBillablebooleanfalse
isRunningboolean
versionstring
Example
1.0.1
employeeIdstringrequired
timesheetIdstring
projectIdstring
taskIdstring
organizationContactIdstring
organizationTeamIdstring
organizationContactIdstring
invoiceItemsArray<InvoiceItem>
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
descriptionstringrequired
pricenumberrequired
quantitynumberrequired
totalValuenumberrequired
applyTaxboolean
applyDiscountboolean
expenseExpense

Same fields as Expense

expenseIdstring
invoiceIdstring
taskTask
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
titlestringrequired
descriptionstring
statusstringrequired
prioritystring
sizestring
issueTypestring
estimatenumber
dueDatestring<date-time>
publicboolean
startDatestring<date-time>
resolvedAtstring<date-time>
versionstring
isDraftboolean
isScreeningTaskboolean
parentTask

Same fields as invoiceItems.task

parentIdstring
projectobject
projectIdstring
organizationSprintobject
organizationSprintIdstring
taskStatusobject
taskStatusIdstring
taskSizeobject
taskSizeIdstring
taskPriorityobject
taskPriorityIdstring
taskTypeIssueType
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
namestringrequired
valuestringrequired
descriptionstring
iconstring
colorstring
isDefaultbooleanfalse
isSystembooleanfalse
imageIdstring
projectIdstring
organizationTeamIdstring
taskTypeIdstring
tagsArray<array>
membersArray<array>
teamsArray<array>
modulesArray<array>
taskIdstring
employeeEmployee

Same fields as employee

employeeIdstring

Same fields as project

projectIdstring
productProduct
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
enabledboolean
codestringrequired
imageUrlstring
featuredImageImageAssetrequired
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
namestring
urlstringrequired
thumbstringrequired
widthnumber0
heightnumber0
sizenumber
isFeaturedbooleanrequired
externalProviderIdstring
storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN
productFeaturedImageArray<Product>required

Same fields as invoiceItems.product

equipmentImageArray<Equipment>required
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
namestringrequired
typestringrequired
serialNumberstring
manufacturedYearnumberrequired
initialCostnumberrequired
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired
maxSharePeriodnumberrequired
autoApproveSharebooleanrequired
equipmentSharingsArray<EquipmentSharing>required
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
namestring
shareRequestDaystring<date-time>
shareStartDaystring<date-time>
shareEndDaystring<date-time>
statusnumberrequired
equipmentIdstring
equipmentSharingPolicyEquipmentSharingPolicy
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
namestringrequired
descriptionstring
equipmentSharingPolicyIdstring
tagsArray<Tag>required

Same fields as tags

warehousesArray<Warehouse>required
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
namestringrequired
codestringrequired
emailstringrequired
descriptionstringrequired
activeboolean
logoIdstringrequired
contactIdstringrequired
productGalleryArray<Product>required

Same fields as invoiceItems.product

featuredImageIdstringrequired
productTypeProductTyperequired
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
iconstringbriefcase-outlinecar-outlinecolor-palette-outlineflash-outlinehome-outlinegift-outlineheart-outlineradio-button-off-outlinepin-outlinesettings-outlinestar-outlineshopping-bag-outlineshare-outlineactivity-outlinealert-triangle-outlinebulb-outlinecheckmark-circle-outlineglobe-2-outlinelayers-outlinephone-outlineshopping-cart-outlinerequired
productsArray<Product>required

Same fields as invoiceItems.product

translationsArray<ProductTypeTranslation>required
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
namestringrequired
descriptionstringrequired
languageCodestringrequired
referenceProductTyperequired

Same fields as invoiceItems.product.productType

referenceIdstringrequired
productTypeIdstringrequired
productCategoryProductCategoryrequired
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
imageUrlstring
imageIdstring
productsArray<Product>required

Same fields as invoiceItems.product

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
namestringrequired
descriptionstringrequired
languageCodestringrequired
referenceIdstringrequired
productCategoryIdstringrequired
translationsArray<ProductTranslation>required
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
namestringrequired
descriptionstringrequired
languageCodestringenbgherufreszhdeptitnlplarrequired
referenceProductrequired

Same fields as invoiceItems.product

referenceIdstringrequired
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
taxesnumberrequired
notesstring
quantitynumberrequired
billingInvoicingPolicystringrequired
internalReferencestringrequired
enabledboolean
productProductrequired

Same fields as invoiceItems.product

productIdstringrequired
imageIdstringrequired
warehouseProductVariantsArray<WarehouseProductVariant>required
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
quantitynumber
variantProductVariantrequired

Same fields as invoiceItems.product.variants

variantIdstringrequired
warehouseProductIdstringrequired
optionsProductOptionrequired
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
namestringrequired
codestringrequired
groupIdstring
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
namestringrequired
descriptionstringrequired
languageCodestringenbgherufreszhdeptitnlplarrequired
referenceIdstringrequired
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
namestringrequired
productProductrequired

Same fields as invoiceItems.product

productIdstringrequired
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
namestringrequired
languageCodestringenbgherufreszhdeptitnlplarrequired
referenceIdstringrequired
invoiceItemsArray<InvoiceItem>

Same fields as invoiceItems

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
quantitynumber
warehouseIdstringrequired
productProductrequired

Same fields as invoiceItems.product

productIdstringrequired
tagsArray<Tag>required

Same fields as tags

productIdstring
tagsArray<Tag>required
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
namestringrequired
colorstringrequired
textColorstring
descriptionstring
iconstring
isSystembooleanfalse
tagTypeIdstring
organizationTeamIdstring
401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey