Settle Voucher

This endpoint allows you to settle a voucher by making an HTTP POST request to the specified URL.

Request Body

Param	Required	Type	Description
voucherId	Mandatory	String	The ID of the voucher to be settled.
data	Mandatory	Object	Additional data related to the voucher settlement.
type	Optional	String	The type of the voucher.
logo	Optional	String	The logo associated with the voucher.
postingTriggeredAt	Optional	Number	The timestamp when the posting was triggered.
postingErrors	Optional	String	Any errors encountered during the posting process.
postingDocNo	Optional	String	The document number generated during posting.
postingTriggered	Optional	Boolean	Indicates if posting was triggered.
postingFailed	Optional	Boolean	Indicates if the posting process failed.

Response

success (boolean): Indicates if the voucher settlement was successful.

Example

Request:

{
    "voucherId": "12345",
    "data": {},
    "type": "expense",
    "logo": "logo.png",
    "postingTriggeredAt": 1629878400,
    "postingErrors": "",
    "postingDocNo": "",
    "postingTriggered": true,
    "postingFailed": true
}

Response:

{
    "success": true
}

### Settle Voucher This endpoint allows you to settle a voucher by making an HTTP POST request to the specified URL. #### Request Body | Param | Required | Type | Description | | --- | --- | --- | --- | | voucherId | Mandatory | String | The ID of the voucher to be settled. | | data | Mandatory | Object | Additional data related to the voucher settlement. | | type | Optional | String | The type of the voucher. | | logo | Optional | String | The logo associated with the voucher. | | postingTriggeredAt | Optional | Number | The timestamp when the posting was triggered. | | postingErrors | Optional | String | Any errors encountered during the posting process. | | postingDocNo | Optional | String | The document number generated during posting. | | postingTriggered | Optional | Boolean | Indicates if posting was triggered. | | postingFailed | Optional | Boolean | Indicates if the posting process failed. | #### Response - `success` (boolean): Indicates if the voucher settlement was successful. #### Example Request: ``` { "voucherId": "12345", "data": {}, "type": "expense", "logo": "logo.png", "postingTriggeredAt": 1629878400, "postingErrors": "", "postingDocNo": "", "postingTriggered": true, "postingFailed": true } ``` Response: ``` { "success": true } ```

Request

This endpoint expects an object.

voucherIdstringRequired

dataobjectRequired

typestringRequired

logostringRequired

postingTriggeredAtintegerRequired

postingErrorsstringRequired

postingDocNostringRequired

postingTriggeredbooleanRequired

postingFailedbooleanRequired

Response

successboolean

Settle Voucher

This endpoint allows you to settle a voucher by making an HTTP POST request to the specified URL.

Request Body

Param	Required	Type	Description
voucherId	Mandatory	String	The ID of the voucher to be settled.
data	Mandatory	Object	Additional data related to the voucher settlement.
type	Optional	String	The type of the voucher.
logo	Optional	String	The logo associated with the voucher.
postingTriggeredAt	Optional	Number	The timestamp when the posting was triggered.
postingErrors	Optional	String	Any errors encountered during the posting process.
postingDocNo	Optional	String	The document number generated during posting.
postingTriggered	Optional	Boolean	Indicates if posting was triggered.
postingFailed	Optional	Boolean	Indicates if the posting process failed.

Response

success (boolean): Indicates if the voucher settlement was successful.

Example

Request:

{
    "voucherId": "12345",
    "data": {},
    "type": "expense",
    "logo": "logo.png",
    "postingTriggeredAt": 1629878400,
    "postingErrors": "",
    "postingDocNo": "",
    "postingTriggered": true,
    "postingFailed": true
}

Response:

{
    "success": true
}

$	curl -X POST https://heimdall.eka.io/apis/external/voucher/settleVoucher \
>	-H "DICE-APP-ID: {{Company Code}}" \
>	-H "X-CLIENT-ID: {{API Client ID}}" \
>	-H "X-CLIENT-SECRET: {{API Client Secret}}" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"voucherId": "V-INDIAN-000000854",
>	"data": {},
>	"type": "",
>	"logo": "",
>	"postingTriggeredAt": 0,
>	"postingErrors": "",
>	"postingDocNo": "",
>	"postingTriggered": true,
>	"postingFailed": false
>	}'

Settle Voucher

Request Body

Response

Example

Headers

Request

Response

Settle Voucher

Request Body

Response

Example