Page Comparison

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

refund_identifier

(mandatory)

Refund identifier

The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:

Include Page

	V4:refund_identifier
	V4:refund_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

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the refund that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the refund that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_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

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the refund should be allocated to. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the refund . The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

life_cycle_state

(mandatory)

String

The state of the retrieved refund which can be one of the following:

DRAFT, POSTED

refund_amount

(mandatory)

Number

The amount of the refund

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

notes

(optional)

String

Shared notes for the refund

back_office_code

(optional)

String

A back office code for the refund. If specified then it should be unique

Tip
Available from CRM.COM R9.1.0

issue_on

(optional)

Date

The date on which the refund is issued

issue_reason

(optional)

String

A description of the reason that the refund is issued

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

refund_identifier

(mandatory)

Refund identifier

The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:

Include Page

	V4:refund_identifier
	V4:refund_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

refund_identifier

(mandatory)

Refund identifier

The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:

Include Page

	V4:refund_identifier
	V4:refund_identifier

rejection_reason_identifier

Rejection reason identifier

The reason that the refund is rejected. The allowed rejection reason identifier fields are the following:

Include Page

	V4:financial_transaction_rejection_reason_identifier
	V4:financial_transaction_rejection_reason_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

refund_identifier

(mandatory)

Refund identifier

The identifier of the refund that should be updated. Only refunds in draft state can be specified.The allowed refund identifier fields are the following:

Include Page

	V4:refund_identifier
	V4:refund_identifier

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the updated accounts receivable to which the refund should be allocated to. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the refund. Only financial transaction types with classification Refund can be specified. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

refund_amount

(optional)

Number

The amount of the refund

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the refund that should be updated. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

notes

(optional)

String

Shared notes for the refund

back_office_code

(optional)

String

A back office code for the refund. If specified then it should be unique

issued_on

(optional)

Date

The date on which the refund was issued

issue_reason

(optional)

String

A description of the reason that the refund is issued

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
 "token":"134273A5D8B341BB82E8060C4E97CECB",
  "refund_identifier":{"reference_number":"51"},
   "accounts_receivable_identifier":{"name":"Jessie03 "},
    "type_identifier":{"name":"Refund 2"},
   "category_identifier":{"code":"RC"},
   "refund_amount":20,
   "back_office_code":"REF000001",
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "notes": null,
    "udf_float_1": 10,
    "udf_float_2": 20,
    "udf_float_3": 30,
    "number": null,
    "udf_float_4": 40,
    "udf_string_1": "udf string 1",
    "udf_string_2": "udf string 2",
    "udf_string_3": "udf string 3",
    "udf_string_4": "udf string 4",
    "udf_string_5": "udf string 5",
    "udf_string_6": "udf string 6",
    "udf_string_7": "udf string 7",
    "udf_string_8": "udf string 8",
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Pickman",
        "middle_name": "Li",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mr",
        "first_name": "Jessie",
        "type": "PERSON",
        "id": "F9A629E466B1EF473CECD46F2A4D63F3",
        "name": null,
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          },
          "social_security_number": "434567",
          "passport_number": "54567432",
          "country_of_residence": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          },
          "name_day": {
            "month": 4,
            "day": 2
          },
          "date_of_birth": {
            "month": 11,
            "day": 1,
            "year": 1988
          },
          "id_number": "983452",
          "id_issued_by_country": {
            "three_character_code": "USA",
            "two_character_code": "US",
            "id": "127",
            "name": "UNITED STATES",
            "alternative_code": null
          }
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "173",
      "id": "6991CE48FA587DF10ADCE6F436647749",
      "name": "Jessie03"
    },
    "issued_reason": null,
    "id": "573F6D322CEB439B8D642ECC9FB3B7C4",
    "posted_on": null,
    "udf_date_1": "2014-05-05T15:49:59",
    "udf_date_2": "2014-06-05T15:49:59",
    "udf_date_3": "2014-07-05T15:49:59",
    "udf_date_4": "2014-08-05T15:49:59",
    "log_information": {
      "updated_date": "2016-05-04T12:13:28",
      "created_date": "2015-04-08T08:53:58",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "issued_on": "2015-04-08T08:53:58",
    "life_cycle_state": "DRAFT",
    "back_office_code": "REF000001",
    "rejection_reason": null,
    "type": {
      "classification": "REFUND",
      "id": "B496E67C8C89CB35BF6C37EF78CD6BA0",
      "name": "Refund 2",
      "description": "Refund 2",
      "alternative_code": "R2"
    },
    "reference_number": "51",
    "category": {
      "id": "945C6EEBC85130C0CC92B550D22946EC",
      "name": "Refund Categories",
      "description": "Refund Categories",
      "code": "RC"
    },
    "refund_amount": 20
  }
}

Versions Compared

Old Version 12

New Version 13

Key