ROSE Developers - Web API Reference

Financials | Payment Category Purpose

The Payment Category Purpose represents the purpose of the payment.

Overview


URL api/{tenantKey}/{orgKey}/financialCore/paymentCategoryPurposes
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 PaymentCategoryPurposes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/paymentCategoryPurposes

GET PaymentCategoryPurposes (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 PaymentCategoryPurposeResource.

Response status codes:

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

Resource URL:

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

GET PaymentCategoryPurpose 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 PaymentCategoryPurposeResource.

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 /financialCore/paymentCategoryPurposes/{id}

GET PaymentCategoryPurpose by key

Returns the entity record that matches the specified key.

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose key.

Response:

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

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 /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}

GET Print PaymentCategoryPurpose 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 /financialCore/paymentCategoryPurposes/{id}/print?template={template}

GET Print PaymentCategoryPurpose by key

Prints the specified entity record.

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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:

GET /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/print

GET Original Print PaymentCategoryPurposeOriginal 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 /financialCore/paymentCategoryPurposes/{id}/printOriginal?template={template}

GET Original Print PaymentCategoryPurpose by key

Prints the specified entity record.

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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:

GET /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/printOriginal

POST Operations

POST PaymentCategoryPurposes

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /financialCore/paymentCategoryPurposes

PUT Operations

PUT Set Description PaymentCategoryPurpose

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

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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 /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/description

PUT Set IsActive PaymentCategoryPurpose

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

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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 /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/isActive

PUT Set Name PaymentCategoryPurpose

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

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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 /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/name

PUT Set PaymentCategoryPurposeKey PaymentCategoryPurpose

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

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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 /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/paymentCategoryPurposeKey

PUT Set Custom Attribute PaymentCategoryPurpose

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

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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:

PUT /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}/{customAttributeName}

DELETE Operations

DELETE PaymentCategoryPurpose 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 /financialCore/paymentCategoryPurposes/{id}

DELETE PaymentCategoryPurpose by key

Deletes the entity record that matches the specified key.

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose 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:

DELETE /financialCore/paymentCategoryPurposes/{paymentCategoryPurposeKey}

Resources


ApiPaymentCategoryPurposeResource

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose key.

The following elements are optional:

name (string) The name of the category.
description (string) The description of the category.


PaymentCategoryPurposeResource

The following elements are required:

paymentCategoryPurposeKey (string) The payment category purpose key.

The following elements are optional:

name (string) The name of the category.
description (string) The description of the category.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.