ROSE Developers - Web API Reference

Taxes | Income Type

Service to manage entities of type 'IncomeType'.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/incomeTypes
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET IncomeTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/incomeTypes

GET IncomeTypes (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 IncomeTypeResource.

Response status codes:

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

Resource URL:

GET /taxesCore/incomeTypes?page={page}&pageSize={pageSize}

GET IncomeType 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 IncomeTypeResource.

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 /taxesCore/incomeTypes/{id}

GET IncomeType by key

Returns the entity record that matches the specified key.

The following elements are required:

incomeTypeKey (string) Income Type.

Response:

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

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 /taxesCore/incomeTypes/{incomeTypeKey}

Resources


IncomeTypeResource

The following elements are required:

incomeTypeKey (string) Income Type.

The following elements are optional:

description (string) Description.