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

...

HTTP Method: GET

Request:

Response:

...

...

GET refunds/show

This method returns information related with a refund.  A single refund is returned by each call

Resource URL

Parameters

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

{
    "status":
    {
        "idmessage": "C32C494AD42A5B1AFE3B205BF9D37CBA"null,
        "posted_ondescription": "2014-07-15T15:44:50"null,
        "udf_date_1code": null,"OK"
    },
    "udf_date_2data": null,
    {
        "udf_datefloat_31": null,
        "udf_datefloat_42": null,
        "logudf_float_information3": null,
       { "number": "17",
          "updatedudf_float_date4": "2014-07-15T15:44:50",
null,
           "createdudf_bystring_unit1": null,
        "udf_string_2": null,
 {          "udf_string_3": null,
        "communityudf_string_name4": "Main Community"null,
        "udf_string_5": null,
        "groupudf_string_name6": "Main Group",null,
        "udf_string_7": null,
        "nameudf_string_8": "Admin Unit"null,
           "accounts_receivable":
    "id": "48305F8849E3C18B227C5BE3A27BA6DF",   {
             "descriptionaccount_owner":
"r1",            {
    "alternative_code": "MG"           "last_name":  },"Johnson",
                "createdmiddle_datename": "2014-07-15T15:44:19",null,
                "updatedcompany_by_unitprofile": null,
            {     "type": "PERSON",
                "communityfirst_name": "Main CommunityPeter",
                "group_name": "Main Group"null,
                "nameid": "Admin UnitC73D1572FEA76C37A08945ECE4DECC98",
                "idcompany_name": "48305F8849E3C18B227C5BE3A27BA6DF"null,
                "descriptiondemographics":
"r1",                {
       "alternative_code": "MG"             }"gender": "MALE",
            "created_by_user":        "passport_issued_by_country": null,
   {                 "personpassport_namenumber": "JackH7839023",
                "username    "social_security_number": "JackH98374",
                "id    "date_of_birth":
 "B8650C555C4EA8C741103961276E7773",                 "email": "j_hadjicosti@crm.com" {
           },             "updated_by_usermonth": 4,
             {           "day": 6,
    "person_name": "JackH",                    "usernameyear": "JackH", 1985
                   "id": "B8650C555C4EA8C741103961276E7773" },
                "email":    "jname_hadjicosti@crm.comday":
            }        {
},         "issued_on": "2014-07-15T15:44:19",               "life_cycle_statemonth": "POSTED",6,
             "back_office_code": null,           "issued_reasononday": "Item was broken",29
         "rejection_reason": null,         "type": },
       {             "classificationid_number": "REFUND984783",
            "name": "Broken Item Refund",      "industry": null
              "id": "09A6B916D5B222FEB54DEEC12F2A6FE9", }
           "description": null},
            "alternativelife_cycle_codestate": "BRITREFACTIVE",
        },         "reference_number": "25192",
        "category":    "name": "Peter Johnson Premium",
 {             "nameid": "2C5FC6F615FA9E798487AC0C293ECCE6"Broken
   Item Refund",    },
        "id": "3D5A60B6CB4E8B4316686A2FFB859FFFC32C494AD42A5B1AFE3B205BF9D37CBA",
            "description"posted_on": "Broken Item Refund","2014-07-15T15:44:50",
        "udf_date_1": null,
        "udf_date_2": null,
     "code   "udf_date_3": null,
"RC3"         }"udf_date_4": null,
        "refundlog_amountinformation":
      80  {
  }
}

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:

...

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

{
    "status          "updated_date": "2014-07-15T15:44:50",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-07-15T15:44:19",
            "updated_by_unit":
    {        {
"message": null,         "description      "community_name": null"Main Community",
        "code        "group_name": "OKMain Group",
    },     "data":     [  "name": "Admin Unit",
    {             "life_cycle_stateid": "POSTED48305F8849E3C18B227C5BE3A27BA6DF",
                "iddescription": "C32C494AD42A5B1AFE3B205BF9D37CBAr1",
                "referencealternative_numbercode": "25MG"

       },     },
   {             "life_cycle_statecreated_by_user":
            {
                "person_name": "POSTEDJackH",
                "idusername": "52A51D5B6C3090EE083690C9C799842EJackH",
            "reference_number    "id": "26B8650C555C4EA8C741103961276E7773",
        }        ]
}

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_amount

(mandatory)

...

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:

...

notes

(optional)

...

back_office_code

(optional)

...

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

...

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

"email": "j_hadjicosti@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "JackH",
                "username": "JackH",
                "id": "B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            }
        },
        "issued_on": "2014-07-15T15:44:19",
        "life_cycle_state": "POSTED",
        "back_office_code": null,
        "issued_reasonon": "Item was broken",
        "rejection_reason": null,
        "type":
        {
            "classification": "REFUND",
            "name": "Broken Item Refund",
            "id": "09A6B916D5B222FEB54DEEC12F2A6FE9",
            "description": null,
            "alternative_code": "BRITREF"
        },
        "reference_number": "25",
        "category":
        {
            "name": "Broken Item Refund",
            "id": "3D5A60B6CB4E8B4316686A2FFB859FFF",
            "description": "Broken Item Refund",
            "code": "RC3"
        },
        "refund_amount": 80
    }
}

GET refunds/list

This method returns information related with refunds. Multiple refunds are returned by each call

Resource URL

Parameters

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

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "life_cycle_state": "POSTED",
            "id": "C32C494AD42A5B1AFE3B205BF9D37CBA",
            "reference_number": "25"
        },
        {
            "life_cycle_state": "POSTED",
            "id": "52A51D5B6C3090EE083690C9C799842E",
            "reference_number": "26"
        }
    ]
}

POST refunds/create

This method is creating a new refund either in Draft or Posted state

Resource URL

Parameters

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

{
	"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.",
}

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

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

{
	"token": "E78968BE92E02C3FCCD2D671B9772EF9",
	"refund_identifier":{"reference_number":"54"},
}

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

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

{
	"token": "E78968BE92E02C3FCCD2D671B9772EF9",
	"categoryrefund_identifier":{"namereference_number":"Broken Item Refund29"},
	"issuerejection_reason_identifier":{"name":"Item was broken."Reject Due to Business Request"},
}

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "issued_on": "2014-07-15T1515T16:5901:1824",
        "life_cycle_state": "POSTEDREJECTED",
        "number": "19"null,
        "id": "308883971F72E715FC64D005FF0C9B1F0FAE4317E8E46BC90490E7A031CE723A",
        "reference_number": "27",
        "posted_on": "2014-07-15T15:59:18": "29",
        "refundposted_amounton": 150null,
     }
}

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:

...

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

...

HTTP Method: POST

Request:

Body:

{
	"token": "E78968BE92E02C3FCCD2D671B9772EF9",
	"refund_identifier":{"reference_number":"54"},
}

Response:

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

...

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

{
	"token": "E78968BE92E02C3FCCD2D671B9772EF9",
	"refund_identifier":{"reference_number":"29"},
	"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
}

{
    "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
    }
}   "refund_amount": 150
    }
}

POST refunds/update

This method is creating a new refund either in Draft or Posted state

Resource URL

Parameters

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