Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Bookkeeping APIs – ...
  10. API: Delete Journal

API: Delete Journal

The purpose of this API is to delete an existing journal.

Request

API Name DeleteJournal
URL https://your_account.modulus.biz/api/bk/v1/DeleteJournal?token=YOUR_TOKEN&journal_id=YOU_JOURNAL_ID
Method DELETE
Source Third Party Server
Recipient modulus® Server
Content Type application/json

URL Parameters

Parameter Required Type Description
token Yes Text Your authentication token.
journal_id Yes Number Has to be initially created by the same integration app, and status is either pending or review.

Responses

HTTP Status result title message object
Success Responses
200 OK true Success Journal deleted successfully. 
{
    "deleted_journal_id": xxx,
    "deleted_date_time": "yyy-mm-dd hh:MM:ss"
}
Failure Responses
400 Bad Request false Bad Request Error message as elaborated here. 
{
    "error_code": xxx
}

Error code as elaborated here.
500 Internal Server Error false Internal Server Error Error message as elaborated here. 
{
    "error_code": xxx
}

Error code as elaborated here.

Example 1

Request 
curl --request DELETE 'https://your_account.modulus.biz/api/bk/v1/DeleteJournal?token=6eeed540c8cf01b8f68b38f5b9e0289b&journal_id=3400'
200 OK 
{
    "result": true,
    "title": "Success",
    "message": "Journal deleted successfully.",
    "object": {
        "deleted_journal_id": 3400,
        "deleted_date_time": "2021-01-14 20:39:57"
    }
}

Example 2

Request 
curl --request DELETE 'https://your_account.modulus.biz/api/bk/v1/DeleteJournal?token=ddd871b104153e1da4c10713ec691d77&journal_id=3434453456'
400 Bad Request 
{
    "result": false,
    "title": "Bad Request",
    "message": "Invalid journal ID parameter.",
    "object": {
        "error_code": 1237
    }
}