Skip to main content

CustomFieldSpecificationListResponseDto

customFields object[]required

The list of custom field specifications.

  • Array [
  • idstring<uuid>required

    The unique kaunt identifier of the field.

    Example: 227aebd0-36a4-4d17-b96d-c5b5d071abd4
    fieldNamestringrequired

    The name of the custom field.

    Example: Supplier ID
    fieldTypeCustomFieldTypeEnumrequired

    The type of the custom field, indicating whether it is a text or number field.

    Possible values: [Text, Number]

    Example: Text
    fieldLevelFieldLevelEnumrequired

    The level of the custom field, indicating whether it applies to the header or line level of a document.

    Possible values: [Header, Line]

    Example: Header
    fieldDescriptionstringnullable

    The description of the custom field.

    Example: The ID of the supplier.
    fieldExtractionInstructionstringrequired

    The extraction instruction for the custom field.

    Example: Extract the supplier ID from the document.
  • ]
  • CustomFieldSpecificationListResponseDto
    {
    "customFields": [
    {
    "id": "227aebd0-36a4-4d17-b96d-c5b5d071abd4",
    "fieldName": "Supplier ID",
    "fieldType": "Text",
    "fieldLevel": "Header",
    "fieldDescription": "The ID of the supplier.",
    "fieldExtractionInstruction": "Extract the supplier ID from the document."
    }
    ]
    }