Financials | Budget Group

The Budget Group represents a configuration about a budget area like supplies and services or sales.

Overview

api/{tenantKey}/{orgKey}/financialCore/budgetGroups

URL	api/{tenantKey}/{orgKey}/financialCore/budgetGroups
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiBudgetGroupBudgetAccountsResource
ApiBudgetGroupBudgetDimensionsResource
ApiBudgetGroupResource
BudgetAccountResource
BudgetDimensionResource
BudgetGroupResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AccountingNature

GET Operations

GET BudgetGroups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups

GET /financialCore/budgetGroups

GET BudgetGroups (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 BudgetGroupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups?page={page}&pageSize={pageSize}

GET /financialCore/budgetGroups?page={page}&pageSize={pageSize}

GET BudgetGroup 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 BudgetGroupResource.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{id}

GET /financialCore/budgetGroups/{id}

GET BudgetGroup by key

Returns the entity record that matches the specified key.

The following elements are required:

budgetGroupKey

(string) The budget group key.

Response:

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

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}

GET /financialCore/budgetGroups/{budgetGroupKey}

GET Print BudgetGroup 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{id}/print?template={template}

GET /financialCore/budgetGroups/{id}/print?template={template}

GET Print BudgetGroup by key

Prints the specified entity record.

The following elements are required:

budgetGroupKey

(string) The budget group key.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/print

GET /financialCore/budgetGroups/{budgetGroupKey}/print

GET Original Print BudgetGroupOriginal 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{id}/printOriginal?template={template}

GET /financialCore/budgetGroups/{id}/printOriginal?template={template}

GET Original Print BudgetGroup by key

Prints the specified entity record.

The following elements are required:

budgetGroupKey

(string) The budget group key.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/printOriginal

GET /financialCore/budgetGroups/{budgetGroupKey}/printOriginal

POST Operations

POST BudgetGroups

Creates a new entity record.

The following elements are required:

budgetGroupResource

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

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 ApiBudgetGroupResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups

POST /financialCore/budgetGroups

POST Budget Group

Inserts a new 'Budget Account' in the 'Budget Group'.

The following elements are required:

budgetGroupKey	(string) The budget group key.
value	(ApiBudgetGroupBudgetAccountsResource) The ApiBudgetGroupBudgetAccountsResource instance. See ApiBudgetGroupBudgetAccountsResource.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts

POST /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts

POST Budget Group

Inserts a new 'Budget Dimension' in the 'Budget Group'.

The following elements are required:

budgetGroupKey	(string) The budget group key.
value	(ApiBudgetGroupBudgetDimensionsResource) The ApiBudgetGroupBudgetDimensionsResource instance. See ApiBudgetGroupBudgetDimensionsResource.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions

POST /financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions

PUT Operations

PUT Set AccountingNature BudgetAccount

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/accountingNature

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/accountingNature

PUT Set BudgetGroupKey BudgetGroup

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

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetGroupKey

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetGroupKey

PUT Set ChartOfAccount BudgetAccount

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/chartOfAccount

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/chartOfAccount

PUT Set ChartOfAccount BudgetGroup

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

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/chartOfAccount

PUT /financialCore/budgetGroups/{budgetGroupKey}/chartOfAccount

PUT Set Description BudgetGroup

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

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/description

PUT /financialCore/budgetGroups/{budgetGroupKey}/description

PUT Set Dimension BudgetDimension

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions/{lineId}/dimension

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions/{lineId}/dimension

PUT Set GLAccount BudgetAccount

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/gLAccount

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/gLAccount

PUT Set IsActive BudgetGroup

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

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/isActive

PUT /financialCore/budgetGroups/{budgetGroupKey}/isActive

PUT Set Custom Attribute BudgetGroup

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/{customAttributeName}

PUT /financialCore/budgetGroups/{budgetGroupKey}/{customAttributeName}

PUT Set Custom Attribute BudgetAccount

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

The following elements are required:

budgetGroupKey	(string) The budget group key.
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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/{customAttributeName}

PUT /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}/{customAttributeName}

DELETE Operations

DELETE Budget Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}

DELETE /financialCore/budgetGroups/{budgetGroupKey}/budgetAccounts/{lineId}

DELETE Budget Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

budgetGroupKey	(string) The budget group 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions/{lineId}

DELETE /financialCore/budgetGroups/{budgetGroupKey}/budgetDimensions/{lineId}

DELETE BudgetGroup 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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{id}

DELETE /financialCore/budgetGroups/{id}

DELETE BudgetGroup by key

Deletes the entity record that matches the specified key.

The following elements are required:

budgetGroupKey

(string) The budget group key.

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:

api/{tenantKey}/{orgKey}/financialCore/budgetGroups/{budgetGroupKey}

DELETE /financialCore/budgetGroups/{budgetGroupKey}

Resources

ApiBudgetGroupBudgetAccountsResource

The following elements are required:

gLAccount	(string) The GL account to be budgeted.
chartOfAccount	(string) The chart of accounts.
accountingNature	(enum AccountingNature) The nature of the balance that is going to be budgeted. See AccountingNature.

ApiBudgetGroupBudgetDimensionsResource

The following elements are required:

dimension

(string) The dimension to be budgeted.

ApiBudgetGroupResource

The following elements are required:

budgetGroupKey	(string) The budget group key.
chartOfAccount	(string) The chart of accounts of the budget group.

The following elements are optional:

description	(string) The budget group description.
budgetAccounts	(List of ApiBudgetGroupBudgetAccountsResource) The list of accounts to be budgeted. See ApiBudgetGroupBudgetAccountsResource.
budgetDimensions	(List of ApiBudgetGroupBudgetDimensionsResource) The list of dimensions to be budgetd. See ApiBudgetGroupBudgetDimensionsResource.

BudgetAccountResource

The following elements are required:

gLAccount	(string) The GL account to be budgeted.
chartOfAccount	(string) The chart of accounts.
accountingNature	(enum AccountingNature) The nature of the balance that is going to be budgeted. See AccountingNature.

BudgetDimensionResource

The following elements are required:

dimension

(string) The dimension to be budgeted.

BudgetGroupResource

The following elements are required:

budgetGroupKey	(string) The budget group key.
chartOfAccount	(string) The chart of accounts of the budget group. (fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.

The following elements are optional:

description	(string) The budget group description.
budgetAccounts	(List of BudgetAccountResource) The list of accounts to be budgeted. See BudgetAccountResource.
budgetDimensions	(List of BudgetDimensionResource) The list of dimensions to be budgetd. See BudgetDimensionResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingNature

1	Debit
2	Credit