Versions Compared

Old Version 1

changes.mady.by.user Georgia Kountouri

Saved on

compared with

New Version Current

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 R15.0.0

Excerpt

This method Write offs the outstanding debt of an Accounts Receivable. A single Accounts Receivable is written off 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 written-off. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request

Body

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token": "{{token}}",
  "accounts_receivable_identifier":{"number":"ACR0000013500"}
}

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "notes": "CRM COM\t2/11/2018 15:22:55\tthere are currently no notes",
        "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-11-02T15:22:57",
            "updated_date": "2018-11-02T15:22:57",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "payment_preferences_set": [
            {
                "payment_preference": {
                    "alternative_code": "C",
                    "name": "Cash",
                    "description": null,
                    "id": "2",
                    "type": "CUSTOM1"
                },
                "bank_branch": null,
                "bank_account_number": null,
                "notes": null,
                "mandate_termination_date": "2019-08-03T15:49:59",
                "payment_medium_brand": null,
                "mandate_signing_date": "2018-08-03T15:49:59",
                "payment_medium_type": {
                    "alternative_code": "CC",
                    "name": "CREDIT CARD",
                    "description": "",
                    "id": "68FAF1F833194091967F86B1AA352129"
                },
                "bank": null,
                "unique_mandate_reference": "03082018_01",
                "cards_set": [],
                "payment_medium_identifier": "03082018_01",
                "account_holder": null,
                "iban": null,
                "default_card": null,
                "business_identifier_code": "03082018_01",
                "id": "E14263A36B6343ED96AFB7101FBF169A",
                "bank_account_type": null
            }
        ],
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": "normal account",
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": "Test  02112018_02",
            "last_name": "02112018_02",
            "id": "BE7DCF57D6F1414580B281A0AFF5DB8D",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Test",
            "demographics": {
                "id_number": "02112018_02",
                "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": "9994D295F71E45D99C14B9BA18DE9655",
            "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": "1",
            "postal_code": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null
        },
        "primary_account": false,
        "type": "CUSTOMER",
        "partner_account": false,
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": "ACR0000013500",
        "udf_float_3": null,
        "udf_float_4": null,
        "balance": 120,
        "credit_limit": 80,
        "credit_period": {
            "credit_period_uot": "DAYS",
            "credit_period_operator": "PLUS_MINUS",
            "credit_period": 2,
            "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": "DEBCE6AFBD7048A98CDCE2D4719ABEC0",
        "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": [
            {
                "presentment_method": {
                    "alternative_code": "P",
                    "name": "Post",
                    "description": null,
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": null,
                        "last_name": "CRM.COM User",
                        "id": "CRM1",
                        "life_cycle_state": "ORGANISATIONAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Template",
                        "demographics": {
                            "id_number": " ",
                            "gender": null,
                            "country_of_residence": null,
                            "date_of_birth": {
                                "month": 4,
                                "year": 1984,
                                "day": 2
                            },
                            "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": "47006270010",
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    },
                    "id": "DDCC4450F9311CA9BC6BD663889A16C9",
                    "state": "ACTIVE",
                    "type": "POST"
                },
                "id": "EDE738738EF045289D2A5A2CAD55691D",
                "state": "ACTIVE"
            }
        ],
        "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,
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [
                {
                    "service_family": {
                        "code": "PF003",
                        "name": "Family C",
                        "description": "Sample Family C",
                        "id": "9A7BF238D6694347942F604F54DCEE5F"
                    },
                    "service_type": null,
                    "maximum_rated_amount_per_day": "0.035299999999999998",
                    "service": null,
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_type": {
                        "meter_reading_type": {
                            "unit_of_measurement": {
                                "alternative_code": "K_1",
                                "name": "Km",
                                "description": null,
                                "id": "E7DE29C3C558416AB3A957864863ABBD"
                            },
                            "alternative_code": "C",
                            "name": "CumulativeMRType",
                            "description": null,
                            "id": "7E033FE7729341D4A1D0ACB83B79926B",
                            "classification": "CUMULATIVE_READING"
                        },
                        "service_type": null,
                        "allowed_metadata_attribute_set": [],
                        "used_for_provisioning": true,
                        "alternative_code": "D",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Decoder",
                        "description": null,
                        "id": "719BA4754DDD44B394F02E87F8247369",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "maximum_rated_amount_per_day": "0.035299999999999998",
                    "service": null,
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": "0.0212000000000000001",
                    "service": {
                        "code": "Antenna",
                        "product_type": {
                            "meter_reading_type": null,
                            "service_type": null,
                            "allowed_metadata_attribute_set": [],
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                }
            ],
            "block_services_not_included_in_usage_allowance_limits_settings": 1,
            "accumulated_maximum_usage_per_day": "40",
            "accumulated_maximum_usage_per_month": "40",
            "block_usage_consumption_when_all_amounts_exceed_credit_limit": null,
            "accumulated_maximum_rated_amount_per_month": "0.0422999999999999973",
            "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": "0.0422999999999999973",
            "accumulated_maximum_usage_per_transaction": null
        },
        "credit_limit_status": "EXCEEDED",
        "parent_account": false,
        "credit_rating": {
            "code": "AA",
            "name": "key_aa_-_subject_to_very_low_credit_risk"
        },
        "name": "ACR0000013500",
        "outstanding_amount": 0,
        "udf_string_6": null,
        "recurring_payments_preferences": {
            "recurring_payment_preference": null,
            "wallet_top_up_rules": {
                "wallet_balance_threshold": null,
                "product_conditions_set": [],
                "top_up_amount": null,
                "frequency": null
            }
        },
        "udf_string_7": null,
        "accounting_period": null,
        "access_tokens_set": [],
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}