POST accounts_receivable/opt_in_for_subscriptions
- p_demou (Deactivated)
- Georgia Kountouri
- Marios Michael
Available from CRM.COM R16.0.0
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 or when the Wallet is set as the payment method. A single Accounts Receivable is updated by each call
Wallet as a payment method is available from CRM.COM R17.0.0
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 to be updated. The allowed account receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||
(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 separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Referred Objects Response Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Both those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved accounts receivable |
| type | String | The type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM or ORGANISATIONAL ORGANISATIONAL type is available from CRM.COM R15.0.0 |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
| description | String | The description of the retrieved accounts receivable |
| notes | String | The notes of the retrieved accounts receivable |
balance | Float | The aggregated amount of posted debits and credits allocated against the accounts receivable, as of a specific date. This information is calculated dynamically |
| opening_balance | Float | The opening balance of the accounts receivable for the latest and still open Accounting Period. This information is calculated during the latest Accounting Period Closing process. |
| opening_balance_date | Date | The date on which the opening balance of the accounts receivable was last calculated by an Accounting Period Closing process. |
outstanding_amount | Float | The total outstanding amount which is owned by the customer, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date. This information is calculated dynamically |
| credit_limit_status | String | Determines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED |
| credit_limit | Number | Is the maximum amount of credit that can be provided to the specific accounts receivable,or in other words the maximum balance that the accounts receivable can ever reach. |
| credit_period | Number | Credit period is the length of time for which a customer is allowed to settle any given debit |
life_cycle_state | String | The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED |
primary_account | Boolean | Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not |
| partner_account | Boolean | Indicates if the accounts receivable is owned by a partner group or a partner unit, i.e. is a partner account |
| parent_account | Boolean | Indicates if the accounts receivable is a parent account in a group accounts |
| is_tax_exempt | Boolean | Indicates if the account owner is tax exempt or not Available from CRM.COM R17.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Contact Information object | The contact information related with the specified accounts receivable | |
Classification object | The classification of the retrieved accounts receivable | |
Credit Rating object | The credit rating of the retrieved accounts receivable | |
| credit_period | Credit Period object | The credit period of the retrieved accounts receivable |
Address object | The billing address of the retrieved accounts receivable | |
| currency | Currency object | The accounts receivable's currency |
| parent_account | Accounts Receivable Object | The parent accounts receivable. Applicable only if the retrieved Accounts Receivable is a member in a group of accounts. |
| accounting_period | Accounting Period Object | The latest Accounting Period for which the accounts receivable's opening balance was calculated for. |
| owned_by_group | Group Object | The group that is owning the accounts receivable Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0 |
| privacy_level | Privacy Level Object | The accounts receivable privacy level Deprecated from CRM.COM R18.0.0 |
| usage_allowance_limits | Usage Allowance Limits Object | The accounts receivable Usage Allowance Limits Available from CRM.COM R13.0.0 Deprecated from CRM.COM R17.0.0 |
Log Information Object | The log information related to the retrieved accounts receivable | |
| account_manager | Users Object | The account manager of the retrieved accounts receivable Applicable only if the retrieved account is owned by a COMPANY |
| pricing_agreement | Pricing Agreement Object | The pricing agreement of the retrieved accounts receivable Applicable only for an Accounts Receivable that is owned by a Company and a Price Plan and/or Usage Service Catalog was agreed as part of a special pricing agreement Available from CRM.COM R14.0.0 From CRM.COM R15.0.0, pricing_agreement is available for all CUSTOMER and ORGANISATIONAL accounts, for both persons and companies |
| recurring_payments_preferences | Recurring Payments Preferences Object | The recurring payments preferences associated with the accounts receivable |
| membership_information | Account Membership Information Object | The accounts receivable membership information in terms of funding scope and the services funded by the parent account. Applicable only if the retrieved accounts receivable is a member account of a group. |
| rewards | Rewards Object | The rewards information of the accounts receivable Available from CRM.COM R17.0.0 |
Set of Accounts Receivable Presentment Preferences Objects | The presentment preferences of the retrieved accounts receivable | |
Set of Accounts Receivable Payment Preferences Objects | The payment preferences of the retrieved accounts receivable | |
| access_tokens_set | Set of Access Token objects | The access tokens associated with the accounts receivable |
| member_accounts | Set of Accounts Receivable Objects | The member accounts of the retrieved accounts receivable. Applicable only if the retrieved account is a Parent Account. |
| usage_allowance_organisational_units | Set of Usage Organisational Conditions Objects | The usage organisational conditions (communities, groups, units) that services can be used at |
Referred Objects Response Data
Examples
HTTP Method: POST
Request
Body
{
"token": "{{token}}",
"accounts_receivable_identifier": { "number": "ACR0000013910"},
"enabled_payment_method_identifier": { "alternative_code": "SP" }
}
Response
{
"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": ""
}
}