ProductVariant
Update an existing record
PUT
Body
application/json
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringtaxesnumberrequirednotesstringquantitynumberrequiredbillingInvoicingPolicystringrequiredinternalReferencestringrequiredenabledbooleanShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringenabledbooleancodestringrequiredimageUrlstringSame fields as image
featuredImageIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringiconstringbriefcase-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-outlinerequiredSame fields as product
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequireddescriptionstringrequiredlanguageCodestringrequiredSame fields as product.productType
referenceIdstringrequiredproductTypeIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringimageUrlstringimageIdstringSame fields as product
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequireddescriptionstringrequiredlanguageCodestringrequiredSame fields as product.productCategory
referenceIdstringrequiredproductCategoryIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequireddescriptionstringrequiredlanguageCodestringenbgherufreszhdeptitnlplarrequiredreferenceIdstringrequiredvariantsArray<ProductVariant>Same fields as ProductVariant
optionGroupsArray<ProductOptionGroup>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredproductIdstringrequiredSame fields as options
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredlanguageCodestringenbgherufreszhdeptitnlplarrequiredSame fields as product.optionGroups
referenceIdstringrequiredinvoiceItemsArray<InvoiceItem>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringdescriptionstringrequiredpricenumberrequiredquantitynumberrequiredtotalValuenumberrequiredapplyTaxbooleanapplyDiscountbooleanexpenseExpenseShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringamountnumberrequiredtypeOfExpensestringnotesstringcurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequiredvalueDatestring<date-time>purposestringtaxTypestringtaxLabelstringrateValuenumberrequiredreceiptstringsplitExpensebooleanrequiredreferencestringstatusstringINVOICEDUNINVOICEDPAIDNOT_BILLABLESame fields as product.invoiceItems.employee
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredemailstringrequiredphonestringrequiredwebsitestringrequiredexpensesArray<Expense>Same fields as product.invoiceItems.expense
tagsArray<Tag>Same fields as product.tags
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredexpensesArray<Expense>Same fields as product.invoiceItems.expense
tagsArray<Tag>Same fields as product.tags
Same fields as product.invoiceItems.project
projectIdstringShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredprimaryEmailstringprimaryPhonestringinviteStatusstringNOT_INVITEDINVITEDACCEPTEDnotesstringcontactTypestringCLIENTCUSTOMERLEADimageUrlstringbudgetnumberbudgetTypestringShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredfirstNamestringrequiredlastNamestringrequiredcountrystringrequiredcitystringrequiredaddressstringrequiredaddress2stringrequiredpostcodestringlatitudenumberlongitudenumberregionCodestringrequiredfaxstringfiscalInformationstringwebsitestringcontactIdstringimageIdstringprojectsArray<OrganizationProject>Same fields as product.invoiceItems.project
invoicesArray<Invoice>Same fields as product.invoiceItems.invoice
paymentsArray<Payment>Same fields as product.invoiceItems.invoice.payments
expensesArray<Expense>Same fields as product.invoiceItems.expense
incomesArray<Income>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringamountnumberrequiredcurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequiredvalueDatestring<date-time>notesstringisBonusbooleanrequiredreferencestringSame fields as product.invoiceItems.employee
clientschemasSame fields as product.invoiceItems.invoice.fromOrganization
clientIdstringrequiredtagsArray<schemas>requiredSame fields as product.invoiceItems.invoice.fromOrganization
timeLogsArray<TimeLog>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringstartedAttimestamptzrequiredstoppedAttimestamptzrequiredlogTypestringTRACKEDMANUALIDLERESUMEDTRACKEDrequiredsourcestringMOBILEBROWSERDESKTOPBROWSER_EXTENSIONHUBSTAFFUPWORKTEAMSCLOCBROWSERrequireddescriptionstringreasonstringisBillablebooleanfalseisRunningbooleanversionstringExample
1.0.1Copy
employeeIdstringrequiredtimesheetIdstringprojectIdstringtaskIdstringorganizationContactIdstringorganizationTeamIdstringorganizationContactIdstringinvoiceItemsArray<InvoiceItem>Same fields as product.invoiceItems
Same fields as product.tags
expenseIdstringinvoiceInvoiceShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringinvoiceDatestring<date-time>requiredinvoiceNumbernumberrequireddueDatestring<date-time>requiredcurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequireddiscountValuenumberrequiredpaidbooleanrequiredtaxnumberrequiredtax2numberrequiredtermsstringtotalValuenumberstatusstringisEstimatebooleanisAcceptedbooleandiscountTypestringPERCENTFLATrequiredtaxTypestringPERCENTFLATrequiredtax2TypestringPERCENTFLATrequiredinvoiceTypestringBY_EMPLOYEE_HOURSBY_PROJECT_HOURSBY_TASK_HOURSBY_PRODUCTSBY_EXPENSESDETAILED_ITEMSsentTostringorganizationContactIdstringinternalNotestringalreadyPaidnumberamountDuenumberhasRemainingAmountInvoicedbooleantokenstringfromOrganizationschemasShow child attributes
selectobjectrelationsobjectwhereobjectrequiredorderobjectwithDeletedbooleantakenumber[0, 100]skipnumber>= 0fromOrganizationIdstringrequiredtoContactschemasSame fields as product.invoiceItems.invoice.fromOrganization
toContactIdstringrequiredinvoiceItemsArray<InvoiceItem>Same fields as product.invoiceItems
paymentsArray<Payment>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringpaymentDatestring<date-time>amountnumberrequirednotestringcurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLpaymentMethodstringBANK_TRANSFERCASHCHEQUECREDIT_CARDDEBITONLINEoverduebooleanemployeeIdstringrequiredinvoiceInvoiceSame fields as product.invoiceItems.invoice
invoiceIdstringprojectOrganizationProjectSame fields as product.invoiceItems.project
projectIdstringorganizationContactOrganizationContactSame fields as product.invoiceItems.expense.organizationContact
organizationContactIdstringtagsArray<array>historyRecordsArray<InvoiceEstimateHistory>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringactionstringrequiredtitlestringShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringthirdPartyIdstringfirstNamestringlastNamestringemailstringphoneNumberstringusernamestringtimeZonestringtimeFormatstring1224hashstringrefreshTokenstringimageUrlstringpreferredLanguagestringenbgherufreszhdeptitnlplarpreferredComponentLayoutstringCARDS_GRIDTABLEuiPreferencesobjectcodestringcodeExpireAtstring<date-time>emailVerifiedAtstring<date-time>lastLoginAtstring<date-time>emailTokenstringroleIdstringimageIdstringdefaultTeamIdstringlastTeamIdstringdefaultOrganizationIdstringlastOrganizationIdstringuserIdstringrequiredSame fields as product.invoiceItems.invoice
invoiceIdstringrequiredSame fields as product.tags
invoiceIdstringtaskTaskShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringtitlestringrequireddescriptionstringstatusstringrequiredprioritystringsizestringissueTypestringestimatenumberdueDatestring<date-time>publicbooleanstartDatestring<date-time>resolvedAtstring<date-time>versionstringisDraftbooleanisScreeningTaskbooleanparentTaskSame fields as product.invoiceItems.task
parentIdstringprojectobjectprojectIdstringorganizationSprintobjectorganizationSprintIdstringtaskStatusobjecttaskStatusIdstringtaskSizeobjecttaskSizeIdstringtaskPriorityobjecttaskPriorityIdstringtaskTypeIssueTypeShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredvaluestringrequireddescriptionstringiconstringcolorstringisDefaultbooleanfalseisSystembooleanfalseimageIdstringprojectIdstringorganizationTeamIdstringtaskTypeIdstringtagsArray<array>membersArray<array>teamsArray<array>modulesArray<array>taskIdstringemployeeEmployeeShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringshort_stringdescriptionstringstartedWorkOnstring<date-time>endWorkstring<date-time>payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLYExample
WEEKLYCopy
billRateValuenumberminimumBillingRatenumberbillRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLExample
USDCopy
reWeeklyLimitnumberofferDatestring<date-time>acceptDatestring<date-time>rejectDatestring<date-time>employeeLevelstringanonymousBonusbooleanaverageIncomenumberrequiredaverageBonusnumberrequiredtotalWorkHoursnumberrequiredaverageExpensesnumberrequiredshow_booleanshow_booleanshow_booleanshow_booleanshow_booleanshow_booleanshow_booleanisJobSearchActivebooleanlinkedInUrlstringfacebookUrlstringinstagramUrlstringtwitterUrlstringgithubUrlstringgitlabUrlstringupworkUrlstringstackoverflowUrlstringisVerifiedbooleanisVettedbooleantotalJobsnumberrequiredjobSuccessnumberrequiredprofile_stringisTrackingEnabledbooleanisOnlinebooleanisAwaystringfalseisTrackingTimebooleanallowScreenshotCapturebooleanallowManualTimebooleanallowModifyTimebooleanallowDeleteTimebooleanallowAgentAppExitbooleanallowLogoutFromAgentAppbooleantrackKeyboardMouseActivitybooleantrackAllDisplaysbooleanupworkIdstringlinkedInIdstringuserIdstringrequiredcontactIdstringrequiredorganizationPositionIdstringrequiredemployeeIdstringprojectOrganizationProjectShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredstartDatestringendDatestringbillingstringRATEFLAT_FEEMILESTONESExample
FLAT_FEECopy
currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLExample
USDCopy
publicbooleanownerstringCLIENTINTERNALExample
CLIENTCopy
taskListTypestringGRIDSPRINTrequiredExample
GRIDCopy
codestringdescriptionstringcolorstringbillablebooleanbillingFlatbooleanopenSourcebooleanprojectUrlstringopenSourceProjectUrlstringbudgetnumberbudgetTypestringhourscostimageUrlstringiconstringstatusstringopenin-progresscompletedcancelledcustomopenisTasksAutoSyncbooleanisTasksAutoSyncOnLabelbooleansyncTagstringarchiveTasksInnumbercloseTasksInnumberorganizationContactIdstringimageIdstringdefaultAssigneeIdstringprojectIdstringproductIdstringwarehousesArray<WarehouseProduct>Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringquantitynumberSame fields as image.warehouses
warehouseIdstringrequiredproductIdstringrequiredSame fields as warehouseProductVariants
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredcolorstringrequiredtextColorstringdescriptionstringiconstringisSystembooleanfalsetagTypeIdstringorganizationTeamIdstringSame fields as image
productIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringurlstringrequiredthumbstringrequiredwidthnumber0heightnumber0sizenumberisFeaturedbooleanrequiredexternalProviderIdstringstorageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEANSame fields as product
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredtypestringrequiredserialNumberstringmanufacturedYearnumberrequiredinitialCostnumberrequiredcurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequiredmaxSharePeriodnumberrequiredautoApproveSharebooleanrequiredSame fields as image
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringshareRequestDaystring<date-time>shareStartDaystring<date-time>shareEndDaystring<date-time>statusnumberrequiredequipmentEquipmentSame fields as image.equipmentImage
equipmentIdstringequipmentSharingPolicyEquipmentSharingPolicyShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequireddescriptionstringequipmentSharingPolicyIdstringSame fields as product.tags
Show child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredcodestringrequiredemailstringrequireddescriptionstringrequiredactivebooleanSame fields as image
logoIdstringrequiredcontactIdstringrequiredSame fields as product.warehouses
Same fields as product
imageIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringquantitynumberSame fields as ProductVariant
variantIdstringrequiredwarehouseProductIdstringrequiredShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequiredcodestringrequiredgroupProductOptionGroupSame fields as product.optionGroups
groupIdstringShow child attributes
deletedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
createdAtstring<date-time>The creation timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
updatedAtstring<date-time>The last update timestamp of the entity.
Example
2018-11-21T06:20:32.232ZCopy
idstringisActivebooleantrueisArchivedbooleanfalsearchivedAtstring<date-time>Example
2018-11-21T06:20:32.232ZCopy
tenantIdstringorganizationIdstringnamestringrequireddescriptionstringrequiredlanguageCodestringenbgherufreszhdeptitnlplarrequiredSame fields as options
referenceIdstringrequiredParameters
idstringrequiredpathResponse
201Created
The record has been successfully edited.
400Bad Request
Invalid input, The response body may contain clues as to what went wrong
401Unauthorized
Unauthorized
403Forbidden
Forbidden
404Not Found
Record not found
Authorization
bearerhttp (bearer) in headerEnter JWT token
Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey