Customer migration started

Event generated when an customer migration is started. Contains the payload with the data to be migrated.

Type: object
Domain: migration
Event: customer_incoming
Version: 1

|
entity

Title: The entity Schema
Type: object

migration

Title: The migration Schema
Description: This field contains the data that identifies a migration.
Type: object

id required

Description: This field is the unique identifier of migration.
Type: string
Example:
31a2d

account_id required

Description: This field is the migration id of the account
Type: string
Example:
a7c3f

version_date required

Description: This field is the date of version of migration.
Type: string
Format: date-time
Example:
2023-10-03T17:25:45Z

social_name

Description: This field is the social name of customer
Type: string
Example:
Mario Bros

email

Description: This field is the e-mail of customer
Type: string
Example:
[email protected]

entity

Type: object

name

Description: This field is the name of customer
Type: string
Example:
Super Mario Bros

document_number

Description: This field is the document number of customer
Type: string
Example:
59769445746

registration

Description: This field is the registration of customer
Type: string
Example:
registration

birth_date

Description: This field is the customer birth date
Type: string
Example:
2022-01-01

gender

Description: This field is the customer gender
Type: string
Example:
M

mother_name

Description: This field is the customer mother's name
Type: string
Example:
Jane Doe

marital_status

Description: This field is the customer marital status
Type: string
Example:
Single

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "$id": "https://pismo.io/events/migration/customer_incoming-1.json",
    "type": "object",
    "title": "Customer migration started",
    "description": "Event generated when an customer migration is started. Contains the payload with the data to be migrated.",
    "required": [
        "entity"
    ],
    "properties": {
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "default": {},
            "title": "The entity Schema",
            "required": [
                "migration"
            ],
            "properties": {
                "migration": {
                    "$id": "#/properties/entity/migration",
                    "type": "object",
                    "title": "The migration Schema",
                    "description": "This field contains the data that identifies a migration.",
                    "required": [
                        "id",
                        "account_id",
                        "version_date"
                    ],
                    "properties": {
                        "id": {
                            "$id": "#/properties/entity/migration/id",
                            "type": "string",
                            "description": "This field is the unique identifier of migration.",
                            "examples": [
                                "31a2d"
                            ]
                        },
                        "account_id": {
                            "$id": "#/properties/entity/migration/account_id",
                            "type": "string",
                            "description": "This field is the migration id of the account ",
                            "examples": [
                                "a7c3f"
                            ]
                        },
                        "version_date": {
                            "$id": "#/properties/entity/migration/version_date",
                            "type": "string",
                            "format": "date-time",
                            "description": "This field is the date of version of migration.",
                            "examples": [
                                "2023-10-03T17:25:45Z"
                            ]
                        },
                        "additionalProperties": false
                    }
                },
                "social_name": {
                    "$id": "#/properties/entity/social_name",
                    "type": "string",
                    "description": "This field is the social name of customer",
                    "examples": [
                        "Mario Bros"
                    ]
                },
                "email": {
                    "$id": "#/properties/entity/email",
                    "type": "string",
                    "description": "This field is the e-mail of customer",
                    "examples": [
                        "[email protected]"
                    ]
                },
                "entity": {
                    "$id": "#/properties/entity/entity",
                    "type": "object",
                    "properties": {
                        "name": {
                            "$id": "#/properties/entity/entity/name",
                            "type": "string",
                            "description": "This field is the name of customer",
                            "examples": [
                                "Super Mario Bros"
                            ]
                        },
                        "document_number": {
                            "$id": "#/properties/entity/entity/document_number",
                            "type": "string",
                            "description": "This field is the document number of customer",
                            "examples": [
                                "59769445746"
                            ]
                        },
                        "registration": {
                            "$id": "#/properties/entity/entity/registration",
                            "type": "string",
                            "description": "This field is the registration of customer",
                            "examples": [
                                "registration"
                            ]
                        },
                        "birth_date": {
                            "$id": "#/properties/entity/entity/birth_date",
                            "type": "string",
                            "description": "This field is the customer birth date",
                            "examples": [
                                "2022-01-01"
                            ]
                        },
                        "gender": {
                            "$id": "#/properties/entity/entity/gender",
                            "type": "string",
                            "description": "This field is the customer gender",
                            "examples": [
                                "M"
                            ]
                        },
                        "mother_name": {
                            "$id": "#/properties/entity/entity/mother_name",
                            "type": "string",
                            "description": "This field is the customer mother's name",
                            "examples": [
                                "Jane Doe"
                            ]
                        },
                        "marital_status": {
                            "$id": "#/properties/entity/entity/marital_status",
                            "type": "string",
                            "description": "This field is the customer marital status",
                            "examples": [
                                "Single"
                            ]
                        },
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        }
    },
    "examples": [
        {
            "entity": {
                "migration": {
                    "id": "31a2d",
                    "account_id": "a7c3f",
                    "version_date": "2023-10-03T17:25:45Z"
                },
                "social_name": "Mario Bros",
                "email": "[email protected]",
                "entity": {
                    "name": "Super Mario Bros",
                    "document_number": "59769445746",
                    "registration": "registration",
                    "birth_date": "2022-01-01",
                    "gender": "M",
                    "mother_name": "Jane Doe",
                    "marital_status": "Single"
                }
            }
        }
    ]
}
{
    "entity": {
        "migration": {
            "id": "31a2d",
            "account_id": "a7c3f",
            "version_date": "2023-10-03T17:25:45Z"
        },
        "social_name": "Mario Bros",
        "email": "[email protected]",
        "entity": {
            "name": "Super Mario Bros",
            "document_number": "59769445746",
            "registration": "registration",
            "birth_date": "2022-01-01",
            "gender": "M",
            "mother_name": "Jane Doe",
            "marital_status": "Single"
        }
    }
}