Versions Compared

Key

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

Available from CRM.COM R6.0.0

Table of Contents
maxLevel2

...

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

...

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

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

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

...

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

...

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

...

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

...

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

...

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

...

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

 

Response:

Code Block
theme
 

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:
Confluence

 

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

 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

...

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

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

 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:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "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"
    }
  ]
}