Create a contract with an auto-generated bundle.

This operation will create a contract inside an automatically generated bundle.

Use this endpoint to add a new contract to an existing Bundle . For example, an employment contract can be added to the bundle which includes the employment offer letter. The bundleId is a unique ID to identify the bundle.

Emphasize that all the fields are required when creating the contract.

The following code snippet is an example of the body for an Employment Agreement:

{
    "created_by_user_id": XXX,
    "name": "Software engineer",
    "fields": [
        
    {
        "id": 6078,
        "label": "Total number of work Hours",
        "name": "contract_workHours",
        "value": "22"
    },
    {
        "id": 6079,
        "label": "Work Location",
        "name": "contract_workLocation",
        "value": "Sevilla"
    },
    {
        "id": 6080,
        "label": "Job title",
        "name": "contract_jobTitle",
        "value": "Software engineer"
    },
    {
        "id": 6082,
        "label": "Notice Period",
        "name": "contract_noticePeriod",
        "value": "noticePeriod1Month",
        "nested_fields": [
            {
                "id": 6121,
                "label": "Restriction Period",
                "name": "contract_restrictionPeriod1Month",
                "value": "restrictionPeriod1Month1Month"
            }
        ]
    },
    {
        "id": 6084,
        "label": "The Employment Commencement Date",
        "name": "contract_startDate",
        "value": "01/11/2022"
    },
    {
        "id": 6085,
        "label": "Agreement Date",
        "name": "contract_agreementDate",
        "value": "01/10/2022"
    },
    {
        "id": 6086,
        "label": "Line Manager",
        "name": "contract_lineManager",
        "value": "Sales"
    },
    {
        "id": 6087,
        "label": "Is this a Software Role?",
        "name": "contract_softwareRole",
        "value": "softwareRoleYes"
    },
    {
        "id": 6088,
        "label": "Is this role remote?",
        "name": "contract_remoteWork",
        "value": "remoteWorkYes"
    },
    {
        "id": 6089,
        "label": "Is this a full time or part time role?",
        "name": "contract_employmentType",
        "value": "fullTime",
        "nested_fields": [
            {
                "id": 6134,
                "label": "Please specify the working hours",
                "name": "contract_employment2",
                "value": "38"
            }
        ]
    },
    {
        "id": 6090,
        "label": "Is the Term of Employment Fixed or not?",
        "name": "contract_fixedTerm",
        "value": "fixedTermNo"
    },
    {
        "id": 6093,
        "label": "Is the Lunch Break paid or unpaid?",
        "name": "contract_paidLunchBreak",
        "value": "paidLunchBreakYes"
    },
    {
        "id": 6094,
        "label": "How will the Employee be paid during the Employment?",
        "name": "contract_paymentType",
        "value": "salary",
        "nested_fields": [
            {
                "id": 6083,
                "label": "Annual salary",
                "name": "contract_salary",
                "value": "[\"£\",2543230000]"
            }
        ]
    },
    {
        "id": 6095,
        "label": "Payment Frequency",
        "name": "contract_paymentFrequency",
        "value": "month"
    },
    {
        "id": 6096,
        "label": "Payment Day",
        "name": "contract_paymentDay",
        "value": "28th"
    },
    {
        "id": 6100,
        "label": "Is the Employee eligible for a pension?",
        "name": "contract_pension",
        "value": "pensionYes",
        "nested_fields": [
            {
                "id": 6138,
                "label": "Please provide the name of the Pension Scheme provider",
                "name": "contract_periodicRentConversion",
                "value": "Provider example CO"
            }
        ]
    },
    {
        "id": 6101,
        "label": "Is the Employee entitled to benefits?",
        "name": "contract_benefits",
        "value": "benefitsNo"
    },
    {
        "id": 6103,
        "label": "Will the Employee be part of a Share Option Plan?",
        "name": "contract_shareOptionPlan",
        "value": "shareOptionPlanNo"
    },
    {
        "id": 6104,
        "label": "Holiday Period",
        "name": "contract_holidayPeriod",
        "value": "June to September"
    },
    {
        "id": 6105,
        "label": "Number of paid holiday days?",
        "name": "contract_holidayAmount",
        "value": "28"
    },
    {
        "id": 6106,
        "label": "Does the allowance include public holidays or not?",
        "name": "contract_holidaysPublic",
        "value": "holidaysPublicYes"
    },
    {
        "id": 6107,
        "label": "Is there a collective agreement which affects this Employment?",
        "name": "contract_collectiveAgreement",
        "value": "collectiveAgreementNo"
    },
    {
        "id": 6109,
        "label": "Is the Employee entitled to sick pay?",
        "name": "contract_sickPay",
        "value": "sickPayYes"
    },
    {
        "id": 6110,
        "label": "Will there be a Probationary Period?",
        "name": "contract_probationPeriod",
        "value": "probationPeriodNo"
    },
    {
        "id": 6115,
        "label": "Will any previous Employment count towards the period of continuous employment? ",
        "name": "contract_previousEmployment",
        "value": "previousEmploymentNo"
    },
    {
        "id": 6118,
        "label": "Does the Company have a staff handbook?",
        "name": "contract_staffHandBook",
        "value": "staffHandBookNo"
    },
    {
        "id": 6120,
        "label": "Is the Employee allowed Outside Interests?",
        "name": "contract_outsideInterests",
        "value": "outsideInterestsYes"
    },
    {
        "id": 6122,
        "label": "Will the Employee be required to complete training?",
        "name": "contract_training",
        "value": "trainingYes",
        "nested_fields": [
            {
                "id": 6124,
                "label": "Training Details",
                "name": "contract_trainingDetails",
                "value": "training details example"
            }
        ]
    },
    {
        "id": 6123,
        "label": "Does the Employer have a Data Protection Policy?",
        "name": "contract_dataProtectionPolicy",
        "value": "dataProtectionPolicyYes"
    },
    {
        "id": 6125,
        "label": "Please confirm if the Employee is entitled to Paid Maternity Leave",
        "name": "contract_paidLeaveMaternity",
        "value": "paidLeaveMaternityNo"
    },
    {
        "id": 6126,
        "label": "Please confirm if the Employee is entitled to Paid Paternity Leave",
        "name": "contract_paidLeavePaternity",
        "value": "paidLeavePaternityYes"
    },
    {
        "id": 6127,
        "label": "Please confirm if the Employee is entitled to Shared Parental Leave",
        "name": "contract_paidLeaveParental",
        "value": "paidLeaveParentalYes"
    },
    {
        "id": 6128,
        "label": "Please confirm if the Employee is entitled to Bereavement Leave",
        "name": "contract_paidLeaveBereavement",
        "value": "paidLeaveBereavementNo"
    },
    {
        "id": 6129,
        "label": "Please confirm if the Employee is entitled to any Other Paid Leave",
        "name": "contract_paidLeaveOther",
        "value": "paidLeaveOtherNo"
    },
    {
        "id": 6133,
        "label": "Please confirm if the Employee is entitled to Adoption Leave",
        "name": "contract_paidLeaveAdoption",
        "value": "paidLeaveAdoptionNo"
    },
    {
        "id": 6135,
        "label": "Will the Employee be required to work Abroad?",
        "name": "contract_wifi",
        "value": "workAbroadYes"
    },
    {
        "id": 6137,
        "label": "Does the Employer have a sickness policy?",
        "name": "contract_solAgent",
        "value": "sicknessPolicyYes"
    },
    {
        "id": 6139,
        "label": "Would the Employer like to add their logo to the agreement?",
        "name": "contract_logo",
        "value": "logoNo"
    },
    {
        "id": 6141,
        "label": "Will the employee be entitled to paid overtime?",
        "name": "contract_overTime",
        "value": "overTimeNo"
    },
    {
        "id": 6145,
        "label": "Will the employee receive a pay increase on the completion of the probationary period?",
        "name": "contract_probationaryPeriodPayIncrease",
        "value": "payIncreaseNo"
    }

    ],
    "template_id": 227
}

