addedInput schema / properties / body / properties / attachments / items / title
Added value: +"AttachmentsDto"
changedInput schema / properties / body / properties / autoInvoice / allOf
Previous value: -[
- {
- "properties": {
- "directPayments": {
- "description": "Direct Payments",
- "example": true,
- "type": "boolean"
- },
- "enabled": {
- "description": "Enable Auto Invoice",
- "example": true,
- "type": "boolean"
- }
- },
- "required": [
- "enabled"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "directPayments": {
+ "description": "Direct Payments",
+ "example": true,
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Enable Auto Invoice",
+ "example": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "AutoInvoicingDto",
+ "type": "object"
+ }
+]
changedInput schema / properties / body / properties / businessDetails / properties / address / allOf
Previous value: -[
- {
- "properties": {
- "addressLine1": {
- "description": "Address Line 1",
- "example": "9931 Beechwood",
- "type": "string"
- },
- "addressLine2": {
- "description": "Address Line 2",
- "example": "Beechwood",
- "type": "string"
- },
- "city": {
- "description": "City",
- "example": "St. Houston",
- "type": "string"
- },
- "countryCode": {
- "description": "Country Code",
- "example": "US",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal Code",
- "example": "559-6993",
- "type": "string"
- },
- "state": {
- "description": "State",
- "example": "TX",
- "type": "string"
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "addressLine1": {
+ "description": "Address Line 1",
+ "example": "9931 Beechwood",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "Address Line 2",
+ "example": "Beechwood",
+ "type": "string"
+ },
+ "city": {
+ "description": "City",
+ "example": "St. Houston",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country Code",
+ "example": "US",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal Code",
+ "example": "559-6993",
+ "type": "string"
+ },
+ "state": {
+ "description": "State",
+ "example": "TX",
+ "type": "string"
+ }
+ },
+ "title": "AddressDto",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / properties / businessDetails / title
Added value: +"BusinessDetailsDto"
changedInput schema / properties / body / properties / contactDetails / allOf
Previous value: -[
- {
- "properties": {
- "additionalEmails": {
- "description": "Secondary email addresses for the contact to be saved",
- "items": {
- "properties": {
- "email": {
- "example": "alex@example.com",
- "type": "string"
- }
- },
- "required": [
- "email"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "address": {
- "properties": {
- "addressLine1": {
- "description": "Address Line 1",
- "example": "9931 Beechwood",
- "type": "string"
- },
- "addressLine2": {
- "description": "Address Line 2",
- "example": "Beechwood",
- "type": "string"
- },
- "city": {
- "description": "City",
- "example": "St. Houston",
- "type": "string"
- },
- "countryCode": {
- "description": "Country Code",
- "example": "US",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal Code",
- "example": "559-6993",
- "type": "string"
- },
- "state": {
- "description": "State",
- "example": "TX",
- "type": "string"
- }
- },
- "type": "object"
- },
- "companyName": {
- "description": "Contact Company Name",
- "example": "ABC Corp.",
- "type": "string"
- },
- "customFields": {
- "description": "Custom Values",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "email": {
- "description": "Contact Email",
- "example": "alex@example.com",
- "type": "string"
- },
- "id": {
- "description": "Contact ID",
- "example": "6578278e879ad2646715ba9c",
- "type": "string"
- },
- "name": {
- "description": "Contact Name",
- "example": "Alex",
- "type": "string"
- },
- "phoneNo": {
- "description": "Contact Phone Number",
- "example": "+1234567890",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "phoneNo",
- "email"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "additionalEmails": {
+ "description": "Secondary email addresses for the contact to be saved",
+ "items": {
+ "properties": {
+ "email": {
+ "example": "alex@example.com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "email"
+ ],
+ "title": "AdditionalEmailsDto",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "address": {
+ "properties": {
+ "addressLine1": {
+ "description": "Address Line 1",
+ "example": "9931 Beechwood",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "Address Line 2",
+ "example": "Beechwood",
+ "type": "string"
+ },
+ "city": {
+ "description": "City",
+ "example": "St. Houston",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country Code",
+ "example": "US",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal Code",
+ "example": "559-6993",
+ "type": "string"
+ },
+ "state": {
+ "description": "State",
+ "example": "TX",
+ "type": "string"
+ }
+ },
+ "title": "AddressDto",
+ "type": "object"
+ },
+ "companyName": {
+ "description": "Contact Company Name",
+ "example": "ABC Corp.",
+ "type": "string"
+ },
+ "customFields": {
+ "description": "Custom Values",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "email": {
+ "description": "Contact Email",
+ "example": "alex@example.com",
+ "type": "string"
+ },
+ "id": {
+ "description": "Contact ID",
+ "example": "6578278e879ad2646715ba9c",
+ "type": "string"
+ },
+ "name": {
+ "description": "Contact Name",
+ "example": "Alex",
+ "type": "string"
+ },
+ "phoneNo": {
+ "description": "Contact Phone Number",
+ "example": "+1234567890",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "phoneNo",
+ "email"
+ ],
+ "title": "ContactDetailsDto",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / properties / discount / title
Added value: +"DiscountDto"
changedInput schema / properties / body / properties / frequencySettings / allOf
Previous value: -[
- {
- "properties": {
- "enabled": {
- "description": "enabled for the frequency settings",
- "example": true,
- "type": "boolean"
- },
- "schedule": {
- "allOf": [
- {
- "properties": {
- "executeAt": {
- "type": "string"
- },
- "rrule": {
- "properties": {
- "count": {
- "description": "Max number of task executions",
- "example": 10,
- "type": "number"
- },
- "dayOfMonth": {
- "description": "-1, 1, 2, 3, ..., 27, 28",
- "example": 15,
- "type": "number"
- },
- "dayOfWeek": {
- "enum": [
- "mo",
- "tu",
- "we",
- "th",
- "fr",
- "sa",
- "su"
- ],
- "example": "mo",
- "type": "string"
- },
- "daysBefore": {
- "description": "Execute task number of days before",
- "example": 5,
- "type": "number"
- },
- "endDate": {
- "description": "End date in YYYY-MM-DD format",
- "example": "2029-11-01",
- "type": "string"
- },
- "endTime": {
- "description": "End time in HH:mm:ss format",
- "example": "18:45:00",
- "type": "string"
- },
- "endType": {
- "description": "End type like after, by, count",
- "example": "by",
- "type": "string"
- },
- "interval": {
- "example": 2,
- "type": "number"
- },
- "intervalType": {
- "enum": [
- "yearly",
- "monthly",
- "weekly",
- "daily",
- "hourly",
- "minutely",
- "secondly"
- ],
- "example": "monthly",
- "type": "string"
- },
- "monthOfYear": {
- "enum": [
- "jan",
- "feb",
- "mar",
- "apr",
- "may",
- "jun",
- "jul",
- "aug",
- "sep",
- "oct",
- "nov",
- "dec"
- ],
- "example": "jan",
- "type": "string"
- },
- "numOfWeek": {
- "description": "-1, 1, 2, 3, 4",
- "example": -1,
- "type": "number"
- },
- "startDate": {
- "description": "Start date in YYYY-MM-DD format",
- "example": "2023-01-01",
- "type": "string"
- },
- "startTime": {
- "description": "Start time in HH:mm:ss format",
- "example": "20:45:00",
- "type": "string"
- },
- "useStartAsPrimaryUserAccepted": {
- "description": "Start as primary user accepted date",
- "example": true,
- "type": "boolean"
- }
- },
- "required": [
- "intervalType",
- "interval",
- "startDate"
- ],
- "type": "object"
- }
- },
- "type": "object"
- }
- ],
- "description": "schedule setting for the estimate"
- }
- },
- "required": [
- "enabled",
- "schedule"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "enabled": {
+ "description": "enabled for the frequency settings",
+ "example": true,
+ "type": "boolean"
+ },
+ "schedule": {
+ "allOf": [
+ {
+ "properties": {
+ "executeAt": {
+ "type": "string"
+ },
+ "rrule": {
+ "properties": {
+ "count": {
+ "description": "Max number of task executions",
+ "example": 10,
+ "type": "number"
+ },
+ "dayOfMonth": {
+ "description": "-1, 1, 2, 3, ..., 27, 28",
+ "example": 15,
+ "type": "number"
+ },
+ "dayOfWeek": {
+ "enum": [
+ "mo",
+ "tu",
+ "we",
+ "th",
+ "fr",
+ "sa",
+ "su"
+ ],
+ "example": "mo",
+ "type": "string"
+ },
+ "daysBefore": {
+ "description": "Execute task number of days before",
+ "example": 5,
+ "type": "number"
+ },
+ "endDate": {
+ "description": "End date in YYYY-MM-DD format",
+ "example": "2029-11-01",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time in HH:mm:ss format",
+ "example": "18:45:00",
+ "type": "string"
+ },
+ "endType": {
+ "description": "End type like after, by, count",
+ "example": "by",
+ "type": "string"
+ },
+ "interval": {
+ "example": 2,
+ "type": "number"
+ },
+ "intervalType": {
+ "enum": [
+ "yearly",
+ "monthly",
+ "weekly",
+ "daily",
+ "hourly",
+ "minutely",
+ "secondly"
+ ],
+ "example": "monthly",
+ "type": "string"
+ },
+ "monthOfYear": {
+ "enum": [
+ "jan",
+ "feb",
+ "mar",
+ "apr",
+ "may",
+ "jun",
+ "jul",
+ "aug",
+ "sep",
+ "oct",
+ "nov",
+ "dec"
+ ],
+ "example": "jan",
+ "type": "string"
+ },
+ "numOfWeek": {
+ "description": "-1, 1, 2, 3, 4",
+ "example": -1,
+ "type": "number"
+ },
+ "startDate": {
+ "description": "Start date in YYYY-MM-DD format",
+ "example": "2023-01-01",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time in HH:mm:ss format",
+ "example": "20:45:00",
+ "type": "string"
+ },
+ "useStartAsPrimaryUserAccepted": {
+ "description": "Start as primary user accepted date",
+ "example": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "intervalType",
+ "interval",
+ "startDate"
+ ],
+ "title": "CustomRRuleOptionsDto",
+ "type": "object"
+ }
+ },
+ "title": "ScheduleOptionsDto",
+ "type": "object"
+ }
+ ],
+ "description": "schedule setting for the estimate"
+ }
+ },
+ "required": [
+ "enabled",
+ "schedule"
+ ],
+ "title": "FrequencySettingsDto",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / properties / items / items / properties / taxes / items / title
Added value: +"ItemTaxDto"
addedInput schema / properties / body / properties / items / items / title
Added value: +"EstimateLineItemDto"
changedInput schema / properties / body / properties / miscellaneousCharges / allOf
Previous value: -[
- {
- "properties": {
- "charges": {
- "description": "charges for the processing fee",
- "items": {
- "type": "array"
- },
- "type": "array"
- },
- "collectedMiscellaneousCharges": {
- "description": "collected miscellaneous charges",
- "example": 10,
- "type": "number"
- },
- "paidCharges": {
- "description": "paid miscellaneous charges",
- "items": {
- "properties": {
- "_id": {
- "description": "id of the processing fee",
- "example": "673d01d7d547648a8dab6211",
- "type": "string"
- },
- "amount": {
- "description": "amount of the processing fee",
- "example": 10,
- "type": "number"
- },
- "charge": {
- "description": "charge for the processing fee",
- "example": 10,
- "type": "number"
- },
- "name": {
- "description": "name of the processing fee",
- "example": "Processing Fee",
- "type": "string"
- }
- },
- "required": [
- "name",
- "charge",
- "amount",
- "_id"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "charges"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "charges": {
+ "description": "charges for the processing fee",
+ "items": {
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "collectedMiscellaneousCharges": {
+ "description": "collected miscellaneous charges",
+ "example": 10,
+ "type": "number"
+ },
+ "paidCharges": {
+ "description": "paid miscellaneous charges",
+ "items": {
+ "properties": {
+ "_id": {
+ "description": "id of the processing fee",
+ "example": "673d01d7d547648a8dab6211",
+ "type": "string"
+ },
+ "amount": {
+ "description": "amount of the processing fee",
+ "example": 10,
+ "type": "number"
+ },
+ "charge": {
+ "description": "charge for the processing fee",
+ "example": 10,
+ "type": "number"
+ },
+ "name": {
+ "description": "name of the processing fee",
+ "example": "Processing Fee",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "charge",
+ "amount",
+ "_id"
+ ],
+ "title": "ProcessingFeePaidChargeDto",
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "charges"
+ ],
+ "title": "ProcessingFeeDto",
+ "type": "object"
+ }
+]
changedInput schema / properties / body / properties / paymentScheduleConfig / allOf
Previous value: -[
- {
- "properties": {
- "dateConfig": {
- "allOf": [
- {
- "properties": {
- "depositDateType": {
- "description": "Deposit date type",
- "enum": [
- "estimate_accepted",
- "custom"
- ],
- "example": "estimate_accepted",
- "type": "string"
- },
- "scheduleDateType": {
- "description": "Payment Schedule Date Type",
- "enum": [
- "regular_interval",
- "custom"
- ],
- "example": "regular_interval",
- "type": "string"
- }
- },
- "required": [
- "depositDateType",
- "scheduleDateType"
- ],
- "type": "object"
- }
- ],
- "description": "Due date type configuration"
- },
- "schedules": {
- "description": "Payment Schedule Items",
- "items": {
- "type": "array"
- },
- "type": "array"
- },
- "type": {
- "description": "Payment Schedule Type",
- "enum": [
- "fixed",
- "percentage"
- ],
- "example": "fixed",
- "type": "string"
- }
- },
- "required": [
- "type",
- "dateConfig",
- "schedules"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "dateConfig": {
+ "allOf": [
+ {
+ "properties": {
+ "depositDateType": {
+ "description": "Deposit date type",
+ "enum": [
+ "estimate_accepted",
+ "custom"
+ ],
+ "example": "estimate_accepted",
+ "type": "string"
+ },
+ "scheduleDateType": {
+ "description": "Payment Schedule Date Type",
+ "enum": [
+ "regular_interval",
+ "custom"
+ ],
+ "example": "regular_interval",
+ "type": "string"
+ }
+ },
+ "required": [
+ "depositDateType",
+ "scheduleDateType"
+ ],
+ "title": "PaymentScheduleDateConfigDto",
+ "type": "object"
+ }
+ ],
+ "description": "Due date type configuration"
+ },
+ "schedules": {
+ "description": "Payment Schedule Items",
+ "items": {
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Payment Schedule Type",
+ "enum": [
+ "fixed",
+ "percentage"
+ ],
+ "example": "fixed",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "dateConfig",
+ "schedules"
+ ],
+ "title": "PaymentScheduleConfigDto",
+ "type": "object"
+ }
+]
changedInput schema / properties / body / properties / sendEstimateDetails / allOf
Previous value: -[
- {
- "properties": {
- "action": {
- "enum": [
- "sms_and_email",
- "send_manually",
- "email",
- "sms"
- ],
- "type": "string"
- },
- "altId": {
- "description": "Location Id or Agency Id",
- "example": "6578278e879ad2646715ba9c",
- "type": "string"
- },
- "altType": {
- "enum": [
- "location"
- ],
- "type": "string"
- },
- "estimateName": {
- "description": "estimate name",
- "example": "Estimate",
- "type": "string"
- },
- "liveMode": {
- "description": "livemode for estimate",
- "example": true,
- "type": "boolean"
- },
- "sentFrom": {
- "allOf": [
- {
- "properties": {
- "fromEmail": {
- "description": "Email id to be used while sending email notification",
- "example": "alex@example.com",
- "type": "string"
- },
- "fromName": {
- "description": "Sender name to be used while sending email notification",
- "example": "Alex",
- "type": "string"
- }
- },
- "type": "object"
- }
- ],
- "description": "sender details for invoice, valid only if invoice is not sent manually"
- },
- "userId": {
- "description": "Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.",
- "example": "6578278e879ad2646715ba9c",
- "type": "string"
- }
- },
- "required": [
- "altId",
- "altType",
- "action",
- "liveMode",
- "userId"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "action": {
+ "enum": [
+ "sms_and_email",
+ "send_manually",
+ "email",
+ "sms"
+ ],
+ "type": "string"
+ },
+ "altId": {
+ "description": "Location Id or Agency Id",
+ "example": "6578278e879ad2646715ba9c",
+ "type": "string"
+ },
+ "altType": {
+ "enum": [
+ "location"
+ ],
+ "type": "string"
+ },
+ "estimateName": {
+ "description": "estimate name",
+ "example": "Estimate",
+ "type": "string"
+ },
+ "liveMode": {
+ "description": "livemode for estimate",
+ "example": true,
+ "type": "boolean"
+ },
+ "sentFrom": {
+ "allOf": [
+ {
+ "properties": {
+ "fromEmail": {
+ "description": "Email id to be used while sending email notification",
+ "example": "alex@example.com",
+ "type": "string"
+ },
+ "fromName": {
+ "description": "Sender name to be used while sending email notification",
+ "example": "Alex",
+ "type": "string"
+ }
+ },
+ "title": "InvoiceSettingsSenderConfigurationDto",
+ "type": "object"
+ }
+ ],
+ "description": "sender details for invoice, valid only if invoice is not sent manually"
+ },
+ "userId": {
+ "description": "Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.",
+ "example": "6578278e879ad2646715ba9c",
+ "type": "string"
+ }
+ },
+ "required": [
+ "altId",
+ "altType",
+ "action",
+ "liveMode",
+ "userId"
+ ],
+ "title": "SendEstimateDto",
+ "type": "object"
+ }
+]
changedInput schema / properties / body / properties / sentTo / allOf
Previous value: -[
- {
- "properties": {
- "email": {
- "description": "Email Address",
- "example": [
- "alex@example.com"
- ],
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "emailBcc": {
- "description": "bcc to be kept in any sent out emails",
- "example": [
- "alex@example.com"
- ],
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "emailCc": {
- "description": "cc to be kept in any sent out emails",
- "example": [
- "alex@example.com"
- ],
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "phoneNo": {
- "description": "Contact Phone Number",
- "example": [
- "+1-214-559-6993"
- ],
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "email"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "email": {
+ "description": "Email Address",
+ "example": [
+ "alex@example.com"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "emailBcc": {
+ "description": "bcc to be kept in any sent out emails",
+ "example": [
+ "alex@example.com"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "emailCc": {
+ "description": "cc to be kept in any sent out emails",
+ "example": [
+ "alex@example.com"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "phoneNo": {
+ "description": "Contact Phone Number",
+ "example": [
+ "+1-214-559-6993"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "email"
+ ],
+ "title": "SentToDto",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / title
Added value: +"CreateEstimatesDto"