Available from CRM.COM R6.0.0

GET accounts_receivable/configuration/payment_preferences/list

This method returns the payment preferences that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple payment preferences 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

Name	Type	Description
id	String	The id of the retrieved payment preference
name	String	The name of the retrieved payment preference
alternative_code	String	The alternative code of the retrieved payment preference
type	Sting	The type of the payment preference, such as DIRECT_DEBIT, STRIPE_PAYMENT_GATEWAY, PAYPAL_PAYMENT_GATEWAY, BRAINTREE_PAYMENT_GATEWAY GENERIC_PAYMENT_GATEWAY, CUSTOM_PAYMENT_GATEWAY, WALLET, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5 BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0
description	Sting	The description of the retrieved payment preference
default	Boolean	It determines if the presentment payment is set as the default in the accounts receivable definition

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "Bitcoin",
            "id": "CE63B8EB21357E21EDCCC9D3283ABBF6",
            "description": null,
            "alternative_code": "BTC"
        },
        {
            "default": true,
            "type": "DIRECT_DEBIT",
            "name": "Direct Debit Payment",
            "id": "3810C9BF3F92876803441E2EE0D8451A",
            "description": null,
            "alternative_code": "DDP"
        },
        {
            "default": false,
            "type": "OTHER",
            "name": "Other",
            "id": "93B637021350715FD1A6BCBBAE1259CA",
            "description": null,
            "alternative_code": "CASH"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "Bank Transfer Payment",
            "id": "0135CB827A97DC1ECDA7EEA993A8ED09",
            "description": "Bank Transfer Payment",
            "alternative_code": "BTP"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "PayPal",
            "id": "99900EE62E8049E226C317F9B25C35EC",
            "description": null,
            "alternative_code": "PP"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "G.N",
            "id": "AA26876BA4DD67142250843E3A360439",
            "description": null,
            "alternative_code": "G.N"
        },
        {
            "default": false,
            "type": "STRIPE_PAYMENT_GATEWAY",
            "name": "Stripe Payment Gateway",
            "id": "E7758C9A298EB68C993D2F0AEEE326F6",
            "description": null,
            "alternative_code": "SPG"
        }
    ]
}

GET accounts_receivable/configuration/presentment_preferences/list

This method returns the presentment preferences that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple presentment preferences 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 presentment preference. The group is filtered against the presentment preference allowed organisational units. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit Identifier

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

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

Name	Type	Description
id	String	The id of the retrieved presentment preference
name	String	The name of the retrieved presentment preference
alternative_code	String	The alternative code of the retrieved presentment preference
type	Sting	The presentment method type which can be one of the following: POST, EMAIL, SMS, F2F, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5
state	String	The state of the presentment preference, which can be ACTIVE or INACTIVE
description	String	A description of the presentment preference
default	Boolean	It determines if the presentment preference is set as the default in the accounts receivable definition
contact_information	Contact Information Object	The contact information related with the retrieved presentment preference

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "state": "ACTIVE",
            "type": "CUSTOM1",
            "name": "Face 2 Face",
            "id": "630EB1D7AEA66353A8D82B061A05201D",
            "description": null,
            "contact_information":
            {
                "last_name": "Georgiou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Miss",
                "type": "PERSON",
                "first_name": "Michalis1",
                "name": "Michalis1 Georgiou",
                "id": "02B4928EE8C9A170F888264D686927DD",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country": null,
                    "passport_number": "123456789",
                    "social_security_number": "45545123",
                    "country_of_residence":
                    {
                        "name": "KINGS LANDING",
                        "id": "DE15"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "454545",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "alternative_code": "F2F"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "EMAIL",
            "name": "By Email",
            "id": "06A57761BCC28FA9687C57321F2BEB28",
            "description": null,
            "contact_information":
            {
                "last_name": "Lannister",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Marios",
                "name": "Marios Lannister",
                "id": "F60EF6A65658F86B3DFADA3809BD85C4",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "country_of_residence":
                    {
                        "name": "CAMEROON",
                        "id": "164"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": 5,
                        "day": 1,
                        "year": 1963
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 1
                    },
                    "id_number": "593664",
                    "id_issued_by_country":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry": null
                }
            },
            "alternative_code": "BE"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "CUSTOM1",
            "name": "mayTest",
            "id": "AD0799F85430C0EF89E6D820D81AF50F",
            "description": null,
            "contact_information":
            {
                "last_name": "May",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Alan",
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Michael",
                "name": "Michael May",
                "id": "22AD2164CE074EB60ECFD5F3F9A55E2D",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "passport_number": "123456",
                    "social_security_number": "654321",
                    "country_of_residence":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry_sector":
                    {
                        "name": "FINANCIALS",
                        "id": "03EA93890F51506ABD9E994CD826EC78",
                        "alternative_code": "FIN"
                    },
                    "date_of_birth":
                    {
                        "month": 5,
                        "day": 30,
                        "year": 1983
                    },
                    "name_day":
                    {
                        "month": 11,
                        "day": 7
                    },
                    "id_number": "868561",
                    "id_issued_by_country":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry":
                    {
                        "name": "IndustryTest",
                        "id": "D65E1F283AE9FED5A572F817DE23EDD1",
                        "code": "IndTest"
                    }
                }
            },
            "alternative_code": "MT"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "SMS",
            "name": "By SMS",
            "id": "03C42DEB72334FBFF653A158B3305152",
            "description": null,
            "contact_information":
            {
                "last_name": "Georgiou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Miss",
                "type": "PERSON",
                "first_name": "Michalis1",
                "name": "Michalis1 Georgiou",
                "id": "02B4928EE8C9A170F888264D686927DD",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country": null,
                    "passport_number": "123456789",
                    "social_security_number": "45545123",
                    "country_of_residence":
                    {
                        "name": "KINGS LANDING",
                        "id": "DE15"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "454545",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "alternative_code": "BS"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "SMS",
            "name": "By SMS1",
            "id": "FF4B64B413EC1EE42D4CF560DBFFB896",
            "description": null,
            "contact_information": null,
            "alternative_code": "BS1"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "CUSTOM1",
            "name": "Face to face 1",
            "id": "7A169C5EA0DF3CFF1AE1A0D28079A692",
            "description": null,
            "contact_information": null,
            "alternative_code": "f2f1"
        },
        {
            "default": false,
            "state": "ACTIVE",
            "type": "POST",
            "name": "toTestRestrictions",
            "id": "E67E535FA0A566B7D6E97C53B64E274A",
            "description": null,
            "contact_information":
            {
                "last_name": "Hadjicosti",
                "life_cycle_state": "MARKETING",
                "middle_name": "Something",
                "company_profile": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Jack",
                "name": "Jack Hadjicosti",
                "id": "824D021B7EB8FEFFC8844EEE9E708951",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "country_of_residence": null,
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "654321",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "alternative_code": "ttr"
        }
    ]
}

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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

