Skip to main content

Contracts, agreements & HR letters

Your workspace keeps three related sets of official documents:

  • Contracts — the employment agreement for each person: type, dates, salary, and terms.
  • Agreements — what else the company agrees with a person: confidentiality, a company vehicle, equipment, a loan, and the like.
  • HR letters — the letters HR issues to employees (experience certificates, salary certificates, warning letters, and so on).

Agreements and HR letters are issued as branded PDFs that carry a QR verification code so an outside party — a bank, an embassy, a future employer — can confirm the document is genuine.


Contracts​

Open Contracts from the admin sidebar (/admin/contracts) to see every contract in your workspace with its employee, type, dates, and status.

Employment contracts and their signature status

Contract types​

TypeMeaning
PermanentOpen-ended employment, usually no end date
Fixed termRuns between a start and end date
ProbationaryTrial period, often with a probation length in months
ConsultantContractor / consultant engagement

Contract statuses​

A contract moves through these states:

  • Draft — created but not yet in force. You can still edit everything.
  • Active — the live agreement for that employee.
  • Renewed — replaced by a newer contract created through the renew action.
  • Terminated — ended early by HR.
  • Expired — its end date has passed.

Create a contract​

A contract can only be created for an employee who already has a salary structure assigned. The contract states the same gross salary payroll will pay, so the figure comes from the salary assignment rather than being retyped. The server refuses to create a contract without one (the error points you at Payroll → Employee Salaries), and the form shows an amber notice with an Assign a salary structure button (linking /admin/payroll/salaries) and keeps the submit disabled while the picked employee has none.

  1. Go to Contracts and choose Create contract (/admin/contracts/create).
  2. Pick the employee. The picker is not limited to active employees — it includes New (Pending Activation) hires, since a new hire is the most common subject of a contract and accepting it is what activates them. Employees who have left (terminated, resigned, retired, or separated) are still excluded.
  3. Once you pick an employee, the form pre-fills the start date (from their joining date), the gross salary and linked salary structure (from their current salary assignment), and the probation months (derived from their recorded probation end date). Only empty fields are filled — anything you already typed is kept.
  4. Choose the contract type and set the end date for fixed-term or probationary contracts.
  5. Review the pay. The gross salary is pre-filled from the salary assignment and the assigned figure is shown under the field; you can override the number, but the form flags the mismatch inline: Changed — this contract will state a different figure from payroll.
  6. Add the terms and conditions text, or leave it to be filled from a template.
  7. If the employee owns inventions, works or know-how from before joining that they keep, list them under Pre-existing intellectual property, one item per line. Leave it empty if there is none (see below).
  8. Save. If you leave the contract number blank, the system generates one for you.

New contracts start in Draft. When the terms are final, open the contract and choose Activate to make it the employee's live agreement.

tip

/admin/contracts/create?employeeId=<id> opens the form with the employee preselected. This is where the activation checklist on the employee profile and the onboarding "Create employment contract" task land.

note

Creating and renewing contracts needs the Contracts: create permission; editing, activating, terminating, and renewing need Contracts: update. See /docs/workspace/roles-and-permissions. Drafting a contract needs only Contracts: create — the salary prefill is served to contract creators without requiring payroll's salary-view permission.

Pre-existing intellectual property​

