v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Divisions

Create division

Creates a division by level and hierarchy ID. To use the holidays defined in an administrative division, specify its ID in administrative_division_id to link your division.

This endpoint generates a Corporate division created event.

post/corporate/v2/divisions

Request body

division_codestring required

Code used to identify your division within the organization. Division code should only contain letters, numbers, and hyphens.

hierarchy_idstring uuid required

Hierarchy ID generated by the Create hierarchy endpoint.

level_idstring uuid required

Level ID generated by the Create hierarchy endpoint.

namestring

Division name

parent_codestring

Division code that can be set as the parent of the division being created. The parent must be at a level with a lower index than the division being created. It must comply with the rule ^[a-zA-Z0-9-]+$.

descriptionstring nullable

Division description

timezonestring

Division timezone in timezone database format.<br> This value is used in the calculations for holidays, weekends, and daily balances. If a timezone is not specified, the division inherits the timezone from its parent division. If the parent division also lacks a specified timezone, Pismo defaults to using UTC. To clear this field, specify an empty string.

program_idsinteger[]

List of allowed program IDs. The programs must belong to the organization. This list is used for validation during the Create transaction banking account process. You can retrieve the organization programs using the List programs endpoint. If no program IDs are specified, this division inherits the program_ids list from the parent division, if it exists.

administrative_division_idinteger

Administrative division ID. Specifying an administrative division ID in this field links your division to it. This is useful when you want to use the holidays defined in that administrative division.

schemaSchemaCreateTransactionBankingAccount

Valid JSON schema as specified in https://json-schema.org/specification.html. Used to validate the JSON of custom fields in the Create transaction banking account process. If this field is not set, the division inherits its schema from the parent division, if it exists.

Example request

{
  "division_code": "US",
  "hierarchy_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "level_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "name": "NY",
  "parent_code": "my-parent-division",
  "description": "NY - New York City",
  "timezone": "America/New_York",
  "program_ids": [
    1,
    2,
    3
  ],
  "administrative_division_id": 13,
  "schema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/product.schema.json",
    "title": "Product",
    "description": "A product from Acme's catalog",
    "type": "object",
    "properties": {
      "product_id": {
        "$ref": "#/components/schemas/ProductID"
      }
    },
    "required": [
      "product_id"
    ]
  }
}

Response

Created

division_idstring uuid required

Pismo generates the division ID when you use the Create division endpoint.