# Create a new business-structure-path

> Create a new business-structure-path

POST

/business-structure-paths/

Creates one or more business structure paths and returns the new ID and details.

#### Helpful resources

-   [Create and manage business structures](https://developer.rippling.com/documentation/rest-api/guides/business-structures)

### Required Scopes

-   business-structure-paths.read-write
    

### Request

-   application/json

**Body**

**job\_code\_id** string required

The Job Code to place at this Business Structure path.

**parent\_id** string

Id of the parent BusinessStructurePath. None for root path.

## Responses

-   200

Successful response

-   application/json

-   Schema
-   Example (from schema)

**Schema**

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string

Name of the path (e.g. 'SF Office > Coffee > Barista').

**parent\_id** string

Id of the parent BusinessStructurePath. None for root path.

**parent** object

The parent path.

**job\_codes\_id** string\[\]

Ordered list of Job code IDs from top to bottom.

**job\_codes** object\[\]

Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job\_codes. Requires both business-structure-paths.read and job-codes.read scopes.

Array \[

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the job dimension.

**job\_dimension\_id** string required

The ID of the job dimension this job code belongs to.

**job\_dimension** object

The job dimension this job code belongs to.

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the job dimension

**external\_id** string

The unique identifier of the job dimension in a third party system

**includes\_custom\_location** boolean

Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.

**roster\_type** string

The roster type of the dimension. PER\_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER\_JOB\_CODE means that each job code has its own group.

**Possible values:** \[PER\_DIMENSION,PER\_JOB\_CODE\]

**group\_id** string

The ID of the dimension roster group.

**org\_attribute\_associations** object\[\]

Organizational attributes associated with the job dimension. Only 'PAY\_RATE' can be set or modified using POST or PATCH requests.

**external\_id** string

The unique identifier of the job code in an outside system.

**group\_id** string

The ID of the job roster group.

**custom\_location** object

The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.

**address** object required

The address of the custom location.

**type** string

The classification of the address.

**Possible values:** \[HOME,WORK,OTHER\]

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

The country component, pursuant to SCIM RFC 7643 4.1.2.

**Possible values:** \[AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,SZ,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IQ,IR,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KR,XK,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,AN,NC,NZ,NI,NE,NG,NU,NF,MK,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RO,RU,RW,RE,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SY,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SE,CH,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW\]

**work\_location\_id** string

The work location associated with the job code.

**work\_location** object

The work location associated with the job code.

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the work location.

**address** object required

The address for the work location.

**type** string

The classification of the address.

**Possible values:** \[HOME,WORK,OTHER\]

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

The country component, pursuant to SCIM RFC 7643 4.1.2.

**Possible values:** \[AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,SZ,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IQ,IR,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KR,XK,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,AN,NC,NZ,NI,NE,NG,NU,NF,MK,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RO,RU,RW,RE,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SY,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SE,CH,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW\]

**department\_id** string

The department associated with the job code.

**department** object

The department associated with the job code.

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the department.

**parent\_id** string

The parent department.

**parent** object

The parent department.

**reference\_code** string

Reference code of the department.

**department\_hierarchy\_id** string\[\]

The identifier of departments in the department hierarchy ordered from parent department to child department.

**department\_hierarchy** object\[\]

List of departments in the department hierarchy. Refer department\_hierarchy\_ids for department hierarchy order.

Expandable field

**pay\_rate** number

The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY\_RATE' organizational attribute.

**pay\_rate\_exceptions\_id** string\[\]

Pay rate overrides id for the job based on exception dimension values.

**pay\_rate\_exceptions** object\[\]

Pay rate overrides for the job based on exception dimension values.

Array \[

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**job\_code\_id** string required

Identifier of Job for which exception is configured.

**job\_code** object

Job for which exception is configured.

**exception\_dimension\_type** string

Type of dimension on which exception is configured

**Possible values:** \[JOB\_CODE,LEVEL,TEAM,DEPARTMENT,WORK\_LOCATION\]

**exception\_dimension\_id** string required

Identifier of dimension object on which exception is configured. This objects details can be queried from exception\_dimension\_type's resource

**pay\_rate** number required

The pay rate for exception on job\_code\_id and exception\_dimension\_id combination

\]

**is\_archived** boolean

Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.

\]

```json
{
  "id": "string",
  "created_at": "string",
  "updated_at": "string",
  "name": "string",
  "parent_id": "string",
  "parent": {},
  "job_codes_id": [
    "string"
  ],
  "job_codes": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "name": "string",
      "job_dimension_id": "string",
      "job_dimension": {
        "id": "string",
        "created_at": "string",
        "updated_at": "string",
        "name": "string",
        "external_id": "string",
        "includes_custom_location": false,
        "roster_type": "PER_DIMENSION",
        "group_id": "string",
        "org_attribute_associations": [
          "DEPARTMENT"
        ]
      },
      "external_id": "string",
      "group_id": "string",
      "custom_location": {
        "address": {
          "type": "HOME",
          "formatted": "string",
          "street_address": "string",
          "locality": "string",
          "region": "string",
          "postal_code": "string",
          "country": "AF"
        }
      },
      "work_location_id": "string",
      "work_location": {
        "id": "string",
        "created_at": "string",
        "updated_at": "string",
        "name": "string",
        "address": {
          "type": "HOME",
          "formatted": "string",
          "street_address": "string",
          "locality": "string",
          "region": "string",
          "postal_code": "string",
          "country": "AF"
        }
      },
      "department_id": "string",
      "department": {
        "id": "string",
        "created_at": "string",
        "updated_at": "string",
        "name": "string",
        "parent_id": "string",
        "parent": {},
        "reference_code": "string",
        "department_hierarchy_id": [
          "string"
        ],
        "department_hierarchy": [
          "string"
        ]
      },
      "pay_rate": 0,
      "pay_rate_exceptions_id": [
        "string"
      ],
      "pay_rate_exceptions": [
        {
          "id": "string",
          "created_at": "string",
          "updated_at": "string",
          "job_code_id": "string",
          "job_code": {},
          "exception_dimension_type": "JOB_CODE",
          "exception_dimension_id": "string",
          "pay_rate": 0
        }
      ],
      "is_archived": false
    }
  ]
}
```

Source: https://developer.rippling.com/documentation/rest-api/reference/create-business-structure-paths

> For the complete documentation index, see [llms.txt](https://developer.rippling.com/llms.txt). Public pages have a Markdown version at the same URL with .md added.
