Customfieldconfigurations

Get CustomFieldConfigurations

get
Authorizations
Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

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

Example: 07/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

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

Example: 07/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
get
GET /CustomFieldConfigurations HTTP/1.1
Host: api.sandbox.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
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
201
The CustumFieldConfiguration for the request.
post
POST /CustomFieldConfigurations HTTP/1.1
Host: api.sandbox.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
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
get
GET /CustomFieldConfigurations/{id} HTTP/1.1
Host: api.sandbox.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
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
all ofOptional
Responses
200
Success
patch
PATCH /CustomFieldConfigurations/{id} HTTP/1.1
Host: api.sandbox.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
Authorizations
Path parameters
entitystringRequired
keystringRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
get
GET /CustomFieldConfigurations/{entity}/{key} HTTP/1.1
Host: api.sandbox.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
Authorizations
Path parameters
entitystringRequired
keystringRequired
Header parameters
api-versionstringOptional
Body
all ofOptional
Responses
200
Success
patch
PATCH /CustomFieldConfigurations/{entity}/{key} HTTP/1.1
Host: api.sandbox.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
PreviousCurrencyNextDocumenttemplate

Last updated