# Plane Documentation ## Docs - [Your first API call](https://docs.plane.com/guides/first-api-call.md): Set up authentication, create a sandbox, and make your first request to the Plane API. - [Guides](https://docs.plane.com/guides/introduction.md): Step-by-step walkthroughs for common tasks using the Plane API. - [Onboard a contractor](https://docs.plane.com/guides/onboard-a-contractor.md): Add a contractor to Plane and start their onboarding flow using the API. - [Send a payment](https://docs.plane.com/guides/send-a-payment.md): Send a one-off payment to a worker using the Plane API. - [Setting up webhooks](https://docs.plane.com/guides/setting-up-webhooks.md): Receive real-time HTTP notifications when events happen in Plane. - [Plane Documentation](https://docs.plane.com/introduction.md): Learn how to use Plane to run payroll, manage workers, and automate people operations across your global team. - [Agreements](https://docs.plane.com/product/agreements.md): Create, send, and track agreements through a complete signing workflow with counterparties. - [Bank Accounts](https://docs.plane.com/product/bank-accounts.md): Add and verify bank accounts for workers and manage your company's funding sources. - [Compliance](https://docs.plane.com/product/compliance.md): Track compliance requirements, tax forms, documents, and agreements across your team from one dashboard. - [Concepts](https://docs.plane.com/product/concepts.md): The mental model behind Plane—workers, payroll, payments, compliance, workflows, and workspaces. - [Documents](https://docs.plane.com/product/documents.md): Upload, organize, and manage documents for individual workers and your workspace. - [Expense Reports](https://docs.plane.com/product/expense-reports.md): Submit, review, and reimburse expense reports for your team—with multi-currency support and payroll integration. - [Holidays](https://docs.plane.com/product/holidays.md): Manage company holiday calendars and see how public holidays integrate with time off and payroll. - [Leave Policies](https://docs.plane.com/product/leave-policies.md): Define accrual rules, carryover limits, and leave types that determine how time off works for your team. - [Members and Roles](https://docs.plane.com/product/members-and-roles.md): Invite team members, assign roles, and control who can see and do what in your workspace. - [Offboarding](https://docs.plane.com/product/offboarding.md): How to terminate workers, handle final steps, and archive profiles in Plane. - [Onboarding](https://docs.plane.com/product/onboarding.md): How Plane onboards employees, contractors, and vendors—from the moment you add a worker to the moment they are fully active. - [Pay Schedules](https://docs.plane.com/product/pay-schedules.md): Define when and how often your team gets paid by creating and managing pay schedules. - [Payment Requests](https://docs.plane.com/product/payment-requests.md): Let contractors submit invoices for review, approval, and payment through a structured workflow. - [Payments](https://docs.plane.com/product/payments.md): Send one-off payments to workers, track money movement, and manage charges and refunds. - [Payroll](https://docs.plane.com/product/payroll.md): Run payroll for your entire team—employees, contractors, and vendors—from a single dashboard. - [Quick Start](https://docs.plane.com/product/quick-start.md): A quick orientation to Plane—set up your workspace, add your first team member, and run payroll in minutes. - [Reports](https://docs.plane.com/product/reports.md): Run, filter, and export built-in reports across payments, payroll, people, expenses, and more. - [Reviewing Payroll](https://docs.plane.com/product/reviewing-payroll.md): Understand the payroll approval workflow—from reviewing prepared items to approving, skipping, or resolving blockers. - [Tax Forms](https://docs.plane.com/product/tax-forms.md): Understand which tax forms Plane collects, when they are required, and how they integrate with payroll. - [Time Management](https://docs.plane.com/product/time.md): Manage leave policies, time-off requests, balances, and time tracking in one system alongside payroll. - [Profiles](https://docs.plane.com/product/worker-profiles.md): Everything you can see and manage on a worker's profile—personal details, employment, compensation, documents, and payment history. - [Workers](https://docs.plane.com/product/workers.md): Manage employees, contractors, and vendors in one system—from onboarding to offboarding. - [Workspace](https://docs.plane.com/product/workspace.md): Configure your workspace—company details, API access, sandboxes, and more. - [Approval](https://docs.plane.com/reference/approvals/object.md) - [Authentication](https://docs.plane.com/reference/authentication.md) - [Create a charge](https://docs.plane.com/reference/charges/create.md) - [Get a charge](https://docs.plane.com/reference/charges/get.md): Retrieve the details of an existing charge. - [List charges](https://docs.plane.com/reference/charges/list.md): Returns a list of all charges in your Plane workspace. - [Charge](https://docs.plane.com/reference/charges/object.md) - [Checklist](https://docs.plane.com/reference/checklists/object.md) - [Get a classification](https://docs.plane.com/reference/classifications/get.md): Retrieve the details of an existing worker classification. - [List classifications](https://docs.plane.com/reference/classifications/list.md): Returns a list of all worker classifications in your Plane workspace. - [Classification](https://docs.plane.com/reference/classifications/object.md) - [Get a compensation](https://docs.plane.com/reference/compensations/get.md): Retrieve the details of an existing compensation change. - [List compensations](https://docs.plane.com/reference/compensations/list.md): Returns a list of all compensation changes in your Plane workspace. - [Compensation](https://docs.plane.com/reference/compensations/object.md) - [Contract](https://docs.plane.com/reference/contracts/object.md) - [Document](https://docs.plane.com/reference/documents/object.md) - [Get an employment](https://docs.plane.com/reference/employments/get.md): Retrieve the details of an existing employment. - [List employments](https://docs.plane.com/reference/employments/list.md): Returns a list of all employments in your Plane workspace. - [Employment](https://docs.plane.com/reference/employments/object.md) - [Entity](https://docs.plane.com/reference/entities/object.md) - [Errors](https://docs.plane.com/reference/errors.md) - [Get an event](https://docs.plane.com/reference/events/get.md): Retrieve the details of an existing event. - [List events](https://docs.plane.com/reference/events/list.md): Returns a list of events in your Plane workspace. - [Event](https://docs.plane.com/reference/events/object.md): Events represent changes to resources in your workspace - [Idempotency](https://docs.plane.com/reference/idempotency.md) - [Introduction](https://docs.plane.com/reference/introduction.md) - [Label](https://docs.plane.com/reference/labels/object.md) - [Get a leave balance](https://docs.plane.com/reference/leave-balances/get.md): Retrieve an existing leave balance. - [List leave balances](https://docs.plane.com/reference/leave-balances/list.md): Returns leave balances in your Plane workspace. - [Leave Balance](https://docs.plane.com/reference/leave-balances/object.md): Leave balances are read-optimized snapshots of a worker's leave position for a period - [Create a leave entitlement](https://docs.plane.com/reference/leave-entitlements/create.md): Assign a leave policy to a worker. - [Delete a leave entitlement](https://docs.plane.com/reference/leave-entitlements/delete.md): Soft-delete a leave entitlement by ending it today. - [Get a leave entitlement](https://docs.plane.com/reference/leave-entitlements/get.md): Retrieve an existing leave entitlement. - [List leave entitlements](https://docs.plane.com/reference/leave-entitlements/list.md): Returns leave entitlements in your Plane workspace. - [Leave Entitlement](https://docs.plane.com/reference/leave-entitlements/object.md): Leave entitlements bind a leave policy to a worker, with optional per-worker overrides - [Update a leave entitlement](https://docs.plane.com/reference/leave-entitlements/update.md): Update manual entitlement overrides or its end date. - [Create a leave policy](https://docs.plane.com/reference/leave-policies/create.md): Create a leave policy in your Plane workspace. - [Delete a leave policy](https://docs.plane.com/reference/leave-policies/delete.md): Delete a custom leave policy. - [Get a leave policy](https://docs.plane.com/reference/leave-policies/get.md): Retrieve an existing leave policy. - [List leave policies](https://docs.plane.com/reference/leave-policies/list.md): Returns leave policies visible to your Plane workspace. - [Leave Policy](https://docs.plane.com/reference/leave-policies/object.md): Leave policies define accrual, carryover, payout, and applicability rules for a leave type - [Update a leave policy](https://docs.plane.com/reference/leave-policies/update.md): Update a custom leave policy. - [Approve a leave request](https://docs.plane.com/reference/leave-requests/approve.md): Approve an existing leave request. - [Create a leave request](https://docs.plane.com/reference/leave-requests/create.md): Create a leave request for a worker. - [Decline a leave request](https://docs.plane.com/reference/leave-requests/decline.md): Decline an existing leave request. - [Get a leave request](https://docs.plane.com/reference/leave-requests/get.md): Retrieve an existing leave request. - [List leave requests](https://docs.plane.com/reference/leave-requests/list.md): Returns leave requests in your Plane workspace. - [Leave Request](https://docs.plane.com/reference/leave-requests/object.md): Leave requests represent a worker's time-off requests - [Create a leave transaction](https://docs.plane.com/reference/leave-transactions/create.md): Create a manual leave balance adjustment. - [Get a leave transaction](https://docs.plane.com/reference/leave-transactions/get.md): Retrieve a single leave transaction within a balance ledger. - [List leave transactions](https://docs.plane.com/reference/leave-transactions/list.md): Returns the ledger for one leave balance. - [Leave Transaction](https://docs.plane.com/reference/leave-transactions/object.md): Leave transactions are ledger entries that explain every change to a leave balance - [Cancel a leave](https://docs.plane.com/reference/leaves/cancel.md): Cancel an existing leave. - [Create a leave](https://docs.plane.com/reference/leaves/create.md): Record approved leave for a worker. - [Get a leave](https://docs.plane.com/reference/leaves/get.md): Retrieve an existing leave. - [List leaves](https://docs.plane.com/reference/leaves/list.md): Returns leaves in your Plane workspace. - [Leave](https://docs.plane.com/reference/leaves/object.md): Leaves represent time away from work for a worker - [Get a location](https://docs.plane.com/reference/locations/get.md): Retrieve the details of an existing work location. - [List locations](https://docs.plane.com/reference/locations/list.md): Returns a list of all work locations in your Plane workspace. - [Location](https://docs.plane.com/reference/locations/object.md) - [Update a location](https://docs.plane.com/reference/locations/update.md): Update the name and/or address of an existing work location. - [Pagination](https://docs.plane.com/reference/pagination.md) - [Approve a payment request](https://docs.plane.com/reference/payment-requests/approve.md) - [Create a payment request](https://docs.plane.com/reference/payment-requests/create.md): Create a contractor payment request in your Plane workspace. - [Decline a payment request](https://docs.plane.com/reference/payment-requests/decline.md) - [Get a payment request](https://docs.plane.com/reference/payment-requests/get.md): Retrieve the details of an existing payment request. - [List payment requests](https://docs.plane.com/reference/payment-requests/list.md): Returns a list of all payment requests in your Plane workspace. - [Payment Request](https://docs.plane.com/reference/payment-requests/object.md) - [Pay a payment request](https://docs.plane.com/reference/payment-requests/pay.md) - [Cancel a payment](https://docs.plane.com/reference/payments/cancel.md): Cancel a previously created payment. - [Create a payment](https://docs.plane.com/reference/payments/create.md): To send funds to a worker on Plane, you create a new payment object. - [Get a payment](https://docs.plane.com/reference/payments/get.md): Retrieve the details of an existing payment. - [List payments](https://docs.plane.com/reference/payments/list.md): Returns a list of all payments in your Plane workspace. - [Payment](https://docs.plane.com/reference/payments/object.md) - [Payroll Change](https://docs.plane.com/reference/payroll-changes/object.md) - [Get a payroll](https://docs.plane.com/reference/payrolls/get.md): Retrieve the details of an existing payroll. - [List payrolls](https://docs.plane.com/reference/payrolls/list.md): Returns a list of payrolls in your Plane workspace. - [Payroll](https://docs.plane.com/reference/payrolls/object.md) - [Project](https://docs.plane.com/reference/projects/object.md) - [Get a refund](https://docs.plane.com/reference/refunds/get.md): Retrieve the details of an existing refund. - [List refunds](https://docs.plane.com/reference/refunds/list.md): Returns a list of all refunds in your Plane workspace. - [Refund](https://docs.plane.com/reference/refunds/object.md) - [Get a reporting](https://docs.plane.com/reference/reportings/get.md): Retrieve the details of an existing reporting. - [List reportings](https://docs.plane.com/reference/reportings/list.md): Returns a list of all reportings in your Plane workspace. - [Reporting](https://docs.plane.com/reference/reportings/object.md) - [Get a role](https://docs.plane.com/reference/roles/get.md): Retrieve the details of an existing role. - [List roles](https://docs.plane.com/reference/roles/list.md): Returns a list of all roles in your Plane workspace. - [Role](https://docs.plane.com/reference/roles/object.md) - [Sandboxes](https://docs.plane.com/reference/sandboxes.md): Create isolated test workspaces to safely test your Plane integration - [Create a sandbox](https://docs.plane.com/reference/sandboxes-create.md): Creates an isolated test workspace for your live Plane workspace. - [Get a sandbox](https://docs.plane.com/reference/sandboxes-get.md): Retrieves the details of an existing sandbox. - [List sandboxes](https://docs.plane.com/reference/sandboxes-list.md): Returns the sandboxes owned by your live Plane workspace. - [Sandbox](https://docs.plane.com/reference/sandboxes-object.md): Sandboxes link a live workspace to an isolated test workspace - [Source](https://docs.plane.com/reference/sources/object.md) - [Task](https://docs.plane.com/reference/tasks/object.md) - [Create a time entry](https://docs.plane.com/reference/time-entries/create.md) - [Delete a time entry](https://docs.plane.com/reference/time-entries/delete.md): Permanently deletes a time entry. - [Get a time entry](https://docs.plane.com/reference/time-entries/get.md): Retrieve details of an existing time entry. - [List time entries](https://docs.plane.com/reference/time-entries/list.md): Returns a list of all time entries in your Plane workspace. - [Time Entry](https://docs.plane.com/reference/time-entries/object.md) - [Update a time entry](https://docs.plane.com/reference/time-entries/update.md) - [Webhooks](https://docs.plane.com/reference/webhooks.md): Receive Plane events in real-time via HTTP - [Create a worker](https://docs.plane.com/reference/workers/create.md): Add a team member or vendor to Plane. - [Get a worker](https://docs.plane.com/reference/workers/get.md): Retrieve the details of an existing worker. - [Invite a worker](https://docs.plane.com/reference/workers/invite.md): Invite a worker to set up their account on Plane. - [List workers](https://docs.plane.com/reference/workers/list.md): Returns workers in your Plane workspace. - [Worker](https://docs.plane.com/reference/workers/object.md) - [Workspace](https://docs.plane.com/reference/workspaces/object.md)