Versions Compared

Key

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

Available from CRM.COM R4.0.0

 

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

voucher_identifier

(mandatory)

Voucher identifier

The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:

Include Page
V4:voucher_identifier
V4:voucher_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Voucher type identifier

The identifier of the voucher type related with the vouchers that should be returned as a result. The allowed voucher type identifier fields are the following:

Include Page
V4:voucher_type_identifier
V4:voucher_type_identifier

lot_identifier
(semi-optional)
Lot identifier

The identifier of the lot related with the vouchers that should be returned as a result. The allowed lot identifier fields are the following:

Include Page
V4:lot_identifier
V4:lot_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

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

...

This method returns a voucher's secret number. The secret number of a single voucher is returned by each call

Tip

Available from CRM.COM R5.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

voucher_identifier

(mandatory)

Voucher identifier

The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:

Include Page
V4:voucher_identifier
V4:voucher_identifier

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

...

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

Tip

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 "Payment Voucher", then a payment will be created in the system
  • If the voucher of a type with classification of "Refund Voucher", then no payment will be created

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

secret_number

(mandatory)

String

The secret number of the voucher that will be used

accounts_receivable_identifier
(mandatory)

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

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.

...

This method returns a random accepted for activation voucher, which is can be selected by the user that is requesting the voucher, and sets the voucher life cycle state to activated. A single voucher is retrieved by each call

Tip

Available from CRM.COM R5.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Voucher type identifier

The identifier of the voucher type related with the voucher that should be returned as a result. The allowed job type identifier fields are the following:

Include Page
V4:voucher_type_identifier
V4:voucher_type_identifier

lot_identifier
(semi-optional)
Lot identifier

The identifier of the lot related with the vouchers that should be returned as a result. The allowed lot identifier fields are the following:

Include Page
V4:lot_identifier
V4:lot_identifier

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that the voucher will be submitted to. The group owning the accounts receivable is filtered against the available vouchers' allowed organisational units. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

group_identifier

(optional)

Group Identifier

The identifier of the group that will be using the voucher. The group is filtered against the available vouchers' allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be using the voucher. The unit is filtered against the available vouchers' allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

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

...

POST vouchers/retrieve_based_on_secret_number

Tip

Available from CRM.COM R11.0.0

This method returns information related with a voucher by specifying the voucher secret number.  A single voucher is returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

secret_number

(mandatory)

String

The secret number of the voucher that should be returned as a result.

 

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

...