Skip to content

Quotation documents API

Note

This API is used in getting data for project documents such as Quotations, Invoices, and Delivery notes.

The API is used in project action page, Export Documents section. This API returns the project data merged with the quotation setting information in JSON Format.

Action Parameters Description
get projectId Get the quotation data of the project
Endpoint
GET 
/api/v2/projects/{projectId}/quotation/

Example Request

curl --location --request GET 'https://app.engineerforce.io/api/v2/projects/{PROJECT_ID}/quotation/'\
--header 'Authorization: API-Token {{YOUR_API_TOKEN}}'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app.engineerforce.io/api/v2/projects/{PROJECT_ID}/quotation/',
  headers: { 'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://app.engineerforce.io/api/v2/projects/{PROJECT_ID}/quotation/")
  .method("GET", body)
  .addHeader("Authorization", "API-Token {{YOUR_API_TOKEN}}")
  .build();
Response response = client.newCall(request).execute();

import requests

url = "https://app.engineerforce.io/api/v2/projects/{PROJECT_ID}/quotation/"

payload={}
headers = {'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Example Response

{
    "project": {
        "id": "{PROJECT_ID}",
        "projectCode": "{PROJECT_CODE}",
        "projectName": "Project YYYYYY",
        "companyName": "TEst",
        "startDate": "2022-10-05",
        "endDate": "2022-10-31",
        "deliveryDates": "",
        "creator": "Hein Khant Zaw",
        "currency": "JPY",
        "task_set": [
            {
                "id": 16,
                "taskName": "Requirement definition",
                "amount": 747600.0,
                "finalEstHours": "[7.8 DD][46.2 HH]",
                "level": 0
            },
            {
                "id": 19,
                "taskName": "Requirement definition",
                "amount": null,
                "finalEstHours": null,
                "level": 1
            },
            {
                "id": 20,
                "taskName": "Check current specifications",
                "amount": null,
                "finalEstHours": null,
                "level": 1
            },
            {
                "id": 17,
                "taskName": "Creation of",
                "amount": 330000.0,
                "finalEstHours": "[33 HH]",
                "level": 0
            },
            {
                "id": 21,
                "taskName": "Creation",
                "amount": null,
                "finalEstHours": null,
                "level": 1
            },
            {
                "id": 18,
                "taskName": "Basic design",
                "amount": 2112000.0,
                "finalEstHours": "[26.4 DD]",
                "level": 0
            },
            {
                "id": 22,
                "taskName": "Screen List",
                "amount": null,
                "finalEstHours": null,
                "level": 1
            }
        ],
        "expense_set": [],
        "discount": {}
    },
    "quotation": {
        "quotationIssueDate": null,
        "invoiceIssueDate": null,
        "deliveryIssueDate": null,
        "projectId": null,
        "teamId": null,
        "basicInfo": {
            "companyName": "",
            "companyAddress": "",
            "companyPhone": "",
            "companyEmail": "",
            "companyPostalCode": "",
            "companyCity": "",
            "companyCountry": "",
            "companySalePerson": "",
            "themeColor": "",
            "themeType": null,
            "qsRemark": "",
            "paymentSwiftCode": "",
            "paymentItrsCode": "",
            "paymentTerm": "",
            "taxRate": null,
            "companyLogo": null,
            "companySignatureImage": null,
            "companyStampImage": null
        },
        "paymentInfo": [],
        "taskField": {
            "estimationInformation": ""
        },
        "idManagement": {
            "quotationIdPrefix": "",
            "orderIdPrefix": "",
            "invoiceIdPrefix": "",
            "quotationDue": null
        },
        "termsAndConditions": {
            "tncType": null,
            "content": false
        }
    }
}