PATCH api/Inspections/{id}/StatementOfWork

Inserts the given statement of work to crm. Note: Requires a valid access token to be provided in the request's auth header.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of inspection.

string

Required

Body Parameters

Statement of work to insert.

CrmStatementOfWork
NameDescriptionTypeAdditional information
StatementOfWorkItems

List of related statement of work items.

Collection of CrmStatementOfWorkItem

Optional

Id

Id of statement of work.

string

Optional

ApprovalStatus

Approval status of statement of work.

string

Optional

ApprovalDate

Date the statement of work was approved.

date

Optional

ProjectObject

Used to reference the related project in CRM.

EntityReference

Optional

ProposedEstimatedCost

Proposed estimated cost of the statement of work.

decimal number

Optional

ApprovedEstimatedCost

Approved estimated cost of the statement of work.

decimal number

Optional

CostVariance

Cost variance between the proposed and approved estimated costs.

decimal number

Optional

ApprovedEstimatedCostPostMarkup

The sum of statement of work items that have been approved with our current markup rate.

decimal number

Optional

Type

Type of statement of work.

string

Optional

Media

List of media items associated with the statement of work.

Collection of CrmMedia

Optional

SqftVariance

The Sqft Variance between Home sqft and sum of sqft for SWITs under the Flooring category

string

Optional

Reference

Used to reference the entity in CRM.

EntityReference

Optional

SystemDate

Current system date of the client that created this object.

date

Optional

CapturedDate

Date and time the client created this object.

date

Optional

Request Formats

application/json, text/json

