Corporate division created
Type: object
Domain: corporate
Event: division_creation
Version: 2
id required
Title: Division unique identifier
Description: Division unique identifier generated by Pismo
Type: string
Min length: 1
Max length: 36
Example:
7c6138a3-0daa-4a49-aa76-fa03294146b2
division_code required
Title: Division code unique identifier
Description: Code string that uniquely identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123
hierarchy_id required
Title: Hierarchy unique identifier
Type: string
Min length: 1
Max length: 36
Example:
775f2caa-8c8c-40dd-908d-0d192f2e0144
level_id required
Title: Level unique identifier
Type: string
Min length: 1
Max length: 36
Example:
21a44048-4097-4a79-a663-46e357497ed8
name required
Title: Division name
Type: string
Min length: 1
Max length: 40
Example:
uk-london-01
description
Title: Division description
Type: string
Min length: 1
Max length: 80
Example:
UK - London
parent_code
Title: The division code that represents the parent of the division.
Type: string
Min length: 1
Max length: 36
Example:
parent-division-code-01
program_ids
Type: array or null
Example:[ 15, 20 ]
schema
Title: Schema
Description: A valid JSON schema as specified in https://json-schema.org/specification.html
Type: object or null
Additional properties: true
Example:{ "$id": "https://example.com/custom-data.schema.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Custom Data", "type": "object", "properties": { "custom_info": { "type": "string", "description": "Custom information" } } }
timezone
Title: Timezone
Description: The timezone of this division. This value will be used when calculating holidays, weekends, and daily balances. The format is based on timezone database standards.
Type: string or null
Min length: 0
Max length: 255
Example:
America/Sao_Paulo
US/Central
America/New_York
administrative_division_id
Title: Administrative Division unique identifier
Description: Administrative Division unique identifier generated by Pismo. This field is used to retrieve the Administrative Division in the Pismo platform APIs.
Type: integer or null
Example:
5305734
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Corporate division created",
"required": [
"id",
"division_code",
"hierarchy_id",
"level_id",
"name"
],
"properties": {
"id": {
"title": "Division unique identifier",
"description": "Division unique identifier generated by Pismo",
"type": "string",
"minLength": 1,
"maxLength": 36,
"examples": [
"7c6138a3-0daa-4a49-aa76-fa03294146b2"
]
},
"division_code": {
"type": "string",
"title": "Division code unique identifier",
"description": "Code string that uniquely identifies the division within your organization.",
"maxLength": 36,
"examples": [
"division-code-123"
]
},
"hierarchy_id": {
"title": "Hierarchy unique identifier",
"type": "string",
"minLength": 1,
"maxLength": 36,
"examples": [
"775f2caa-8c8c-40dd-908d-0d192f2e0144"
]
},
"level_id": {
"title": "Level unique identifier",
"type": "string",
"minLength": 1,
"maxLength": 36,
"examples": [
"21a44048-4097-4a79-a663-46e357497ed8"
]
},
"name": {
"title": "Division name",
"type": "string",
"minLength": 1,
"maxLength": 40,
"examples": [
"uk-london-01"
]
},
"description": {
"title": "Division description",
"type": "string",
"minLength": 1,
"maxLength": 80,
"examples": [
"UK - London"
]
},
"parent_code": {
"title": "The division code that represents the parent of the division.",
"type": "string",
"minLength": 1,
"maxLength": 36,
"examples": [
"parent-division-code-01"
]
},
"program_ids": {
"title": "List of allowed program ids",
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 0,
"maximum": 99999999999,
"examples": [
15,
20
]
}
},
"schema": {
"type": [
"object",
"null"
],
"title": "Schema",
"description": "A valid JSON schema as specified in https://json-schema.org/specification.html",
"additionalProperties": true,
"examples": [
{
"$id": "https://example.com/custom-data.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Custom Data",
"type": "object",
"properties": {
"custom_info": {
"type": "string",
"description": "Custom information"
}
}
}
]
},
"timezone": {
"title": "Timezone",
"description": "The timezone of this division. This value will be used when calculating holidays, weekends, and daily balances. The format is based on timezone database standards.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 255,
"examples": [
"America/Sao_Paulo",
"US/Central",
"America/New_York"
]
},
"administrative_division_id": {
"title": "Administrative Division unique identifier",
"description": "Administrative Division unique identifier generated by Pismo. This field is used to retrieve the Administrative Division in the Pismo platform APIs.",
"type": [
"integer",
"null"
],
"examples": [
5305734
]
}
}
}
{
"id": "7c6138a3-0daa-4a49-aa76-fa03294146b2",
"division_code": "division-code-123",
"hierarchy_id": "775f2caa-8c8c-40dd-908d-0d192f2e0144",
"level_id": "21a44048-4097-4a79-a663-46e357497ed8",
"name": "uk-london-01",
"description": "UK - London",
"parent_code": "parent-division-code-01",
"program_ids": [
15,
20
],
"schema": {
"$id": "https://example.com/custom-data.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Custom Data",
"type": "object",
"properties": {
"custom_info": {
"type": "string",
"description": "Custom information"
}
}
},
"timezone": "America/Sao_Paulo",
"administrative_division_id": 5305734
}
Updated 19 days ago