Name	Type	Description
id	String	The id of the retrieved classification
name	String	The name of the retrieved classification
alternative_code	String	The alternative code of the retrieved classification
description	Sting	The description of the retrieved classification
default	Boolean	It determines if the classification is set as the default in the active accounts receivable definition

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": true,
            "name": "Account Class1",
            "id": "C44FE706153511DF368C9BCEFBC3AF39",
            "description": "desc",
            "alternative_code": "AC1"
        },
        {
            "default": false,
            "name": "Bad Debtor",
            "id": "57F0EB5645AC9E3D8A622ADE666A57F3",
            "description": "Have History of more than 3 overdue bills",
            "alternative_code": "BD"
        },
        {
            "default": false,
            "name": "Standard Customer",
            "id": "DE3DC5FD43B51C09F7E0573B845ABE08",
            "description": "Standard Customer",
            "alternative_code": "SA"
        },
        {
            "default": false,
            "name": "Premium Customer",
            "id": "3E09F9BCD54109F3F66A91F1E8450109",
            "description": "Premium Customer",
            "alternative_code": "PC"
        },
        {
            "default": false,
            "name": "Employee",
            "id": "428C4DD5F04EE657E7F627D854334694",
            "description": "Employee",
            "alternative_code": "E"
        },
        {
            "default": false,
            "name": "Louciatest",
            "id": "E4E7E76B32DEA28566B934881180290E",
            "description": null,
            "alternative_code": "test"
        },
        {
            "default": false,
            "name": "LuciaTest4",
            "id": "54C07E41E53FABF9706D19785E7FF3DD",
            "description": null,
            "alternative_code": "Lt4"
        },
        {
            "default": false,
            "name": "VIP Customer",
            "id": "DD764F3EB0334FC857F8BE5DD4CB41E1",
            "description": "VIP Customer",
            "alternative_code": "VC"
        }
    ]
}

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

Name	Type	Description
id	String	The id of the retrieved bank
name	String	The name of the retrieved bank
alternative_code	String	The alternative code of the retrieved bank
description	String	The description of the retrieved bank
bank_branches_set	Set of Bank Branch Objects	The bank branches related with the retrieved bank

Referred Objects Response Data

bank branches referred response objet

