Update Credit Note Config | DICE

Update Credit Note Configuration

This endpoint allows you to update the configuration of a credit note by sending a POST request. The request requires a payload that includes various attributes related to the credit note, such as its ID, associated data, and status flags for posting and payment processes.

Request Body

The request body must be in JSON format and should contain the following parameters:

creditNoteId (string): The unique identifier for the credit note.
data (object): An object containing additional data related to the credit note.
type (string): The type of the credit note.
logo (string): A logo associated with the credit note.
postingTriggeredAt (integer): A timestamp indicating when posting was triggered.
paymentTriggeredAt (integer): A timestamp indicating when payment was triggered.
postingErrors (string): Any errors that occurred during posting.
paymentErrors (string): Any errors that occurred during payment.
postingDocNo (string): The document number associated with posting.
paymentDocNo (string): The document number associated with payment.
paymentUtr (string): The UTR number for the payment.
postingTriggered (boolean): A flag indicating if posting has been triggered.
paymentTriggered (boolean): A flag indicating if payment has been triggered.
postingFailed (boolean): A flag indicating if posting has failed.
paymentFailed (boolean): A flag indicating if payment has failed.
postingSynced (boolean): A flag indicating if posting has been synced.
paymentSynced (boolean): A flag indicating if payment has been synced.

Example Request Body

1 {
2   "creditNoteId": "CN-INDIAN-000000162",
3   "data": {
4     "Dummy data key": "Dummy data value"
5   },
6   "type": "Dummy type",
7   "logo": "Dummy logo",
8   "postingTriggeredAt": 1011,
9   "paymentTriggeredAt": 1013,
10   "postingErrors": "Nil",
11   "paymentErrors": "Nil",
12   "postingDocNo": "Sample postingDocNo",
13   "paymentDocNo": "Sample paymentDocNo",
14   "paymentUtr": "Sample paymentUtr",
15   "postingTriggered": true,
16   "paymentTriggered": true,
17   "postingFailed": false,
18   "paymentFailed": false,
19   "postingSynced": true,
20   "paymentSynced": true
21 }

Response

On a successful request, the API will respond with a JSON object indicating the success of the operation:

1 {
2   "success": true
3 }

This endpoint allows you to update the configuration settings for a specific credit note using its unique identifier. The request requires a JSON payload containing various parameters related to the credit note configuration.

Request

