GEgetpliant
Custom Fields

Create Custom Field

Changed on

Create a new custom field for the organization. Custom fields can be used to store additional information on transactions. For example, you can create a custom field to store an internal identifier, a project name, or accounting related data. Custom fields can be of type TEXT or SELECT. TEXT custom fields can store any text value. SELECT custom fields can store a fixed set of options. Each new custom field is created ACTIVE.

post/transactions/custom-fields

Request

Query parameters

organizationIdstring uuid required

The unique identifier of the organization to create the custom field for.

Request body

labelstring required

The label of the custom field, displayed in the UI.

descriptionstring

The description of the custom field, displayed in the UI, optional.

defaultValuestring

The default value of the custom field, optional.

type'TEXT' | 'SELECT' required

The type of the custom field. TEXT represents a custom field which can store any text value. SELECT represents a custom field which can store a fixed set of options.

automationType'CARD' required

The automation type of the custom field. For now only CARD is supported. This means, that the custom fields default value will be copied to every transaction made with the card the field is set on.

mandatoryOnAutomationboolean required

If set to true, this means this custom field is mandatory to be filled with a default value on the level of the automation, here CARD.

mandatoryForExportboolean required

If set to true, this means this custom field is mandatory to be filled on every transaction which should be exported with the Pliant accounting export.

visibility'ADMIN_AND_CARDHOLDER' | 'ADMIN_ONLY' | 'NOWHERE'

Controls where the values of this custom field are visible. ADMIN_AND_CARDHOLDER makes the values visible to both admins and cardholders. ADMIN_ONLY makes the values visible only to admins. NOWHERE hides the values from both admins and cardholders. Optional; defaults to ADMIN_AND_CARDHOLDER when omitted.

Response

Ok. The custom field can be used after you received the callback for the CUSTOM_FIELD_CREATED event.

Changes

  • a4fbf7d068b4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status