DocChangeMessage

organizationCodestringrequired

The organization code

Example: SAMPLE_ORG

typeEventType (string)required

The type of event

Possible values: [documentChange]

operationOperationType (string)required

The operation performed on the document

Possible values: [create, update, delete]

Example: create

document objectrequired

idstring<uuid>required

The document ID in UUID format

Example: 123e4567-e89b-12d3-a456-426614174000

namestringrequired

The name of the document

Example: test.pdf

mimeTypestringrequired

The MIME type of the document

Example: application/pdf

metadata object

Additional metadata associated with the document

property name*string

classCodestring

The class code of the document

Possible values: Value must match regular expression ^[A-Z0-9_]{3,20}$

Example: INVOICE

DocChangeMessage

{
  "organizationCode": "SAMPLE_ORG",
  "type": "documentChange",
  "operation": "create",
  "document": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "test.pdf",
    "mimeType": "application/pdf",
    "metadata": {
      "AMOUNT": "1000",
      "AMOUNT_CURRENCY": "USD",
      "INVOICE_NUMBER": "INV-123456",
      "CUSTOMER_NAME": "John Doe"
    },
    "classCode": "INVOICE"
  }
}