Accounting | Budget

The Budget end point is used to create a spending plan to a company for a specific fiscal year. It allows the budgeted amount to be distributed monthly for a given account and set of dimensions.

Overview

URL	api/{tenantKey}/{orgKey}/accounting/budgets
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Budgets
  • GET Budgets (paged)
  • GET Budget by identifier
  • GET Budget by key
  • GET Print Budget by identifier
  • GET Print Budget by key
  • GET Original Print BudgetOriginal by identifier
  • GET Original Print Budget by key
• POST:
  • POST Budgets
  • POST Budget
• PUT:
  • PUT Set Custom Attribute Budget
  • PUT Set Custom Attribute BudgetLine
  • PUT Set IsActive Budget
  • PUT Set BudgetStatus Budget
  • PUT Set Remarks Budget
  • PUT Set Note Budget
  • PUT Set ExchangeRate Budget
  • PUT Set ExchangeRateDate Budget
  • PUT Set Description Budget
  • PUT Set GLAccount BudgetLine
  • PUT Set DimensionSet BudgetLine
  • PUT Set BudgetAmount BudgetLine
  • PUT Set BudgetAmountPer01 BudgetLine
  • PUT Set BudgetAmountPer02 BudgetLine
  • PUT Set BudgetAmountPer03 BudgetLine
  • PUT Set BudgetAmountPer04 BudgetLine
  • PUT Set BudgetAmountPer05 BudgetLine
  • PUT Set BudgetAmountPer06 BudgetLine
  • PUT Set BudgetAmountPer07 BudgetLine
  • PUT Set BudgetAmountPer08 BudgetLine
  • PUT Set BudgetAmountPer09 BudgetLine
  • PUT Set BudgetAmountPer10 BudgetLine
  • PUT Set BudgetAmountPer11 BudgetLine
  • PUT Set BudgetAmountPer12 BudgetLine
  • PUT Set ChartOfAccount BudgetLine
  • PUT Set Currency BudgetLine
  • PUT Set AccountingNature BudgetLine
  • PUT Set DimensionSetJson BudgetLine
• DELETE:
  • DELETE Budget Line by identifier
  • DELETE Budget by identifier
  • DELETE Budget by key

All Resources

This service uses the following resources:

• ApiBudgetBudgetLinesResource
• ApiBudgetResource
• BudgetLineResource
• BudgetResource
• MoneyResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AccountingNature
• DocumentStatus

GET Operations

GET Budgets

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See BudgetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Budgets (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BudgetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Budget by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See BudgetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Budget by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.

Response:

When successful, the response body contains the entity record. See BudgetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Print Budget by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print Budget by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Original Print BudgetOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print Budget by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST Budgets

Creates a new entity record.

The following elements are required:

budgetResource

(ApiBudgetResource) The request body should contain the entity record that should be created. See ApiBudgetResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBudgetResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Budget

Inserts a new 'Budget Line' in the 'Budget'.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(ApiBudgetBudgetLinesResource) The ApiBudgetBudgetLinesResource instance. See ApiBudgetBudgetLinesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set AccountingNature BudgetLine

Updates the value of attribute 'AccountingNature' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum AccountingNature) The request body should contain the new value for the attribute. See AccountingNature.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmount BudgetLine

Updates the value of attribute 'BudgetAmount' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer01 BudgetLine

Updates the value of attribute 'BudgetAmountPer01' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer02 BudgetLine

Updates the value of attribute 'BudgetAmountPer02' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer03 BudgetLine

Updates the value of attribute 'BudgetAmountPer03' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer04 BudgetLine

Updates the value of attribute 'BudgetAmountPer04' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer05 BudgetLine

Updates the value of attribute 'BudgetAmountPer05' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer06 BudgetLine

Updates the value of attribute 'BudgetAmountPer06' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer07 BudgetLine

Updates the value of attribute 'BudgetAmountPer07' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer08 BudgetLine

Updates the value of attribute 'BudgetAmountPer08' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer09 BudgetLine

Updates the value of attribute 'BudgetAmountPer09' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer10 BudgetLine

Updates the value of attribute 'BudgetAmountPer10' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer11 BudgetLine

Updates the value of attribute 'BudgetAmountPer11' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetAmountPer12 BudgetLine

Updates the value of attribute 'BudgetAmountPer12' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BudgetStatus Budget

Updates the value of attribute 'BudgetStatus' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(enum DocumentStatus) The request body should contain the new value for the attribute. See DocumentStatus.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ChartOfAccount BudgetLine

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Currency BudgetLine

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Description Budget

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSet BudgetLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSetJson BudgetLine

Updates the value of attribute 'DimensionSetJson' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ExchangeRate Budget

Updates the value of attribute 'ExchangeRate' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ExchangeRateDate Budget

Updates the value of attribute 'ExchangeRateDate' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set GLAccount BudgetLine

Updates the value of attribute 'GLAccount' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive Budget

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Note Budget

Updates the value of attribute 'Note' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Remarks Budget

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Custom Attribute Budget

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Custom Attribute BudgetLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE Budget Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Budget by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Budget by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiBudgetBudgetLinesResource

The following elements are required:

