Financials | Payment Method

Service to manage entities of type 'PaymentMethod'.

Overview

api/{tenantKey}/{orgKey}/financialCore/paymentMethods

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

All Operations

This service includes the following operations:

GET:
POST:
- POST PaymentMethods
- POST Payment Method
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiPaymentMethodPaymentMethodParametersResource
ApiPaymentMethodResource
PaymentMethodParameterResource
PaymentMethodResource

All Enumerations

This service uses the following enumerations:

PaymentMethodType

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods

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:

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

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:

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

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}

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:

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

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/print

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:

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

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/printOriginal

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.

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods

POST /financialCore/paymentMethods

POST Payment Method

Inserts a new 'Payment Method Parameter' in the 'Payment Method'.

The following elements are required:

paymentMethodsKey	(string) The payment method's key.
value	(ApiPaymentMethodPaymentMethodParametersResource) The ApiPaymentMethodPaymentMethodParametersResource instance. See ApiPaymentMethodPaymentMethodParametersResource.

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

POST /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodParameters

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/balanceManaged

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/description

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/details

PUT /financialCore/paymentMethods/{paymentMethodsKey}/details

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/fiscalClassification

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isActive

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInFinancialAccount

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInFinancialAccount

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isAllowedInPettyCash

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isAvailableInPurchases

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isAvailableInSales

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/isEft

PUT /financialCore/paymentMethods/{paymentMethodsKey}/isEft

PUT Set OnlinePaymentProvider PaymentMethod

Updates the value of attribute 'OnlinePaymentProvider' 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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/onlinePaymentProvider

PUT /financialCore/paymentMethods/{paymentMethodsKey}/onlinePaymentProvider

PUT Set Parameter PaymentMethodParameter

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

The following elements are required:

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

PUT /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodParameters/{lineId}/parameter

PUT Set PaymentGatewayParameter PaymentMethodParameter

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

The following elements are required:

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

PUT /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodParameters/{lineId}/paymentGatewayParameter

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodsKey

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodType

PUT /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodType

PUT Set PayPalClientid PaymentMethod

Updates the value of attribute 'PayPalClientid' 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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/payPalClientid

PUT /financialCore/paymentMethods/{paymentMethodsKey}/payPalClientid

PUT Set PayPalClientSecret PaymentMethod

Updates the value of attribute 'PayPalClientSecret' 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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/payPalClientSecret

PUT /financialCore/paymentMethods/{paymentMethodsKey}/payPalClientSecret

PUT Set PayPalMerchantid PaymentMethod

Updates the value of attribute 'PayPalMerchantid' 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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}/payPalMerchantid

PUT /financialCore/paymentMethods/{paymentMethodsKey}/payPalMerchantid

PUT Set Value PaymentMethodParameter

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

The following elements are required:

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

PUT /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodParameters/{lineId}/value

PUT Set ValueDateOffset PaymentMethod

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

The following elements are required:

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

PUT /financialCore/paymentMethods/{paymentMethodsKey}/valueDateOffset

DELETE Operations

DELETE Payment Method Parameter by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

DELETE /financialCore/paymentMethods/{paymentMethodsKey}/paymentMethodParameters/{lineId}

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:

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

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:

api/{tenantKey}/{orgKey}/financialCore/paymentMethods/{paymentMethodsKey}

DELETE /financialCore/paymentMethods/{paymentMethodsKey}

Resources

ApiPaymentMethodPaymentMethodParametersResource

The following elements are required:

parameter	(string) Parameter.
paymentGatewayParameter	(string) Payment Gateway Parameter.

The following elements are optional:

value

(string) Value.

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 operations.
balanceManaged	(bool) Indicates whether this payment method is balance managed or not.
valueDateOffset	(int) The number of days to offset this payment term.
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.
onlinePaymentProvider	(string) Online Payment Provider.
paymentMethodParameters	(List of ApiPaymentMethodPaymentMethodParametersResource) Payment Method Parameters. See ApiPaymentMethodPaymentMethodParametersResource.
payPalMerchantid	(string) The PayPal Merchant's identifier.
payPalClientid	(string) ThePayPal client's identifier.
payPalClientSecret	(string) The PayPal client's secret.

PaymentMethodParameterResource

The following elements are required:

parameter	(string) Parameter.
paymentGatewayParameter	(string) Payment Gateway Parameter.

The following elements are optional:

value

(string) Value.

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 operations.
isAvailableInOnLineStore	(bool) Available in Online Store.
balanceManaged	(bool) Indicates whether this payment method is balance managed or not.
valueDateOffset	(int) The number of days to offset this payment term.
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.
onlinePaymentProvider	(string) Online Payment Provider. (fk) Allowed value: the natural key of a record of type OnlinePaymentProvider.
paymentMethodParameters	(List of PaymentMethodParameterResource) Payment Method Parameters. See PaymentMethodParameterResource.
payPalMerchantid	(string) The PayPal Merchant's identifier.
payPalClientid	(string) ThePayPal client's identifier.
payPalClientSecret	(string) The PayPal client's secret.

Enumerations

PaymentMethodType

1	Cash
2	Check
4	Other
6	BankTransfer
7	DirectDebit
8	OnlinePayment