The standard employment agreement includes a schedule of pre-existing intellectual property: what the employee created before joining and keeps as their own. The agreement treats anything not listed there as company property, so record the declaration before the employee signs.

  • The schedule prints the Pre-existing intellectual property field of the contract, each line on its own line. When the field is empty it prints None disclosed.
  • You can fill it in on the create form, or later from the contract's detail page: Edit next to Pre-existing intellectual property. It can be changed until the contract is accepted in the portal or a signed copy is uploaded, and not on a terminated or renewed contract.
  • Renewing a contract carries the declaration over to the new contract.
  • In a custom contract template, the declaration is the {{preExistingIP}} variable. Use {{#if preExistingIP}}…{{else}}…{{/if}} to print your own wording when nothing was declared.

Templates​

Contract templates hold your standard terms so you don't retype them for every hire. Manage them under Contracts → Templates (/admin/contracts/templates). You can create, edit, delete, and preview a template's rendered output before using it.

A contract is printed from your workspace's default agreement unless you choose otherwise. Where you have templates of your own that are switched on, New contract offers an Agreement template list: pick one and that contract is printed from it, and so is its renewal. The standard designs in the gallery are not in that list; copy one to make it yours first.

  • National ID. The standard agreement names the employee's national ID (for example a Social Security Number) in its opening paragraph, its details table, the acceptance record and the signature page. When the employee has no ID on record, it leaves that wording out. In your own template, {{employee.cnic}} prints a dash when no ID is recorded; wrap the wording in {{#if employee.hasNationalId}}…{{/if}} to leave it out instead.
  • Agreement date. {{date}} is the date the agreement carries in its header and on its signature page. See Signing a contract for which date that is.

Signing a contract​

There are two ways a contract gets signed:

  • Electronic acceptance — the employee opens Contracts and agreements in their portal (/portal/contract), reviews the agreement, and accepts it. The system records the acceptance along with the employee's IP address and browser for the record.
  • Physical copy — HR prints, signs, and scans the agreement, then opens the contract and uses Upload signed copy to attach the scan and record the signed date.

Until it is signed, the agreement is dated today. Once it is signed, it is dated the day it was signed: the day the employee accepted it in the portal (in your workspace's time zone), or the signed date recorded with the uploaded copy, whichever came first. That date stays the same every time anyone opens or downloads the agreement.

Signing does more than complete the paperwork. For an employee still in New (Pending Activation), either signature path activates them automatically — their status flips to Active and their pro-rata leave for the current fiscal year is allocated. The Upload signed copy path matters especially for employees created without a portal login, who cannot e-accept: recording the signed paper copy is their only activation route.

Activation is idempotent and one-directional. It only ever moves a New employee to Active — it never revives someone terminated, resigned, or retired, and re-signing does nothing for an already-active employee. See Employees for the full picture of statuses and activation.

You can also record witnesses for the printable copy, and if an acceptance was made in error, an admin can revoke acceptance with a reason.

Download the PDF​

From a contract's detail page you can download it as a PDF. Three variants are available:

  • Plain — the agreement text only.
  • Default — the standard rendered agreement.
  • Stamp overlay — a version prepared to carry the company stamp/seal.

Employees can download their own agreement from the portal.

Renew a contract​

Only active or expired contracts can be renewed.

  1. Open the contract and choose Renew.
  2. Enter the new end date — it must be later than the current end date (or the start date if there isn't one).
  3. Optionally set a new salary and a reason for the renewal.

Renewing does three things automatically:

  • Records a renewal history entry (old end date, new end date, salary, reason).
  • Marks the current contract as Renewed.
  • Creates a fresh Active contract that begins where the old one ended, carrying over the type, salary structure, terms, and pre-existing intellectual property declaration.

Expiring contracts​

Open Contracts → Expiring (/admin/contracts/expiring) to see contracts approaching their end date so you can renew or terminate them in time. The window defaults to the next 30 days; you can widen or narrow it.

Agreements​

Some things a company agrees with its people do not belong in the employment contract: keeping information confidential, using a company vehicle, holding company equipment, the terms of a loan, a non-compete, a contractor's services. Agreements are where you keep those. Open Contracts → Agreements (/admin/agreements).

An agreement is separate from the contract. Issuing, accepting or ending one never changes the employee's contract or their status.

The tiles at the top count what is waiting for an answer, in force, expiring within 30 days and declined. Select a tile to list those agreements.

Agreements: tiles for what is waiting, in force, expiring and declined, above each agreement with its person, state and dates

Agreement types​

Contracts → Agreement types (/admin/agreements/types) is your catalogue. Each type has a name, its text, what it is about, and how long an agreement of it runs.

Every workspace starts with six types: Confidentiality, Company vehicle, Equipment handover, Loan, Non-compete, and Contractor services. They are written in your workspace's document language.

caution

The starting types hold starting text, not legal advice. Each one is switched off until you switch it on. Read the text, adapt it to the law where you employ people, and switch it on only then. A type that is switched off cannot be issued.

To add a type of your own, choose New type. For each type you set:

SettingWhat it does
Name and DescriptionThe name is the title printed on every agreement of this type.
Text of the agreementWhat the person reads and accepts.
What it is aboutThe person only, a loan of the person, or an asset held by the person.
How long it runs, in monthsThe expiry date is worked out from the effective date. Leave it empty for no end date.
Name whoever sends it as signing for the companyPrints the sender's name and job title as the company's signatory.
Switched onOnly a type that is switched on can be issued.

A starting type cannot be deleted, and neither can a type that agreements were issued from. Switch it off instead.

Fields in the text​

The text can hold fields that are filled in when an agreement is issued: the person's name, job title and department, the company's name and address, the agreement's number and dates, the signatory, and, for a type about a loan or an asset, that loan's amount and instalments or that asset's name and tag. Select a field in the Fields panel to put it where the cursor is.

Two rules keep a wrong document from going out:

  • A type cannot be saved with a field that is not in the panel, with a field that has formatting inside it, or with a loan or asset field in a type that is not about one.
  • An agreement cannot be issued while a field its text uses has nothing to fill it. The message names the field. A text that prints the expiry date needs an expiry date; a text that prints the company's address needs one on the company profile; a text that prints the signatory's job title needs whoever sends it to have an employee record.

Changing a type's text changes the agreements issued from then on. An agreement that was already sent keeps the text it was sent with.

An agreement type: its name and text, with what it is about, how long it runs and the fields that can be put into the text

Issue an agreement​

  1. Go to Agreements and choose Issue an agreement (/admin/agreements/new).
  2. Pick the agreement type. Only types that are switched on are listed.
  3. Choose who it is for: everyone, chosen departments, branches or roles, or named people. Each person gets their own copy. A type about a loan or an asset is issued to one named person, and you then pick the loan or the asset.
  4. Set the effective date and the expiry: as the type says, no end date, or a date of your own.
  5. With one named person chosen, Show preview shows their copy and names any field that has nothing to fill it.
  6. Choose Send now, or Save as draft to send it later from its own page.

An audience is everyone employed in it, including people on leave. One request issues to at most 200 people; for a larger audience, issue it one department or branch at a time.

When some people cannot be given the agreement, the others still get theirs, and the result lists who was left out and why, which is usually an agreement of the same type already waiting for them.

Each agreement gets a number such as AGR-2027-00012, counted from 1 each year.

What the person does​

Sending emails the person a link. In their portal they open Contracts and agreements, read the agreement to the end, and then either:

  • Accept, by typing their full name as it appears on the agreement. The acceptance is recorded with the date and time, the name typed, the IP address and the browser.
  • Decline, giving a reason. Whoever sent the agreement is emailed the reason.

From the moment an agreement is sent, its text cannot be changed. The record keeps a fingerprint (SHA-256) of the text as it was sent.

Someone who has not answered is reminded by email after three days and once more after seven. You can also choose Send a reminder on the agreement's page.

Agreement statuses​

StatusMeaning
DraftWritten, not yet sent. A draft can be deleted.
Waiting for an answerSent to the person.
In forceAccepted.
DeclinedThe person refused it and gave a reason.
WithdrawnYou withdrew it before it was accepted, or it was still waiting for an answer when its expiry date passed.
EndedYou ended it early after it was accepted.
ExpiredIts expiry date has passed.

Withdraw, end and renew​

  • Withdraw an agreement that is waiting for an answer or was declined. The person can no longer accept it, its QR code no longer verifies, and it has no PDF to download from then on.
  • End agreement ends one that is in force, for example when a vehicle is returned. It stays on record as an agreement that was in force and has ended.
  • Renew an agreement that is in force, expired or ended. A new draft is written for the same person from the type's current text. Check it, then send it.

Withdrawing and ending both ask for a reason, which is kept on the record.

Expiring agreements​

The day after its expiry date, an agreement in force becomes Expired. One that is still waiting for an answer on that day can no longer be accepted, so it is Withdrawn automatically, with that as the reason. The people who manage agreements are emailed once about each agreement, 30 days before it runs out, in one message that lists all of them.

PDF and verification​

Download PDF on an agreement's page gives the document with the signature blocks and a QR verification code. The person can download their own copy from the portal. A draft has no PDF, and neither has a withdrawn agreement.

Scanning the code confirms the agreement is genuine and shows its number, its dates and where it stands. It never shows the agreement's text: see Document verification.

note

Reading agreements and their types needs the Agreements: view permission. Writing types, and issuing, sending, withdrawing, ending and renewing agreements, need Agreements: manage. HR Manager and HR Officer hold both by default, and Accountant holds view. A person needs no extra permission to read and answer their own agreements. See /docs/workspace/roles-and-permissions.


HR letters​

Open HR letters from the admin sidebar (/admin/hr-letters) to see every letter your workspace has issued.

Issued HR letters

Letter types​

You can issue these letter types:

Letter typeTypical use
Offer letterJob offer before joining
Appointment letterConfirms the appointment on joining
Confirmation letterConfirms an employee after probation
Experience certificateProof of prior employment
Salary certificateStates current salary, e.g. for a bank
Increment letterRecords a pay increase
Promotion letterRecords a promotion
Transfer letterRecords a move between locations/departments
Warning letterFormal disciplinary warning
Termination letterEnds employment
CustomAny other letter you design

A confirmation letter is normally generated automatically when you confirm an employee at the end of probation (see Onboarding & offboarding), but you can also issue one manually from the Issue screen like any other type. The manual form asks for the same details the automatic path fills in — designation, department, joining date, and confirmation date — so a re-issue or correction matches the auto-issued original.

Letter templates​

Manage the wording under HR letters → Templates (/admin/hr-letters/templates). Each template has a name, a type from the list above, and body content. Templates use placeholder tokens that get filled in with the employee's data and the values you enter when issuing. You can preview a template — saved or unsaved — before using it. Deactivating a template hides it from the issue screen without deleting past letters.

Issue a letter​

  1. Go to HR letters → Issue (/admin/hr-letters/issue).
  2. Choose the employee, the letter type and the template. Each standard design is listed once per language (for example "Standard Salary Certificate · EN"); the template's language decides the letter's wording and date format. For an Experience Certificate the employee search also finds people who have left.
  3. Fill in the letter's fields — these are the values that replace the template placeholders. For salary and increment letters, the current salary can be pulled in to prefill.
  4. Set the issued date and issue the letter.

Every issued letter gets a reference number automatically and a QR verification code embedded in its PDF (see Document verification below).

From the issued-letters list you can open any letter and email it to the employee as a PDF attachment.

note

Issuing letters and managing templates needs the HR letters: manage permission.

Letter requests from employees​

Employees can ask HR for certain letters themselves, instead of emailing a request.

From their portal Letters page (/portal/letters), an employee can request one of:

  • Experience certificate
  • Salary certificate
  • Appointment letter
  • Offer letter

Administrative letters — warnings, terminations, transfers, promotions, increments, and custom letters — can never be self-requested; those always originate from HR.

When requesting, the employee gives a purpose and can add who it's addressed to and any notes. On experience and salary certificates, the addressee replaces "To Whom It May Concern". An employee can cancel a request while it is still pending.

Handling requests as HR: open HR letters → Requests (/admin/hr-letters/requests). A request moves through:

  • Pending — waiting on HR.
  • Issued — fulfilled; issuing a letter against the request links the two and automatically emails the employee.
  • Rejected — declined with a reason.
  • Cancelled — withdrawn by the employee.

To fulfil a request, issue the matching letter and link it to the request; the request flips to Issued on its own. To decline, use Reject and provide a reason.

note

Reviewing and rejecting requests needs the HR letters: manage requests permission. Employees need HR letters: request to raise one and HR letters: view own to see their issued letters.


Company document library​

Company Documents → Document Library (/admin/documents/library) holds the documents the company gives its people rather than collects from them: the handbook, policies, forms. Each document has a title, a category (a free label the portal groups by), a description, a file, and an audience: Everyone, or chosen Departments, Branches, Roles or Named people, the same audience an announcement and a knowledge base article take. A narrowed audience with nobody in it cannot be saved. A document shared with a role reaches the people whose login holds that role, so someone without a login is not in it. It is a Draft until you Publish it, which needs a file; Archive takes it off the portal later and keeps everything recorded.

Tick Ask everyone to acknowledge it for a document people must confirm they have read. On publishing, everyone in the audience is emailed (Company Document to Acknowledge) and the document sits at the top of their Company Documents page until they press I have read it. The document page shows Acknowledgements: n of m, who has and who has not, and a filter for either.

Replace file on a published document makes a new version and asks everyone again: an acknowledgement is of a version, so a revised policy is never covered by a signature on the old one. The page lists people who acknowledged an earlier version as such.

Search inside the files​

People find a library document by the words written inside its file, not only by its title and description: someone who types "notice period" finds the handbook that mentions it on page twelve, with the passage around the words. The same text answers the portal's search box and the AI assistant.

When a file is uploaded, its text is read in the background, usually within a few seconds. PDF, Word (.docx) and plain text (.txt, .csv) files are read. The document page says what came of it under the file's name:

A library document's page: under the file's name, a line saying people can find the document by the words inside its file

The page saysWhat it means
People can find this document by the words inside its fileThe text was read; for a PDF, with the number of pages. A very long file is searched in its first part only (about 300,000 characters, or 1,500 pages).
No text could be read from this fileThe file opened but holds no text: almost always a scan, which is pictures of pages. People find it by its title and description only, so write a description that names what is inside, or upload the original instead of the scan.
This kind of file is not searched insideAn image, a spreadsheet, the old Word format (.doc), or a PDF protected by a password. Found by title and description.
The file is too large to search insideOver 20 MB.
The file could not be read for searchThe file is damaged, or something went wrong reading it. It is tried again on the next two days.

Files in any language are read. Right-to-left text (Arabic, Urdu, Persian) is put back in reading order, and letters that the three keyboards type differently are treated as the same letter, so a word typed on one finds the same word written on another.

Replacing the file reads the new one and forgets the old one's text at once. Files uploaded before search read them are caught up by the daily job, twenty per workspace a day, newest first.

The text is used for search and nothing else. A reader is shown the short passage around the words they looked for, and only in documents they are in the audience of; HR's own pages never display it.

Files are stored in the workspace's private storage and served only to people in the audience, with the access token; a link copied out of the portal does not open for anyone else. The library needs company_documents.manage; reading and acknowledging ride company_documents.view, which every role has.

note

No Google Drive or OneDrive sync is built in yet. The library keeps its files behind the same storage service as everything else, so the storage adapters can carry it later without changing what you set up here.

Documents from your group​

In a workspace that is part of a group, documents the group publishes appear in the library marked "From your group", with their own copy of the file in this workspace's storage. They open, are searched and are acknowledged like your own, but nobody here can edit, replace, archive or delete them: the group does, and a new file from the group arrives as a new version.

Document verification (QR codes)​

Every issued HR letter — and salary slips, tax certificates and agreements — carries a QR code and a short verification code printed on the PDF. This lets anyone holding a copy confirm it is genuine and see the official version, without logging in.

How a verifier checks a document​

  1. They scan the QR code or open the printed link, which takes them to your workspace's public verify page:

    https://<your-workspace-domain>/verify/<code>
  2. The public page shows whether the document is valid or revoked, along with the document type, the employee, the issuing company, and the relevant dates.

  3. They can download the official copy of the PDF straight from that page to compare against the copy they were handed. An agreement is the exception: the page shows its number, its dates and where it stands (accepted, ended, expired), and never the document, which is between the company and the person.

The verify page is public and requires no account. It only ever shows that single document's summary and, except for an agreement, the official PDF — nothing about other employees or other documents. Lookups are rate-limited to protect against someone guessing codes.

tip

The QR code is only embedded if your workspace has a public app URL or verified custom domain configured, so that the printed link is one an outsider can actually reach. See /docs/workspace/custom-domain.

Revoking a document​

If a letter was issued in error or is no longer valid, open it and use the Revoke action (a reason is required). After that:

  • The public verify page marks the document revoked and shows the reason.
  • The official PDF can no longer be downloaded from the verify page.

Revocation can be reversed with Unrevoke if it was a mistake. Revoking or restoring a document requires the manage permission for that document type — for letters, that's HR letters: manage.

An agreement's code is revoked when you withdraw the agreement. The verify page then says it was withdrawn before it was accepted; the reason you gave stays on your record and is not shown there. An agreement's code cannot be revoked or restored on its own: it follows the agreement. An agreement that was in force and has ended or expired still verifies, and the page says what became of it.

Brand Studio ID cards are the exception: they are revoked only in Brand Studio, which revokes the card and its QR code together and also stops the card printing, and a revoked card is never restored (issue a new one instead).


  • /docs/workspace/employees — employee records that contracts and letters draw from, and the document requests and expiry alerts
  • /docs/workspace/payroll — salary structures linked to contracts
  • /docs/workspace/roles-and-permissions — who can create, issue, and revoke