> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://open-api-docs.dice.tech/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://open-api-docs.dice.tech/_mcp/server.

# Update Credit Note Config

POST https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2
Content-Type: application/json

## 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.

Reference: https://open-api-docs.dice.tech/dice-standardized-ap-is-v-2-copy/credit-note/update-credit-note-config

## Servers

- `https://heimdall.eka.io` (https://heimdall.eka.io, default)
- `https://heimdall.eka.ioapis` (https://heimdall.eka.ioapis)

## Request

### Headers

- `DICE-APP-ID` (string, optional)
- `X-CLIENT-ID` (string, optional)
- `X-CLIENT-SECRET` (string, optional)

### Body (application/json)

- `creditNoteId` (string, required)
- `data` (object, required)
- `type` (string, required)
- `logo` (string, required)
- `postingTriggeredAt` (integer, required)
- `paymentTriggeredAt` (integer, required)
- `postingErrors` (string, required)
- `paymentErrors` (string, required)
- `postingDocNo` (string, required)
- `paymentDocNo` (string, required)
- `paymentUtr` (string, required)
- `postingTriggered` (boolean, required)
- `paymentTriggered` (boolean, required)
- `postingFailed` (boolean, required)
- `paymentFailed` (boolean, required)
- `postingSynced` (boolean, required)
- `paymentSynced` (boolean, required)

## Response

### 200

OK

- `success` (boolean, required)

## Examples

**Request**

```json
{
  "creditNoteId": "",
  "type": "",
  "logo": "",
  "postingTriggeredAt": 0,
  "paymentTriggeredAt": 0,
  "postingErrors": "",
  "paymentErrors": "",
  "postingDocNo": "",
  "paymentDocNo": "",
  "paymentUtr": "",
  "postingTriggered": false,
  "paymentTriggered": false,
  "postingFailed": false,
  "paymentFailed": false,
  "postingSynced": false,
  "paymentSynced": false
}
```

**Response**

```json
{
  "success": true
}
```

**SDK Code**

```python Credit Note_Update Credit Note Config_example
import requests

url = "https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2"

payload = {
    "creditNoteId": "",
    "type": "",
    "logo": "",
    "postingTriggeredAt": 0,
    "paymentTriggeredAt": 0,
    "postingErrors": "",
    "paymentErrors": "",
    "postingDocNo": "",
    "paymentDocNo": "",
    "paymentUtr": "",
    "postingTriggered": False,
    "paymentTriggered": False,
    "postingFailed": False,
    "paymentFailed": False,
    "postingSynced": False,
    "paymentSynced": False
}
headers = {
    "DICE-APP-ID": "{{Company Code}}",
    "X-CLIENT-ID": "{{API Client ID}}",
    "X-CLIENT-SECRET": "{{API Client Secret}}",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Credit Note_Update Credit Note Config_example
const url = 'https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2';
const options = {
  method: 'POST',
  headers: {
    'DICE-APP-ID': '{{Company Code}}',
    'X-CLIENT-ID': '{{API Client ID}}',
    'X-CLIENT-SECRET': '{{API Client Secret}}',
    'Content-Type': 'application/json'
  },
  body: '{"creditNoteId":"","type":"","logo":"","postingTriggeredAt":0,"paymentTriggeredAt":0,"postingErrors":"","paymentErrors":"","postingDocNo":"","paymentDocNo":"","paymentUtr":"","postingTriggered":false,"paymentTriggered":false,"postingFailed":false,"paymentFailed":false,"postingSynced":false,"paymentSynced":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Credit Note_Update Credit Note Config_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2"

	payload := strings.NewReader("{\n  \"creditNoteId\": \"\",\n  \"type\": \"\",\n  \"logo\": \"\",\n  \"postingTriggeredAt\": 0,\n  \"paymentTriggeredAt\": 0,\n  \"postingErrors\": \"\",\n  \"paymentErrors\": \"\",\n  \"postingDocNo\": \"\",\n  \"paymentDocNo\": \"\",\n  \"paymentUtr\": \"\",\n  \"postingTriggered\": false,\n  \"paymentTriggered\": false,\n  \"postingFailed\": false,\n  \"paymentFailed\": false,\n  \"postingSynced\": false,\n  \"paymentSynced\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("DICE-APP-ID", "{{Company Code}}")
	req.Header.Add("X-CLIENT-ID", "{{API Client ID}}")
	req.Header.Add("X-CLIENT-SECRET", "{{API Client Secret}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Credit Note_Update Credit Note Config_example
require 'uri'
require 'net/http'

url = URI("https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["DICE-APP-ID"] = '{{Company Code}}'
request["X-CLIENT-ID"] = '{{API Client ID}}'
request["X-CLIENT-SECRET"] = '{{API Client Secret}}'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"creditNoteId\": \"\",\n  \"type\": \"\",\n  \"logo\": \"\",\n  \"postingTriggeredAt\": 0,\n  \"paymentTriggeredAt\": 0,\n  \"postingErrors\": \"\",\n  \"paymentErrors\": \"\",\n  \"postingDocNo\": \"\",\n  \"paymentDocNo\": \"\",\n  \"paymentUtr\": \"\",\n  \"postingTriggered\": false,\n  \"paymentTriggered\": false,\n  \"postingFailed\": false,\n  \"paymentFailed\": false,\n  \"postingSynced\": false,\n  \"paymentSynced\": false\n}"

response = http.request(request)
puts response.read_body
```

```java Credit Note_Update Credit Note Config_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2")
  .header("DICE-APP-ID", "{{Company Code}}")
  .header("X-CLIENT-ID", "{{API Client ID}}")
  .header("X-CLIENT-SECRET", "{{API Client Secret}}")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditNoteId\": \"\",\n  \"type\": \"\",\n  \"logo\": \"\",\n  \"postingTriggeredAt\": 0,\n  \"paymentTriggeredAt\": 0,\n  \"postingErrors\": \"\",\n  \"paymentErrors\": \"\",\n  \"postingDocNo\": \"\",\n  \"paymentDocNo\": \"\",\n  \"paymentUtr\": \"\",\n  \"postingTriggered\": false,\n  \"paymentTriggered\": false,\n  \"postingFailed\": false,\n  \"paymentFailed\": false,\n  \"postingSynced\": false,\n  \"paymentSynced\": false\n}")
  .asString();
```

```php Credit Note_Update Credit Note Config_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2', [
  'body' => '{
  "creditNoteId": "",
  "type": "",
  "logo": "",
  "postingTriggeredAt": 0,
  "paymentTriggeredAt": 0,
  "postingErrors": "",
  "paymentErrors": "",
  "postingDocNo": "",
  "paymentDocNo": "",
  "paymentUtr": "",
  "postingTriggered": false,
  "paymentTriggered": false,
  "postingFailed": false,
  "paymentFailed": false,
  "postingSynced": false,
  "paymentSynced": false
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'DICE-APP-ID' => '{{Company Code}}',
    'X-CLIENT-ID' => '{{API Client ID}}',
    'X-CLIENT-SECRET' => '{{API Client Secret}}',
  ],
]);

echo $response->getBody();
```

```csharp Credit Note_Update Credit Note Config_example
using RestSharp;

var client = new RestClient("https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2");
var request = new RestRequest(Method.POST);
request.AddHeader("DICE-APP-ID", "{{Company Code}}");
request.AddHeader("X-CLIENT-ID", "{{API Client ID}}");
request.AddHeader("X-CLIENT-SECRET", "{{API Client Secret}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"creditNoteId\": \"\",\n  \"type\": \"\",\n  \"logo\": \"\",\n  \"postingTriggeredAt\": 0,\n  \"paymentTriggeredAt\": 0,\n  \"postingErrors\": \"\",\n  \"paymentErrors\": \"\",\n  \"postingDocNo\": \"\",\n  \"paymentDocNo\": \"\",\n  \"paymentUtr\": \"\",\n  \"postingTriggered\": false,\n  \"paymentTriggered\": false,\n  \"postingFailed\": false,\n  \"paymentFailed\": false,\n  \"postingSynced\": false,\n  \"paymentSynced\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Credit Note_Update Credit Note Config_example
import Foundation

let headers = [
  "DICE-APP-ID": "{{Company Code}}",
  "X-CLIENT-ID": "{{API Client ID}}",
  "X-CLIENT-SECRET": "{{API Client Secret}}",
  "Content-Type": "application/json"
]
let parameters = [
  "creditNoteId": "",
  "type": "",
  "logo": "",
  "postingTriggeredAt": 0,
  "paymentTriggeredAt": 0,
  "postingErrors": "",
  "paymentErrors": "",
  "postingDocNo": "",
  "paymentDocNo": "",
  "paymentUtr": "",
  "postingTriggered": false,
  "paymentTriggered": false,
  "postingFailed": false,
  "paymentFailed": false,
  "postingSynced": false,
  "paymentSynced": false
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://heimdall.eka.io/apis/external/vendor/creditNote/updateCreditNoteConfig#postApisExternalVendorCreditnoteUpdatecreditnoteconfig2")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```