---
title: "Create external leave budget"
method: POST
path: "/external-leave-budgets"
tags: ["external-leave-budgets"]
---

# Create external leave budget

`POST /external-leave-budgets`

## Request

- Base URL: `https://api.hoorayhr.io`
- URL: `https://api.hoorayhr.io/external-leave-budgets`
- Auth: API key in header `authorization`

Creates a new resource with data.

## Request body

- union
  - ExternalLeaveBudgets
    - `id` integer: ID of the external-leave-budget record
    - `externalLeaveTypeId` integer, required: ID of the external-leave-type
    - `userId` integer, required: Unique id of the user of the external-leave-budget record
    - `year` integer: Year of the external-leave-budget record
    - `transferred` number: Budget transferred from the previous year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `received` number: Budget received this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `expired` number: Budget expired this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `spent` number: Budget spent this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `available` number: Budget available this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `createdAt` string, date-time: Creation date of the external leave budget
    - `updatedAt` string, date-time: Last updated date of the external leave budget
  - ExternalLeaveBudgets[]
    - `id` integer: ID of the external-leave-budget record
    - `externalLeaveTypeId` integer, required: ID of the external-leave-type
    - `userId` integer, required: Unique id of the user of the external-leave-budget record
    - `year` integer: Year of the external-leave-budget record
    - `transferred` number: Budget transferred from the previous year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `received` number: Budget received this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `expired` number: Budget expired this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `spent` number: Budget spent this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `available` number: Budget available this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `createdAt` string, date-time: Creation date of the external leave budget
    - `updatedAt` string, date-time: Last updated date of the external leave budget

## Response `201`

created

- union
  - ExternalLeaveBudgets
    - `id` integer: ID of the external-leave-budget record
    - `externalLeaveTypeId` integer, required: ID of the external-leave-type
    - `userId` integer, required: Unique id of the user of the external-leave-budget record
    - `year` integer: Year of the external-leave-budget record
    - `transferred` number: Budget transferred from the previous year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `received` number: Budget received this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `expired` number: Budget expired this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `spent` number: Budget spent this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `available` number: Budget available this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `createdAt` string, date-time: Creation date of the external leave budget
    - `updatedAt` string, date-time: Last updated date of the external leave budget
  - ExternalLeaveBudgets[]
    - `id` integer: ID of the external-leave-budget record
    - `externalLeaveTypeId` integer, required: ID of the external-leave-type
    - `userId` integer, required: Unique id of the user of the external-leave-budget record
    - `year` integer: Year of the external-leave-budget record
    - `transferred` number: Budget transferred from the previous year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `received` number: Budget received this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `expired` number: Budget expired this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `spent` number: Budget spent this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `available` number: Budget available this year (in minutes or days, depending on the leaveInDays value of the related external-leave-type)
    - `createdAt` string, date-time: Creation date of the external leave budget
    - `updatedAt` string, date-time: Last updated date of the external leave budget

## Other responses

- `401`: not authenticated
- `500`: general error

---

[API](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation.md) · [All operations](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/revisions/3adcd47cd827?raw)
