Versions Compared

Old Version 19

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 20

changes.mady.by.user Former user

Saved on

Key

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

Available from CRM.COM R6.0.0

...

Tip

Available from CRM.COM R6.0.0

Table of Contents
maxLevel2

GET accounts_receivable/configuration/payment_preferences/list

...

Name

Type

Description

token

String

The token retrieved from the login method

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

...

Resource URL

Parameters

group

The identifier of the unit that will be providing the presentment preference. The unit is filtered against the presentment preference allowed organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

token

String

The token retrieved from the login method

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the presentment preference. The group is filtered against the presentment preference allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Group Unit Identifier

The identifier of the group unit that will be providing the presentment preference. The group unit is filtered against the presentment preference allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifierV4:group_identifier

unit_identifier

(optional)

Unit Identifier
Include Page
V4:unit_identifierV4:unit_identifier

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

Response Data

...

Examples

...

titleExample 1

HTTP Method: GET

 

Request:

Response:

 

...

themeConfluence
languagejavascript
linenumberstrue

...

allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

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

Response Data

Include Page
V4:presentment_preferences_complete
V4:presentment_preferences_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "state": "ACTIVE",
            "type": "CUSTOM1",
            "name": "Face 2 Face",
            "id": "630EB1D7AEA66353A8D82B061A05201D",
            "messagedescription": null,
            "description"contact_information":
            {
                "last_name": null,"Georgiou",
            "code    "life_cycle_state": "OKFINANCIAL",
                "middle_name": null,
  },     "data":     [    "company_profile": null,
   {             "defaulttitle": true"Miss",
                "statetype": "ACTIVEPERSON",
                "typefirst_name": "CUSTOM1Michalis1",
                "name": "FaceMichalis1 2 FaceGeorgiou",
                "id": "630EB1D7AEA66353A8D82B061A05201D02B4928EE8C9A170F888264D686927DD",
            "description    "company_name": null,
                "contact_informationdemographics":
                {
                    "last_namegender": "GeorgiouFEMALE",
                "life_cycle_state    "passport_issued_by_country": "FINANCIAL"null,
                    "middlepassport_namenumber": null, "123456789",
                    "companysocial_security_profilenumber": null"45545123",
                "title": "Miss",      "country_of_residence":
          "type": "PERSON",          {
      "first_name": "Michalis1",                 "name": "Michalis1KINGS GeorgiouLANDING",
                "id": "02B4928EE8C9A170F888264D686927DD",       "id": "DE15"
        "company_name": null,           },
     "demographics":                 {"industry_sector": null,
                    "genderdate_of_birth":
 "FEMALE",                   {
 "passport_issued_by_country": null,                       "passport_numbermonth": "123456789"null,
                    "social_security_number    "day": "45545123"null,
                     "country_of_residence   "year": null
                   {   },
                     "name_day":
 "KINGS LANDING",                  {
      "id": "DE15"                 "month": null,
  },                      "industry_sectorday": null,
                    "date_of_birth":},
                    {
"id_number": "454545",
                       "month"id_issued_by_country": null,
                    "industry": null
  "day": null,              }
            },
"year": null           "alternative_code": "F2F"
        },
        {
            "name_daydefault": false,
            "state": "ACTIVE",
     {         "type": "EMAIL",
               "monthname": "By nullEmail",
            "id": "06A57761BCC28FA9687C57321F2BEB28",
            "daydescription": null,
            "contact_information":
        },    {
                "idlast_numbername": "454545Lannister",
   
                "idlife_issuedcycle_by_countrystate": null"FINANCIAL",
                "middle_name": null,
   "industry": null             "company_profile": null,
         }       "title": "Mr",
    },             "alternative_codetype": "F2FPERSON",
         },       "first_name": "Marios",
   {             "defaultname": false,"Marios Lannister",
                "stateid": "ACTIVEF60EF6A65658F86B3DFADA3809BD85C4",
                "typecompany_name": "EMAIL"null,
                "namedemographics": "By Email",
                {
      "id": "06A57761BCC28FA9687C57321F2BEB28",             "descriptiongender": null"MALE",
            "contact_information":        "passport_issued_by_country": null,
   {                 "lastpassport_namenumber": "Lannister"null,
                    "lifesocial_cyclesecurity_statenumber": "FINANCIAL"null,
                "middle_name    "country_of_residence":
null,                 "company_profile": null,  {
              "title": "Mr",         "name": "CAMEROON",
      "type": "PERSON",                 "first_nameid": "Marios164",
                  "name": "Marios Lannister"},
                "id    "industry_sector": "F60EF6A65658F86B3DFADA3809BD85C4"null,
                "company_name": null,
            "date_of_birth":
       "demographics":             {
   {                     "gendermonth": "MALE",5,
                        "passport_issued_by_countryday": null1,
                        "passport_numberyear": null,1963
                    "social_security_number": null},
                    "countryname_of_residenceday":
                    {
                        "namemonth": "CAMEROON"5,
                        "idday": "164"1
                    },
                    "industryid_sectornumber": null"593664",
                    "dateid_issued_ofby_birthcountry":
                    {
                        "monthname": 5,
                        "day": 1"CYPRUS",
                        "yearid": 1963"181"
                    },
                    "name_dayindustry": null
                }
  {          },
             "alternative_code": "month": 5,BE"
        },
        {
            "daydefault": 1false,
            "state": "ACTIVE",
      },      "type": "CUSTOM1",
             "id_numbername": "593664mayTest",
            "id": "AD0799F85430C0EF89E6D820D81AF50F",
            "id_issued_by_countrydescription": null,
             "contact_information":
     {        {
                "last_name": "CYPRUSMay",
                  "life_cycle_state": "FINANCIAL",
                "idmiddle_name": "181Alan",
                "company_profile": null,
    },            "title": "Mr",
        "industry": null       "type": "PERSON",
        }        "first_name": "Michael",
   },             "alternative_codename": "BE"Michael May",
          },      "id": "22AD2164CE074EB60ECFD5F3F9A55E2D",
   {             "defaultcompany_name": falsenull,
            "state": "ACTIVE",   "demographics":
         "type": "CUSTOM1",      {
      "name": "mayTest",             "idgender": "AD0799F85430C0EF89E6D820D81AF50FMALE",
  
         "description": null,             "contact_informationpassport_issued_by_country":

           {         {
       "last_name": "May",                 "life_cycle_statename": "FINANCIALUNITED KINGDOM",
                "middle_name": "Alan",       "id": "126"
        "company_profile": null,           },
     "title": "Mr",                 "type"passport_number": "PERSON123456",
                    "firstsocial_security_namenumber": "Michael654321",
                "name    "country_of_residence":
"Michael May",                 "id": "22AD2164CE074EB60ECFD5F3F9A55E2D", {
               "company_name": null,        "name": "CYPRUS",
       "demographics":                 {
"id": "181"
                   "gender": "MALE" },
                    "passport_issued_by_countryindustry_sector":
                    {
                        "name": "UNITED KINGDOMFINANCIALS",
                        "id": "12603EA93890F51506ABD9E994CD826EC78",
                    },
    "alternative_code": "FIN"
                   "passport_number": "123456" },
                    "socialdate_securityof_numberbirth": "654321",
                    {
    "country_of_residence":                     {"month": 5,
                        "nameday": "CYPRUS"30,
                        "idyear": "181"1983
                    },
                    "industryname_sectorday":
                    {
                        "namemonth": "FINANCIALS"11,
                        "idday": "03EA93890F51506ABD9E994CD826EC78",7
                        "alternative_code": "FIN"},
                      }"id_number": "868561",
                    "dateid_issued_ofby_birthcountry":
                    {
                        "monthname": 5"UNITED KINGDOM",
                        "dayid": 30, "126"
                    },
                    "yearindustry": 1983
                    {
             },           "name": "IndustryTest",
        "name_day":                "id": "D65E1F283AE9FED5A572F817DE23EDD1",
   {                     "code": "IndTest"
  "month": 11,                 }
       "day": 7        }
            },
            "alternative_code": "MT"
       "id_number": "868561", },
        {
            "id_issued_by_countrydefault": false,
            "state": "ACTIVE",
     {          "type": "SMS",
              "name": "UNITEDBy KINGDOMSMS",
            "id": "03C42DEB72334FBFF653A158B3305152",
            "iddescription": "126"null,
            "contact_information":
        },    {
                "industrylast_name": "Georgiou",
                "life_cycle_state": "FINANCIAL",
 {               "middle_name": null,
        "name": "IndustryTest",       "company_profile": null,
                "idtitle": "D65E1F283AE9FED5A572F817DE23EDD1Miss",
                "type": "PERSON",
      "code": "IndTest"         "first_name": "Michalis1",
          }      "name": "Michalis1 Georgiou",
        }        "id": "02B4928EE8C9A170F888264D686927DD",
   },             "alternativecompany_codename": "MT"null,
        },         {
  "demographics":
         "default": false,        {
      "state": "ACTIVE",             "typegender": "SMSFEMALE",
             "name": "By SMS",     "passport_issued_by_country": null,
      "id": "03C42DEB72334FBFF653A158B3305152",             "descriptionpassport_number": null"123456789",
            "contact_information":        "social_security_number": "45545123",
   {                 "lastcountry_of_nameresidence":
"Georgiou",                 "life_cycle_state": "FINANCIAL",  {
              "middle_name": null,         "name": "KINGS LANDING",
     "company_profile": null,                   "titleid": "MissDE15",
                   "type": "PERSON", },
                    "firstindustry_namesector": "Michalis1",null,
                    "namedate_of_birth": "Michalis1 Georgiou",
                    {
      "id": "02B4928EE8C9A170F888264D686927DD",                 "company_namemonth": null,
                "demographics":            "day": null,
    {                     "genderyear": "FEMALE",null
                    "passport_issued_by_country": null},
                    "passportname_numberday": "123456789",
                    "social_security_number": "45545123",{
                        "country_of_residencemonth": null,
                   {     "day": null
                  "name": "KINGS LANDING",
   },
                    "id_number": "DE15454545",
                    } "id_issued_by_country": null,
                    "industry_sector": null,
                }
           "date_of_birth":
 },
            "alternative_code": "BS"
     {   },
        {
            "monthdefault": nullfalse,
            "state": "ACTIVE",
            "daytype": null"SMS",
            "name": "By SMS1",
            "yearid": null"FF4B64B413EC1EE42D4CF560DBFFB896",
            "description": null,
      },      "contact_information": null,
             "namealternative_daycode": "BS1"
        },
        {
 {           "default": false,
            "monthstate": null"ACTIVE",
            "type": "CUSTOM1",
            "dayname": "Face to nullface 1",
            "id": "7A169C5EA0DF3CFF1AE1A0D28079A692",
     },       "description": null,
            "idcontact_numberinformation": "454545"null,
            "alternative_code": "f2f1"
      "id_issued_by_country": null,  },
        {
            "industrydefault": nullfalse,
              "state": "ACTIVE",
 }             }"type": "POST",
            "alternative_codename": "BStoTestRestrictions",
            },"id": "E67E535FA0A566B7D6E97C53B64E274A",
            {"description": null,
            "defaultcontact_information":
  false,          {
  "state": "ACTIVE",             "typelast_name": "SMSHadjicosti",
              "name  "life_cycle_state": "By SMS1MARKETING",
                "idmiddle_name": "FF4B64B413EC1EE42D4CF560DBFFB896Something",
            "description": null,    "company_profile": null,
                "contact_informationtitle": null,
            "alternative_code    "type": "BS1PERSON",
            },    "first_name": "Jack",
   {             "defaultname": false,"Jack Hadjicosti",
                "stateid": "ACTIVE824D021B7EB8FEFFC8844EEE9E708951",
             "type   "company_name": "CUSTOM1"null,
            "name": "Face to face 1"demographics",:
            "id": "7A169C5EA0DF3CFF1AE1A0D28079A692",   {
         "description": null,
            "contact_informationgender": null,
            "alternative_code": "f2f1"         },
"passport_issued_by_country": null,
       {             "defaultpassport_number": falsenull,
              "state": "ACTIVE",     "social_security_number": null,
      "type": "POST",             "namecountry_of_residence": "toTestRestrictions"null,
            "id": "E67E535FA0A566B7D6E97C53B64E274A",       "industry_sector": null,
      "description": null,             "contactdate_of_informationbirth":
            {        {
        "last_name": "Hadjicosti",                 "life_cycle_state"month": "MARKETING"null,
                "middle_name": "Something",          "day": null,
      "company_profile": null,                 "titleyear": null,
                   "type": "PERSON" },
                    "firstname_nameday":
"Jack",                 "name": "Jack Hadjicosti", {
               "id": "824D021B7EB8FEFFC8844EEE9E708951",        "month": null,
       "company_name": null,                 "demographicsday": null
                    {},
                    "genderid_number": null"654321",
                    "passportid_issued_by_country": null,
                    "passport_numberindustry": null,
                }
   "social_security_number": null,        },
            "countryalternative_of_residencecode": null,
     "ttr"
        }
      "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
          ]
}

