Customfieldconfigurations

Get CustomFieldConfigurations

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

FilterstringOptional

Filter the results. See developer resources for more information. On endpoints whose entity supports custom fields you can also filter by custom field: customFieldEq('fieldName', 'value') (equals) or customFieldExist('fieldName') (field has a non-empty value). Custom-field functions may only be combined with and.

Example: name eq 'Adam' and age gt 20 and customFieldEq('region', 'EU')

OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2026-07-01

ModifiedBeforestring · date-timeOptional

Apply a separate filter to only get records that has been modified Before the specified date time.

Example: 2026-07-01

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

totalPagesinteger · int32 · nullableOptional

totalCountinteger · int32Optional

nextPagestring · uri · nullableOptional

previousPagestring · uri · nullableOptional

firstPagestring · uri · nullableOptional

lastPagestring · uri · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get/CustomFieldConfigurations

GET /CustomFieldConfigurations HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "name": "text",
      "defaultValue": "text",
      "fieldType": "Text",
      "entity": "Account",
      "list": "text",
      "typeEntity": "Account",
      "entityObject": "text"
    }
  ]
}

Create CustomFieldConfiguration

post

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

fieldTypestring · enumRequiredPossible values:

entitystring · enumOptionalPossible values:

keystring · nullableOptional

namestring · nullableOptional

defaultValuestring · nullableOptional

typeEntitystring · enumOptionalPossible values:

Responses

201

The CustumFieldConfiguration for the request.

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post/CustomFieldConfigurations

POST /CustomFieldConfigurations HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "fieldType": "Text",
  "entity": "Account",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "list": {
    "key": "text",
    "value": "text"
  },
  "typeEntity": "Account"
}

No content

Get CustomFieldConfiguration by Id

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

keystring · nullableOptional

namestring · nullableOptional

defaultValuestring · nullableOptional

fieldTypestring · enumOptionalPossible values:

entitystring · enumOptionalPossible values:

liststring · nullableOptional

typeEntitystring · enumOptionalPossible values:

entityObjectstring · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get/CustomFieldConfigurations/{id}

GET /CustomFieldConfigurations/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "fieldType": "Text",
  "entity": "Account",
  "list": "text",
  "typeEntity": "Account",
  "entityObject": "text"
}

Update CustomFieldConfiguration by Id

patch

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Body

fieldTypestring · enumOptionalPossible values:

entitystring · enumOptionalPossible values:

keystring · nullableOptional

namestring · nullableOptional

defaultValuestring · nullableOptional

typeEntitystring · enumOptionalPossible values:

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

patch/CustomFieldConfigurations/{id}

PATCH /CustomFieldConfigurations/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 148

{
  "fieldType": "Text",
  "entity": "Account",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "list": {
    "key": "text",
    "value": "text"
  },
  "typeEntity": "Account"
}

No content

Get CustomFieldConfiguration by Entity and Key

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

entitystringRequired

keystringRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

keystring · nullableOptional

namestring · nullableOptional

defaultValuestring · nullableOptional

fieldTypestring · enumOptionalPossible values:

entitystring · enumOptionalPossible values:

liststring · nullableOptional

typeEntitystring · enumOptionalPossible values:

entityObjectstring · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get/CustomFieldConfigurations/{entity}/{key}

GET /CustomFieldConfigurations/{entity}/{key} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "fieldType": "Text",
  "entity": "Account",
  "list": "text",
  "typeEntity": "Account",
  "entityObject": "text"
}

Update CustomFieldConfiguration by Entity and key.

patch

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

entitystringRequired

keystringRequired

Header parameters

api-versionstringOptional

Body

fieldTypestring · enumOptionalPossible values:

entitystring · enumOptionalPossible values:

keystring · nullableOptional

namestring · nullableOptional

defaultValuestring · nullableOptional

typeEntitystring · enumOptionalPossible values:

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

patch/CustomFieldConfigurations/{entity}/{key}

PATCH /CustomFieldConfigurations/{entity}/{key} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 148

{
  "fieldType": "Text",
  "entity": "Account",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "list": {
    "key": "text",
    "value": "text"
  },
  "typeEntity": "Account"
}

No content

PreviousCurrency NextDocumenttemplate

Last updated 9 months ago

Was this helpful?