---
title: "Prepare Team paperwork"
method: POST
path: "/team/prepare"
tags: ["team"]
---

# Prepare Team paperwork

`POST /team/prepare`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/team/prepare`
- Auth: HTTP bearer

For people already on Team. kind change: records each pay, title or options change as a draft with its letter from the company's confirmed change template (letter: false records it without one), then asks to send the letters. kind departure: records each last day, private until sent, with its letter from the company's departure template, then asks to send it. kind papers: fills the offer letter and the CIIAA from the company's confirmed templates and asks to send them. Sending waits for the person's approval: send them to approval_url. Only use pay the person gave you.

## Request body

- object
  - `kind` 'change' | 'departure' | 'papers', required
  - `changes` object[]: For kind change.
    - `email` string, email, required: The person's email on Team.
    - `effective_on` string, date, required: The day it takes effect, YYYY-MM-DD.
    - `title` string: The new title, if it changes.
    - `pay` object: The new pay exactly as the person told you; never suggest or estimate pay.
      - `amount` string, required
      - `currency` string, required
      - `period` 'year' | 'hour', required
    - `options` integer: New options, if any.
  - `departures` object[]: For kind departure.
    - `email` string, email, required: The person's email on Team.
    - `last_day` string, date, required: Their last day, YYYY-MM-DD.
    - `ended_by` 'resigned' | 'company', required: Whether they resigned or the company ended it.
  - `letter` boolean: For kind change or departure: fill the company's letter for each person.
  - `papers` object: For kind papers.
    - `email` string, email, required: The person's email on Team.
    - `send` string[], required: Which papers, each from the company's confirmed template.
    - `title` string
    - `start_date` string, date
    - `pay` object: Exactly as the person told you; never suggest pay.
      - `amount` string, required
      - `currency` string, required
      - `period` 'year' | 'hour', required
    - `manager` string

## Response `200`

The result.

- object
  - `kind` 'change' | 'departure' | 'papers', required
  - `people` object[], required
    - `party_id` string, required
    - `name` string, required
    - `record_id` string, nullable, required
  - `approval` object, nullable, required
    - `approval_id` string, required
    - `approval_url` string, required
  - `sent` boolean, required
  - `prepared_at` string, date-time, required

## Other responses

- `default`: An RFC 9457 problem.

---

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