PIpismo
Divisions

Get division

Retrieves a division by its division code.

get/corporate/v2/divisions/{divisionCode}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v2/divisions/{divisionCode}
  • Auth
    HTTP bearer

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

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

This ID is immutable and cannot be changed.

division_codestring

Division code registered in 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.<br>

NOTE: administrative_division_id points to holiday calendar. Administrative division is deprecated and replaced by holiday calendar, and both continue to use the same underlying data structure for backward compatibility. The administrative division ID is functionally equivalent to holiday_calendar_id and refers to the calendar that defines holidays and working days. For more information, refer to Add holiday.

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 defined at https://json-schema.org/specification.html. This schema validates the JSON custom fields used in the Create transaction banking account process. If this field is not set, the division inherits its schema from the parent division, if one exists. The example below is shown in YAML for readability; the API requires JSON.

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",
  "division_code": "US",
  "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": {
        "description": "Product ID",
        "type": "integer",
        "format": "int64",
        "example": 1234
      }
    },
    "required": [
      "product_id"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.