GET accounts_receivable/configuration/classifications/list

This method returns the classifications that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple classifications are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the classification. The group is filtered against the classifications' allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the classifications. The unit is filtered against the classifications' allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

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

Response Data

Include Page
V4:classifications_complete
V4:classifications_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
             "monthmessage": null,
           "description": null,
            "daycode": null"OK"
    },
    "data":
    [
     },   {
                 "id_number"default": "654321",
       true,
            "id_issued_by_countryname": null,
    "Account Class1",
               "industryid": null
                } "C44FE706153511DF368C9BCEFBC3AF39",
             }"description": "desc",
            "alternative_code": "ttrAC1"
        },
       ]
}

GET accounts_receivable/configuration/classifications/list

This method returns the classifications that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple classifications are returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

group_identifier

(optional)

...

The identifier of the group that will be providing the classification. The group is filtered against the classifications' allowed organisational units. The allowed group identifier fields are the following:

...

unit_identifier

(optional)

...

The identifier of the unit that will be providing the classifications. The unit is filtered against the classifications' allowed organisational units. The allowed unit identifier fields are the following:

...

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    { {
            "default": false,
            "name": "Bad Debtor",
            "id": "57F0EB5645AC9E3D8A622ADE666A57F3",
            "description": "Have History of more than 3 overdue bills",
            "alternative_code": "BD"
        },
        {
            "default": false,
            "messagename": null,"Standard Customer",
            "descriptionid": null"DE3DC5FD43B51C09F7E0573B845ABE08",
            "codedescription": "Standard "OK"Customer",
       },     "dataalternative_code": "SA"
        [},
        {
            "default": truefalse,
            "name": "AccountPremium Class1Customer",
            "id": "C44FE706153511DF368C9BCEFBC3AF393E09F9BCD54109F3F66A91F1E8450109",
            "description": "descPremium Customer",
            "alternative_code": "AC1PC"
        },
        {
            "default": false,
            "name": "Bad DebtorEmployee",
            "id": "57F0EB5645AC9E3D8A622ADE666A57F3428C4DD5F04EE657E7F627D854334694",
            "description": "Have History of more than 3 overdue billsEmployee",
            "alternative_code": "BDE"
        },
        {
            "default": false,
            "name": "Standard CustomerLouciatest",
            "id": "DE3DC5FD43B51C09F7E0573B845ABE08E4E7E76B32DEA28566B934881180290E",
            "description": "Standard Customer"null,
            "alternative_code": "SAtest"
        },
        {
            "default": false,
            "name": "Premium CustomerLuciaTest4",
            "id": "3E09F9BCD54109F3F66A91F1E845010954C07E41E53FABF9706D19785E7FF3DD",
            "description": "Premium Customer"null,
            "alternative_code": "PC"
 "Lt4"
        },
        {
            "default": false,
       },     "name":    {"VIP Customer",
            "defaultid": false"DD764F3EB0334FC857F8BE5DD4CB41E1",
            "namedescription": "EmployeeVIP Customer",
            "idalternative_code": "428C4DD5F04EE657E7F627D854334694VC",
        }
     "description": "Employee",
            "alternative_code": "E"
        },
        {
            "default": false,
            "name": "Louciatest",
            "id": "E4E7E76B32DEA28566B934881180290E",
            "description": null,
            "alternative_code": "test"
        },
        {
   ]
}

