Versions Compared

Old Version 1

changes.mady.by.user p_demou

Saved on

compared with

New Version 2

changes.mady.by.user Marios Michael

Saved on

Key

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

Available from CRM.COM R16.0.0

Excerpt

This method sets up the payments preferences of an Accounts Receivable which opt in for automatic payments on subscriptions whenever the credit limit is exceeded, but only if the active Accounts Receivable Definition allows it. A single Accounts Receivable is updated by each call

...

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 to be updated. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

enabled_payment_method_identifier

(optional)

Payment Preference Identifier

The identifier of the payment preference to be set as the opt in for subscriptions payment method for the accounts receivable. The allowed payment preference identifier fields are the following

Include Page
V4:payment_preference_identifier
V4:payment_preference_identifier

wallet_top_up_rules

(optional)

Wallet Top Up Rules Object

The wallet top up rules that will be applied for the accounts receivable (applicable only if the active accounts receivable definition allows it)

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request

 

Body

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

Response

Code Block
 {
    "token": "{{token}}",
    "accounts_receivable_identifier": { "number": "ACR0000013910"},
    "enabled_payment_method_identifier": { "alternative_code": "SP" }
}

 

Response

Code Block
 {
    "data": {
        "notes": null,
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "CommunityA",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "CommunityA",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2019-03-06T09:08:30",
            "updated_date": "2019-03-06T15:35:22",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "payment_preferences_set": [
            {
                "payment_preference": {
                    "alternative_code": "SP",
                    "name": "Stripe Payment",
                    "description": null,
                    "id": "27869C712D2A4B22BB5AC35AB1E42DC7",
                    "type": "STRIPE_PAYMENT_GATEWAY"
                },
                "bank_branch": null,
                "opt_in_for_purchases": true,
                "bank_account_number": null,
                "notes": null,
                "mandate_termination_date": null,
                "payment_medium_brand": null,
                "mandate_signing_date": null,
                "opt_in_for_subscriptions": true,
                "use_for_recurring_payments": false,
                "payment_medium_type": null,
                "bank": null,
                "unique_mandate_reference": null,
                "cards_set": [
                    {
                        "expiration_year": 2022,
                        "card_holder_name": "MMI",
                        "payment_gateway_reference_number": "card_1EAtqpE0IcJRGs11VkuvhnCo",
                        "expiration_month": 4,
                        "id": "2D1398612169453DB0B21176D3E5AB30",
                        "type": "CREDIT",
                        "brand": "VISA",
                        "last_digits": "**** **** **** 4242"
                    }
                ],
                "payment_medium_identifier": null,
                "account_holder": null,
                "iban": null,
                "default_card": {
                    "expiration_year": 2022,
                    "card_holder_name": "MMI",
                    "payment_gateway_reference_number": "card_1EAtqpE0IcJRGs11VkuvhnCo",
                    "expiration_month": 4,
                    "id": "2D1398612169453DB0B21176D3E5AB30",
                    "type": "CREDIT",
                    "brand": "VISA",
                    "last_digits": "**** **** **** 4242"
                },
                "business_identifier_code": null,
                "id": "3A721F5396204C1989FAECBEA630C851",
                "bank_account_type": null
            }
        ],
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "CommunityA",
            "name": "Main Group",
            "description": "Main Group ",
            "id": "1"
        },
        "description": null,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": "Test  06032019_01",
            "last_name": "06032019_01",
            "id": "56D77DCD7F1A49099244E9E41A85A928",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Test",
            "demographics": {
                "id_number": "06032019_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": {
            "country": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
            },
            "apartment_number": null,
            "care_of": null,
            "is_primary": false,
            "municipality": null,
            "type": "HOME",
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "street_name": "Test",
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_15": null,
            "po_box_postal_code": null,
            "udf_string_16": null,
            "udf_string_13": null,
            "udf_string_14": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "id": "DC5D4A789C0842BE9655F1F39A9D85AC",
            "state": "Active",
            "udf_string_10": null,
            "udf_float_1": null,
            "floor": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "area": 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": "5",
            "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": "ACR0000013910",
        "udf_float_3": null,
        "udf_float_4": null,
        "balance": 69.1,
        "credit_limit": 70,
        "credit_period": {
            "credit_period_uot": "DAYS",
            "credit_period_operator": "PLUS_MINUS",
            "credit_period": 6,
            "credit_period_after_x_months": 1,
            "credit_period_setting": "ON_THE_XTH_DAY",
            "credit_period_day_of_month": 10
        },
        "currency": {
            "suffix_symbol": null,
            "prefix_symbol": "€",
            "decimal_part_name": null,
            "code": "EUR",
            "integer_part_name": null,
            "id": "2",
            "life_cycle_state": "EFFECTIVE"
        },
        "id": "8355FE083B454C28BA6C77E4B41953DC",
        "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": null,
        "presentment_preferences_set": [],
        "udf_string_1": null,
        "life_cycle_state": "ACTIVE",
        "classification": {
            "alternative_code": "VC",
            "name": "VIP Customer",
            "id": "F36179059928D40AC42DF66A67364021"
        },
        "usage_allowance_limits": {
            "percentage_of_allowed_exceeded_usage_limit": 10,
            "usage_allowance_organisational_units": [],
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [],
            "block_services_not_included_in_usage_allowance_limits_settings": 0,
            "accumulated_maximum_usage_per_day": "200000",
            "accumulated_maximum_usage_per_month": "300000",
            "block_usage_consumption_when_all_amounts_exceed_credit_limit": 0,
            "accumulated_maximum_rated_amount_per_month": "99574.2719999999972",
            "currency": {
                "suffix_symbol": null,
                "prefix_symbol": "€",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "2",
                "life_cycle_state": "EFFECTIVE"
            },
            "accumulated_maximum_rated_amount_per_day": "49787.1359999999986",
            "accumulated_maximum_usage_per_transaction": null
        },
        "credit_limit_status": "NOT_EXCEEDED",
        "parent_account": false,
        "credit_rating": {
            "code": "A",
            "name": "key_a_-_subject_to_low_credit_risk"
        },
        "name": "ACR0000013910 Test  06032019_01",
        "outstanding_amount": 0,
        "udf_string_6": null,
        "recurring_payments_preferences": {
            "recurring_payment_preference": {
                "payment_preference": {
                    "alternative_code": "SP",
                    "name": "Stripe Payment",
                    "description": null,
                    "id": "27869C712D2A4B22BB5AC35AB1E42DC7",
                    "type": "STRIPE_PAYMENT_GATEWAY"
                },
                "bank_branch": null,
                "opt_in_for_purchases": true,
                "bank_account_number": null,
                "notes": null,
                "mandate_termination_date": null,
                "payment_medium_brand": null,
                "mandate_signing_date": null,
                "opt_in_for_subscriptions": true,
                "use_for_recurring_payments": false,
                "payment_medium_type": null,
                "bank": null,
                "unique_mandate_reference": null,
                "cards_set": [
                    {
                        "expiration_year": 2022,
                        "card_holder_name": "MMI",
                        "payment_gateway_reference_number": "card_1EAtqpE0IcJRGs11VkuvhnCo",
                        "expiration_month": 4,
                        "id": "2D1398612169453DB0B21176D3E5AB30",
                        "type": "CREDIT",
                        "brand": "VISA",
                        "last_digits": "**** **** **** 4242"
                    }
                ],
                "payment_medium_identifier": null,
                "account_holder": null,
                "iban": null,
                "default_card": {
                    "expiration_year": 2022,
                    "card_holder_name": "MMI",
                    "payment_gateway_reference_number": "card_1EAtqpE0IcJRGs11VkuvhnCo",
                    "expiration_month": 4,
                    "id": "2D1398612169453DB0B21176D3E5AB30",
                    "type": "CREDIT",
                    "brand": "VISA",
                    "last_digits": "**** **** **** 4242"
                },
                "business_identifier_code": null,
                "id": "3A721F5396204C1989FAECBEA630C851",
                "bank_account_type": null
            },
            "wallet_top_up_rules": {}
        },
        "udf_string_7": null,
        "accounting_period": null,
        "access_tokens_set": [],
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}