Get full Task data with works, materials, etc.

2min
GET
This endpoint allows to get task full information with all relations and all task information.
AUTHENTICATION
Authorization
apiKey
QUERY PARAMETERS
guid
string
GUID format entity identifier generated by Frontu.
systemId
string
Entity identifier from external system.
RESPONSES
200
Returned when successful
object
Returned when successful
systemId
string
code
string
title
string
clientName
string
clientEmail
string
rating
number
agreement
boolean
signatureType
string
signatureFile
string
description
string
abortMessage
string
clientNote
string
clientNoteReply
string
distance
number
workPrice
number
workPriceWithVat
number
routePrice
number
routePriceWithVat
number
materialPrice
number
materialPriceWithVat
number
finalPrice
number
finalPriceWithVat
number
vat
number
currency
string
status
number
stopStatusMessage
string
plannedTime
string
plannedEndTime
string
fetched
boolean
time
string
ended
string
pastDue
boolean
duration
number
durationFull
number
billDate
string
billStatus
boolean
reassigned
boolean
filesExists
boolean
user
object
Example: [object Object]
formerUser
string
assignor
string
taskType
object
Example: [object Object]
workspace
object
Example: [object Object]
client
object
Example: [object Object]
works
object[]
Example: 
materials
object[]
Example: 
routeHistories
object[]
Example: 
taskRequest
string
createdBy
string
requireObjectCode
boolean
requireSignature
boolean
taskTypePriority
number
guid
string
created
string
updated
string
version
number
deleted
boolean
receivedByExternalSystem
boolean
helpers
object[]
Example: 
tags
object[]
Example: 
404
Entity not found
Curl
Python
PHP
Shell
C#
|
curl --location --request GET 'https://dev1.frontu.com/client/api/v2/tasks/full' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://dev1.frontu.com/client/api/v2/tasks/full' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
RESPONSES
200
404
|
// Returned when successful 
{
  "systemId": "",
  "code": "",
  "title": "",
  "clientName": "",
  "clientEmail": "",
  "rating": 0,
  "agreement": false,
  "signatureType": "",
  "signatureFile": "",
  "description": "",
  "abortMessage": "",
  "clientNote": "",
  "clientNoteReply": "",
  "distance": 0,
  "workPrice": 0,
  "workPriceWithVat": 0,
  "routePrice": 0,
  "routePriceWithVat": 0,
  "materialPrice": 0,
  "materialPriceWithVat": 0,
  "finalPrice": 0,
  "finalPriceWithVat": 0,
  "vat": 0,
  "currency": "",
  "status": 0,
  "stopStatusMessage": "",
  "plannedTime": "",
  "plannedEndTime": "",
  "fetched": false,
  "time": "",
  "ended": "",
  "pastDue": false,
  "duration": 0,
  "durationFull": 0,
  "billDate": "",
  "billStatus": false,
  "reassigned": false,
  "filesExists": false,
  "user": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "formerUser": "",
  "assignor": "",
  "taskType": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "workspace": {
    "title": "",
    "serialNumber": "",
    "guid": "",
    "systemId": ""
  },
  "client": {
    "title": "",
    "companyCode": "",
    "guid": "",
    "systemId": ""
  },
  "works": [
    {
      "title": "",
      "description": "",
      "duration": 0,
      "suggestedDuration": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "standartizedWork": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "workTime": 0,
      "workType": 0,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": "",
      "equipment": {
        "title": "",
        "guid": "",
        "systemId": "",
        "serialNumber": ""
      }
    }
  ],
  "materials": [
    {
      "title": "",
      "description": "",
      "serialNumber": "",
      "amount": 0,
      "suggestedAmount": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "standartizedMaterial": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "debited": false,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": "",
      "equipment": {
        "title": "",
        "guid": "",
        "systemId": "",
        "serialNumber": ""
      }
    }
  ],
  "routeHistories": [
    {
      "distance": 0,
      "duration": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": ""
    }
  ],
  "taskRequest": "",
  "createdBy": "",
  "requireObjectCode": false,
  "requireSignature": false,
  "taskTypePriority": 0,
  "guid": "",
  "created": "",
  "updated": "",
  "version": 0,
  "deleted": false,
  "receivedByExternalSystem": false,
  "helpers": [
    {
      "title": "",
      "guid": "",
      "systemId": ""
    }
  ],
  "tags": [
    {}
  ]
}
// Returned when successful 
{
  "systemId": "",
  "code": "",
  "title": "",
  "clientName": "",
  "clientEmail": "",
  "rating": 0,
  "agreement": false,
  "signatureType": "",
  "signatureFile": "",
  "description": "",
  "abortMessage": "",
  "clientNote": "",
  "clientNoteReply": "",
  "distance": 0,
  "workPrice": 0,
  "workPriceWithVat": 0,
  "routePrice": 0,
  "routePriceWithVat": 0,
  "materialPrice": 0,
  "materialPriceWithVat": 0,
  "finalPrice": 0,
  "finalPriceWithVat": 0,
  "vat": 0,
  "currency": "",
  "status": 0,
  "stopStatusMessage": "",
  "plannedTime": "",
  "plannedEndTime": "",
  "fetched": false,
  "time": "",
  "ended": "",
  "pastDue": false,
  "duration": 0,
  "durationFull": 0,
  "billDate": "",
  "billStatus": false,
  "reassigned": false,
  "filesExists": false,
  "user": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "formerUser": "",
  "assignor": "",
  "taskType": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "workspace": {
    "title": "",
    "serialNumber": "",
    "guid": "",
    "systemId": ""
  },
  "client": {
    "title": "",
    "companyCode": "",
    "guid": "",
    "systemId": ""
  },
  "works": [
    {
      "title": "",
      "description": "",
      "duration": 0,
      "suggestedDuration": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "standartizedWork": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "workTime": 0,
      "workType": 0,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": "",
      "equipment": {
        "title": "",
        "guid": "",
        "systemId": "",
        "serialNumber": ""
      }
    }
  ],
  "materials": [
    {
      "title": "",
      "description": "",
      "serialNumber": "",
      "amount": 0,
      "suggestedAmount": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "standartizedMaterial": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "debited": false,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": "",
      "equipment": {
        "title": "",
        "guid": "",
        "systemId": "",
        "serialNumber": ""
      }
    }
  ],
  "routeHistories": [
    {
      "distance": 0,
      "duration": 0,
      "price": 0,
      "priceWithVat": 0,
      "user": {
        "title": "",
        "guid": "",
        "systemId": ""
      },
      "deleted": false,
      "guid": "",
      "systemId": "",
      "created": "",
      "updated": ""
    }
  ],
  "taskRequest": "",
  "createdBy": "",
  "requireObjectCode": false,
  "requireSignature": false,
  "taskTypePriority": 0,
  "guid": "",
  "created": "",
  "updated": "",
  "version": 0,
  "deleted": false,
  "receivedByExternalSystem": false,
  "helpers": [
    {
      "title": "",
      "guid": "",
      "systemId": ""
    }
  ],
  "tags": [
    {}
  ]
}
﻿
﻿
Updated 31 Jul 2023
Did this page help you?
Create / Update Task
Get Task detail information
Docs powered by
Archbee
Main

Get full Task data with works, materials, etc.
