PUT V3/odata/Budget({key})
Updates Budget entity
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
BudgetId from Budget entity |
integer |
Required |
Body Parameters
QicsUnity.Api.Areas.V3.Models.Budget| Name | Description | Type | Additional information |
|---|---|---|---|
| BudgetId |
Gets or sets BudgetId |
integer |
Required 64-bit signed integer |
| ProjectId |
Gets or sets ProjectId |
integer |
Required 64-bit signed integer |
| ProjectName |
Gets or sets Project.Name. Readonly property. |
string | |
| Name |
Gets or sets Name |
string |
Required |
| Description |
Gets or sets Description. Readonly legacy property which returns Notes property value. |
string | |
| IsLeaf |
Gets or sets a value indicating whether entity is leaf or parent budget. Ignored on update. |
boolean | |
| ItemCompanyId |
Gets or sets ItemCompanyId of restriction item |
integer |
64-bit signed integer Nullable |
| EmployeeCompanyId |
Gets or sets EmployeeCompanyId of restriction employee |
integer |
64-bit signed integer Nullable |
| State |
Gets or sets State |
QicsUnity.Common.BusinessObjects.BudgetState |
Required |
| Hours |
Gets or sets Hours |
decimal number |
Nullable |
| IsRateCustom |
Gets or sets a value indicating whether sales rate is custom |
boolean |
Required |
| Rate |
Gets or sets sales rate. Applied only when sales rate is custom. |
decimal number |
Nullable |
| IsCostRateCustom |
Gets or sets a value indicating whether cost rate is custom |
boolean |
Required |
| CostRate |
Gets or sets cost rate. Applied only when cost rate is custom. |
decimal number |
Nullable |
| ExpenseQuantity |
Gets or sets ExpenseQuantity |
decimal number |
Nullable |
| IsExpenseRateCustom |
Gets or sets a value indicating whether expense rate is custom |
boolean |
Required |
| ExpenseRate |
Gets or sets expense rate. Applied only when expense rate is custom. |
decimal number |
Nullable |
| Notes |
Gets or sets Notes |
string | |
| StartDate |
Gets or sets start date |
date |
Required date and time of day |
| EndDate |
Gets or sets end date |
date |
date and time of day Nullable |
| AllowPlanning |
Gets or sets a value indicating whether budget can be planned |
boolean |
Required |
| UseSelectedAgreements |
Gets or sets a value indicating whether list of selected invoicing agreements is assigned to the budget When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, UseSelectedAgreements will be overriden from parent budget. |
boolean |
Required |
| SelectedInvoicingAgreementIds |
Gets or sets list of invoicing agreement IDs when Selected agreements option is chosen When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, SelectedInvoicingAgreementIds will be overriden from parent budget. |
Collection of integer | |
| ParentBudgetId |
Gets or sets BudgetId of parent Budget |
integer |
64-bit signed integer Nullable |
| ChildBudgetIds |
Gets or sets list of BudgetIds which are children of this parent budget. Valid only for non leaf budgets. |
Collection of integer |
None. |
| LinkChildrenToSameAgreementsAsParent |
Gets or sets a value indicating whether leaf budgets are linked to the same invoicing agreements as this parent budget. Valid only for non leaf budgets. When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, LinkChildrenToSameAgreementsAsParent will be overriden from parent budget. |
boolean |
None. |
Request Formats
application/json, text/json, application/scim+json
{
"BudgetId": "1",
"ProjectId": "2",
"ProjectName": "sample 3",
"Name": "sample 4",
"Description": "sample 5",
"IsLeaf": true,
"ItemCompanyId": "1",
"EmployeeCompanyId": "1",
"State": "Open",
"Hours": "1",
"IsRateCustom": true,
"Rate": "1",
"IsCostRateCustom": true,
"CostRate": "1",
"ExpenseQuantity": "1",
"IsExpenseRateCustom": true,
"ExpenseRate": "1",
"Notes": "sample 10",
"StartDate": "2026-01-02T07:52:27.8588955+00:00",
"EndDate": "2026-01-02T07:52:27.8588955+00:00",
"AllowPlanning": true,
"UseSelectedAgreements": true,
"SelectedInvoicingAgreementIds": [
"1",
"2"
],
"ParentBudgetId": "1",
"ChildBudgetIds": [
"1",
"2"
],
"LinkChildrenToSameAgreementsAsParent": true
}
application/xml, text/xml
<Budget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models">
<AllowPlanning>true</AllowPlanning>
<BudgetId>1</BudgetId>
<ChildBudgetIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</ChildBudgetIds>
<CostRate>1</CostRate>
<Description>sample 5</Description>
<EmployeeCompanyId>1</EmployeeCompanyId>
<EndDate>2026-01-02T07:52:27.8588955+00:00</EndDate>
<ExpenseQuantity>1</ExpenseQuantity>
<ExpenseRate>1</ExpenseRate>
<Hours>1</Hours>
<IsCostRateCustom>true</IsCostRateCustom>
<IsExpenseRateCustom>true</IsExpenseRateCustom>
<IsLeaf>true</IsLeaf>
<IsRateCustom>true</IsRateCustom>
<ItemCompanyId>1</ItemCompanyId>
<LinkChildrenToSameAgreementsAsParent>true</LinkChildrenToSameAgreementsAsParent>
<Name>sample 4</Name>
<Notes>sample 10</Notes>
<ParentBudgetId>1</ParentBudgetId>
<ProjectId>2</ProjectId>
<ProjectName>sample 3</ProjectName>
<Rate>1</Rate>
<SelectedInvoicingAgreementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</SelectedInvoicingAgreementIds>
<StartDate>2026-01-02T07:52:27.8588955+00:00</StartDate>
<State>Open</State>
<UseSelectedAgreements>true</UseSelectedAgreements>
</Budget>
Response Information
Resource Description
QicsUnity.Api.Areas.V3.Models.Budget| Name | Description | Type | Additional information |
|---|---|---|---|
| BudgetId |
Gets or sets BudgetId |
integer |
Required 64-bit signed integer |
| ProjectId |
Gets or sets ProjectId |
integer |
Required 64-bit signed integer |
| ProjectName |
Gets or sets Project.Name. Readonly property. |
string | |
| Name |
Gets or sets Name |
string |
Required |
| Description |
Gets or sets Description. Readonly legacy property which returns Notes property value. |
string | |
| IsLeaf |
Gets or sets a value indicating whether entity is leaf or parent budget. Ignored on update. |
boolean | |
| ItemCompanyId |
Gets or sets ItemCompanyId of restriction item |
integer |
64-bit signed integer Nullable |
| EmployeeCompanyId |
Gets or sets EmployeeCompanyId of restriction employee |
integer |
64-bit signed integer Nullable |
| State |
Gets or sets State |
QicsUnity.Common.BusinessObjects.BudgetState |
Required |
| Hours |
Gets or sets Hours |
decimal number |
Nullable |
| IsRateCustom |
Gets or sets a value indicating whether sales rate is custom |
boolean |
Required |
| Rate |
Gets or sets sales rate. Applied only when sales rate is custom. |
decimal number |
Nullable |
| IsCostRateCustom |
Gets or sets a value indicating whether cost rate is custom |
boolean |
Required |
| CostRate |
Gets or sets cost rate. Applied only when cost rate is custom. |
decimal number |
Nullable |
| ExpenseQuantity |
Gets or sets ExpenseQuantity |
decimal number |
Nullable |
| IsExpenseRateCustom |
Gets or sets a value indicating whether expense rate is custom |
boolean |
Required |
| ExpenseRate |
Gets or sets expense rate. Applied only when expense rate is custom. |
decimal number |
Nullable |
| Notes |
Gets or sets Notes |
string | |
| StartDate |
Gets or sets start date |
date |
Required date and time of day |
| EndDate |
Gets or sets end date |
date |
date and time of day Nullable |
| AllowPlanning |
Gets or sets a value indicating whether budget can be planned |
boolean |
Required |
| UseSelectedAgreements |
Gets or sets a value indicating whether list of selected invoicing agreements is assigned to the budget When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, UseSelectedAgreements will be overriden from parent budget. |
boolean |
Required |
| SelectedInvoicingAgreementIds |
Gets or sets list of invoicing agreement IDs when Selected agreements option is chosen When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, SelectedInvoicingAgreementIds will be overriden from parent budget. |
Collection of integer | |
| ParentBudgetId |
Gets or sets BudgetId of parent Budget |
integer |
64-bit signed integer Nullable |
| ChildBudgetIds |
Gets or sets list of BudgetIds which are children of this parent budget. Valid only for non leaf budgets. |
Collection of integer |
None. |
| LinkChildrenToSameAgreementsAsParent |
Gets or sets a value indicating whether leaf budgets are linked to the same invoicing agreements as this parent budget. Valid only for non leaf budgets. When ParentBudgetId is filled, and parent budget has LinkChildrenToSameAgreementsAsParent set to true, LinkChildrenToSameAgreementsAsParent will be overriden from parent budget. |
boolean |
None. |
Response Formats
application/json, text/json, application/scim+json
{
"BudgetId": "1",
"ProjectId": "2",
"ProjectName": "sample 3",
"Name": "sample 4",
"Description": "sample 5",
"IsLeaf": true,
"ItemCompanyId": "1",
"EmployeeCompanyId": "1",
"State": "Open",
"Hours": "1",
"IsRateCustom": true,
"Rate": "1",
"IsCostRateCustom": true,
"CostRate": "1",
"ExpenseQuantity": "1",
"IsExpenseRateCustom": true,
"ExpenseRate": "1",
"Notes": "sample 10",
"StartDate": "2026-01-02T07:52:27.8588955+00:00",
"EndDate": "2026-01-02T07:52:27.8588955+00:00",
"AllowPlanning": true,
"UseSelectedAgreements": true,
"SelectedInvoicingAgreementIds": [
"1",
"2"
],
"ParentBudgetId": "1",
"ChildBudgetIds": [
"1",
"2"
],
"LinkChildrenToSameAgreementsAsParent": true
}
application/xml, text/xml
<Budget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models">
<AllowPlanning>true</AllowPlanning>
<BudgetId>1</BudgetId>
<ChildBudgetIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</ChildBudgetIds>
<CostRate>1</CostRate>
<Description>sample 5</Description>
<EmployeeCompanyId>1</EmployeeCompanyId>
<EndDate>2026-01-02T07:52:27.8588955+00:00</EndDate>
<ExpenseQuantity>1</ExpenseQuantity>
<ExpenseRate>1</ExpenseRate>
<Hours>1</Hours>
<IsCostRateCustom>true</IsCostRateCustom>
<IsExpenseRateCustom>true</IsExpenseRateCustom>
<IsLeaf>true</IsLeaf>
<IsRateCustom>true</IsRateCustom>
<ItemCompanyId>1</ItemCompanyId>
<LinkChildrenToSameAgreementsAsParent>true</LinkChildrenToSameAgreementsAsParent>
<Name>sample 4</Name>
<Notes>sample 10</Notes>
<ParentBudgetId>1</ParentBudgetId>
<ProjectId>2</ProjectId>
<ProjectName>sample 3</ProjectName>
<Rate>1</Rate>
<SelectedInvoicingAgreementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</SelectedInvoicingAgreementIds>
<StartDate>2026-01-02T07:52:27.8588955+00:00</StartDate>
<State>Open</State>
<UseSelectedAgreements>true</UseSelectedAgreements>
</Budget>