Method: POST
Endpoint: {{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig

Request Body:

1 {
2   "creditNoteId": "",
3   "data": {},
4   "type": "",
5   "logo": "",
6   "postingTriggeredAt": 0,
7   "paymentTriggeredAt": 0,
8   "postingErrors": "",
9   "paymentErrors": "",
10   "postingDocNo": "",
11   "paymentDocNo": "",
12   "paymentUtr": "",
13   "postingTriggered": false,
14   "paymentTriggered": false,
15   "postingFailed": false,
16   "paymentFailed": false,
17   "postingSynced": false,
18   "paymentSynced": false
19 }

Parameters

creditNoteId (string): The unique identifier for the credit note.
data (object): Additional data related to the credit note configuration.
type (string): The type of credit note.
logo (string): URL or path to the logo associated with the credit note.
postingTriggeredAt (integer): Timestamp for when posting was triggered.
paymentTriggeredAt (integer): Timestamp for when payment was triggered.
postingErrors (string): Any errors encountered during posting.
paymentErrors (string): Any errors encountered during payment.
postingDocNo (string): Document number associated with posting.
paymentDocNo (string): Document number associated with payment.
paymentUtr (string): Unique transaction reference for payment.
postingTriggered (boolean): Indicates if posting was triggered.
paymentTriggered (boolean): Indicates if payment was triggered.
postingFailed (boolean): Indicates if posting failed.
paymentFailed (boolean): Indicates if payment failed.
postingSynced (boolean): Indicates if posting is synced.
paymentSynced (boolean): Indicates if payment is synced.

Response

The response will indicate the success of the operation.

Example Response:

1 {
2   "success": true
3 }

This response confirms that the credit note configuration update was successful.

This endpoint allows you to update the configuration settings for a specific credit note. It is designed to handle various parameters related to the credit note and its associated posting and payment processes.

HTTP Method

POST

Endpoint

{{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig

Request Body Parameters

The request body should be in JSON format and include the following parameters:

creditNoteId (string): The unique identifier for the credit note that you wish to update.
data (object): A JSON object containing additional configuration data related to the credit note.
type (string): The type of credit note being updated.
logo (string): A URL or identifier for the logo associated with the credit note.
postingTriggeredAt (integer): A timestamp indicating when the posting was triggered.
paymentTriggeredAt (integer): A timestamp indicating when the payment was triggered.
postingErrors (string): Any errors encountered during the posting process.
paymentErrors (string): Any errors encountered during the payment process.
postingDocNo (string): The document number associated with the posting.
paymentDocNo (string): The document number associated with the payment.
paymentUtr (string): The Unique Transaction Reference for the payment.
postingTriggered (boolean): Indicates whether the posting has been triggered.
paymentTriggered (boolean): Indicates whether the payment has been triggered.
postingFailed (boolean): Indicates whether the posting has failed.
paymentFailed (boolean): Indicates whether the payment has failed.
postingSynced (boolean): Indicates whether the posting has been synced.
paymentSynced (boolean): Indicates whether the payment has been synced.

Expected Response

On a successful request, the API will return a JSON object indicating the success of the operation:

1 {
2   "success": true
3 }

This response confirms that the credit note configuration has been updated successfully.

## Update Credit Note Configuration This endpoint allows you to update the configuration of a credit note by sending a POST request. The request requires a payload that includes various attributes related to the credit note, such as its ID, associated data, and status flags for posting and payment processes. ### Request Body The request body must be in JSON format and should contain the following parameters: - `creditNoteId` (string): The unique identifier for the credit note. - `data` (object): An object containing additional data related to the credit note. - `type` (string): The type of the credit note. - `logo` (string): A logo associated with the credit note. - `postingTriggeredAt` (integer): A timestamp indicating when posting was triggered. - `paymentTriggeredAt` (integer): A timestamp indicating when payment was triggered. - `postingErrors` (string): Any errors that occurred during posting. - `paymentErrors` (string): Any errors that occurred during payment. - `postingDocNo` (string): The document number associated with posting. - `paymentDocNo` (string): The document number associated with payment. - `paymentUtr` (string): The UTR number for the payment. - `postingTriggered` (boolean): A flag indicating if posting has been triggered. - `paymentTriggered` (boolean): A flag indicating if payment has been triggered. - `postingFailed` (boolean): A flag indicating if posting has failed. - `paymentFailed` (boolean): A flag indicating if payment has failed. - `postingSynced` (boolean): A flag indicating if posting has been synced. - `paymentSynced` (boolean): A flag indicating if payment has been synced. ### Example Request Body ``` json { "creditNoteId": "CN-INDIAN-000000162", "data": { "Dummy data key": "Dummy data value" }, "type": "Dummy type", "logo": "Dummy logo", "postingTriggeredAt": 1011, "paymentTriggeredAt": 1013, "postingErrors": "Nil", "paymentErrors": "Nil", "postingDocNo": "Sample postingDocNo", "paymentDocNo": "Sample paymentDocNo", "paymentUtr": "Sample paymentUtr", "postingTriggered": true, "paymentTriggered": true, "postingFailed": false, "paymentFailed": false, "postingSynced": true, "paymentSynced": true } ``` ### Response On a successful request, the API will respond with a JSON object indicating the success of the operation: ``` json { "success": true } ``` This endpoint allows you to update the configuration settings for a specific credit note using its unique identifier. The request requires a JSON payload containing various parameters related to the credit note configuration. ### Request **Method:** POST **Endpoint:** `{{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig` **Request Body:** ``` json { "creditNoteId": "", "data": {}, "type": "", "logo": "", "postingTriggeredAt": 0, "paymentTriggeredAt": 0, "postingErrors": "", "paymentErrors": "", "postingDocNo": "", "paymentDocNo": "", "paymentUtr": "", "postingTriggered": false, "paymentTriggered": false, "postingFailed": false, "paymentFailed": false, "postingSynced": false, "paymentSynced": false } ``` ### Parameters - **creditNoteId** (string): The unique identifier for the credit note. - **data** (object): Additional data related to the credit note configuration. - **type** (string): The type of credit note. - **logo** (string): URL or path to the logo associated with the credit note. - **postingTriggeredAt** (integer): Timestamp for when posting was triggered. - **paymentTriggeredAt** (integer): Timestamp for when payment was triggered. - **postingErrors** (string): Any errors encountered during posting. - **paymentErrors** (string): Any errors encountered during payment. - **postingDocNo** (string): Document number associated with posting. - **paymentDocNo** (string): Document number associated with payment. - **paymentUtr** (string): Unique transaction reference for payment. - **postingTriggered** (boolean): Indicates if posting was triggered. - **paymentTriggered** (boolean): Indicates if payment was triggered. - **postingFailed** (boolean): Indicates if posting failed. - **paymentFailed** (boolean): Indicates if payment failed. - **postingSynced** (boolean): Indicates if posting is synced. - **paymentSynced** (boolean): Indicates if payment is synced. ### Response The response will indicate the success of the operation. **Example Response:** ``` json { "success": true } ``` This response confirms that the credit note configuration update was successful. This endpoint allows you to update the configuration settings for a specific credit note. It is designed to handle various parameters related to the credit note and its associated posting and payment processes. #### HTTP Method `POST` #### Endpoint `{{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig` #### Request Body Parameters The request body should be in JSON format and include the following parameters: - **creditNoteId** (string): The unique identifier for the credit note that you wish to update. - **data** (object): A JSON object containing additional configuration data related to the credit note. - **type** (string): The type of credit note being updated. - **logo** (string): A URL or identifier for the logo associated with the credit note. - **postingTriggeredAt** (integer): A timestamp indicating when the posting was triggered. - **paymentTriggeredAt** (integer): A timestamp indicating when the payment was triggered. - **postingErrors** (string): Any errors encountered during the posting process. - **paymentErrors** (string): Any errors encountered during the payment process. - **postingDocNo** (string): The document number associated with the posting. - **paymentDocNo** (string): The document number associated with the payment. - **paymentUtr** (string): The Unique Transaction Reference for the payment. - **postingTriggered** (boolean): Indicates whether the posting has been triggered. - **paymentTriggered** (boolean): Indicates whether the payment has been triggered. - **postingFailed** (boolean): Indicates whether the posting has failed. - **paymentFailed** (boolean): Indicates whether the payment has failed. - **postingSynced** (boolean): Indicates whether the posting has been synced. - **paymentSynced** (boolean): Indicates whether the payment has been synced. #### Expected Response On a successful request, the API will return a JSON object indicating the success of the operation: ``` json { "success": true } ``` This response confirms that the credit note configuration has been updated successfully.

Request

This endpoint expects an object.

creditNoteIdstringRequired

dataobjectRequired

typestringRequired

logostringRequired

postingTriggeredAtintegerRequired

paymentTriggeredAtintegerRequired

postingErrorsstringRequired

paymentErrorsstringRequired

postingDocNostringRequired

paymentDocNostringRequired

paymentUtrstringRequired

postingTriggeredbooleanRequired

paymentTriggeredbooleanRequired

postingFailedbooleanRequired

paymentFailedbooleanRequired

postingSyncedbooleanRequired

paymentSyncedbooleanRequired

Response

successboolean

Update Credit Note Configuration

Request Body

The request body must be in JSON format and should contain the following parameters:

creditNoteId (string): The unique identifier for the credit note.
data (object): An object containing additional data related to the credit note.
type (string): The type of the credit note.
logo (string): A logo associated with the credit note.
postingTriggeredAt (integer): A timestamp indicating when posting was triggered.
paymentTriggeredAt (integer): A timestamp indicating when payment was triggered.
postingErrors (string): Any errors that occurred during posting.
paymentErrors (string): Any errors that occurred during payment.
postingDocNo (string): The document number associated with posting.
paymentDocNo (string): The document number associated with payment.
paymentUtr (string): The UTR number for the payment.
postingTriggered (boolean): A flag indicating if posting has been triggered.
paymentTriggered (boolean): A flag indicating if payment has been triggered.
postingFailed (boolean): A flag indicating if posting has failed.
paymentFailed (boolean): A flag indicating if payment has failed.
postingSynced (boolean): A flag indicating if posting has been synced.
paymentSynced (boolean): A flag indicating if payment has been synced.

Example Request Body

1 {
2   "creditNoteId": "CN-INDIAN-000000162",
3   "data": {
4     "Dummy data key": "Dummy data value"
5   },
6   "type": "Dummy type",
7   "logo": "Dummy logo",
8   "postingTriggeredAt": 1011,
9   "paymentTriggeredAt": 1013,
10   "postingErrors": "Nil",
11   "paymentErrors": "Nil",
12   "postingDocNo": "Sample postingDocNo",
13   "paymentDocNo": "Sample paymentDocNo",
14   "paymentUtr": "Sample paymentUtr",
15   "postingTriggered": true,
16   "paymentTriggered": true,
17   "postingFailed": false,
18   "paymentFailed": false,
19   "postingSynced": true,
20   "paymentSynced": true
21 }

Response

On a successful request, the API will respond with a JSON object indicating the success of the operation:

1 {
2   "success": true
3 }

Request

Method: POST
Endpoint: {{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig

Request Body:

1 {
2   "creditNoteId": "",
3   "data": {},
4   "type": "",
5   "logo": "",
6   "postingTriggeredAt": 0,
7   "paymentTriggeredAt": 0,
8   "postingErrors": "",
9   "paymentErrors": "",
10   "postingDocNo": "",
11   "paymentDocNo": "",
12   "paymentUtr": "",
13   "postingTriggered": false,
14   "paymentTriggered": false,
15   "postingFailed": false,
16   "paymentFailed": false,
17   "postingSynced": false,
18   "paymentSynced": false
19 }

Parameters

creditNoteId (string): The unique identifier for the credit note.
data (object): Additional data related to the credit note configuration.
type (string): The type of credit note.
logo (string): URL or path to the logo associated with the credit note.
postingTriggeredAt (integer): Timestamp for when posting was triggered.
paymentTriggeredAt (integer): Timestamp for when payment was triggered.
postingErrors (string): Any errors encountered during posting.
paymentErrors (string): Any errors encountered during payment.
postingDocNo (string): Document number associated with posting.
paymentDocNo (string): Document number associated with payment.
paymentUtr (string): Unique transaction reference for payment.
postingTriggered (boolean): Indicates if posting was triggered.
paymentTriggered (boolean): Indicates if payment was triggered.
postingFailed (boolean): Indicates if posting failed.
paymentFailed (boolean): Indicates if payment failed.
postingSynced (boolean): Indicates if posting is synced.
paymentSynced (boolean): Indicates if payment is synced.

Response

The response will indicate the success of the operation.

Example Response:

1 {
2   "success": true
3 }

This response confirms that the credit note configuration update was successful.

HTTP Method

POST

Endpoint

{{host}}/apis/external/vendor/creditNote/updateCreditNoteConfig

Request Body Parameters

The request body should be in JSON format and include the following parameters:

creditNoteId (string): The unique identifier for the credit note that you wish to update.
data (object): A JSON object containing additional configuration data related to the credit note.
type (string): The type of credit note being updated.
logo (string): A URL or identifier for the logo associated with the credit note.
postingTriggeredAt (integer): A timestamp indicating when the posting was triggered.
paymentTriggeredAt (integer): A timestamp indicating when the payment was triggered.
postingErrors (string): Any errors encountered during the posting process.
paymentErrors (string): Any errors encountered during the payment process.
postingDocNo (string): The document number associated with the posting.
paymentDocNo (string): The document number associated with the payment.
paymentUtr (string): The Unique Transaction Reference for the payment.
postingTriggered (boolean): Indicates whether the posting has been triggered.
paymentTriggered (boolean): Indicates whether the payment has been triggered.
postingFailed (boolean): Indicates whether the posting has failed.
paymentFailed (boolean): Indicates whether the payment has failed.
postingSynced (boolean): Indicates whether the posting has been synced.
paymentSynced (boolean): Indicates whether the payment has been synced.

Expected Response

On a successful request, the API will return a JSON object indicating the success of the operation:

1 {
2   "success": true
3 }

This response confirms that the credit note configuration has been updated successfully.

1	{
2	"creditNoteId": "CN-INDIAN-000000162",
3	"data": {
4	"Dummy data key": "Dummy data value"
5	},
6	"type": "Dummy type",
7	"logo": "Dummy logo",
8	"postingTriggeredAt": 1011,
9	"paymentTriggeredAt": 1013,
10	"postingErrors": "Nil",
11	"paymentErrors": "Nil",
12	"postingDocNo": "Sample postingDocNo",
13	"paymentDocNo": "Sample paymentDocNo",
14	"paymentUtr": "Sample paymentUtr",
15	"postingTriggered": true,
16	"paymentTriggered": true,
17	"postingFailed": false,
18	"paymentFailed": false,
19	"postingSynced": true,
20	"paymentSynced": true
21	}

1	{
2	"creditNoteId": "",
3	"data": {},
4	"type": "",
5	"logo": "",
6	"postingTriggeredAt": 0,
7	"paymentTriggeredAt": 0,
8	"postingErrors": "",
9	"paymentErrors": "",
10	"postingDocNo": "",
11	"paymentDocNo": "",
12	"paymentUtr": "",
13	"postingTriggered": false,
14	"paymentTriggered": false,
15	"postingFailed": false,
16	"paymentFailed": false,
17	"postingSynced": false,
18	"paymentSynced": false
19	}

Update Credit Note Configuration

Request Body

Example Request Body

Response

Request

Parameters

Response

HTTP Method

Endpoint

Request Body Parameters

Expected Response

Headers

Request

Response

Update Credit Note Configuration

Request Body

Example Request Body

Response

Request

Parameters

Response

HTTP Method

Endpoint

Request Body Parameters

Expected Response