Change Return Status Event
Cette page est en cours de traduction. Elle sera mise à jour dès que son contenu sera disponible en français.
The Change Return Status Event is sent when the return status of a return is changed following a manual or automatic modification.
Here are the different properties provided in the generic data object for this event:
|
Property |
Type |
Description |
|
documentId |
String |
GUID of the document for which the action has been triggered. |
|
returnId |
Integer |
Id of the taxpayer for this return.
|
|
returnStatusId |
String |
GUID of the return status that was successfully applied. |
|
returnStatus |
String |
Name of the return status that was successfully applied. |
Here is an example of a request body for a return status changed to Completed:
Copier
{
"id": "3a10ca54-1033-744c-add6-6a14c143aeb7",
"createdAt": "2025-07-07T14:14:14Z",
"event": "ChangeReturnStatusEvent",
"product": "T1",
"productYear": 2024,
"data": {
"returnId": 0,
"returnStatusId": "a4511cf6-1a4c-21ab-c1d0-a144217ac111",
"returnStatusName": "Completed",
"documentId": "a1422ab7-2c3a-11ac-b0f1-a256674af177"
}
}