GET accounts_receivable/configuration/banks/list

This method returns the banks that are allowed to be used in the system, as specified in the active accounts receivable definition. Note that banks can be used in payment preferences, only if the selected payment preference is of type direct debit. Multiple banks are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Include Page
V4:banks_complete
V4:banks_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "defaultdescription": falsenull,
  
         "namecode": "LuciaTest4OK",
       },
    "iddata":
"54C07E41E53FABF9706D19785E7FF3DD",    [
        "description": null,
{
            "alternativebank_branches_codeset":
"Lt4"         },   [
     {           {
 "default": false,             "name": "VIP Customer",
            "idname": "DD764F3EB0334FC857F8BE5DD4CB41E1laiki 1",
      
     "description": "VIP Customer",             "alternative_codeid": "VC5B410756A58A97832F333E4153850AF4",
           }     ]
}

GET accounts_receivable/configuration/banks/list

This method returns the banks that are allowed to be used in the system, as specified in the active accounts receivable definition. Note that banks can be used in payment preferences, only if the selected payment preference is of type direct debit. Multiple banks are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {    "description": null,
                    "alternative_code": "1"
                },
                {
                    "name": "laiki 2",
                    "id": "DDA4D4240B4694A7C401EFF2A7D7D4CE",
                    "description": null,
                    "alternative_code": "2"
                }
            ],
            "messagename": "Laiki nullBank",
            "descriptionid": null,"26E4307E2DCA062A5877BF3A9BC1369D",
            "codedescription": "OKLaiki Bank",
    },        "dataalternative_code": "LB"
   [     },
        {
            "bank_branches_set":
            [
                {
                    "name": "laiki BOC 13",
                    "id": "5B410756A58A97832F333E4153850AF49F1E3ADDC484B3CA1DFC5C64CF2627F8",
                    "description": null,
                    "alternative_code": "1 B3"
                },
                {
                    "name": "laiki BOC 21",
                    "id": "DDA4D4240B4694A7C401EFF2A7D7D4CE7559D997AD2DA661F2FC3AFE90257F79",
                    "description": null,
                    "alternative_code": "2B1"
                },
            ],      {
      "name": "Laiki Bank",
            "idname": "26E4307E2DCA062A5877BF3A9BC1369D BOC 2",
                    "descriptionid": "Laiki Bank53321CDD52CE3A125E9277E55BB302C7",
            "alternative_code": "LB"         },
"description": null,
       {             "bankalternative_branches_setcode": "B2"
             [   }
            ],
{            "name": "Bank of Cyprus",
     "name       "id": "A5B487FA26F43959188DB9584D2522D5" BOC 3",,
            "description": "Bank of  Cyprus",
            "idalternative_code": "9F1E3ADDC484B3CA1DFC5C64CF2627F8BOC",
        }
           "description": null,
                    "alternative_code": " B3"
                },
                {
                    "name": " BOC 1",
                    "id": "7559D997AD2DA661F2FC3AFE90257F79",
                    "description": null,
           ]
}

