Skip to end of banner
Go to start of banner

GET accounts_receivable/vouchers/list

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Available from CRM.COM R14.0.0

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

Resource URL

Parameters

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

applicable_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 to be used and belong to that Account Receivable account
  • False - Will return only the vouchers that were used against the specified Account Receivable account
  • Not Specified - Will return all above vouchers

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

Restrictions

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

Response Data

Unable to render {include} The included page could not be found.

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 
  • No labels