Page Comparison

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.

...

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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

applicableeligible_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 and belong to that Account Receivable account
False - Will return only the vouchers that were used 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)

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

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

...

Response Data

Include Page

	V4:accounts_receivable_vouchers_list_shortvoucher_complete
	V4:accounts_receivable_vouchers_list_shortvoucher_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "data": [
        {
            "allowed_organisational_units_set": [],
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2017-08-09T17:52:40",
                "updated_date": "2017-08-09T18:11:22",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": null,
            "expiration_date": "2017-10-09T17:52:40",
            "udf_date_2": null,
            "type": {
                "alternative_code": "RVT",
                "value_options": "VARIABLE",
                "name": "Refund Voucher Type",
                "description": null,
                "id": "895651D1732B47CE972A4AA9B9D9FFBC",
                "classification": "REFUND_VOUCHER"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "products_set": [],
            "udf_date_3": null,
            "number": "V00200912",
            "udf_float_3": null,
            "udf_float_4": null,
            "effective_date": "2017-08-09T17:52:40",
            "id": "A63A8BAFDD304E3B90868127655758E7",
            "udf_float_1": null,
            "value": 10,
            "udf_float_2": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_1": null,
            "life_cycle_state": "ACTIVATED",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "refund": {
                "posted_on": "2017-08-09T17:52:38",
                "number": "R00000238",
                "refund_amount": 10,
                "issued_on": "2017-08-09T17:52:18",
                "currency_rate_period": null,
                "id": "4168DEA1AC744C27A3D1CC216B0CD5EF",
                "life_cycle_state": "POSTED",
                "reference_number": "356"
            }
        },
        {
            "allowed_organisational_units_set": [],
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2017-08-10T15:27:43",
                "updated_date": "2017-08-10T15:27:43",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": null,
            "expiration_date": "2017-10-10T15:27:43",
            "udf_date_2": null,
            "type": {
                "alternative_code": "RVT",
                "value_options": "VARIABLE",
                "name": "Refund Voucher Type",
                "description": null,
                "id": "895651D1732B47CE972A4AA9B9D9FFBC",
                "classification": "REFUND_VOUCHER"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "products_set": [],
            "udf_date_3": null,
            "number": "V00200917",
            "udf_float_3": null,
            "udf_float_4": null,
            "effective_date": "2017-08-10T15:27:43",
            "id": "60A3DD48AD27403C8226856FF35FD4D3",
            "udf_float_1": null,
            "value": 10,
            "udf_float_2": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_1": null,
            "life_cycle_state": "ACTIVATED",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "refund": {
                "posted_on": "2017-08-10T15:27:41",
                "number": "R00000244",
                "refund_amount": 10,
                "issued_on": "2017-08-10T15:27:31",
                "currency_rate_period": null,
                "id": "4BDEF6E7B301472FA8B5DA5D1BCB9650",
                "life_cycle_state": "POSTED",
                "reference_number": "362"
            }
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Response Data

Examples