Page Comparison

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.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

The identifier of the account receivable whose credit period will be updated. The allowed account receivable identifier fields are the following:

...

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)

...

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

Tip
Available from CRM.COM R14.2.0

...

credit_period_operator

(mandatory)

...

String

...

fields_set

(optional)

...

Restrictions

It is mandatory to specify one of the semi-optional parameters. Both those parameters is allowed to be specified.

Response Data

...

Examples

HTTP Method: POST

Request:

Body:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTUwMjE5ODUzMCIsImlhdCI6IjE1MDIxOTEzMzAiLCJqdGkiOiI3NDRGN0JERUZFQ0Y0NzAzODA2RjNFREVEMzI4NTYxNSJ9.puPbMQBnXGaZn4vijM9IqFE7ktANYYBoQLPgh93UACs",
 "accounts_receivable_identifier":{"number":"ACR0000012378"},
"credit_period":2,
"credit_period_operator":"PLUS"
}

Response:

Code Block { 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.

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 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 on conditions)

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. Available and mandatory only if the credit_period_operatoris set to PLUS or MINUS

Tip

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

From CRM.COM R16.0.0 it is mandatory if the credit period's operator is set to PLUS, MINUS

credit_period_uot

(mandatory on conditions)

String

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

Tip
Available from CRM.COM R14.2.0

credit_period_operator

(mandatory)

String

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

Tip

Available from CRM.COM R14.2.0

From CRM.COM R16.0.0 the parameter is mandatory

credit_period_setting

(mandatory on conditions)

String

The credit period's setting if the credit period operator is set to "SPECIFIC_PERIOD". 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 separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Both those parameters is allowed to be specified.

Response Data

