---
title: "Field"
url: "https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543/schemas/Field"
---

> Full API specification: https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543.md

# Field

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Document Generator API
  version: "1.0"
components:
  schemas:
    FieldType:
      enum:
        - SignatureComponent
        - InitialsComponent
        - DateComponent
        - TextComponent
        - SelectComponent
        - CheckComponent
        - CheckGroupComponent
        - AttachmentComponent
        - SignatureAnnotationComponent
        - TextAnnotationComponent
        - CheckmarkAnnotationComponent
        - PaymentComponent
      type: string
    GroupRequirement:
      enum:
        - OnlyOne
        - OneOrMore
      type: string
    TextAlignment:
      enum:
        - Left
        - Right
        - Center
      type: string
    SignatureType:
      enum:
        - Typed
        - Drawn
      type: string
    Role:
      type: object
      properties:
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        sequence:
          type: integer
          format: int32
        isSender:
          type: boolean
      additionalProperties: false
    DataPreFilledType:
      enum:
        - None
        - Manual
        - SourceMapped
      type: string
    Field:
      type: object
      properties:
        id:
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/FieldType"
        x:
          type: number
          format: double
          nullable: true
        y:
          type: number
          format: double
          nullable: true
        height:
          type: number
          format: double
          nullable: true
        width:
          type: number
          format: double
          nullable: true
        isRequired:
          type: boolean
          nullable: true
        groupRequirement:
          $ref: "#/components/schemas/GroupRequirement"
        fontSize:
          type: integer
          format: int32
          nullable: true
        multiline:
          type: boolean
          nullable: true
        transparent:
          type: boolean
          nullable: true
        textAlign:
          $ref: "#/components/schemas/TextAlignment"
        selectOptions:
          type: array
          items:
            type: string
          nullable: true
        chargeAfterExecuted:
          type: boolean
          nullable: true
        paymentAmount:
          type: integer
          format: int32
          nullable: true
        helpText:
          type: string
          nullable: true
        page:
          type: integer
          format: int32
          nullable: true
        name:
          type: string
          nullable: true
        isDateSigned:
          type: boolean
          nullable: true
        dateFormat:
          type: string
          nullable: true
        signatureImage:
          type: string
          nullable: true
        signatureText:
          type: string
          nullable: true
        signatureType:
          $ref: "#/components/schemas/SignatureType"
        signatureJsonData:
          type: string
          nullable: true
        groupId:
          type: string
          nullable: true
        signatureId:
          type: string
          nullable: true
        assignedTo:
          $ref: "#/components/schemas/Role"
        dataPreFilledType:
          $ref: "#/components/schemas/DataPreFilledType"
        variableId:
          type: string
          nullable: true
        attributePath:
          type: string
          nullable: true
        value:
          type: string
          nullable: true
        fullyQualifiedPath:
          type: string
          nullable: true
      additionalProperties: false
```