GET accounts_receivable/configuration/bank_account_types/list

This method returns the bank account types that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple bank account types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Include Page
V4:bank_account_types_complete
V4:bank_account_types_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "alternative_codemessage": "B1" null,
        "description": null,
        },
"code": "OK"
    },
    "data":
    [
{        {
            "name": "Basic BOCChecking 2Account",
       
            "id": "53321CDD52CE3A125E9277E55BB302C7D8B407BE7C18713201DD2FBA65A90EF0",
 
                  "description": null,"Basic Checking  Account",
                 "alternative_code": "B2"
       BCA"
        },
         {
  ],             "name": "BankSavings of CyprusAccount",
            "id": "A5B487FA26F43959188DB9584D2522D5249CEEE1901507788DF83C8758E4716E",
            "description": "BankSavings of CyprusAccount3232e",
            "alternative_code": "BOCSA"
        }
    ]
}

GET accounts_receivable/configuration/

...

credit_

...

ratings/list

This method returns the bank account types credit ratings that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple bank account types credit ratings are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Include Page
V4:bankcredit_accountratings_types_complete
V4:bankcredit_account_typesratings_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "namedefault": "Basic Checking Account"false,
            "idcredit_limit_type": "D8B407BE7C18713201DD2FBA65A90EF0USER_DEFINED",
            "descriptionlabel": "BasicVery Low CheckingCredit AccountRisk",
            "alternative_codename": "BCA"AA - Financial obligations are subject to very low }credit risk",
        {    "code": "AA"
       "name": "Savings Account"},
        {
   "id": "249CEEE1901507788DF83C8758E4716E",
            "descriptiondefault": "Savings Account3232e"false,
            "alternativecredit_limit_codetype": "SAUSER_DEFINED",
        }     ]
}

