Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Divisions

Get division

Retrieves a division by its division code.

get/corporate/v2/divisions/{divisionCode}

Path parameters

divisionCodestring required

Division code registered in the Create division endpoint.

Response

Get division response

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 required

Division name

division_idstring uuid

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

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.

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.

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 response

{
  "hierarchy_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "level_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "name": "NY",
  "division_id": "6f8a456a-8b1a-4022-a2f8-7612595330b5",
  "administrative_division_id": 13,
  "parent_code": "my-parent-division",
  "description": "NY - New York City",
  "timezone": "America/New_York",
  "program_ids": [
    1,
    2,
    3
  ],
  "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"
    ]
  }
}