Versions Compared

Key

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

Available from CRM.COM R14.0.0

Excerpt

This method returns the Activated vouchers (used or not) Vouchers that were assigned to the specified Accounts Receivable. Multiple vouchers are retrieved by this call.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier  

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

eligible_for_use

(optional)

Boolean

Determines if the retrieved results will be consisted by Activated vouchers that belong to that Account Receivable account and are available to be used or not

The following options are available

  • True - Will return only Activated Vouchers that are ready eligible to be used (not expired) and belong to that Account Receivable account
  • False - Will return only the vouchers that vouchers which are not eligible for use (i.e.  they were used, or expired or cancelled) and are assigned against the specified Account Receivable account
  • Not Specified - Will return all above vouchers that belong to the specified Accounts Receivable

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

NumberDefines 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

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

...