Versions Compared

Key

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

Available from CRM.COM R4.0.0

Excerpt

This method returns information related with vouchers. Multiple vouchers are returned by each call.

...

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

...