| Table of Contents | ||
|---|---|---|
|
GET refunds/show
This method returns information related with a refund. A single refund is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Refund identifier
The identifier of the refund that should be returned as a result. The allowed refund 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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET refunds/list
This method returns information related with refunds. Multiple refunds are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
type_identifier
(optional)
...
The financial transaction type of the refund that should be returned as a result. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST refunds/create
This method is creating a new refund either in Draft or Posted state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(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:
...
type_identifier
(mandatory)
...
The financial transaction type of the refund . The allowed financial transaction type identifier field are the following:
...
life_cycle_state
(mandatory)
...
The state of the retrieved refund which can be one of the following:
DRAFT, POSTED
...
refund_method_identifier
(optional)
...
The refund method of the refund. If not specified then the refund method which is specified as the default on the selected refund type is applied. The allowed refund method identifier fields are the following:
...
| Tip |
|---|
...
refund_amount
(mandatory)
...
intended_currency_identifier
(optional)
...
The currency that the user was intended to use for the refund. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
...
| Tip |
|---|
...
category_identifier
(optional)
...
The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
accounts_receivable_payment_preference_identifier
(mandatory on conditions)
...
The accounts receivable payment preferences that will be used by generic payment gateways to process the refund. The specified accounts receivable payment preferences should belong to the specified accounts receivable. This information is applicable and mandatory only if the refund will be processed by a generic payment gateway, as denoted by the selected refund method. The allowed accounts receivable payment preference identifier fields are the following:
...
| Tip |
|---|
...
notes
(optional)
...
back_office_code
(optional)
...
A back office code for the refund. If specified then it should be unique
| Tip |
|---|
...
issue_on
(optional)
...
issue_reason
(optional)
...
udf_string_1
(optional)
...
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
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"accounts_receivable_identifier":{"number":"192"},
"type_identifier":{"name":"Broken Item Refund"},
"life_cycle_state":"POSTED",
"refund_amount":"150",
"category_identifier":{"name":"Broken Item Refund"},
"issue_reason":"Item was broken.",
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2014-07-15T15:59:18",
"life_cycle_state": "POSTED",
"number": "19",
"id": "308883971F72E715FC64D005FF0C9B1F",
"reference_number": "27",
"posted_on": "2014-07-15T15:59:18",
"refund_amount": 150
}
} |
POST refunds/post
This method is used to post a refund which is in draft state.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Refund identifier
The identifier of the refund that should be returned as a result. The allowed refund 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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"refund_identifier":{"reference_number":"54"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2015-02-02T12:40:14",
"life_cycle_state": "POSTED",
"number": "24",
"id": "85EEB0CD1DB6A8CF299A035079576A94",
"reference_number": "54",
"posted_on": "2015-02-02T12:42:11",
"refund_amount": 20
}
} |
POST refunds/reject
This method is used to reject a refund which is in draft state.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Refund identifier
The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:
...
The reason that the refund is rejected. The allowed rejection reason 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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"refund_identifier":{"reference_number":"29"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2014-07-15T16:01:24",
"life_cycle_state": "REJECTED",
"number": null,
"id": "0FAE4317E8E46BC90490E7A031CE723A",
"reference_number": "29",
"posted_on": null,
"refund_amount": 150
}
} |
POST refunds/update
| Tip |
|---|
Available from CRM.COM R9.1.0 |
This method is updating a single Refund but only as long as it is in Draft life cycle state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
refund_identifier
(mandatory)
...
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:
...
(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:
...
type_identifier
(optional)
...
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:
...
refund_amount
(optional)
...
intended_currency_identifier
(optional)
...
The currency that the user was intended to use for the refund. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
...
| Tip |
|---|
...
category_identifier
(optional)
...
The financial transaction category of the refund that should be updated. The allowed financial transaction category identifier fields are the following:
...
notes
(optional)
...
back_office_code
(optional)
...
A back office code for the refund. If specified then it should be unique
...
issued_on
(optional)
...
issue_reason
(optional)
...
udf_string_1
(optional)
...
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
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|