Page Comparison

Tip
Available from CRM.COM R14.14.0

Excerpt
This method uses multiple vouchers (printed or electronic). Either all vouchers will be successfully used, or none.

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier
(mandatory)

Accounts receivable identifier

The identifier of the account receivable that the payments should be allocated in. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

secret_numbers_set

(mandatory)

Voucher Secret Number Object

Information related to the vouchers that will be used such as voucher's secret number and payment category. At least one voucher information is mandatory

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

...

Examples

Expand

title	Example 1

Expand

title	Example 1

HTTP Method: POST

Request:

Body

Code Block

language	js
theme	Confluence
linenumbers	true

{
    "token": "{{token}}",
    "secret_numbers_set": [
        {
            "secret_number": "478998235307",
            "notes":"test1"
        },
        {
            "secret_number": "176404672883",
            "notes":"test2"
        },
        {
            "secret_number": "348597852067",
            "notes":"test3"
        }
    ],
    "accounts_receivable_identifier": {
        "number": "ACR0000001698"
    }
}

Response:

Code Block

language	js
theme	Confluence
linenumbers	true

{
    "data": [
        {
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "AU",
                    "group_name": "EKO  Group",
                    "community_name": "Internal Community",
                    "name": "Admin Unit",
                    "description": "Admin Unit",
                    "id": "30DCAB2BEE60E08D3466CF23CA406201"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2014-10-30T18:45:24",
                "updated_date": "2019-08-26T16:43:55",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": null,
            "extra_added_value": 0,
            "expiration_date": "2030-11-14T00:00:00",
            "udf_date_2": null,
            "type": {
                "alternative_code": "BV",
                "value_options": "FIXED",
                "name": "Basic Voucher",
                "description": "Basic Voucher",
                "id": "69BEF054387FA38D08DFA49539CA7E69",
                "classification": "PRINTED_PAYMENT_VOUCHER"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "products_set": [],
            "udf_date_3": null,
            "lot": {
                "number": "1",
                "alternative_code": "00001",
                "description": "Basic voucher 1,500 ",
                "id": "43554E7E2510290931C01CBEE8BBAFA4"
            },
            "number": "27",
            "udf_float_3": null,
            "udf_float_4": null,
            "effective_date": "2014-11-01T00:00:00",
            "payment": {
                "posted_on": "2019-08-26T16:43:55",
                "number": "1375",
                "payment_amount": 1500,
                "issued_on": "2019-08-26T16:43:55",
                "currency_rate_period": {
                    "from_date": "2018-08-07 00:00:00.0",
                    "to_date": null,
                    "rate": 5,
                    "inverse_rate": 0.2,
                    "currency": {
                        "suffix_symbol": "N/A",
                        "prefix_symbol": "€",
                        "decimal_part_name": "cents",
                        "code": "EUR",
                        "integer_part_name": "euro",
                        "id": "2",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "id": "71996F27996C44DC9E2FD4C2F05AE563"
                },
                "id": "5C0BAB59898140F8B80AAF3EF440D592",
                "life_cycle_state": "POSTED",
                "reference_number": "7561"
            },
            "currency": {
                "suffix_symbol": "N/A",
                "prefix_symbol": "€",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "id": "0291BB649702C20DE6EE44AD3B0C11C7",
            "udf_float_1": null,
            "value": 1500,
            "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": "USED",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        {
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "AU",
                    "group_name": "EKO  Group",
                    "community_name": "Internal Community",
                    "name": "Admin Unit",
                    "description": "Admin Unit",
                    "id": "30DCAB2BEE60E08D3466CF23CA406201"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2014-10-30T18:45:22",
                "updated_date": "2019-08-26T16:43:56",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": null,
            "extra_added_value": 0,
            "expiration_date": "2030-11-14T00:00:00",
            "udf_date_2": null,
            "type": {
                "alternative_code": "BV",
                "value_options": "FIXED",
                "name": "Basic Voucher",
                "description": "Basic Voucher",
                "id": "69BEF054387FA38D08DFA49539CA7E69",
                "classification": "PRINTED_PAYMENT_VOUCHER"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "products_set": [],
            "udf_date_3": null,
            "lot": {
                "number": "1",
                "alternative_code": "00001",
                "description": "Basic voucher 1,500 ",
                "id": "43554E7E2510290931C01CBEE8BBAFA4"
            },
            "number": "3",
            "udf_float_3": null,
            "udf_float_4": null,
            "effective_date": "2014-11-01T00:00:00",
            "payment": {
                "posted_on": "2019-08-26T16:43:56",
                "number": "1376",
                "payment_amount": 1500,
                "issued_on": "2019-08-26T16:43:56",
                "currency_rate_period": {
                    "from_date": "2018-08-07 00:00:00.0",
                    "to_date": null,
                    "rate": 5,
                    "inverse_rate": 0.2,
                    "currency": {
                        "suffix_symbol": "N/A",
                        "prefix_symbol": "€",
                        "decimal_part_name": "cents",
                        "code": "EUR",
                        "integer_part_name": "euro",
                        "id": "2",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "id": "71996F27996C44DC9E2FD4C2F05AE563"
                },
                "id": "9D8E27AFE8C54F87B7936B62327948D0",
                "life_cycle_state": "POSTED",
                "reference_number": "7562"
            },
            "currency": {
                "suffix_symbol": "N/A",
                "prefix_symbol": "€",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "id": "BD9596280FE954B59F2C3A574B80EB5D",
            "udf_float_1": null,
            "value": 1500,
            "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": "USED",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        {
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "AU",
                    "group_name": "EKO  Group",
                    "community_name": "Internal Community",
                    "name": "Admin Unit",
                    "description": "Admin Unit",
                    "id": "30DCAB2BEE60E08D3466CF23CA406201"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2014-10-30T18:45:24",
                "updated_date": "2019-08-26T16:43:56",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "test@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "description": null,
            "extra_added_value": 0,
            "expiration_date": "2030-11-14T00:00:00",
            "udf_date_2": null,
            "type": {
                "alternative_code": "BV",
                "value_options": "FIXED",
                "name": "Basic Voucher",
                "description": "Basic Voucher",
                "id": "69BEF054387FA38D08DFA49539CA7E69",
                "classification": "PRINTED_PAYMENT_VOUCHER"
            },
            "udf_date_1": null,
            "udf_date_4": null,
            "products_set": [],
            "udf_date_3": null,
            "lot": {
                "number": "1",
                "alternative_code": "00001",
                "description": "Basic voucher 1,500 ",
                "id": "43554E7E2510290931C01CBEE8BBAFA4"
            },
            "number": "30",
            "udf_float_3": null,
            "udf_float_4": null,
            "effective_date": "2014-11-01T00:00:00",
            "payment": {
                "posted_on": "2019-08-26T16:43:56",
                "number": "1377",
                "payment_amount": 1500,
                "issued_on": "2019-08-26T16:43:56",
                "currency_rate_period": {
                    "from_date": "2018-08-07 00:00:00.0",
                    "to_date": null,
                    "rate": 5,
                    "inverse_rate": 0.2,
                    "currency": {
                        "suffix_symbol": "N/A",
                        "prefix_symbol": "€",
                        "decimal_part_name": "cents",
                        "code": "EUR",
                        "integer_part_name": "euro",
                        "id": "2",
                        "life_cycle_state": "EFFECTIVE"
                    },
                    "id": "71996F27996C44DC9E2FD4C2F05AE563"
                },
                "id": "24ED62E448F6466EB9310B5E32BAE9C1",
                "life_cycle_state": "POSTED",
                "reference_number": "7563"
            },
            "currency": {
                "suffix_symbol": "N/A",
                "prefix_symbol": "€",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "id": "9B839233DF9C49238410FCB4EABE65D0",
            "udf_float_1": null,
            "value": 1500,
            "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": "USED",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 1

New Version 2

Key

Examples