GET accounts_receivable/configuration/credit_ratings/list

This method returns the credit ratings that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple credit ratings are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    { "label": "Low Credit Risk",
            "name": "A - Financial obligations are subject to low credit risk",
            "code": "A"
        },
        {
            "default": false,
            "credit_limit_type": "USER_DEFINED",
            "messagelabel": null, "Minimal Credit Risk",
            "descriptionname": null, "AAA - Financial obligations at minimal credit risk",
            "code": "OKAAA"
        },
    "data":    {
     [         {"default": true,
            "defaultcredit_limit_amount": false500,
            "credit_limit_type": "USERNUMERIC_DEFINEDVALUE",
            "label": "Very LowModerate Credit Risk",
            "name": "AABAA - Financial obligations are subject to very lowmoderate credit risk",
            "code": "AABAA"
        },
        {
            "default": false,
            "credit_limit_amount": 300,
            "credit_limit_type": "USERNUMERIC_DEFINEDVALUE",
            "label": "LowHigh Credit Risk",
            "name": "AB - Financial obligations are subject to lowhigh credit risk",
            "code": "AB"
        },
        {
            "default": false,
            "credit_limit_amount": 200,
            "credit_limit_type": "USERNUMERIC_DEFINEDVALUE",
            "label": "MinimalVery High Credit Risk",
            "name": "AAACAA - Financial obligations at minimalare subject to very high credit risk",
            "code": "AAACAA"
        },
        {
            "default": true,
            "credit_limit_amount": 500,
            "credit_limit_type": "NUMERIC_VALUE",
            "label": "Moderate Credit Risk",
            "name": "BAA - Financial obligations are subject to moderate credit risk",
            "code": "BAA"
        },
        {
            "default": false,
            "credit_limit_amount": 300,
            "credit_limit_type": "NUMERIC_VALUE",
            "label": "High Credit Risk",
            "name": "B - Financial obligations are subject to high credit risk",
            "code": "B"
        },
        {
            "default": false,
            "credit_limit_amount": 200,
            "credit_limit_type": "NUMERIC_VALUE",
            "label": "Very High Credit Risk",
            "name": "CAA - Financial obligations are subject to very high credit risk",
            "code": "CAA"
        }
    ]
} ]
}

GET accounts_receivable/configuration/payment_medium_brands/list

Tip

Available from CRM.COM R10.0.0

This method returns the payment medium brands that are allowed to be used by payments of a specific type. Multiple payment medium brands are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

payment_medium_brand_identifier

(mandatory)

Payment Medium Brand Identifier

The identifier of the brand of the payment medium that will be using the customer event. The allowed payment medium brand identifier fields are the following:

Include Page
V4:payment_medium_brand_identifier
V4:payment_medium_brand_identifier

 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

Response Data

Include Page
V4:payment_medium_brand_complete
V4:payment_medium_brand_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

 

GET accounts_receivable/configuration/payment_medium_types/list

Tip

Available from CRM.COM R10.0.0

This method returns the payment medium types that are allowed to be used by payments of a specific type. Multiple payment medium types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

payment_medium_type_identifier

(mandatory)

Payment Medium Type Identifier

The identifier of the type of the payment medium that will be using the customer event. The allowed payment medium type identifier fields are the following:

Include Page
V4:payment_medium_type_identifier
V4:payment_medium_type_identifier

 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

Response Data

Include Page
V4:payment_medium_type_complete
V4:payment_medium_type_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response: