Versions Compared

Old Version 6

changes.mady.by.user p_demou

Saved on

compared with

New Version 7

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

Excerpt

This method changes the credit period of accounts receivable in order to override the active Accounts Receivable Definition's default credit period settings. A single accounts receivable's credit period can be 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 whose credit period will be updated. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

credit_period

(mandatory)

Number

The credit period of the accounts receivable in days which overrides the active accounts receivable definition's default credit period. The number of days must not exceed the active Accounts Receivable Definition's proximity range

Tip

From CRM.COM R14.2.0 the credit period can be specified either in Days or Months.

credit_period_uot

(mandatory)

String

Defines whether the credit period of the account will be specified in Days, Months or a Fixed period. Available values are DAYS, MONTHS and FIXED. The default value is DAYS

Tip

Available from CRM.COM R14.2.0

The "FIXED" option is available from CRM.COM R16.0.0

credit_period_operator

(semi-optional)

String

The credit period's operator which can either be set to PLUS or MINUS.

Tip

Available from CRM.COM R14.2.0

From CRM.COM R16.0.0 the parameter is mandatory if "PLUS" or "MINUS" operator is selected

credit_period_setting

(semi-optional)

String

The credit period's setting if the credit period operator is set to "FIXED". Available values are:

  • X_DAYS_AFTER
  • NTH_DAY_AFTER_X_MONTHS
Tip

Available from CRM.COM R16.0.0

credit_period_days

(mandatory on conditions)

Number

The credit period's number of days after the transaction's posted date. Available and mandatory only if the credit_period_setting is set to "X_DAYS_AFTER"

Tip

Available from CRM.COM R16.0.0

credit_period_nth_day

(mandatory on conditions)

Number

The credit period's Nth day after X months after the transaction's posted date. Available and mandatory only if the credit_period_setting is set to "NTH_DAY_AFTER_X_MONTHS"

Tip

Available from CRM.COM R16.0.0


credit_period_x_month

(mandatory on conditions)

Number

The credit period's Nth day after X months after the transaction's posted date. Available and mandatory only if the credit_period_setting is set to "NTH_DAY_AFTER_X_MONTHS"

Tip

Available from CRM.COM R16.0.0

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
 {
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTUwMjE5ODUzMCIsImlhdCI6IjE1MDIxOTEzMzAiLCJqdGkiOiI3NDRGN0JERUZFQ0Y0NzAzODA2RjNFREVEMzI4NTYxNSJ9.puPbMQBnXGaZn4vijM9IqFE7ktANYYBoQLPgh93UACs",
 "accounts_receivable_identifier":{"number":"ACR0000012378"},
"credit_period":2,
"credit_period_operator":"PLUS"
}

 

Response:

Code Block
 

    {
        "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-08-08T12:49:36",
                "updated_date": "2017-08-08T14:25: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":
            [
            ],
            "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": "Test 7554_3",
                "last_name": "7554_3",
                "id": "BCC9DDC5CABF4EE6888C4B0F51C04B36",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Test",
                "demographics":
                {
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "7554_3",
                    "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,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": "7554_3",
                    "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": "HOME",
                "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": "60E01D108BDB4BEE9BAD4BC73716E2DC",
                "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",
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "number": "ACR0000012378",
            "udf_float_3": null,
            "udf_float_4": null,
            "balance": -9898.4,
            "credit_limit": 50,
            "credit_period":
            {
                "credit_period": 2,
                "credit_period_setting": "X_DAYS_AFTER",
                "credit_period_number_of_days": 3,
                "credit_period_operator": "PLUS"
            },
            "currency":
            {
                "suffix_symbol": null,
                "prefix_symbol": "\u20ac",
                "decimal_part_name": null,
                "code": "EUR",
                "integer_part_name": null,
                "id": "2"
            },
            "id": "916E4A9F0700459DB9FA71E38DD0FE44",
            "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": "M",
                "name": "Membership",
                "id": "3CD4328DC1A14A2F977CBC1D418D188A"
            },
            "usage_allowance_limits":
            {
                "accumulated_maximum_rated_amount_per_transaction": null,
                "usage_services_allowance":
                [
                    {
                        "service_family": null,
                        "service_type": null,
                        "maximum_rated_amount_per_day": null,
                        "service":
                        {
                            "code": "Serendipity",
                            "product_type":
                            {
                                "service_type": "USAGE",
                                "used_for_provisioning": true,
                                "alternative_code": "V",
                                "udr_type":
                                {
                                    "unit_of_measurement":
                                    {
                                        "alternative_code": "A",
                                        "name": "Amount",
                                        "description": null,
                                        "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
                                    },
                                    "alternative_code": "V",
                                    "name": "VOD",
                                    "description": null,
                                    "id": "B3CFC986221548279752B1ABC6F4C480"
                                },
                                "composition_method": "FLAT",
                                "name": "Usage Services",
                                "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                                "id": "751C638AA3534B768408AAC4D73CF516",
                                "classification": "SERVICES",
                                "physical_good_type": null
                            },
                            "alternative_code": "S_1",
                            "description": "VOD: Serendipity ",
                            "id": "BD3ACEE7D6244DCAA375D0744DA75540"
                        },
                        "maximum_usage_per_transaction": "1",
                        "maximum_rated_amount_per_month": null,
                        "maximum_usage_per_day": "3",
                        "maximum_rated_amount_per_transaction": null,
                        "maximum_usage_per_month": null
                    },
                    {
                        "service_family": null,
                        "service_type": null,
                        "maximum_rated_amount_per_day": "100",
                        "service":
                        {
                            "code": "Usage Service 3",
                            "product_type":
                            {
                                "service_type": "USAGE",
                                "used_for_provisioning": false,
                                "alternative_code": "USTB",
                                "udr_type":
                                {
                                    "unit_of_measurement":
                                    {
                                        "alternative_code": "L",
                                        "name": "Litres",
                                        "description": null,
                                        "id": "2D11FC94261B4C53B742B61633660167"
                                    },
                                    "alternative_code": "L",
                                    "name": "Litres",
                                    "description": null,
                                    "id": "B1238270684F4457B6D8EBD4CA00963B"
                                },
                                "composition_method": "FLAT",
                                "name": "Usage Service Type B",
                                "description": null,
                                "id": "8FEC7EEE39254E55ABA2C3382C432D2D",
                                "classification": "SERVICES",
                                "physical_good_type": null
                            },
                            "alternative_code": "US3",
                            "description": "Usage Service 3",
                            "id": "6444E6324BCE4A34A99DD795E55C016D"
                        },
                        "maximum_usage_per_transaction": null,
                        "maximum_rated_amount_per_month": "1000",
                        "maximum_usage_per_day": null,
                        "maximum_rated_amount_per_transaction": null,
                        "maximum_usage_per_month": null
                    },
                    {
                        "service_family": null,
                        "service_type":
                        {
                            "service_type": "USAGE",
                            "used_for_provisioning": false,
                            "alternative_code": "USTA",
                            "udr_type":
                            {
                                "unit_of_measurement":
                                {
                                    "alternative_code": "L",
                                    "name": "Litres",
                                    "description": null,
                                    "id": "2D11FC94261B4C53B742B61633660167"
                                },
                                "alternative_code": "L",
                                "name": "Litres",
                                "description": null,
                                "id": "B1238270684F4457B6D8EBD4CA00963B"
                            },
                            "composition_method": "FLAT",
                            "name": "Usage Service Type A",
                            "description": null,
                            "id": "819661A2C34A4BBF9005E74387CD7A40",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "maximum_rated_amount_per_day": null,
                        "service": null,
                        "maximum_usage_per_transaction": "10",
                        "maximum_rated_amount_per_month": null,
                        "maximum_usage_per_day": "15",
                        "maximum_rated_amount_per_transaction": null,
                        "maximum_usage_per_month": "1000"
                    }
                ],
                "accumulated_maximum_usage_per_day": "100",
                "accumulated_maximum_usage_per_month": "1000",
                "accumulated_maximum_rated_amount_per_month": "1000",
                "currency":
                {
                    "suffix_symbol": null,
                    "prefix_symbol": "\u20ac",
                    "decimal_part_name": null,
                    "code": "EUR",
                    "integer_part_name": null,
                    "id": "2"
                },
                "accumulated_maximum_rated_amount_per_day": "100",
                "accumulated_maximum_usage_per_transaction": null
            },
            "credit_limit_status": "NOT_EXCEEDED",
            "credit_rating":
            {
                "code": "AAA",
                "name": "key_aaa_-_subject_to_minimal_credit_risk"
            },
            "name": "ACR0000012378",
            "outstanding_amount": 0,
            "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
themeConfluence
languagejavascript
linenumberstrue
 {
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTUwMjE5ODUzMCIsImlhdCI6IjE1MDIxOTEzMzAiLCJqdGkiOiI3NDRGN0JERUZFQ0Y0NzAzODA2RjNFREVEMzI4NTYxNSJ9.puPbMQBnXGaZn4vijM9IqFE7ktANYYBoQLPgh93UACs",
 "accounts_receivable_identifier":{"number":"ACR0000013902"},
  "credit_period_nth_day":4,
  "credit_period_x_month":2,
  "credit_period_operator":"SPECIFIC_PERIOD",
  "credit_period_setting":"ON_THE_XTH_DAY",
  "fields_set":"credit_period"

}

 

Response:

Code Block
{
    "data": {
        "credit_period": {
            "credit_period_operator": "SPECIFIC_PERIOD",
            "credit_period_after_x_months": 2,
            "credit_period_setting": "ON_THE_XTH_DAY",
            "credit_period_day_of_month": 4
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}