Skip to content

Proposal document API

Note

This API is used in creating pptx for project proposal.

Action Parameters Description
get id Get the quotation data of the project
Endpoint
GET 
/api/v2/proposal/?id={id}

Example Request

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

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app.engineerforce.io/api/v2/proposal/?id={PROJECT_ID}',
  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/proposal/?id={PROJECT_ID}")
  .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/proposal/?id={PROJECT_ID}"

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

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

print(response.text)

Example Response
projectId String
projectName String
startDate String
endDate String
customerName String
currency String
estimatedPrice String
techStack String
deliveryDates String
assignees Array[object]
  id Integer
  name String
  title String
  status String
task Array[object]
  id Integer
  name String
  amount String
  parentTaskId String
  startDate String
  endDate String
  duration Integer
expense Array[object]
  id Integer
  name String
  amount Integer
  type String
unitTasks Array[object]
  id Integer
  name String
  amount String
  parentTaskId String
  startDate String
  endDate String
  duration Integer 
    {
    "projectId": "{PROJECT_ID}",
    "projectName": "{Project Name}",
    "startDate": "YYYY-MM-DD",
    "endDate": "YYYY-MM-DD",
    "customerName": "{Customer Name}",
    "currency": "JPY",
    "estimatedPrice": "{Price}",
    "techStack": "",
    "deliveryDates": "YYYY-MM-DD, YYYY-MM-DD, YYYY-MM-DD",
    "assignees": [
        {
            "id": 1,
            "name": "{Assignee Name}",
            "title": "Developer",
            "status": "Full-time employee"
        },
        {
            "id": 3,
            "name": "Senior Developer",
            "title": "Senior Developer",
            "status": "Partner"
        },
        {
            "id": 2,
            "name": "Junior Developer",
            "title": "Junior Developer",
            "status": "Partner"
        }
    ],
    "task": [
        {
            "id": 1,
            "name": "{Large Task Name}",
            "amount": 999999,
            "parentTaskId": null,
            "startDate": "YYYY-MM-DD",
            "endDate": "YYYY-MM-DD",
            "duration": 10
        },
        {
            "id": 3,
            "name": "{Medium Task Name}",
            "amount": 1130000.0,
            "parentTaskId": 1,
            "startDate": null,
            "endDate": null,
            "duration": null
        },
        {
            "id": 4,
            "name": "{Medium Task Name}",
            "amount": 440000.0,
            "parentTaskId": 1,
            "startDate": null,
            "endDate": null,
            "duration": null
        },
    ],
    "expense": [
        {
            "id": 1,
            "name": "{Expense Name}",
            "amount": 30.0,
            "type": "Expense"
        },
        {
            "id": 2,
            "name": "{Expense Name}",
            "amount": 3330.0,
            "type": "Expense"
        }
    ],
    "unitTasks": [
        {
            "id": 2,
            "name": "{Unit Task Name}",
            "amount": 200000,
            "parentTaskId": null,
            "startDate": null,
            "endDate": null,
            "duration": 21
        },
        {
            "id": 3,
            "name": "{Unit Task Name}",
            "amount": 40000,
            "parentTaskId": null,
            "startDate": null,
            "endDate": null,
            "duration": 21
        }
    ]
    }