Update an additional code

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/additional_codes/ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "additional_code": {
      "display_name": "Project code (AU)",
      "description": "Project reference for purchase lines"
    }
  }'

from exsited import build_client

client = build_client()

response = client.additional_codes.update_settings_additional_code(
    "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "additional_code": {
            "display_name": "Project code (AU)",
            "description": "Project reference for purchase lines",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.additionalCodes.updateSettingsAdditionalCode('ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    additional_code: {display_name: 'Project code (AU)', description: 'Project reference for purchase lines'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->additionalCodes->updateSettingsAdditionalCode(
    'ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
    [
        'additional_code' => [
            'display_name' => 'Project code (AU)',
            'description' => 'Project reference for purchase lines',
        ],
    ],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.additionalCodes().updateSettingsAdditionalCode(
        "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "additional_code", Map.of(
                        "display_name", "Project code (AU)",
                        "description", "Project reference for purchase lines")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.AdditionalCodes.UpdateSettingsAdditionalCodeAsync(
    "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["additional_code"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Project code (AU)",
            ["description"] = "Project reference for purchase lines",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.additionalCodes.updateSettingsAdditionalCode(
  'ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'additional_code': {
      'display_name': 'Project code (AU)',
      'description': 'Project reference for purchase lines',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.AdditionalCodes().UpdateSettingsAdditionalCode(context.Background(), "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"additional_code": map[string]any{
		"display_name": "Project code (AU)",
		"description":  "Project reference for purchase lines",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

PATCH

settings

additional_codes

{additional_code_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/additional_codes/ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "additional_code": {
      "display_name": "Project code (AU)",
      "description": "Project reference for purchase lines"
    }
  }'

from exsited import build_client

client = build_client()

response = client.additional_codes.update_settings_additional_code(
    "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    {
        "additional_code": {
            "display_name": "Project code (AU)",
            "description": "Project reference for purchase lines",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.additionalCodes.updateSettingsAdditionalCode('ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d', {
    additional_code: {display_name: 'Project code (AU)', description: 'Project reference for purchase lines'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->additionalCodes->updateSettingsAdditionalCode(
    'ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
    [
        'additional_code' => [
            'display_name' => 'Project code (AU)',
            'description' => 'Project reference for purchase lines',
        ],
    ],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.additionalCodes().updateSettingsAdditionalCode(
        "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
        Map.of(
                "additional_code", Map.of(
                        "display_name", "Project code (AU)",
                        "description", "Project reference for purchase lines")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.AdditionalCodes.UpdateSettingsAdditionalCodeAsync(
    "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d",
    new Dictionary<string, object?>
    {
        ["additional_code"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Project code (AU)",
            ["description"] = "Project reference for purchase lines",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.additionalCodes.updateSettingsAdditionalCode(
  'ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d',
  {
    'additional_code': {
      'display_name': 'Project code (AU)',
      'description': 'Project reference for purchase lines',
    },
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.AdditionalCodes().UpdateSettingsAdditionalCode(context.Background(), "ac_1a1b2c3d4e5f4a6b8c7d9e0f1a2b3c4d", map[string]any{
	"additional_code": map[string]any{
		"display_name": "Project code (AU)",
		"description":  "Project reference for purchase lines",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send the fields to change under additional_code. You can change its fields or its status.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

additional_code_id

string

required

The additional code's ac_ id, as a listing or a create returns it.

Body

application/json

additional_code

object

required

Show child attributes

Response

200

The additional code is updated.

Guides

API reference

Authorizations

Path Parameters

Body

Response