Tip
Available from CRM.COM R6.0.0

Table of Contents

maxLevel	2

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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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)

...

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:

...

unit_identifier

(optional)

...

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:

...

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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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)

...

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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

...

Examples

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" } ] }

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 19

New Version Current

Key

GET accounts_receivable/configuration/payment_preferences/list

Resource URL

Parameters

Response Data

Examples

GET accounts_receivable/configuration/presentment_preferences/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/classifications/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/banks/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/bank_account_types/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/credit_ratings/list

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 19

New Version Current

Key

GET accounts_receivable/configuration/payment_preferences/list

Resource URL

Parameters

Response Data

Examples

GET accounts_receivable/configuration/presentment_preferences/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/classifications/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/banks/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/bank_account_types/list

Parameters

Response Data

Examples

GET accounts_receivable/configuration/credit_ratings/list

Parameters

Response Data

Examples