Versions Compared

Old Version 1

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

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

Available from CRM.COM R13.1.0

Excerpt

This method adds a Presentment Preference Preferences to an Accounts Receivable. A single Multiple Accounts Receivable's Presentment Preference is Preferences can be added by each call. Only one Accounts Receivable is updated by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable whose presentment preferences will be updated. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

presentment_preferences_set 

 

 

 

 

 

(optional)

Set of Presentment Preferences Object            

The presentment preferences that will be added to the retrieved accounts receivable

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

Anchor
accounts_receivable_presentment_preferences_add referred objects parameters
accounts_receivable_presentment_preferences_add referred objects parameters
Referred Parameter Objects Data

Include Page
V4:accounts_receivable_presentment_preference_parameter
V4:accounts_receivable_presentment_preference_parameter

Restrictions

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

Response Data

Include Page
V4:accounts_receivable_complete
V4:accounts_receivable_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392"
    },
  "presentment_preferences_set":
    [
       {
           
           "presentment_preference_identifier":{"alternative_code":"E"},
           "state":"ACTIVE",
           "email":
           {
               "action":"EXISTING",
               "email":
            {
                    "type":"PERSONAL"
            }
           }
       },
        {
           
           "presentment_preference_identifier":{"alternative_code":"S"},
           "state":"ACTIVE",
           "phone":
           {
               "action":"EXISTINGUPDATED",
           "type":"MOBILE",
           "phone":{
                    "type":"FAX",
                    "number":"99047380"
            }
           }
       }
    ]
}

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "notes": null,
        "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-07-28T12:26:08",
            "updated_date": "2017-08-08T16:46:36",
            "updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "payment_preferences_set": [],
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": null,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Τζιηρτζιηπή",
            "id": "7B7A165FD2804DA59BFE70F353F79579",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "νΊΚοΥ",
            "title": null,
            "type": "PERSON",
            "first_name": "Κατερίνα",
            "demographics": {
                "name_day": {
                    "month": null,
                    "day": null
                },
                "id_number": null,
                "gender": null,
                "country_of_residence": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "billing_address": null,
        "primary_account": true,
        "type": "CUSTOMER",
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": "ACR0000001392",
        "udf_float_3": null,
        "udf_float_4": null,
        "balance": null,
        "credit_period_operator": "PLUS",
        "credit_period": 0,
        "currency": {
            "suffix_symbol": "N/A",
            "prefix_symbol": "€",
            "decimal_part_name": "cents",
            "code": "EUR",
            "integer_part_name": "euro",
            "id": "2"
        },
        "id": "76FBE26DE50D424987AC4CC69619A9C5",
        "opening_balance": 0,
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_string_2": null,
        "opening_balance_date": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": {
            "number": "14",
            "name": "PL Group A_Share_Low",
            "id": "9DCEFDA9D56145978C265085CD146810",
            "hierarchy_level": 1
        },
        "presentment_preferences_set": [
            {
                "presentment_method": {
                    "alternative_code": "E",
                    "name": "Email",
                    "description": null,
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": null,
                        "last_name": "may",
                        "id": "7F1D15F4735C4461A2E033FD960DDB10",
                        "life_cycle_state": "MARKETING",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "michael",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "gender": null,
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    },
                    "id": "67EC7B4252DA209B59733125FB248CED",
                    "state": "ACTIVE",
                    "type": "EMAIL"
                },
                "id": "CC45B0DFF43D40FF8ECEFB4FF3353364",
                "state": "ACTIVE",
                "email": {
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "notes": null,
                    "udf_string_5": null,
                    "udf_string_1": null,
                    "type": "PERSONAL",
                    "udf_date_2": null,
                    "udf_date_1": null,
                    "udf_date_4": null,
                    "udf_date_3": null,
                    "udf_float_3": null,
                    "udf_float_4": null,
                    "id": "2DEE492F1AC248D7A03B51853C3889F1",
                    "state": "Active",
                    "udf_string_6": null,
                    "udf_float_1": null,
                    "udf_string_7": null,
                    "udf_float_2": null,
                    "email": "e_tzirtzipi@crm.com",
                    "udf_string_8": null
                }
            },
            {
                "phone": {
                    "udf_string_2": null,
                    "country": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "notes": null,
                    "udf_string_5": null,
                    "area_code": "357",
                    "udf_string_1": null,
                    "type": "FAX",
                    "udf_date_2": null,
                    "udf_date_1": null,
                    "udf_date_4": null,
                    "udf_date_3": null,
                    "full_number": "35799047380",
                    "number": "99047380",
                    "udf_float_3": null,
                    "udf_float_4": null,
                    "id": "23A39D9C9FA046469B5455A37A5BE53E",
                    "state": "Active",
                    "udf_float_1": null,
                    "udf_string_6": null,
                    "udf_float_2": null,
                    "udf_string_7": null,
                    "udf_string_8": null
                },
                "presentment_method": {
                    "alternative_code": "S",
                    "name": "SMS",
                    "description": null,
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": null,
                        "last_name": "CRM.COM User",
                        "id": "CRM1",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Template",
                        "demographics": {
                            "name_day": {
                                "month": null,
                                "day": null
                            },
                            "id_number": " ",
                            "gender": null,
                            "country_of_residence": null,
                            "date_of_birth": {
                                "month": 4,
                                "year": 1984,
                                "day": 2
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": "47006270010",
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    },
                    "id": "065C471C80B5A3985272DD16BAAB8043",
                    "state": "ACTIVE",
                    "type": "SMS"
                },
                "id": "0AF13261DC964703A013C5BCB5A3F79F",
                "state": "ACTIVE"
            }
        ],
        "udf_string_1": null,
        "life_cycle_state": "ACTIVE",
        "classification": {
            "alternative_code": "E",
            "name": "Employee",
            "id": "E093533DA53A4167C69762073D1B13A8"
        },
        "credit_limit_status": null,
        "credit_rating": {
            "code": "AAA",
            "name": "key_aaa_-_subject_to_minimal_credit_risk"
        },
        "name": "ACR0000001392 Κατερίνα Τζιηρτζιηπή",
        "outstanding_amount": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "accounting_period": null,
        "access_tokens_set": [],
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}