Versions Compared

Version Old Version 2 New Version Current
Changes made by

Joseph Ioannou (Unlicensed)

Georgia Kountouri

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 Payment Preference Preferences to an Accounts Receivable. A single Multiple Accounts Receivable's Payment 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 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 added

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_add referred objects parameters
accounts_receivable_payment_preferences_add 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
languagejavascript
themeConfluence
linenumberstrue
 {
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392"
    },
  "payment_preferences_set":
    [
       
       {
           "account_holder": "Ekaterini Tzirtzipi",
           "is_default":true,
           "bank_account_number": "001002001",
           "payment_preference_identifier":{"name":"Paypal Payment"},
           "payment_medium_identifier":"e_tzirtzipi@crm.com"
       }
    ]
}

Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
 

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": null,
                "payment_medium_brand": null,
                "use_for_recurring_payments": false,
                "payment_medium_type": null,
                "bank": null,
                "cards_set": [],
                "payment_medium_identifier": "e_tzirtzipi@crm.com",
                "account_holder": "Ekaterini Tzirtzipi",
                "default_card": null,
                "id": "AE4B3A15D3554D9FBEDC80D0BAF8D76D",
                "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": "080",
                "account_holder": null,
                "default_card": null,
                "id": "7F933FF760E74FA1A08B46B8814D36F3",
                "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": ""
    }
}



Expand
titleExample 2

HTTP Method: POST


Request

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392"
    },
  "payment_preferences_set":
    [
       "payment_preference_identifier":{"name":"Stripe Payment"},
	   "cards_set":
	   [
			{
				"number":"**** **** **** 4242",
				"expiration_month":1,
				"expiration_year":2020,
				"card_security_code":2020,
				"card_holder_name":"MMI",
				"default":true,
				"address_line_1":"address_line_1",
				"address_line_2":"address_line_2",
				"address_city":"address_city",
				"address_zip":"address_zip",
				"address_state":"address_state",
				"address_country":"address_country"
			}
		]       
    ]
}

Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "data": {
        "notes": "CRM COM\t7/6/2018 12:47:05\tWeb API Test\tCRM COM\t7/6/2018 12:47:33\tWeb API Test\tCRM COM\t7/6/2018 12:51:09\tWeb API Test",
        "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": "2018-06-07T09:02:23",
            "updated_date": "2018-06-07T11:52:42",
            "updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "payment_preferences_set": [
            {
                "payment_preference": {
                    "alternative_code": "SP",
                    "name": "Stripe Payment",
                    "description": "Stripe",
                    "id": "27869C712D2A4B22BB5AC35AB1E42DC7",
                    "type": "STRIPE_PAYMENT_GATEWAY"
                },
                "bank_branch": null,
                "bank_account_number": null,
                "notes": null,
                "mandate_termination_date": null,
                "payment_medium_brand": null,
                "mandate_signing_date": null,
                "payment_medium_type": null,
                "bank": null,
                "unique_mandate_reference": null,
                "cards_set": [
                    {
                        "expiration_year": 2020,
                        "card_holder_name": "MMI",
                        "payment_gateway_reference_number": "card_1CaMkbE0IcJRGs11mCLMpPrW",
                        "expiration_month": 1,
                        "id": "E8ADCD8199D4462E924D361BCF2FFA1C",
                        "type": "CREDIT",
                        "brand": "VISA",
                        "last_digits": "**** **** **** 4242"
                    }
                ],
                "payment_medium_identifier": null,
                "account_holder": null,
                "iban": null,
                "default_card": {
                    "expiration_year": 2020,
                    "card_holder_name": "MMI",
                    "payment_gateway_reference_number": "card_1CaMkbE0IcJRGs11mCLMpPrW",
                    "expiration_month": 1,
                    "id": "E8ADCD8199D4462E924D361BCF2FFA1C",
                    "type": "CREDIT",
                    "brand": "VISA",
                    "last_digits": "**** **** **** 4242"
                },
                "business_identifier_code": null,
                "id": "DE67CD3826C0481BA68DD6491F76BD2C",
                "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": "07062018_01",
            "id": "6373D7F9F7C640D89B9B14DF28E23F2B",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Test",
            "demographics": {
                "id_number": "07062018_01",
                "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,
                "industry": null,
                "name_day": {
                    "month": null,
                    "day": null
                },
                "passport_number_expiration_date": null,
                "id_number_expiration_date": null,
                "passport_number": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "billing_address": {
            "apartment_number": null,
            "care_of": null,
            "country": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
            },
            "municipality": null,
            "type": "BUSINESS",
            "udf_date_2": null,
            "udf_date_1": null,
            "street_name": "A",
            "udf_date_4": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "po_box_postal_code": null,
            "udf_string_15": null,
            "udf_string_16": null,
            "udf_string_13": null,
            "udf_string_14": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "id": "15165BE5C8C6492FB71106EF088DD067",
            "state": "Active",
            "udf_string_10": null,
            "floor": null,
            "udf_float_1": null,
            "udf_float_2": null,
            "area": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_1": null,
            "po_box": null,
            "town_city": null,
            "district": null,
            "street_number": null,
            "postal_code": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null
        },
        "primary_account": true,
        "type": "CUSTOMER",
        "partner_account": false,
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": "ACR0000001954",
        "udf_float_3": null,
        "udf_float_4": null,
        "balance": null,
        "credit_period": {},
        "currency": {
            "suffix_symbol": "N/A",
            "prefix_symbol": "€",
            "decimal_part_name": "cents",
            "code": "EUR",
            "integer_part_name": "euro",
            "id": "2",
            "life_cycle_state": "EFFECTIVE"
        },
        "id": "973946BC04B24EB6BB0F7A86427ED92E",
        "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,
        "parent_account": false,
        "credit_rating": {
            "code": "AAA",
            "name": "key_aaa_-_subject_to_minimal_credit_risk"
        },
        "name": "ACR0000001954 Test 07062018_01",
        "outstanding_amount": null,
        "udf_string_6": null,
        "recurring_payments_preferences": {
            "recurring_payment_preference": null,
            "wallet_top_up_rules": {}
        },
        "udf_string_7": null,
        "accounting_period": null,
        "access_tokens_set": [],
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}