Divisions

Update division

Updates a division. Only provided fields are updated. Other fields are left unchanged.

This endpoint generates a Corporate division updated event.

patch/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.

Request body

division_codestring

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

This is a client-provided ID and can be changed.

hierarchy_idstring uuid

Hierarchy ID generated by the Create hierarchy endpoint.

level_idstring uuid

Level ID generated by the Create hierarchy 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.

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.

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 request

{
  "division_code": "US",
  "hierarchy_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "level_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
  "administrative_division_id": 13,
  "name": "NY",
  "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"
    ]
  }
}

Response

No Content

Changes

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