Versions Compared

Old Version 2

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

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 changes the payment preferences of accounts receivable. A single accounts receivable's payment preferences updates existing Payment Preferences of an Accounts Receivable. Multiple Accounts Receivable's Payment Preferences can be updated 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 payment 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

 

 

 

 

 

 

payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable that will be updated

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_payment_preferences_update referred objects parameters
accounts_receivable_payment_preferences_update referred objects parameters
Referred Parameter Objects Data

Include Page
V4:accounts_receivable_payment_preference_parameter
V4:accounts_receivable_payment_preference_parameter

Restrictions

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392"
    },
  "payment_preferences_set":
    [
       
       {
           "payment_preference_identifier":{"name":"Paypal Payment"},
           "payment_medium_identifier":"e_tzirtzipi3@crm.com",
           "notes":"et"
       }
    ]
}

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-07-28T12:26:10",
            "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": [
            {
                "payment_preference": {
                    "alternative_code": "PP_1",
                    "name": "Paypal Payment",
                    "description": null,
                    "id": "7E9E4D27B0AB4D4981D7D3B4E682F6E0",
                    "type": "PAYPAL_PAYMENT_GATEWAY"
                },
                "bank_branch": null,
                "bank_account_number": "001002001",
                "notes": "et",
                "payment_medium_brand": null,
                "use_for_recurring_payments": false,
                "payment_medium_type": null,
                "bank": null,
                "cards_set": [],
                "payment_medium_identifier": "e_tzirtzipi3@crm.com",
                "account_holder": "Ekaterini Tzirtzipi",
                "default_card": null,
                "id": "1C296CB938D74EEA9456A444C24B117E",
                "bank_account_type": null
            },
            {
                "payment_preference": {
                    "alternative_code": "TC_1",
                    "name": "Custom 1",
                    "description": null,
                    "id": "4F566DD555FD4C3DAFDDF4A2B2B3692B",
                    "type": "CUSTOM1"
                },
                "bank_branch": null,
                "bank_account_number": null,
                "notes": null,
                "payment_medium_brand": null,
                "use_for_recurring_payments": false,
                "payment_medium_type": null,
                "bank": null,
                "cards_set": [],
                "payment_medium_identifier": "e_tzirtzipi2@crm.com",
                "account_holder": null,
                "default_card": null,
                "id": "8BB29A181AE14B5ABF85BD0213E99191",
                "bank_account_type": null
            }
        ],
        "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,
                "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": [],
        "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": ""
    }
}