Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...


Excerpt

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:

Include Page
V4:group_identifier
V4:group_identifier

Tip

Deprecated from CRM.COM R18.0.0


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:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Deprecated from CRM.COM R18.0.0


business_unit_identifier

(optional)

Business Unit Identifier

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

Include Page
V4:business_unit_identifier
V4:business_unit_identifier

Tip

Available from CRM.COM R18.0.0


fields_set

(optional)

List of Strings, comma separated 

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

Response Data

Include Page
V4:presentment_preferences_complete
V4:presentment_preferences_complete

...

Expand
titleExample 1

HTTP Method: GET

 


Request:

Response: 


code
Code Block
language
javascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "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"
        }
    ]
}


...