Versions Compared

Key

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

...

...

...

...

...

...


Excerpt

This method is used to reject an invoice which is in draft state.

...

Name

Type

Description

token

String

The token retrieved from the login method

invoice_identifier

(mandatory)

Invoice identifier  

The identifier of the invoice that should be rejected. The allowed invoice identifier fields are the following:

Include Page
V4:invoice_identifier
V4:invoice_identifier

rejection_reason_identifier

(optional)

Rejection reason identifier

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

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
language
languagejavascript
themeConfluence
javascriptlinenumberstrue
{
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"invoice_identifier":{"reference_number":"559"},
	"rejection_reason_identifier":{"name":"Reject Due to Business Request"}
}


Response:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount": 57,
        "issued_on": "2014-11-07T11:38:48",
        "life_cycle_state": "REJECTED",
        "unsettled_amount": 0,
        "number": "I00000519",
        "due_on": "2014-11-10T15:49:59",
        "id": "7968903798226F14CB73E59E2DD8712B",
        "outstanding_amount": 0,
        "reference_number": "559",
        "posted_on": "2014-11-07T11:45:41"
    }
}


...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"{{token}}",
    "invoice_identifier":{"reference_number":"541"},
    "rejection_reason_identifier":{"name":"Reject Due to Error"}
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "data": {
    "posted_on": "2016-04-14T06:43:24",
    "number": "542",
    "total_amount": 100,
    "unsettled_amount": 0,
    "issued_on": "2016-04-15T00:00:00",
    "currency_rate_period": null,
    "id": "01A75EF631294253B24B2401CA65F15D",
    "life_cycle_state": "REJECTED",
    "outstanding_amount": 0,
    "reference_number": "541",
    "due_on": "2016-04-16T06:43:24"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...