ROSE Developers - Web API Reference

Financials | Payment Method

A Payment Method represents the number of ways in which merchants can collect payments from their customers.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET PaymentMethods

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /financialCore/paymentMethods

GET PaymentMethods (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 PaymentMethodResource.

Response status codes:

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

Resource URL:

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

GET PaymentMethod 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 PaymentMethodResource.

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

GET PaymentMethod by key

Returns the entity record that matches the specified key.

The following elements are required:

paymentMethodsKey (string) The payment method's key.

Response:

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

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/paymentMethods/{paymentMethodsKey}

GET Print PaymentMethod 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/paymentMethods/{id}/print?template={template}

GET Print PaymentMethod by key

Prints the specified entity record.

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/print

GET Original Print PaymentMethodOriginal 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/paymentMethods/{id}/printOriginal?template={template}

GET Original Print PaymentMethod by key

Prints the specified entity record.

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/printOriginal

POST Operations

POST PaymentMethods

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /financialCore/paymentMethods

PUT Operations

PUT Set BalanceManaged PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/balanceManaged

PUT Set Description PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/description

PUT Set Details PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/details

PUT Set ElectronicTransferFileType PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's key.
value (enum ElectronicTransferFileType) The request body should contain the new value for the attribute.
See ElectronicTransferFileType.

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/paymentMethods/{paymentMethodsKey}/electronicTransferFileType

PUT Set ElectronicTransferPurpose PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's key.
value (enum ElectronicTransferPurpose) The request body should contain the new value for the attribute.
See ElectronicTransferPurpose.

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/paymentMethods/{paymentMethodsKey}/electronicTransferPurpose

PUT Set FiscalClassification PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/fiscalClassification

PUT Set IsActive PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/isActive

PUT Set IsAllowedInFinancialAccount PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInFinancialAccount

PUT Set IsAllowedInPaymentBatches PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInPaymentBatches

PUT Set IsAllowedInPettyCash PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInPettyCash

PUT Set IsAvailableInPurchases PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAvailableInPurchases

PUT Set IsAvailableInSales PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAvailableInSales

PUT Set IsEft PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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.

Resource URL:

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isEft

PUT Set PaymentMethodsKey PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/paymentMethodsKey

PUT Set PaymentMethodType PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's key.
value (enum PaymentMethodType) The request body should contain the new value for the attribute.
See PaymentMethodType.

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/paymentMethods/{paymentMethodsKey}/paymentMethodType

PUT Set Custom Attribute PaymentMethod

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

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}/{customAttributeName}

DELETE Operations

DELETE PaymentMethod 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/paymentMethods/{id}

DELETE PaymentMethod by key

Deletes the entity record that matches the specified key.

The following elements are required:

paymentMethodsKey (string) The payment method's 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/paymentMethods/{paymentMethodsKey}

Resources


ApiPaymentMethodResource

The following elements are required:

paymentMethodsKey (string) The payment method's key.
isAvailableInSales (bool) Determines if this payment method can be used in sales.
isAvailableInPurchases (bool) Determines if this payment method can be used in purchases.
isAllowedInPettyCash (bool) Determines if this payment method can be used in petty cash operations.
isAllowedInFinancialAccount (bool) Determines if this payment method can be used in bank accounts.
isAllowedInPaymentBatches (bool) Determines if this payment method can be used in payment batches.
balanceManaged (bool) Indicates whether this payment method is balance managed or not.
paymentMethodType (enum PaymentMethodType) The associated payment method type.
See PaymentMethodType.
isEft (bool) Indicates whether the payment method is an Electronic funds transfer.

The following elements are optional:

description (string) The payment method's description.
fiscalClassification (string) The associated fiscal classification.
details (string) The details.
electronicTransferFileType (enum ElectronicTransferFileType) Indicates the electronic transfer file type that will be generated in the payment batch.
See ElectronicTransferFileType.
electronicTransferPurpose (enum ElectronicTransferPurpose) Indicates the electronic transfer purpose to be included in the generated payment batch file.
See ElectronicTransferPurpose.


PaymentMethodResource

The following elements are required:

paymentMethodsKey (string) The payment method's key.
isAvailableInSales (bool) Determines if this payment method can be used in sales.
isAvailableInPurchases (bool) Determines if this payment method can be used in purchases.
isAllowedInPettyCash (bool) Determines if this payment method can be used in petty cash operations.
isAllowedInFinancialAccount (bool) Determines if this payment method can be used in bank accounts.
isAllowedInPaymentBatches (bool) Determines if this payment method can be used in payment batches.
balanceManaged (bool) Indicates whether this payment method is balance managed or not.
paymentMethodType (enum PaymentMethodType) The associated payment method type.
See PaymentMethodType.
isEft (bool) Indicates whether the payment method is an Electronic funds transfer.

The following elements are optional:

description (string) The payment method's description.
fiscalClassification (string) The associated fiscal classification.
(fk) Allowed value: the natural key of a record of type PaymentMethodFiscalClassification. These records are accessibly through the PaymentMethodFiscalClassifications service.
details (string) The details.
electronicTransferFileType (enum ElectronicTransferFileType) Indicates the electronic transfer file type that will be generated in the payment batch.
See ElectronicTransferFileType.
electronicTransferPurpose (enum ElectronicTransferPurpose) Indicates the electronic transfer purpose to be included in the generated payment batch file.
See ElectronicTransferPurpose.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


ElectronicTransferFileType

1 SEPA
2 SEPADD
3 CARRCGD
4 PS2BCP


ElectronicTransferPurpose

1 SALA
2 SUPP
3 OTHR


PaymentMethodType

1 Cash
2 Check
3 ElectronicTransfer
4 Other