The following code snippet is an example of the body for an Assured Shorthold Tenancy Agreement:

{
    "created_by_user_id": xxxxx,
    "name": "Software engineer",
    "fields": [
        {
            "id": 5931,
            "label": "Address of the property",
            "name": "contract_address",
            "value": "Calle Cuna, Sevilla"
        },
        {
            "id": 5932,
            "label": "Agreement Date",
            "name": "contract_agreementDate",
            "value": "01/09/2022"
        },
        {
            "id": 5933,
            "label": "Is the property subject to a mortgage?",
            "name": "contract_mortgage",
            "value": "mortgageNo"
        },
        {
            "id": 5934,
            "label": "How frequently will the rent be paid?",
            "name": "contract_rentFrequency",
            "value": "month",
            "nested_fields": [
                {
                    "id": 6015,
                    "label": "Would the Landlord and Tenant like to introduce a break clause?",
                    "name": "contract_breakClause",
                    "value": "breakClauseYes",
                    "nested_fields": [
                        {
                            "id": 6016,
                            "label": "After how many months of the Tenancy can the Landlord and Tenant serve a break notice?",
                            "name": "contract_breakClauseStart",
                            "value": "3 months"
                        }
                    ]
                }
            ]
        },
        {
            "id": 5935,
            "label": "Is the Landlord bound by a Superior Lease?",
            "name": "contract_superiorLease",
            "value": "superiorLeaseNo"
        },
        {
            "id": 5936,
            "label": "Start Date",
            "name": "contract_startDate",
            "value": "16/10/2022"
        },
        {
            "id": 5937,
            "label": "Will the Tenant be assigned a parking space?",
            "name": "contract_parking",
            "value": "parkingNo"
        },
        {
            "id": 5939,
            "label": "Has the Landlord engaged an Agent to enter into this agreement?",
            "name": "contract_agent",
            "value": "agentNo"
        },
        {
            "id": 5944,
            "label": "How long after the end of the tenancy will the deposit be returned? ",
            "name": "contract_depositReturn",
            "value": "28 Working Days"
        },
        {
            "id": 5945,
            "label": "Rent Amount",
            "name": "contract_individualRent",
            "value": "28 Working Days"
        },
        {
            "id": 5947,
            "label": "What is the nature of the AST?",
            "name": "contract_letType",
            "value": "hmo",
            "nested_fields": [
                {
                    "id": 5956,
                    "label": "Room",
                    "name": "contract_room",
                    "value": "hmo"
                },
                {
                    "id": 5967,
                    "label": "Would you like to attach the House Rules?",
                    "name": "contract_itemRepair",
                    "value": "hmoHouseRulesNo"
                }
            ]
        },
        {
            "id": 5948,
            "label": "Will the tenant be required to clean the Property to a professional standard on check out?",
            "name": "contract_professionalClean",
            "value": "professionalCleanNo"
        },
        {
            "id": 5949,
            "label": "Is the Landlord responsible for paying any utilities?",
            "name": "contract_landlordUtilities",
            "value": "landlordUtilitiesNo"
        },
        {
            "id": 5952,
            "label": "Does the property have shared facilities?",
            "name": "contract_sharedFacilities",
            "value": "sharedFacilitiesNo"
        },
        {
            "id": 5953,
            "label": "Are there any permitted occupiers?",
            "name": "contract_permittedOccupiers",
            "value": "permittedOccupiersNo"
        },
        {
            "id": 5957,
            "label": "End Date",
            "name": "contract_endDate",
            "value": "01/09/2026"
        },
        {
            "id": 5960,
            "label": "Is the Tenant required to have a guarantor?",
            "name": "contract_guarantorRequired",
            "value": "guarantorNo"
        },
        {
            "id": 5962,
            "label": "Is the Tenant responsible for paying any utilities?",
            "name": "contract_tenantUtilities",
            "value": "tenantUtilitiesNo"
        },
        {
            "id": 5964,
            "label": "Who is responsible for paying council tax?",
            "name": "contract_councilTax",
            "value": "councilTenant"
        },
        {
            "id": 5966,
            "label": "Will the tenancy continue as a contractual periodic tenancy after the End Date?",
            "name": "contract_periodicRentConversion",
            "value": "periodicNo"
        },
        {
            "id": 5970,
            "label": "Is there any part of the property (including the exterior) which is excluded from this tenancy?",
            "name": "contract_propertyExclusions",
            "value": "propertyExclusionsNo"
        },
        {
            "id": 5975,
            "label": "Who will pay the deposit?",
            "name": "contract_depositOther",
            "value": "depositOtherTenant"
        },
        {
            "id": 5977,
            "label": "Would the Landlord or Agent like to upload their logo to the Agreement?",
            "name": "contract_logo",
            "value": "logoNo"
        },
        {
            "id": 5978,
            "label": "Is the Landlord happy to receive legal notices via email?",
            "name": "contract_noticeConsentLandlord",
            "value": "noticeConsentLandlordNo"
        },
        {
            "id": 5979,
            "label": "Is the Tenant happy to receive legal notices via email?",
            "name": "contract_noticeConsentTenant",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5980,
            "label": "Deposit Amount",
            "name": "contract_depositAmount",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5981,
            "label": "Account holder name where rent payments must be paid",
            "name": "contract_bankHolderName",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5982,
            "label": "Bank Account Number",
            "name": "contract_bankAccountNumber",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5983,
            "label": "Name of the bank where rent payments must be paid",
            "name": "contract_bankDetails",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5984,
            "label": "Bank Account Sort Code",
            "name": "contract_bankAccountSortCode",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5985,
            "label": "Please specify the Name and address of the Deposit provider's next of kin",
            "name": "contract_depositNextKinName",
            "value": "noticeConsentTenantNo"
        },
        {
            "id": 5986,
            "label": "By which day of the week or month should rent payments be made?",
            "name": "contract_paymentDay",
            "value": "1st calendar day of the month"
        },
        {
            "id": 5987,
            "label": "Is the Tenant required to pay an additional sum to cover the first Days of Rent?",
            "name": "contract_extraFee",
            "value": "extraFeeNo"
        },
        {
            "id": 5988,
            "label": "Has the landlord taken out insurance against standard risks?",
            "name": "contract_insuredRisk",
            "value": "insuredRiskNo"
        },
        {
            "id": 5989,
            "label": "Is the Tenant allowed pets?",
            "name": "contract_pets",
            "value": "petsNo"
        },
        {
            "id": 5990,
            "label": "Is there a Lead Tenant for the purposes of the deposit?",
            "name": "contract_leadTenant",
            "value": "leadTenantNo"
        },
        {
            "id": 5991,
            "label": "Would you like to add any special terms to the tenancy agreement?",
            "name": "contract_specialTerms",
            "value": "specialTermsYes",
            "nested_fields": [
                {
                    "id": 5961,
                    "label": "How many special terms are there?",
                    "name": "contract_specialTermsNumber",
                    "value": "specialTermsOne",
                    "nested_fields": [
                        {
                            "id": 5992,
                            "label": "Please state the special term as you want it to appear in the contract",
                            "name": "contract_specialTermsDetails",
                            "value": "special term example"
                        }
                    ]
                }
            ]
        },
        {
            "id": 5999,
            "label": "Bank reference",
            "name": "contract_bankReference",
            "value": "63572GYBGIEXAMPLE"
        },
        {
            "id": 6000,
            "label": "Would you like to attach the Inventory and Schedule of Condition?",
            "name": "contract_inventory",
            "value": "inventoryNo"
        },
        {
            "id": 6013,
            "label": "Would the landlord or agent like the payments to be made by standing order?",
            "name": "contract_standingOrder",
            "value": "standingOrderNo"
        },
        {
            "id": 6014,
            "label": "Must the Tenant notify the landlord immediately if they cease to be in full time employment?",
            "name": "contract_tenantEmployment",
            "value": "tenantEmploymentNo"
        }
    ],
    "template_id": 223
}

📘

Contracts

There is no limit on the number of contracts inside a bundle. However, a bundle tends to group contracts which are related to the same parties.

📘

Bundles

For more information about bundles, please read the Bundle section of of the Legislate concepts section.

🚧

Contract fields

When creating a contract you will need to provide the contract fields. Use the get template terms endpoint to retrieve the contract fields you need to provide.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!