gLAccount	(string) The GL account that is going to be budgeted. Only GL accounts from the budget group are allowed.
budgetAmount	(MoneyResource) The budget amount that the combination GL account and dimension allows. See MoneyResource .
budgetAmountPer01	(MoneyResource) The budget amount for period 1. See MoneyResource .
budgetAmountPer02	(MoneyResource) The budget amount for period 2. See MoneyResource .
budgetAmountPer03	(MoneyResource) The budget amount for period 3. See MoneyResource .
budgetAmountPer04	(MoneyResource) The budget amount for period 4. See MoneyResource .
budgetAmountPer05	(MoneyResource) The budget amount for period 5. See MoneyResource .
budgetAmountPer06	(MoneyResource) The budget amount for period 6. See MoneyResource .
budgetAmountPer07	(MoneyResource) The budget amount for period 7. See MoneyResource .
budgetAmountPer08	(MoneyResource) The budget amount for period 8. See MoneyResource .
budgetAmountPer09	(MoneyResource) The budget amount for period 9. See MoneyResource .
budgetAmountPer10	(MoneyResource) The budget amount for period 10. See MoneyResource .
budgetAmountPer11	(MoneyResource) The budget amount for period 11. See MoneyResource .
budgetAmountPer12	(MoneyResource) The budget amount for period 12. See MoneyResource .
chartOfAccount	(string) The chart of accounts of the company (Internal).
currency	(string) The base currency of the company (Internal).
accountingNature	(enum AccountingNature) The accounting nature of the budget lines (Internal). See AccountingNature.

The following elements are optional:

dimensionSet	(string) The dimension set that is going to be budgetd. The user can only select dimensions from the budget group, leave the others unassigned (0...).
dimensionSetJson	(string) The json representation of the dimension set (Internal).

ApiBudgetResource

The following elements are required:

company	(string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods.
ledger	(string) The budget ledger. Only budget ledgers can be selected.
budgetStatus	(enum DocumentStatus) The budget status.It can have the status in progress or completed. See DocumentStatus.
exchangeRate	(decimal) Internal. Always 1.

The following elements are optional:

budgetLines	(List of ApiBudgetBudgetLinesResource) The budget lines. The number of line are limited with the combination of gl accounts and dimensions. See ApiBudgetBudgetLinesResource.
remarks	(string) A remark for the budget.
note	(string) A reference for the budget.
exchangeRateDate	(DateTime) Internal. Always today.
description	(string) The budget description.

BudgetLineResource

The following elements are required:

gLAccount	(string) The GL account that is going to be budgeted. Only GL accounts from the budget group are allowed.
budgetAmount	(MoneyResource) The budget amount that the combination GL account and dimension allows. See MoneyResource .
distributedAmount	(MoneyResource) The partial amount from the budget amount that is assigned to each one of the 12 periods. Automatically calculated. See MoneyResource .
budgetAmountPer01	(MoneyResource) The budget amount for period 1. See MoneyResource .
budgetAmountPer02	(MoneyResource) The budget amount for period 2. See MoneyResource .
budgetAmountPer03	(MoneyResource) The budget amount for period 3. See MoneyResource .
budgetAmountPer04	(MoneyResource) The budget amount for period 4. See MoneyResource .
budgetAmountPer05	(MoneyResource) The budget amount for period 5. See MoneyResource .
budgetAmountPer06	(MoneyResource) The budget amount for period 6. See MoneyResource .
budgetAmountPer07	(MoneyResource) The budget amount for period 7. See MoneyResource .
budgetAmountPer08	(MoneyResource) The budget amount for period 8. See MoneyResource .
budgetAmountPer09	(MoneyResource) The budget amount for period 9. See MoneyResource .
budgetAmountPer10	(MoneyResource) The budget amount for period 10. See MoneyResource .
budgetAmountPer11	(MoneyResource) The budget amount for period 11. See MoneyResource .
budgetAmountPer12	(MoneyResource) The budget amount for period 12. See MoneyResource .
chartOfAccount	(string) The chart of accounts of the company (Internal).
currency	(string) The base currency of the company (Internal).
accountingNature	(enum AccountingNature) The accounting nature of the budget lines (Internal). See AccountingNature.

The following elements are optional:

dimensionSet	(string) The dimension set that is going to be budgetd. The user can only select dimensions from the budget group, leave the others unassigned (0...).
dimensionSetJson	(string) The json representation of the dimension set (Internal).

BudgetResource

The following elements are required:

company	(string) The company code is the central organizational unit of the system. This is to whose transactions will be posted . You must define at least one company before create the journal entry transaction, but if you have only one company the system will select then automatically. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
budgetGroup	(string) The budget group is used to reference a budget area (ex.: supplies and services). You can only associate budget group from the same chart of accounts as the company. (fk) Allowed value: the natural key of a record of type BudgetGroup. These records are accessibly through the BudgetGroups service.
financialYear	(string) A time period, usually 12 months for which a company is required to provide the balance sheet. But in under certain circumstances, a fiscal year can have more than 12 months, for example opening our close periods. (fk) Allowed value: the natural key of a record of type FinancialYear. These records are accessibly through the FinancialYears service.
ledger	(string) The budget ledger. Only budget ledgers can be selected. (fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
currency	(string) The budget currency. Read only, the base currency is always used. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
budgetStatus	(enum DocumentStatus) The budget status.It can have the status in progress or completed. See DocumentStatus.
totalBudget	(MoneyResource) The total amount of the budget. See MoneyResource .
exchangeRate	(decimal) Internal. Always 1.

The following elements are optional:

budgetLines	(List of BudgetLineResource) The budget lines. The number of line are limited with the combination of gl accounts and dimensions. See BudgetLineResource.
remarks	(string) A remark for the budget.
note	(string) A reference for the budget.
exchangeRateDate	(DateTime) Internal. Always today.
description	(string) The budget description.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingNature

1	Debit
2	Credit

DocumentStatus

1	Open
2	Completed
3	Processing