ROSE Developers - Web API Reference

Materials Management | Stock Accounts

The materials account determinations endpoint is used to store the account types and his determination the a select chart of account.

Overview


URL api/{tenantKey}/{orgKey}/materialsCore/materialsAcctDeterminations
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET MaterialsAcctDeterminations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /materialsCore/materialsAcctDeterminations

GET MaterialsAcctDeterminations (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 MaterialsAcctDeterminationResource.

Response status codes:

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

Resource URL:

GET /materialsCore/materialsAcctDeterminations?page={page}&pageSize={pageSize}

GET MaterialsAcctDetermination 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 MaterialsAcctDeterminationResource.

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 /materialsCore/materialsAcctDeterminations/{id}

GET MaterialsAcctDetermination by key

Returns the entity record that matches the specified key.

The following elements are required:

chartOfAccount (string) The chart of accounts.

Response:

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

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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}

GET Print MaterialsAcctDetermination 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 /materialsCore/materialsAcctDeterminations/{id}/print?template={template}

GET Print MaterialsAcctDetermination by key

Prints the specified entity record.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}/print

GET Original Print MaterialsAcctDeterminationOriginal 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 /materialsCore/materialsAcctDeterminations/{id}/printOriginal?template={template}

GET Original Print MaterialsAcctDetermination by key

Prints the specified entity record.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}/printOriginal

POST Operations

POST MaterialsAcctDeterminations

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /materialsCore/materialsAcctDeterminations

POST Stock Accounts

Inserts a new 'Materials Acct Determination Line' in the 'Stock Accounts'.

The following elements are required:

chartOfAccount (string) The chart of accounts.
value (ApiMaterialsAcctDeterminationAccountsLinesResource) The ApiMaterialsAcctDeterminationAccountsLinesResource instance.
See ApiMaterialsAcctDeterminationAccountsLinesResource.

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:

POST /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines

POST Stock Accounts

Inserts a new 'Purchases GL Account' in the 'Stock Accounts'.

The following elements are required:

chartOfAccount (string) The chart of accounts.
value (ApiMaterialsAcctDeterminationPurchasesAccountsResource) The ApiMaterialsAcctDeterminationPurchasesAccountsResource instance.
See ApiMaterialsAcctDeterminationPurchasesAccountsResource.

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:

POST /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts

PUT Operations

PUT Set ChartOfAccount PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/chartOfAccount

PUT Set COGSAccount MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/cOGSAccount

PUT Set GRIRAccountCredit MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/gRIRAccountCredit

PUT Set GRIRAccountDebit MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/gRIRAccountDebit

PUT Set InTransitAccount MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/inTransitAccount

PUT Set IsActive MaterialsAcctDetermination

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}/isActive

PUT Set ItemTaxSchema PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/itemTaxSchema

PUT Set PartyTaxSchema PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/partyTaxSchema

PUT Set PriceDifAccount MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/priceDifAccount

PUT Set PurchaseItemAccountType PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/purchaseItemAccountType

PUT Set PurchasesAccount PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/purchasesAccount

PUT Set PurchasesOffsetAccount PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/purchasesOffsetAccount

PUT Set PurchasesReturnsAccount PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/purchasesReturnsAccount

PUT Set PurchasesReturnsOffsetAccount PurchasesGLAccount

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}/purchasesReturnsOffsetAccount

PUT Set StockAccount MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/stockAccount

PUT Set Custom Attribute MaterialsAcctDeterminationLine

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

The following elements are required:

chartOfAccount (string) The chart of accounts.
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:

PUT /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Materials Acct Determination Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

chartOfAccount (string) The chart of accounts.
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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}/accountsLines/{lineId}

DELETE Purchases GL Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

chartOfAccount (string) The chart of accounts.
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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}/purchasesAccounts/{lineId}

DELETE MaterialsAcctDetermination 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 /materialsCore/materialsAcctDeterminations/{id}

DELETE MaterialsAcctDetermination by key

Deletes the entity record that matches the specified key.

The following elements are required:

chartOfAccount (string) The chart of accounts.

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 /materialsCore/materialsAcctDeterminations/{chartOfAccount}

Resources


ApiMaterialsAcctDeterminationAccountsLinesResource

The following elements are required:

itemAccountType (string) The item account type.
stockAccount (string) The stock GL account for the chart of accounts.
cOGSAccount (string) The cost of goods sold GL account for the chart of accounts.
priceDifAccount (string) The price differences GL account for the chart of accounts.

The following elements are optional:

inTransitAccount (string) In Transit GL account.
gRIRAccountDebit (string) GRIR GL account debit.
gRIRAccountCredit (string) GRIR GL account credit.


ApiMaterialsAcctDeterminationPurchasesAccountsResource

The following elements are required:

purchaseItemAccountType (string) The item account type.
purchasesAccount (string) Purchase account.
chartOfAccount (string) The chart of account of the list.

The following elements are optional:

itemTaxSchema (string) The item tax schema.
partyTaxSchema (string) The party tax schema.
purchasesOffsetAccount (string) Purchase offset account.
purchasesReturnsAccount (string) Purchase returns account.
purchasesReturnsOffsetAccount (string) Purchase returns offset account.


ApiMaterialsAcctDeterminationResource

The following elements are required:

chartOfAccount (string) The chart of accounts.

The following elements are optional:

accountsLines (List of ApiMaterialsAcctDeterminationAccountsLinesResource) The account determinations lines.
See ApiMaterialsAcctDeterminationAccountsLinesResource.
purchasesAccounts (List of ApiMaterialsAcctDeterminationPurchasesAccountsResource) The list of purchase accounts.
See ApiMaterialsAcctDeterminationPurchasesAccountsResource.


MaterialsAcctDeterminationLineResource

The following elements are required:

itemAccountType (string) The item account type.
chartOfAccount (string) The chart of accounts.
stockAccount (string) The stock GL account for the chart of accounts.
cOGSAccount (string) The cost of goods sold GL account for the chart of accounts.
priceDifAccount (string) The price differences GL account for the chart of accounts.

The following elements are optional:

inTransitAccount (string) In Transit GL account.
gRIRAccountDebit (string) GRIR GL account debit.
gRIRAccountCredit (string) GRIR GL account credit.


MaterialsAcctDeterminationResource

The following elements are required:

chartOfAccount (string) The chart of accounts.
(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:

accountsLines (List of MaterialsAcctDeterminationLineResource) The account determinations lines.
See MaterialsAcctDeterminationLineResource.
purchasesAccounts (List of PurchasesGLAccountResource) The list of purchase accounts.
See PurchasesGLAccountResource.


PurchasesGLAccountResource

The following elements are required:

purchaseItemAccountType (string) The item account type.
purchasesAccount (string) Purchase account.
chartOfAccount (string) The chart of account of the list.

The following elements are optional:

itemTaxSchema (string) The item tax schema.
partyTaxSchema (string) The party tax schema.
purchasesOffsetAccount (string) Purchase offset account.
purchasesReturnsAccount (string) Purchase returns account.
purchasesReturnsOffsetAccount (string) Purchase returns offset account.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.