Update a receive term

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/receive_terms/RT-0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "receive_term": {
      "display_name": "Net 30 days",
      "description": "Updated description."
    }
  }'

from exsited import build_client

client = build_client()

response = client.receive_terms.update_settings_receive_term(
    "RT-0001",
    {
        "receive_term": {
            "display_name": "Net 30 days",
            "description": "Updated description.",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.receiveTerms.updateSettingsReceiveTerm('RT-0001', {
    receive_term: {display_name: 'Net 30 days', description: 'Updated description.'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->receiveTerms->updateSettingsReceiveTerm('RT-0001', [
    'receive_term' => ['display_name' => 'Net 30 days', 'description' => 'Updated description.'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.receive_terms.receive_terms_dto.ReceiveTermsDto.SettingsReceiveTerm;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsReceiveTerm> response = client.receiveTerms().updateSettingsReceiveTerm(
        "RT-0001",
        Map.of(
                "receive_term", Map.of(
                        "display_name", "Net 30 days",
                        "description", "Updated description.")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReceiveTerms.UpdateSettingsReceiveTermAsync(
    "RT-0001",
    new Dictionary<string, object?>
    {
        ["receive_term"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Net 30 days",
            ["description"] = "Updated description.",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.receiveTerms.updateSettingsReceiveTerm(
  'RT-0001',
  {
    'receive_term': {
      'display_name': 'Net 30 days',
      'description': 'Updated description.',
    },
  },
);
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.ReceiveTerms().UpdateSettingsReceiveTerm(context.Background(), "RT-0001", map[string]any{
	"receive_term": map[string]any{
		"display_name": "Net 30 days",
		"description":  "Updated description.",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "receive_term": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "duration": 123,
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "period": "<string>",
    "status": "<string>"
  }
}

PATCH

settings

receive_terms

{receive_term_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/receive_terms/RT-0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "receive_term": {
      "display_name": "Net 30 days",
      "description": "Updated description."
    }
  }'

from exsited import build_client

client = build_client()

response = client.receive_terms.update_settings_receive_term(
    "RT-0001",
    {
        "receive_term": {
            "display_name": "Net 30 days",
            "description": "Updated description.",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.receiveTerms.updateSettingsReceiveTerm('RT-0001', {
    receive_term: {display_name: 'Net 30 days', description: 'Updated description.'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->receiveTerms->updateSettingsReceiveTerm('RT-0001', [
    'receive_term' => ['display_name' => 'Net 30 days', 'description' => 'Updated description.'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.receive_terms.receive_terms_dto.ReceiveTermsDto.SettingsReceiveTerm;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsReceiveTerm> response = client.receiveTerms().updateSettingsReceiveTerm(
        "RT-0001",
        Map.of(
                "receive_term", Map.of(
                        "display_name", "Net 30 days",
                        "description", "Updated description.")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReceiveTerms.UpdateSettingsReceiveTermAsync(
    "RT-0001",
    new Dictionary<string, object?>
    {
        ["receive_term"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Net 30 days",
            ["description"] = "Updated description.",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.receiveTerms.updateSettingsReceiveTerm(
  'RT-0001',
  {
    'receive_term': {
      'display_name': 'Net 30 days',
      'description': 'Updated description.',
    },
  },
);
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.ReceiveTerms().UpdateSettingsReceiveTerm(context.Background(), "RT-0001", map[string]any{
	"receive_term": map[string]any{
		"display_name": "Net 30 days",
		"description":  "Updated description.",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "receive_term": {
    "created_by": "<unknown>",
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "duration": 123,
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": "<unknown>",
    "last_updated_on": "<string>",
    "name": "<string>",
    "object": "<string>",
    "period": "<string>",
    "status": "<string>"
  }
}

Updates fields of the receive term, such as display_name and description, wrapped in receive_term. Set status to active or inactive to enable or disable it.

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

receive_term_id

string

required

The receive term's id.

Body

application/json

receive_term

object

required

Show child attributes

Response

200 - application/json

The updated receive term, under receive_term.

receive_term

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response