Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Georgia Kountouri

Saved on

Key

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

...

...

...

...

...


Excerpt

This method is used to reject a credit note which is in draft state.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

credit_note_identifier

(mandatory)

Credit note identifier  

The identifier of the credit note that should be posted. Only credit notes in draft state can be specified.The allowed credit note identifier fields are the following:

Include Page
V4:credit_note_identifier
V4:credit_note_identifier

rejection_reason_identifier

(optional)

Rejection reason identifier

The reason that the credit note 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

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.

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"credit_note_identifier":{"reference_number":"119"},
	"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount": 18,
        "issued_on": "2014-07-14T14:28:51",
        "life_cycle_state": "REJECTED",
        "number": null,
        "id": "FFB55C221FE17BF201AEAF2E5A504E94",
        "reference_number": "119",
        "posted_on": null
    }
}


...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "token":"{{token}}",
    "credit_note_identifier":{"reference_number":"39"},
    "rejection_reason_identifier":{"name":"Reject Due to Error"}
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "data": {
    "posted_on": null,
    "number": null,
    "total_amount": null,
    "issued_on": "2016-07-05T15:08:48",
    "currency_rate_period": null,
    "id": "DDF96980E8B5427BB63133FA6B1574E1",
    "life_cycle_state": "REJECTED",
    "reference_number": "39"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...