ClientTaxDetailUpdatedV1

v1.0.0

{
  "$id": "https://example.com/ClientTaxDetailUpdatedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientTaxDetailUpdatedV1",
  "description": "An event raised when a client's tax detail is updated. This will be a full replacement of the tax details as it will contain all the documents.",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g ClientTaxDetailUpdatedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
        "applicationBreadcrumb": {
          "type": "string",
          "description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
        },
        "version":{
          "type": "string",
          "description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
        },
        "sentAtUtc": {
          "type": "string",
          "description":  "When event was sent by the publishers in ISO 8601 "
        },
        "isTransactionalAccountAvailableForClient": {
          "type": "boolean",
          "description":  "Indicates if the transaction account for a client is available"
        }
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
    },
    "data": {
      "type": "object",
      "properties": {
        "client": {
          "type": "object",
          "properties": {
            "globalClientId": {
              "type": "string",
              "description": "The GUID of client"
            },
            "clientNumber": {
              "type": "number",
              "description": "The CRM number of the client"
            },
            "type": {
              "type": "string",
              "description": "The type of client, e.g. Person or Organisation"
            }
          }
        },
        "taxDocuments":{
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
               "type":{
                  "type" : "string",
                  "description": "Allowed values W-9, W-8BEN, W-8BEN-E, W-8ECI, W-8EXP, W-8IMY, DAC7."
                },
                "referenceNumber" : {
                  "type" : "string",
                  "description": "The tax reference number of the client"
                },
                "documentStatus": {
                  "type" : "string",
                  "description" : "Allowed values Active and Inactive"
                },
                "federalTaxClassification": {
                  "type": "string",
                  "description": "Federal tax classification. Allowed values: C Corporation, Individual, Individual/single-member LLC, Individual/sole proprietor, LLC/C-Corporation, LLC/P-Partnership, LLC/S-Corporation, Other, Partnership, S Corporation, Trust/Estate"
                },
                "country" : {
                  "type": "string",
                  "description": "Tax country"
                },
                "identificationNumberType": {
                  "type": "string",
                  "description": "Allowed values EIN, SSN"
                },
                "documentExpireAt": {
                  "type": "date",
                  "description": "Expiry date of the tax document"
                }
            }
          }
          }
        }
        
      }
    }
}