Include Page

	V4:accounts_receivable_complete
	V4:accounts_receivable_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"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",
                    "dataname": "Admin Unit",
       {             "notesdescription": null"admin unit",
             "log_information":       "id": "1"
            {    },
                "created_by_unitdate": "2017-08-08T12:49:36",
               {    "updated_date": "2017-08-08T14:25:22",
                "alternativeupdated_by_codeuser":
"adminunit",                     "group_name": "Main Group",{
                    "communityperson_name": "CommunityCRM COM",
                    "nameid": "Admin Unit1",
                    "descriptionemail": "admin unitdev@crm.com",
                    "idusername": "1MPAdministrator"
                },
                "updatedcreated_by_unituser":
                {
                    "alternativeperson_codename": "adminunitMPAdministrator",
                    "group_nameid": "Main Group1",
                    "community_nameemail": "Communitydev@crm.com",
                    "nameusername": "Admin UnitMPAdministrator",
                }
   "description": "admin unit",       },
             "idpayment_preferences_set":
   "1"         [
       },     ],
            "createdowned_by_date": "2017-08-08T12:49:36",group":
            {
                "updatedalternative_datecode": "2017-08-08T14:25:22MG",
                "updatedcommunity_by_username": "Community",
               { "name": "Main Group",
                 "person_namedescription": "CRMMain COMGroup",
   
                "id": "1",
            },
            "emaildescription": "dev@crm.com",null,
            "contact_information":
            "username": "MPAdministrator"{
                 }"company_profile": null,
                "created_bycompany_username": null,
               { "name":   "Test 7554_3",
                "personlast_name": "MPAdministrator7554_3",

                   "id": "1BCC9DDC5CABF4EE6888C4B0F51C04B36",
 
                  "email"life_cycle_state": "dev@crm.comFINANCIAL",
 
                  "usernamemiddle_name": "MPAdministrator"null,
                }
"title": null,
           },     "type": "PERSON",
      "payment_preferences_set":          "first_name": "Test",
 [             ],   "demographics":
         "owned_by_group":         {
   {                 "alternativename_codeday":
"MG",                 "community_name": "Community",  {
              "name": "Main Group",        "month": null,
       "description": "Main Group",                 "idday": "1"null
              },      },
      "description": null,             "contactid_informationnumber":         "7554_3",
   {                 "company_profilegender": null,
                    "companycountry_of_nameresidence": null,
                    {
     "name": "Test 7554_3",                 "lastalternative_namecode": "7554_3CYP",
                    "id    "three_character_code": "BCC9DDC5CABF4EE6888C4B0F51C04B36CYP",
                  "life_cycle_state      "name": "FINANCIALCYPRUS",
                "middle_name": null,       "id": "181",
        "title": null,                 "type"two_character_code": "PERSONCY",
                "first_name": "Test",   },
             "demographics":         "date_of_birth":
       {             {
       "name_day":                   "month": null,
 {                         "monthyear": null,
                        "day": null
                    },
                    "idindustry_numbersector": "7554_3"null,
                    "genderpassport_number": null,
                    "country_of_residenceindustry": null,
                   {
  "social_security_number": "7554_3",
                      "alternative_code"id_issued_by_country": "CYP"null,
                        "three_character_code": "CYP","passport_issued_by_country": null
                }
           "name": "CYPRUS" },
            "billing_address":
           "id": "181", {
                "apartment_number": null,
      "two_character_code": "CY"         "care_of": null,
          },      "country":
              "date_of_birth":  {
                  {    "alternative_code": "CYP",
                    "monththree_character_code": null"CYP",
                        "yearname": null"CYPRUS",
 
                      "dayid": null"181",
                    },
    "two_character_code": "CY"
               "industry_sector": null,
    },
                "passport_numbermunicipality": null,
   
                "industrytype": null"HOME",
                    "socialudf_securitydate_number2": "7554_3"null,

                   "idudf_issueddate_by_country1": null,
 
                  "passport_issued_by_countrystreet_name": null"A",
                 }"udf_date_4": null,
            },    "udf_date_3": null,
       "billing_address":             {"udf_float_3": null,
                "apartmentudf_float_number4": null,
                "care_ofpo_box_postal_code": null,
                "countryudf_string_15": null,
               {
  "udf_string_16": null,
                  "alternativeudf_string_code13": "CYP"null,
                    "threeudf_characterstring_code14": "CYP"null,
                    "name"udf_string_11": "CYPRUS",
   null,
                "idudf_string_12": "181"null,
                    "two_character_code"id": "CY60E01D108BDB4BEE9BAD4BC73716E2DC",
                 }"state": "Active",
                "municipalityudf_string_10": null,
                "typefloor": "HOME"null,
                "udf_datefloat_21": null,
                "udf_datefloat_12": null,
                "street_namearea": "A"null,
                "udf_datestring_42": null,
                "udf_datestring_3": null,
                "udf_floatstring_34": null,
                "udf_floatstring_45": null,
                "poudf_boxstring_postal_code1": null,
                "udfpo_string_15box": null,
                "udftown_string_16city": null,
                "udf_string_13district": null,
                "udfstreet_string_14number": null,
                "udfpostal_string_11code": null,
                "udf_string_126": null,
                "idudf_string_7": "60E01D108BDB4BEE9BAD4BC73716E2DC"null,
                "stateudf_string_8": "Active"null,
                "udf_string_109": null,
            },
            "floorprimary_account": nulltrue,
  
             "udf_float_1type": null,
  "CUSTOMER",
             "udf_floatdate_2": null,
                "area"udf_date_1": null,
 
              "udf_stringdate_24": null,
   
            "udf_stringdate_3": null,
            "number": "ACR0000012378",
            "udf_stringfloat_43": null,
   
            "udf_stringfloat_54": null,
                "udf_string_1"balance": null,
 -9898.4,
              "pocredit_boxlimit": null50,
   
            "towncredit_cityperiod":
null,            {
    "district": null,                 "street_number"credit_period": null2,
                "postalcredit_period_codesetting": null"X_DAYS_AFTER",
                "udf_string_6credit_period_number_of_days": null3,
                "udfcredit_stringperiod_7operator": null,"PLUS"
                "udf_string_8": null},
            "currency":
   "udf_string_9": null         {
   },             "primarysuffix_accountsymbol": truenull,
                "typeprefix_symbol": "CUSTOMER\u20ac",
                "udfdecimal_datepart_2name": null,
            "udf_date_1    "code": null"EUR",
                "udfinteger_datepart_4name": null,
              "udf_date_3  "id": null,"2"
            "number": "ACR0000012378"},
            "udf_float_3id": null"916E4A9F0700459DB9FA71E38DD0FE44",
            "udfopening_float_4balance": null0,
            "balanceudf_float_1": -9898.4null,
            "creditudf_float_limit2": 50null,
            "creditudf_string_period2": null,
           {
    "opening_balance_date": null,
            "creditudf_string_period3": 2null,
   
            "creditudf_periodstring_setting4": "X_DAYS_AFTER",
  null,
             "creditudf_period_number_of_daysstring_5": 3null,
                "creditprivacy_period_operatorlevel": "PLUS"null,
            },"presentment_preferences_set":
            "currency":[
            {],
                "suffix_symbol"udf_string_1": null,
  
             "prefixlife_cycle_symbolstate": "\u20acACTIVE",
   
            "decimal_part_nameclassification":
null,            {
    "code": "EUR",
                "integeralternative_part_namecode": null"M",
                "idname": "2Membership",
            },
            "id": "916E4A9F0700459DB9FA71E38DD0FE443CD4328DC1A14A2F977CBC1D418D188A",
            "opening_balance": 0},
            "udfusage_floatallowance_1limits":
 null,           {
  "udf_float_2": null,             "udf_string_2accumulated_maximum_rated_amount_per_transaction": null,
                "openingusage_balanceservices_dateallowance": null,
                [
   "udf_string_3": null,             "udf_string_4": null,  {
          "udf_string_5": null,             "privacyservice_levelfamily": null,
            "presentment_preferences_set":             ["service_type": null,
            ],             "udf_string_1maximum_rated_amount_per_day": null,
               "life_cycle_state": "ACTIVE",        "service":
    "classification":              {      {
          "alternative_code": "M",                 "namecode": "MembershipSerendipity",
                "id": "3CD4328DC1A14A2F977CBC1D418D188A"           "product_type":
 },              "usage_allowance_limits":             {
                "accumulated_maximum_rated_amount_per_transaction": null,                 "usageservice_services_allowancetype": "USAGE",
                 [               "used_for_provisioning": true,
       {                         "servicealternative_familycode": null"V",
                        "service_type": null,        "udr_type":
                  "maximum_rated_amount_per_day": null,             {
           "service":                         {"unit_of_measurement":
                            "code": "Serendipity",       {
                     "product_type":                   "alternative_code": "A",
        {                                 "service_typename": "USAGEAmount",
                                   "used_for_provisioning     "description": true,null,
                                        "alternative_codeid": "V",0F24D08950AA4B5DB5C5F52FA5A4A7D1"
                                    },
   "udr_type":                                  {"alternative_code": "V",
                                    "unit_of_measurementname": "VOD",
                                   {    "description": null,
                                    "alternative_codeid": "A",B3CFC986221548279752B1ABC6F4C480"
                                },
                "name": "Amount",                "composition_method": "FLAT",
                         "description": null,      "name": "Usage Services",
                                "iddescription": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
  Used for VOD , PPV, TELEPHONE CALLS ETC",
                                 },
 "id": "751C638AA3534B768408AAC4D73CF516",
                                  "alternative_codeclassification": "VSERVICES",
   
                                "namephysical_good_type": "VOD",null
                            },
       "description": null,                    "alternative_code": "S_1",
               "id": "B3CFC986221548279752B1ABC6F4C480"            "description": "VOD: Serendipity ",
                 },           "id": "BD3ACEE7D6244DCAA375D0744DA75540"
                    "composition_method": "FLAT",        },
                        "namemaximum_usage_per_transaction": "Usage Services",
       1",
                        "descriptionmaximum_rated_amount_per_month": "Used for VOD , PPVnull,
TELEPHONE CALLS ETC",                                 "id"maximum_usage_per_day": "751C638AA3534B768408AAC4D73CF5163",
                                "classification"maximum_rated_amount_per_transaction": "SERVICES"null,
                        "maximum_usage_per_month": null
       "physical_good_type": null            },
                },    {
                        "alternativeservice_codefamily": "S_1",
   null,
                         "descriptionservice_type": "VOD: Serendipity ",
null,
                           "id"maximum_rated_amount_per_day": "BD3ACEE7D6244DCAA375D0744DA75540100",
                        "service":
 },                       {
 "maximum_usage_per_transaction": "1",                           "maximum_rated_amount_per_monthcode": null"Usage Service 3",
                            "maximum_usage_per_dayproduct_type": "3",
                            {
    "maximum_rated_amount_per_transaction": null,                            "maximum_usage_per_monthservice_type": null"USAGE",
                    },            "used_for_provisioning": false,
       {                         "servicealternative_familycode": null"USTB",
                        "service_type": null,       "udr_type":
                 "maximum_rated_amount_per_day": "100",              {
          "service":                         {
 "unit_of_measurement":
                           "code": "Usage Service 3",      {
                      "product_type":                    "alternative_code": "L",
        {                                 "service_typename": "USAGELitres",
                                "used_for_provisioning": false,       "description": null,
                        "alternative_code": "USTB",               "id": "2D11FC94261B4C53B742B61633660167"
                "udr_type":                    },
            {                        "alternative_code": "L",
           "unit_of_measurement":                         "name": "Litres",
          {                          "description": null,
             "alternative_code": "L",                          "id": "B1238270684F4457B6D8EBD4CA00963B"
              "name": "Litres",                  },
                        "description": null,       "composition_method": "FLAT",
                                "idname": "2D11FC94261B4C53B742B61633660167"Usage Service Type B",
                                "description": }null,
                                    "alternative_code"id": "L8FEC7EEE39254E55ABA2C3382C432D2D",
 
                                  "nameclassification": "LitresSERVICES",
                                "physical_good_type": null
                   "description": null,        },
                            "idalternative_code": "B1238270684F4457B6D8EBD4CA00963BUS3",
                                },
   "description": "Usage Service 3",
                            "composition_methodid": "FLAT6444E6324BCE4A34A99DD795E55C016D",
                        },
       "name": "Usage Service Type B",             "maximum_usage_per_transaction": null,
                  "description": null,        "maximum_rated_amount_per_month": "1000",
                        "idmaximum_usage_per_day": "8FEC7EEE39254E55ABA2C3382C432D2D",
       null,
                        "classificationmaximum_rated_amount_per_transaction": "SERVICES"null,
                          "maximum_usage_per_month": null
       "physical_good_type": null            },
                },    {
                        "alternativeservice_codefamily": "US3"null,
                            "description"service_type":
"Usage Service 3",                      {
      "id": "6444E6324BCE4A34A99DD795E55C016D"                     "service_type": "USAGE",
   },                         "maximumused_usagefor_per_transactionprovisioning": nullfalse,
                            "maximum_rated_amount_per_monthalternative_code": "1000USTA",
                            "maximum_usage_per_day": null,udr_type":
                            {
      "maximum_rated_amount_per_transaction": null,                         "maximumunit_usageof_per_monthmeasurement":
null                       },         {
           {                         "servicealternative_familycode": null"L",
                        "service_type":              "name": "Litres",
          {                             "service_typedescription": "USAGE"null,
                            "used_for_provisioning": false,             "id": "2D11FC94261B4C53B742B61633660167"
               "alternative_code": "USTA",                         },
   "udr_type":                              {"alternative_code": "L",
                                "unit_of_measurementname": "Litres",
                               { "description": null,
                                  "alternative_codeid": "LB1238270684F4457B6D8EBD4CA00963B",
                            },
         "name": "Litres",                  "composition_method": "FLAT",
                 "description": null,          "name": "Usage Service Type A",
                      "id": "2D11FC94261B4C53B742B61633660167"     "description": null,
                          },    "id": "819661A2C34A4BBF9005E74387CD7A40",
                            "alternative_codeclassification": "LSERVICES",
 
                              "name"physical_good_type": "Litres",null
                        },
       "description": null,                "maximum_rated_amount_per_day": null,
               "id": "B1238270684F4457B6D8EBD4CA00963B"        "service": null,
                   },     "maximum_usage_per_transaction": "10",
                      "composition_method  "maximum_rated_amount_per_month": "FLAT"null,
 
                          "name": "Usage Service Type A",
  "maximum_usage_per_day": "15",
                         "description"maximum_rated_amount_per_transaction": null,
  
                         "id"maximum_usage_per_month": "819661A2C34A4BBF9005E74387CD7A401000",
                    }
       "classification": "SERVICES",        ],
                    "physical_good_type"accumulated_maximum_usage_per_day": null"100",
                        },
  "accumulated_maximum_usage_per_month": "1000",
                     "accumulated_maximum_rated_amount_per_daymonth": null, "1000",
                "currency":
           "service": null,    {
                    "maximum_usage_per_transactionsuffix_symbol": "10"null,
                        "maximum_rated_amount_per_monthprefix_symbol": null"\u20ac",

                       "maximumdecimal_usagepart_per_dayname": "15",
   null,
                    "maximum_rated_amount_per_transactioncode": null,
   "EUR",
                    "maximuminteger_usagepart_per_monthname": "1000"null,
                    }"id": "2"
                ]},
                "accumulated_maximum_maximumrated_usageamount_per_day": "100",
                "accumulated_maximum_usage_per_monthtransaction": "1000", null
            },
            "accumulatedcredit_maximum_rated_amount_per_monthlimit_status": "1000NOT_EXCEEDED",

               "currency"credit_rating":
                {
                    "suffix_symbol"code": null,
   "AAA",
                "prefix_symbolname": "\u20ac",key_aaa_-_subject_to_minimal_credit_risk"
            },
            "decimal_part_name": null,
       "ACR0000012378",
            "codeoutstanding_amount": "EUR",0,
            "udf_string_6": null,
            "integerudf_partstring_name7": null,
      
             "idaccounting_period": "2"null,
            "access_tokens_set":
   },         [
       "accumulated_maximum_rated_amount_per_day": "100",    ],
            "accumulatedudf_maximum_usage_per_transactionstring_8": null
        },
   },     "status":
       "credit_limit_status": "NOT_EXCEEDED", {
            "credit_ratingcode":  "OK",
          {    "description": "",
            "codemessage": "AAA",
        }
    }


"name": "key_aaa_-_subject_to_minimal_credit_risk"
            },
            "name": "ACR0000012378",
            "outstanding_amount": 0,
            "udf_string_6": null,

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
"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": {
        "udfcredit_string_7period": null,{
            "accountingcredit_period_operator": null"SPECIFIC_PERIOD",
            "access_tokens_setcredit_period_after_x_months": 2,
           [
            ] "credit_period_setting": "ON_THE_XTH_DAY",
            "udf_string_8credit_period_day_of_month": null4
        },
    },
    "status":
        {
   
        "code": "OK",

           "description": "",
            "message": ""
        }
    }

Versions Compared

Old Version 5

New Version Current

Key

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples