Skip to navigation

Update Invoice Attr

View as Markdown

Update Invoice Attr

This API use to update invoice details.

API endpoint allow user to update invoice attributes by sending an HTTP POST request to the specified URL. The request should include the invoice ID, data, type, logo, posting triggered timestamp, posting errors, posting document number, and posting status flags.

Request Body

ParamRequiredTypeDescription
invoiceIdMandatoryStringThe ID of the invoice to be updated.
dataMandatoryObjectThe updated data for the invoice.
typeOptionalStringThe type of the invoice.
logoOptionalStringThe logo associated with the invoice.
postingTriggeredAtOptionalTimestampTimestamp indicating when the posting was triggered.
postingErrorsOptionalStringAny errors that occurred during posting.
postingDocNoOptionalStringThe document number generated during posting.
postingTriggeredOptionalBooleanBoolean flag indicating if posting was triggered.
postingFailedOptionalBooleanBoolean flag indicating if posting failed.
postingSyncedOptionalBooleanBoolean flag indicating if posting was synced.

Response

Upon successful execution, the API returns a JSON object with a success key, indicating whether the update was successful.

Example 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.
invoiceIdstringRequired
dataobjectRequired
typestringRequired
postingTriggeredAtintegerRequired
postingErrorsstringRequired
postingDocNostringRequired
postingTriggeredbooleanRequired
postingFailedbooleanRequired
postingSyncedbooleanRequired

Response

OK
successboolean