Name	Type	Description
id	String	The id of the retrieved bank branch
name	String	The name of the retrieved bank branch
alternative_code	String	The alternative code of the retrieved bank branch
description	String	The description of the retrieved bank branch

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "bank_branches_set":
            [
                {
                    "name": "laiki 1",
                    "id": "5B410756A58A97832F333E4153850AF4",
                    "description": null,
                    "alternative_code": "1"
                },
                {
                    "name": "laiki 2",
                    "id": "DDA4D4240B4694A7C401EFF2A7D7D4CE",
                    "description": null,
                    "alternative_code": "2"
                }
            ],
            "name": "Laiki Bank",
            "id": "26E4307E2DCA062A5877BF3A9BC1369D",
            "description": "Laiki Bank",
            "alternative_code": "LB"
        },
        {
            "bank_branches_set":
            [
                {
                    "name": " BOC 3",
                    "id": "9F1E3ADDC484B3CA1DFC5C64CF2627F8",
                    "description": null,
                    "alternative_code": " B3"
                },
                {
                    "name": " BOC 1",
                    "id": "7559D997AD2DA661F2FC3AFE90257F79",
                    "description": null,
                    "alternative_code": "B1"
                },
                {
                    "name": " BOC 2",
                    "id": "53321CDD52CE3A125E9277E55BB302C7",
                    "description": null,
                    "alternative_code": "B2"
                }
            ],
            "name": "Bank of Cyprus",
            "id": "A5B487FA26F43959188DB9584D2522D5",
            "description": "Bank of Cyprus",
            "alternative_code": "BOC"
        }
    ]
}

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

Name	Type	Description
id	String	The id of the retrieved bank account type
name	String	The name of the retrieved bank account type
alternative_code	String	The alternative code of the retrieved bank account type
description	String	The description of the retrieved bank account type

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "name": "Basic Checking Account",
            "id": "D8B407BE7C18713201DD2FBA65A90EF0",
            "description": "Basic Checking Account",
            "alternative_code": "BCA"
        },
        {
            "name": "Savings Account",
            "id": "249CEEE1901507788DF83C8758E4716E",
            "description": "Savings Account3232e",
            "alternative_code": "SA"
        }
    ]
}

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

Name	Type	Description
code	String	The code of the retrieved credit rating which can be one of the following: AAA, AA, A, BAA, BA, B, CAA, CA, C
name	String	The name of the retrieved credit rating which can be one of the following: AAA - Financial Obligations at Minimal Credit Risk AA - Financial Obligations Are Subject to Very Low Credit Risk A - Financial Obligations Are Subject to Low Credit Risk BAA - Financial Obligations Are Subject to Moderate Credit Risk BA - Financial Obligations Are Subject to Substantial Credit Risk B - Financial Obligations Are Subject to High Credit Risk CAA - Financial Obligations Are Subject to Very High Credit Risk CA - Financial Obligations Are Highly Speculative and Are Likely of Some Prospect of Recovery C - Financial Obligations Are Highly Speculative and Are Likely of Little Prospect of Recovery
label	String	The label of the retrieved credit rating, as specified in the accounts receivable definition
credit_limit_type	String	The credit limit type of the retrieved credit rating, as specified in the accounts receivable definition, which can be one of the following: USER_DEFINED, NUMERIC_VALUE Deprecated from CRM.COM R11.0.0
credit_limit_amount	Number	The credit limit amount of the retrieved credit rating, as specified in the accounts receivable definition. Credit limit amount is returned in the default system currency
default	Boolean	It determines if the retrieved credit rating is set as the default in the accounts receivable definition

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "credit_limit_type": "USER_DEFINED",
            "label": "Very Low Credit Risk",
            "name": "AA - Financial obligations are subject to very low credit risk",
            "code": "AA"
        },
        {
            "default": false,
            "credit_limit_type": "USER_DEFINED",
            "label": "Low Credit Risk",
            "name": "A - Financial obligations are subject to low credit risk",
            "code": "A"
        },
        {
            "default": false,
            "credit_limit_type": "USER_DEFINED",
            "label": "Minimal Credit Risk",
            "name": "AAA - Financial obligations at minimal credit risk",
            "code": "AAA"
        },
        {
            "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

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
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

payment_medium_brand object response data

Name	Type	Description
id	String	The id of the retrieved payment medium brand
name	String	The name of the retrieved payment medium brand
alternative_code	String	The alternative code of the retrieved payment medium brand
description	String	The description of the retrieved payment medium brand

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "id": "A01DB55EE5624E80ADA3CD7AF166AF30",
      "name": "AMERICAN EXPRESS",
      "description": "Payment Medium Brand 2: American Express",
      "alternative_code": "AE"
    },
    {
      "id": "F7B18DE5D55E452C81AF6F1EAD3E934C",
      "name": "VISA",
      "description": "Payment Medium Brand 1: Visa",
      "alternative_code": "V"
    }
  ]
}

GET accounts_receivable/configuration/payment_medium_types/list

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
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

payment_medium_type object response data

Name	Type	Description
id	String	The id of the retrieved payment medium type
name	String	The name of the retrieved payment medium type
alternative_code	String	The alternative code of the retrieved payment medium type
description	String	The description of the retrieved payment medium type

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "id": "0EC912D6358341B4BAE55CFA70FE0F2D",
      "name": "Credit Card",
      "description": "Payment Medium Type 1: Credit Card",
      "alternative_code": "CC"
    },
    {
      "id": "D37196CC81CC458DB8A355055EEC7E34",
      "name": "Bank Transfer Payment",
      "description": "Payment Medium Type 2: Bank Transfer Payment",
      "alternative_code": "BTP"
    }
  ]
}