Sample:
{
  "StatementOfWorkItems": [
    {
      "Id": "sample string 1",
      "MobileUniqueIdentifier": "sample string 2",
      "StatementOfWorkObject": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Approved": true,
      "Area": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItem": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "AreaDefinition": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItemDefinition": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "ProductOrService": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Cost": 1.0,
      "Quantity": 1.0,
      "TotalCost": 1.0,
      "UnitType": "sample string 3",
      "TenantResponsibilityPercentage": 1.0,
      "Reference": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3748217-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3748217-05:00"
    },
    {
      "Id": "sample string 1",
      "MobileUniqueIdentifier": "sample string 2",
      "StatementOfWorkObject": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Approved": true,
      "Area": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItem": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "AreaDefinition": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItemDefinition": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "ProductOrService": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Cost": 1.0,
      "Quantity": 1.0,
      "TotalCost": 1.0,
      "UnitType": "sample string 3",
      "TenantResponsibilityPercentage": 1.0,
      "Reference": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3748217-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3748217-05:00"
    }
  ],
  "Id": "sample string 1",
  "ApprovalStatus": "sample string 2",
  "ApprovalDate": "2025-05-23T16:41:58.3748217-05:00",
  "ProjectObject": {
    "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
    "LogicalName": "sample string 2",
    "Name": "sample string 3"
  },
  "ProposedEstimatedCost": 1.0,
  "ApprovedEstimatedCost": 1.0,
  "CostVariance": 1.0,
  "ApprovedEstimatedCostPostMarkup": 1.0,
  "Type": "sample string 3",
  "Media": [
    {
      "MediaId": 1,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Data": "sample string 2",
      "Name": "sample string 3",
      "Caption": "sample string 4",
      "MediaKey": "sample string 5",
      "Ordinal": 6,
      "MimeType": "sample string 7",
      "Url": "sample string 8",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "IsAnnotation": true,
      "IsThumbnail": true,
      "Height": 1,
      "Width": 1,
      "Reference": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3748217-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3748217-05:00"
    },
    {
      "MediaId": 1,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Data": "sample string 2",
      "Name": "sample string 3",
      "Caption": "sample string 4",
      "MediaKey": "sample string 5",
      "Ordinal": 6,
      "MimeType": "sample string 7",
      "Url": "sample string 8",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "IsAnnotation": true,
      "IsThumbnail": true,
      "Height": 1,
      "Width": 1,
      "Reference": {
        "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3748217-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3748217-05:00"
    }
  ],
  "SqftVariance": "sample string 4",
  "Reference": {
    "Id": "45d5e057-557a-4318-b28b-64eced0b2684",
    "LogicalName": "sample string 2",
    "Name": "sample string 3"
  },
  "SystemDate": "2025-05-23T16:41:58.3748217-05:00",
  "CapturedDate": "2025-05-23T16:41:58.3748217-05:00"
}

Response Information

Resource Description

Returns statement of work inserted.

CrmStatementOfWork
NameDescriptionTypeAdditional information
StatementOfWorkItems

List of related statement of work items.

Collection of CrmStatementOfWorkItem

Optional

Id

Id of statement of work.

string

Optional

ApprovalStatus

Approval status of statement of work.

string

Optional

ApprovalDate

Date the statement of work was approved.

date

Optional

ProjectObject

Used to reference the related project in CRM.

EntityReference

Optional

ProposedEstimatedCost

Proposed estimated cost of the statement of work.

decimal number

Optional

ApprovedEstimatedCost

Approved estimated cost of the statement of work.

decimal number

Optional

CostVariance

Cost variance between the proposed and approved estimated costs.

decimal number

Optional

ApprovedEstimatedCostPostMarkup

The sum of statement of work items that have been approved with our current markup rate.

decimal number

Optional

Type

Type of statement of work.

string

Optional

Media

List of media items associated with the statement of work.

Collection of CrmMedia

Optional

SqftVariance

The Sqft Variance between Home sqft and sum of sqft for SWITs under the Flooring category

string

Optional

Reference

Used to reference the entity in CRM.

EntityReference

Optional

SystemDate

Current system date of the client that created this object.

date

Optional

CapturedDate

Date and time the client created this object.

date

Optional

Response Formats

application/json, text/json

Sample:
{
  "StatementOfWorkItems": [
    {
      "Id": "sample string 1",
      "MobileUniqueIdentifier": "sample string 2",
      "StatementOfWorkObject": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Approved": true,
      "Area": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItem": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "AreaDefinition": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItemDefinition": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "ProductOrService": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Cost": 1.0,
      "Quantity": 1.0,
      "TotalCost": 1.0,
      "UnitType": "sample string 3",
      "TenantResponsibilityPercentage": 1.0,
      "Reference": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3904458-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3904458-05:00"
    },
    {
      "Id": "sample string 1",
      "MobileUniqueIdentifier": "sample string 2",
      "StatementOfWorkObject": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Approved": true,
      "Area": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItem": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "AreaDefinition": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "InspectionItemDefinition": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "ProductOrService": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "Cost": 1.0,
      "Quantity": 1.0,
      "TotalCost": 1.0,
      "UnitType": "sample string 3",
      "TenantResponsibilityPercentage": 1.0,
      "Reference": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3904458-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3904458-05:00"
    }
  ],
  "Id": "sample string 1",
  "ApprovalStatus": "sample string 2",
  "ApprovalDate": "2025-05-23T16:41:58.3904458-05:00",
  "ProjectObject": {
    "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
    "LogicalName": "sample string 2",
    "Name": "sample string 3"
  },
  "ProposedEstimatedCost": 1.0,
  "ApprovedEstimatedCost": 1.0,
  "CostVariance": 1.0,
  "ApprovedEstimatedCostPostMarkup": 1.0,
  "Type": "sample string 3",
  "Media": [
    {
      "MediaId": 1,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Data": "sample string 2",
      "Name": "sample string 3",
      "Caption": "sample string 4",
      "MediaKey": "sample string 5",
      "Ordinal": 6,
      "MimeType": "sample string 7",
      "Url": "sample string 8",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "IsAnnotation": true,
      "IsThumbnail": true,
      "Height": 1,
      "Width": 1,
      "Reference": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3904458-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3904458-05:00"
    },
    {
      "MediaId": 1,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Data": "sample string 2",
      "Name": "sample string 3",
      "Caption": "sample string 4",
      "MediaKey": "sample string 5",
      "Ordinal": 6,
      "MimeType": "sample string 7",
      "Url": "sample string 8",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "IsAnnotation": true,
      "IsThumbnail": true,
      "Height": 1,
      "Width": 1,
      "Reference": {
        "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
        "LogicalName": "sample string 2",
        "Name": "sample string 3"
      },
      "SystemDate": "2025-05-23T16:41:58.3904458-05:00",
      "CapturedDate": "2025-05-23T16:41:58.3904458-05:00"
    }
  ],
  "SqftVariance": "sample string 4",
  "Reference": {
    "Id": "3eed7c17-2c3a-44b1-9951-982d82522b61",
    "LogicalName": "sample string 2",
    "Name": "sample string 3"
  },
  "SystemDate": "2025-05-23T16:41:58.3904458-05:00",
  "CapturedDate": "2025-05-23T16:41:58.3904458-05:00"
}