Skip to navigation
Dice Standardized APIs V2 CopyVoucher

Settle Voucher

View as Markdown

Settle Voucher

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

Request Body

ParamRequiredTypeDescription
voucherIdMandatoryStringThe ID of the voucher to be settled.
dataMandatoryObjectAdditional data related to the voucher settlement.
typeOptionalStringThe type of the voucher.
logoOptionalStringThe logo associated with the voucher.
postingTriggeredAtOptionalNumberThe timestamp when the posting was triggered.
postingErrorsOptionalStringAny errors encountered during the posting process.
postingDocNoOptionalStringThe document number generated during posting.
postingTriggeredOptionalBooleanIndicates if posting was triggered.
postingFailedOptionalBooleanIndicates 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
}

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Request

This endpoint expects an object.
voucherIdstringRequired
dataobjectRequired
typestringRequired
postingTriggeredAtintegerRequired
postingErrorsstringRequired
postingDocNostringRequired
postingTriggeredbooleanRequired
postingFailedbooleanRequired

Response

OK
successboolean