Versions Compared

Old Version 10

changes.mady.by.user p_demou

Saved on

compared with

New Version Current

changes.mady.by.user Antonis Papageorgiou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

From CRM.COM R13.1.0 and onwards the process of using a voucher is enhanced as follows:

  • If the voucher of a type with classification of "Payment Voucher" or "Electronic Voucher", then a payment will be created in the system

From CRM.COM R14.0.0 and onwards the process of using a voucher is enhanced as follows:

  • If the voucher of a type with classification of "Refund Voucher", then no payment will be created


Excerpt

This method uses a voucher. Single voucher is used by each call

Resource URL

http://host_name/crmapi/rest/$version/vouchers/use 

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

secret_number

(mandatory on conditions)

String

The secret number of the voucher that will be used

Tip

From CRM.COM R18.0.0, secret_number is not applicable for vouchers of type category "identifies customergift card"


accounts_receivable_identifier
(mandatory on conditions)

Accounts receivable identifier

The identifier of the account receivable that the payment should be allocated in. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

Tip

From CRM.COM R18.0.0, accounts_receivable_identifier is not applicable for vouchers of type category "identifies customergift card"


payment_category_identifier
(optional)		Payment category identifier

The identifier of the payment category related with the payment that will be created. The allowed payment category identifier fields are the following:

Include Page
V4:financial_transaction_category_identifier
V4:financial_transaction_category_identifier

Tip

From CRM.COM R14.0.0, if the payment_category_identifier is provided and the voucher is of type with classification "Refund Voucher", then the payment_category_identifier will be ignored


notes
(optional)

Notes Object

The notes for the payment to be created

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip

Available from CRM.COM R10.0.0


Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...