Create a receive term

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/receive_terms" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "receive_term": {
      "name": "net-30",
      "display_name": "Net 30",
      "period": "MONTHLY",
      "duration": 1
    }
  }'

from exsited import build_client

client = build_client()

response = client.receive_terms.create_settings_receive_term(
    {
        "receive_term": {
            "name": "net-30",
            "display_name": "Net 30",
            "period": "MONTHLY",
            "duration": 1,
        }
    }
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.receiveTerms.createSettingsReceiveTerm({
    receive_term: {name: 'net-30', display_name: 'Net 30', period: 'MONTHLY', duration: 1},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->receiveTerms->createSettingsReceiveTerm([
    'receive_term' => [
        'name' => 'net-30',
        'display_name' => 'Net 30',
        'period' => 'MONTHLY',
        'duration' => 1,
    ],
]);
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().createSettingsReceiveTerm(
        Map.of(
                "receive_term", Map.of(
                        "name", "net-30",
                        "display_name", "Net 30",
                        "period", "MONTHLY",
                        "duration", 1)));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReceiveTerms.CreateSettingsReceiveTermAsync(new Dictionary<string, object?>
{
    ["receive_term"] = new Dictionary<string, object?>
    {
        ["name"] = "net-30",
        ["display_name"] = "Net 30",
        ["period"] = "MONTHLY",
        ["duration"] = 1,
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.receiveTerms.createSettingsReceiveTerm({
  'receive_term': {
    'name': 'net-30',
    'display_name': 'Net 30',
    'period': 'MONTHLY',
    'duration': 1,
  },
});
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().CreateSettingsReceiveTerm(context.Background(), map[string]any{
	"receive_term": map[string]any{
		"name":         "net-30",
		"display_name": "Net 30",
		"period":       "MONTHLY",
		"duration":     1,
	},
}, 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>"
  }
}

POST

settings

receive_terms

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/receive_terms" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "receive_term": {
      "name": "net-30",
      "display_name": "Net 30",
      "period": "MONTHLY",
      "duration": 1
    }
  }'

from exsited import build_client

client = build_client()

response = client.receive_terms.create_settings_receive_term(
    {
        "receive_term": {
            "name": "net-30",
            "display_name": "Net 30",
            "period": "MONTHLY",
            "duration": 1,
        }
    }
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.receiveTerms.createSettingsReceiveTerm({
    receive_term: {name: 'net-30', display_name: 'Net 30', period: 'MONTHLY', duration: 1},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->receiveTerms->createSettingsReceiveTerm([
    'receive_term' => [
        'name' => 'net-30',
        'display_name' => 'Net 30',
        'period' => 'MONTHLY',
        'duration' => 1,
    ],
]);
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().createSettingsReceiveTerm(
        Map.of(
                "receive_term", Map.of(
                        "name", "net-30",
                        "display_name", "Net 30",
                        "period", "MONTHLY",
                        "duration", 1)));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ReceiveTerms.CreateSettingsReceiveTermAsync(new Dictionary<string, object?>
{
    ["receive_term"] = new Dictionary<string, object?>
    {
        ["name"] = "net-30",
        ["display_name"] = "Net 30",
        ["period"] = "MONTHLY",
        ["duration"] = 1,
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.receiveTerms.createSettingsReceiveTerm({
  'receive_term': {
    'name': 'net-30',
    'display_name': 'Net 30',
    'period': 'MONTHLY',
    'duration': 1,
  },
});
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().CreateSettingsReceiveTerm(context.Background(), map[string]any{
	"receive_term": map[string]any{
		"name":         "net-30",
		"display_name": "Net 30",
		"period":       "MONTHLY",
		"duration":     1,
	},
}, 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>"
  }
}

Creates a receive term from a name, display_name, period and duration, wrapped in receive_term. Send period in upper case, such as MONTHLY; it comes back in lower case.

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.

Body

application/json

receive_term

object

required

Show child attributes

Response

201 - application/json

The new receive term, under receive_term.

receive_term

object

Show child attributes

Guides

API reference

Authorizations

Body

Response