VOGSY API Reference

Introduction

The VOGSY API Platform gives you access to your data using our powerful REST APIs. It uses the REST framework with standard secure HTTP methods and JSON encoded requests and responses. Most operations use a GET, POST or DELETE method The base URL for app requests is https://vogsy.io

Authentication

The VOGSY API use API Keys for authentication. You can view and manage your API keys in the Back office in the Manage API keys section. If this is not yet enabled, please get in touch with our support team support@vogsy.com. API Keys are tied to a specific user and have a limited scope and lifespan. It is important to keep them secure. Do not share your API keys in publicly accessible areas.

Once you have your API key, pass it in each request using a header called X-Api-Key.

Allocations

Return the cap of a resource allocation

path Parameters

calculation_line_id

required

string

Responses

Distribute planning hours for a resource allocatio

Distribute planning hours for a resource allocation over a time period

path Parameters

resource_allocation_id

required

string

Request Body schema: application/json

hours	number or null
automaticallyDetermineFinishDate	boolean or null
startDate	string or null <date>
finishDate	string or null <date>
planHoursMonday	boolean or null
planHoursTuesday	boolean or null
planHoursWednesday	boolean or null
planHoursThursday	boolean or null
planHoursFriday	boolean or null
planHoursSaturday	boolean or null
planHoursSunday	boolean or null
fixedHoursMonday	number or null
fixedHoursTuesday	number or null
fixedHoursWednesday	number or null
fixedHoursThursday	number or null
fixedHoursFriday	number or null
fixedHoursSaturday	number or null
fixedHoursSunday	number or null

Responses

Request samples

Payload

Content type

application/json

{"hours": 0,
"automaticallyDetermineFinishDate": true,
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"planHoursMonday": true,
"planHoursTuesday": true,
"planHoursWednesday": true,
"planHoursThursday": true,
"planHoursFriday": true,
"planHoursSaturday": true,
"planHoursSunday": true,
"fixedHoursMonday": 0,
"fixedHoursTuesday": 0,
"fixedHoursWednesday": 0,
"fixedHoursThursday": 0,
"fixedHoursFriday": 0,
"fixedHoursSaturday": 0,
"fixedHoursSunday": 0
}

Delete a resource allocation

path Parameters

resource_allocation_id

required

string

Responses

Save the resource allocations

path Parameters

calculation_line_id

required

string

Request Body schema: application/json

Array of objects or null (ResourceAllocationWrite)

Responses

Request samples

Payload

Content type

application/json

{"allocations": [{"id": "string",
"personId": "string",
"hours": 0,
"hasCustomSalesRate": true,
"salesRate": 0,
"salesRateInvoiceCurrency": 0,
"costRate": 0,
"costRateEmployeeCurrency": 0,
"employeeCurrency": {"id": "string",
"name": "string",
"code": "string",
"decimals": 0,
"rate": 0,
"symbol": "string",
"isDefault": true,
"inverse": true,
"archived": true
},
"planMonday": true,
"planTuesday": true,
"planWednesday": true,
"planThursday": true,
"planFriday": true,
"planSaturday": true,
"planSunday": true,
"fixedHoursMonday": 0,
"fixedHoursTuesday": 0,
"fixedHoursWednesday": 0,
"fixedHoursThursday": 0,
"fixedHoursFriday": 0,
"fixedHoursSaturday": 0,
"fixedHoursSunday": 0,
"generateNewPlanning": true,
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"jobRoleId": "string"
}
]
}

Get the resource-allocations of a calculation-line

path Parameters

calculation_line_id

required

string

Responses

Deliverables

Insert or update a deliverable

path Parameters

project_id

required

string

Request Body schema: application/json

id	string or null <id>
name	string or null
desc	string or null
startDate	string or null <date>
finishDate	string or null <date>
invoiceMethodId	string or null
fixedPriceOtherCurrency	number or null
departmentId	string or null <id>
revenueTypeId	string or null <id>
hasCalculationLimit	boolean or null
calculationLimitOtherCurrency	number or null
poNumber	string or null
isAutoExtend	boolean or null
quantity	number or null
amountPerTerm	number or null
discountDescription	string or null
discountPercentage	integer or null
surchargeDescription	string or null
surchargePercentage	integer or null
completePercentage	integer or null
invoicingFrequencyId	integer or null
momentOfInvoicingId	string or null
vatTypeId	string or null <id>
opportunityId	string or null <id>
autoApproveTimesheets	boolean or null
templateId	string or null <id>
copyFromDeliverableId	string or null <id>
copyAllocations	boolean or null
copyAllocationHours	boolean or null
copyTasks	boolean or null
copyInvoiceSchedule	boolean or null
copySubscriptionLines	boolean or null
applySalesRatesFromPriceList	boolean or null
shouldRecalculateSalesRates	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"invoiceMethodId": "string",
"fixedPriceOtherCurrency": 0,
"departmentId": "string",
"revenueTypeId": "string",
"hasCalculationLimit": true,
"calculationLimitOtherCurrency": 0,
"poNumber": "string",
"isAutoExtend": true,
"quantity": 0,
"amountPerTerm": 0,
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"completePercentage": 0,
"invoicingFrequencyId": 0,
"momentOfInvoicingId": "string",
"vatTypeId": "string",
"opportunityId": "string",
"autoApproveTimesheets": true,
"templateId": "string",
"copyFromDeliverableId": "string",
"copyAllocations": true,
"copyAllocationHours": true,
"copyTasks": true,
"copyInvoiceSchedule": true,
"copySubscriptionLines": true,
"applySalesRatesFromPriceList": true,
"shouldRecalculateSalesRates": true
}

Return a list of deliverables for a project

path Parameters

project_id

required

string

Responses

Return a deliverable form

path Parameters

project_id

required

string

Request Body schema: application/json

id	string or null <id>
name	string or null
desc	string or null
startDate	string or null <date>
finishDate	string or null <date>
invoiceMethodId	string or null
fixedPriceOtherCurrency	number or null
departmentId	string or null <id>
revenueTypeId	string or null <id>
hasCalculationLimit	boolean or null
calculationLimitOtherCurrency	number or null
poNumber	string or null
isAutoExtend	boolean or null
quantity	number or null
amountPerTerm	number or null
discountDescription	string or null
discountPercentage	integer or null
surchargeDescription	string or null
surchargePercentage	integer or null
completePercentage	integer or null
invoicingFrequencyId	integer or null
momentOfInvoicingId	string or null
vatTypeId	string or null <id>
opportunityId	string or null <id>
autoApproveTimesheets	boolean or null
templateId	string or null <id>
copyFromDeliverableId	string or null <id>
copyAllocations	boolean or null
copyAllocationHours	boolean or null
copyTasks	boolean or null
copyInvoiceSchedule	boolean or null
copySubscriptionLines	boolean or null
applySalesRatesFromPriceList	boolean or null
shouldRecalculateSalesRates	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"invoiceMethodId": "string",
"fixedPriceOtherCurrency": 0,
"departmentId": "string",
"revenueTypeId": "string",
"hasCalculationLimit": true,
"calculationLimitOtherCurrency": 0,
"poNumber": "string",
"isAutoExtend": true,
"quantity": 0,
"amountPerTerm": 0,
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"completePercentage": 0,
"invoicingFrequencyId": 0,
"momentOfInvoicingId": "string",
"vatTypeId": "string",
"opportunityId": "string",
"autoApproveTimesheets": true,
"templateId": "string",
"copyFromDeliverableId": "string",
"copyAllocations": true,
"copyAllocationHours": true,
"copyTasks": true,
"copyInvoiceSchedule": true,
"copySubscriptionLines": true,
"applySalesRatesFromPriceList": true,
"shouldRecalculateSalesRates": true
}

Delete a deliverable

path Parameters

deliverable_id required	string
project_id required	string

Responses

Insert or update a deliverable

path Parameters

deliverable_id required	string
project_id required	string

Request Body schema: application/json

id	string or null <id>
name	string or null
desc	string or null
startDate	string or null <date>
finishDate	string or null <date>
invoiceMethodId	string or null
fixedPriceOtherCurrency	number or null
departmentId	string or null <id>
revenueTypeId	string or null <id>
hasCalculationLimit	boolean or null
calculationLimitOtherCurrency	number or null
poNumber	string or null
isAutoExtend	boolean or null
quantity	number or null
amountPerTerm	number or null
discountDescription	string or null
discountPercentage	integer or null
surchargeDescription	string or null
surchargePercentage	integer or null
completePercentage	integer or null
invoicingFrequencyId	integer or null
momentOfInvoicingId	string or null
vatTypeId	string or null <id>
opportunityId	string or null <id>
autoApproveTimesheets	boolean or null
templateId	string or null <id>
copyFromDeliverableId	string or null <id>
copyAllocations	boolean or null
copyAllocationHours	boolean or null
copyTasks	boolean or null
copyInvoiceSchedule	boolean or null
copySubscriptionLines	boolean or null
applySalesRatesFromPriceList	boolean or null
shouldRecalculateSalesRates	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"invoiceMethodId": "string",
"fixedPriceOtherCurrency": 0,
"departmentId": "string",
"revenueTypeId": "string",
"hasCalculationLimit": true,
"calculationLimitOtherCurrency": 0,
"poNumber": "string",
"isAutoExtend": true,
"quantity": 0,
"amountPerTerm": 0,
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"completePercentage": 0,
"invoicingFrequencyId": 0,
"momentOfInvoicingId": "string",
"vatTypeId": "string",
"opportunityId": "string",
"autoApproveTimesheets": true,
"templateId": "string",
"copyFromDeliverableId": "string",
"copyAllocations": true,
"copyAllocationHours": true,
"copyTasks": true,
"copyInvoiceSchedule": true,
"copySubscriptionLines": true,
"applySalesRatesFromPriceList": true,
"shouldRecalculateSalesRates": true
}

Return a deliverable form

path Parameters

deliverable_id required	string
project_id required	string

Request Body schema: application/json

id	string or null <id>
name	string or null
desc	string or null
startDate	string or null <date>
finishDate	string or null <date>
invoiceMethodId	string or null
fixedPriceOtherCurrency	number or null
departmentId	string or null <id>
revenueTypeId	string or null <id>
hasCalculationLimit	boolean or null
calculationLimitOtherCurrency	number or null
poNumber	string or null
isAutoExtend	boolean or null
quantity	number or null
amountPerTerm	number or null
discountDescription	string or null
discountPercentage	integer or null
surchargeDescription	string or null
surchargePercentage	integer or null
completePercentage	integer or null
invoicingFrequencyId	integer or null
momentOfInvoicingId	string or null
vatTypeId	string or null <id>
opportunityId	string or null <id>
autoApproveTimesheets	boolean or null
templateId	string or null <id>
copyFromDeliverableId	string or null <id>
copyAllocations	boolean or null
copyAllocationHours	boolean or null
copyTasks	boolean or null
copyInvoiceSchedule	boolean or null
copySubscriptionLines	boolean or null
applySalesRatesFromPriceList	boolean or null
shouldRecalculateSalesRates	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"invoiceMethodId": "string",
"fixedPriceOtherCurrency": 0,
"departmentId": "string",
"revenueTypeId": "string",
"hasCalculationLimit": true,
"calculationLimitOtherCurrency": 0,
"poNumber": "string",
"isAutoExtend": true,
"quantity": 0,
"amountPerTerm": 0,
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"completePercentage": 0,
"invoicingFrequencyId": 0,
"momentOfInvoicingId": "string",
"vatTypeId": "string",
"opportunityId": "string",
"autoApproveTimesheets": true,
"templateId": "string",
"copyFromDeliverableId": "string",
"copyAllocations": true,
"copyAllocationHours": true,
"copyTasks": true,
"copyInvoiceSchedule": true,
"copySubscriptionLines": true,
"applySalesRatesFromPriceList": true,
"shouldRecalculateSalesRates": true
}

Move down a deliverable within its project

path Parameters

deliverable_id required	string
project_id required	string

Responses

Move up a deliverable within its project

path Parameters

deliverable_id required	string
project_id required	string

Responses

Return all calculated activities of a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

employeeId

string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"employeeId": "string"
}

Return all calculation lines of a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

useCurrency

string or null

Responses

Request samples

Payload

Content type

application/json

{"useCurrency": "string"
}

Change order of the calculation lines of a deliver

Change order of the calculation lines of a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
deliverableCalculationIds	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"deliverableCalculationIds": ["string"
]
}

Return the calculation line form

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
name	string or null
	object or null
	object or null
startDate	string or null <date>
finishDate	string or null <date>
costRate	number or null
desc	string or null
hours	number or null
	object or null
	object or null
	object or null
remark	string or null
salesRate	number or null
salesRateInvoiceCurrency	number or null
type	string or null
amountPerTerm	number or null
quantity	integer or null
nrOfTasks	integer or null
nrOfTodoTasks	integer or null
nrOfDoingTasks	integer or null
	Array of objects or null (PurchaseOrder)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"activity": {"id": "string",
"name": "string"
},
"cost": {"id": "string",
"name": "string"
},
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"costRate": 0,
"desc": "string",
"hours": 0,
"actual": {"cost": 0,
"sales": 0,
"salesWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0
},
"salesPercentage": 0,
"salesPercentageWithDiscountSurcharge": 0,
"costPercentage": 0,
"costPercentageWithDiscountSurcharge": 0,
"amountInvoiced": 0,
"amountInvoicedWithDiscountSurcharge": 0,
"manuallyAmountInvoiced": 0,
"manuallyAmountInvoicedWithDiscountSurcharge": 0,
"hours": 0,
"hoursDraft": 0,
"hoursPlanned": 0,
"hoursToPlan": 0
},
"calculated": {"cost": 0,
"sales": 0,
"salesWithDiscountSurcharge": 0,
"orderValue": 0,
"orderValueWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0,
"hours": 0
},
"hours": 0
},
"forecast": {"cost": 0,
"sales": 0,
"hours": 0,
"salesWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0
},
"isPending": true
},
"remark": "string",
"salesRate": 0,
"salesRateInvoiceCurrency": 0,
"type": "string",
"amountPerTerm": 0,
"quantity": 0,
"nrOfTasks": 0,
"nrOfTodoTasks": 0,
"nrOfDoingTasks": 0,
"purchaseOrders": [{"id": "string",
"purchaseOrderNumber": 0,
"project": {"id": "string",
"name": "string"
},
"deliverable": {"id": "string",
"name": "string"
},
"cost": {"id": "string",
"name": "string"
},
"deliverableCalculationId": "string",
"supplier": {"id": "string",
"name": "string",
"avatar": "string",
"coverImage": "string",
"desc": "string",
"email": "string",
"folderId": "string",
"folderResourceString": "string",
"isCustomer": true,
"isSupplier": true,
"useDailyRates": true,
"accountManagerId": "string",
"nrOfContacts": null,
"nrOfOpportunities": 0,
"nrOfProjects": 0,
"nrOfInvoices": 0,
"nrOfDueInvoices": 0,
"permalink": "string",
"phone": "string",
"website": "string",
"priceListId": "string",
"countryCode": "string",
"isTimesheetsApprovedByClientDefault": true,
"customerCode": "string"
},
"contact": {"id": "string",
"name": "string"
},
"department": {"id": "string",
"name": "string"
},
"purchaseOrderAmount": 0,
"purchaseInvoiceAmount": 0,
"desc": "string"
}
]
}

Return the calculation line form

path Parameters

deliverable_id required	string
calculation_line_id required	string

Request Body schema: application/json

id	string or null <id>
name	string or null
	object or null
	object or null
startDate	string or null <date>
finishDate	string or null <date>
costRate	number or null
desc	string or null
hours	number or null
	object or null
	object or null
	object or null
remark	string or null
salesRate	number or null
salesRateInvoiceCurrency	number or null
type	string or null
amountPerTerm	number or null
quantity	integer or null
nrOfTasks	integer or null
nrOfTodoTasks	integer or null
nrOfDoingTasks	integer or null
	Array of objects or null (PurchaseOrder)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"activity": {"id": "string",
"name": "string"
},
"cost": {"id": "string",
"name": "string"
},
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"costRate": 0,
"desc": "string",
"hours": 0,
"actual": {"cost": 0,
"sales": 0,
"salesWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0
},
"salesPercentage": 0,
"salesPercentageWithDiscountSurcharge": 0,
"costPercentage": 0,
"costPercentageWithDiscountSurcharge": 0,
"amountInvoiced": 0,
"amountInvoicedWithDiscountSurcharge": 0,
"manuallyAmountInvoiced": 0,
"manuallyAmountInvoicedWithDiscountSurcharge": 0,
"hours": 0,
"hoursDraft": 0,
"hoursPlanned": 0,
"hoursToPlan": 0
},
"calculated": {"cost": 0,
"sales": 0,
"salesWithDiscountSurcharge": 0,
"orderValue": 0,
"orderValueWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0,
"hours": 0
},
"hours": 0
},
"forecast": {"cost": 0,
"sales": 0,
"hours": 0,
"salesWithDiscountSurcharge": 0,
"margin": {"amount": 0,
"amountWithDiscountSurcharge": 0,
"percentage": 0,
"percentageWithDiscountSurcharge": 0
},
"isPending": true
},
"remark": "string",
"salesRate": 0,
"salesRateInvoiceCurrency": 0,
"type": "string",
"amountPerTerm": 0,
"quantity": 0,
"nrOfTasks": 0,
"nrOfTodoTasks": 0,
"nrOfDoingTasks": 0,
"purchaseOrders": [{"id": "string",
"purchaseOrderNumber": 0,
"project": {"id": "string",
"name": "string"
},
"deliverable": {"id": "string",
"name": "string"
},
"cost": {"id": "string",
"name": "string"
},
"deliverableCalculationId": "string",
"supplier": {"id": "string",
"name": "string",
"avatar": "string",
"coverImage": "string",
"desc": "string",
"email": "string",
"folderId": "string",
"folderResourceString": "string",
"isCustomer": true,
"isSupplier": true,
"useDailyRates": true,
"accountManagerId": "string",
"nrOfContacts": null,
"nrOfOpportunities": 0,
"nrOfProjects": 0,
"nrOfInvoices": 0,
"nrOfDueInvoices": 0,
"permalink": "string",
"phone": "string",
"website": "string",
"priceListId": "string",
"countryCode": "string",
"isTimesheetsApprovedByClientDefault": true,
"customerCode": "string"
},
"contact": {"id": "string",
"name": "string"
},
"department": {"id": "string",
"name": "string"
},
"purchaseOrderAmount": 0,
"purchaseInvoiceAmount": 0,
"desc": "string"
}
]
}

Update or insert a calculation line

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
	Array of objects or null (MainEntityBase)
canChangeComponent	boolean or null
canDelete	boolean or null
activityId	string or null <id>
costId	string or null <id>
costAmount	number or null
costRate	number or null
desc	string or null
finishDate	string or null <date>
hours	number or null
hoursAllocated	number or null
remark	string or null
salesAmount	number or null
salesAmountInvoiceCurrency	number or null
salesRate	number or null
salesRateInvoiceCurrency	number or null
startDate	string or null <date>
typeId	string or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"assignees": [{"id": "string",
"name": "string"
}
],
"canChangeComponent": true,
"canDelete": true,
"activityId": "string",
"costId": "string",
"costAmount": 0,
"costRate": 0,
"desc": "string",
"finishDate": "2019-08-24",
"hours": 0,
"hoursAllocated": 0,
"remark": "string",
"salesAmount": 0,
"salesAmountInvoiceCurrency": 0,
"salesRate": 0,
"salesRateInvoiceCurrency": 0,
"startDate": "2019-08-24",
"typeId": "string"
}

Delete a calculation line

path Parameters

deliverable_id required	string
calculation_line_id required	string

Responses

Update or insert a calculation line

path Parameters

deliverable_id required	string
calculation_line_id required	string

Request Body schema: application/json

id	string or null <id>
	Array of objects or null (MainEntityBase)
canChangeComponent	boolean or null
canDelete	boolean or null
activityId	string or null <id>
costId	string or null <id>
costAmount	number or null
costRate	number or null
desc	string or null
finishDate	string or null <date>
hours	number or null
hoursAllocated	number or null
remark	string or null
salesAmount	number or null
salesAmountInvoiceCurrency	number or null
salesRate	number or null
salesRateInvoiceCurrency	number or null
startDate	string or null <date>
typeId	string or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"assignees": [{"id": "string",
"name": "string"
}
],
"canChangeComponent": true,
"canDelete": true,
"activityId": "string",
"costId": "string",
"costAmount": 0,
"costRate": 0,
"desc": "string",
"finishDate": "2019-08-24",
"hours": 0,
"hoursAllocated": 0,
"remark": "string",
"salesAmount": 0,
"salesAmountInvoiceCurrency": 0,
"salesRate": 0,
"salesRateInvoiceCurrency": 0,
"startDate": "2019-08-24",
"typeId": "string"
}

Close a deliverable

path Parameters

deliverable_id

required

string

Responses

Return a list of reasons why a deliverable can't b

Return a list of reasons why a deliverable can't be closed

path Parameters

deliverable_id

required

string

Responses

Commit the opening balance for a deliverable

path Parameters

deliverable_id

required

string

Responses

Reopen a deliverable

path Parameters

deliverable_id

required

string

Responses

Reverse the opening balance for a deliverable

path Parameters

deliverable_id

required

string

Responses

Return all subscription lines of a deliverable

path Parameters

deliverable_id

required

string

Responses

Return the subscription line of a deliverable form

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
desc	string or null
quantity	integer or null
amountPerTerm	number or null
startDate	string or null <date>
finishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"desc": "string",
"quantity": 0,
"amountPerTerm": 0,
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}

Return the subscription line of a deliverable form

path Parameters

deliverable_id required	string
deliverable_subscription_id required	string

Request Body schema: application/json

id	string or null <id>
desc	string or null
quantity	integer or null
amountPerTerm	number or null
startDate	string or null <date>
finishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"desc": "string",
"quantity": 0,
"amountPerTerm": 0,
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}

Update or insert a subscription line of a delivera

Update or insert a subscription line of a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
desc	string or null
quantity	integer or null
amountPerTerm	number or null
startDate	string or null <date>
finishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"desc": "string",
"quantity": 0,
"amountPerTerm": 0,
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}

Delete a subscription line of a deliverable

path Parameters

deliverable_id required	string
deliverable_subscription_id required	string

Responses

Update or insert a subscription line of a delivera

Update or insert a subscription line of a deliverable

path Parameters

deliverable_id required	string
deliverable_subscription_id required	string

Request Body schema: application/json

id	string or null <id>
desc	string or null
quantity	integer or null
amountPerTerm	number or null
startDate	string or null <date>
finishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"desc": "string",
"quantity": 0,
"amountPerTerm": 0,
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}

Insert an external issue for a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

externalProjectId	string or null
issueType	string or null
title	string or null
description	string or null
epicName	string or null
activityId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"externalProjectId": "string",
"issueType": "string",
"title": "string",
"description": "string",
"epicName": "string",
"activityId": "string"
}

Return a list of external issues for a deliverable

path Parameters

deliverable_id

required

string

Responses

Return the external issue form

path Parameters

deliverable_id

required

string

Responses

Link an external issue to a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

activityId	string or null <id>
issueId	string or null

Responses

Request samples

Payload

Content type

application/json

{"activityId": "string",
"issueId": "string"
}

UnLink an external issue from a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

issueId

string or null

Responses

Request samples

Payload

Content type

application/json

{"issueId": "string"
}

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

id	string or null <id>
canDelete	boolean or null
invoiceAmount	number or null
invoiceDate	string or null <date>
invoiceDesc	string or null
	object or null
periodStartDate	string or null <date>
periodFinishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"canDelete": true,
"invoiceAmount": 0,
"invoiceDate": "2019-08-24",
"invoiceDesc": "string",
"status": {"id": "string",
"name": "string"
},
"periodStartDate": "2019-08-24",
"periodFinishDate": "2019-08-24"
}

Return a list of invoicing schedules of a delivera

Return a list of invoicing schedules of a deliverable

path Parameters

deliverable_id

required

string

Responses

Delete an invoicing schedule

path Parameters

deliverable_id required	string
billing_period_id required	string

Responses

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters

deliverable_id required	string
billing_period_id required	string

Request Body schema: application/json

id	string or null <id>
canDelete	boolean or null
invoiceAmount	number or null
invoiceDate	string or null <date>
invoiceDesc	string or null
	object or null
periodStartDate	string or null <date>
periodFinishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"canDelete": true,
"invoiceAmount": 0,
"invoiceDate": "2019-08-24",
"invoiceDesc": "string",
"status": {"id": "string",
"name": "string"
},
"periodStartDate": "2019-08-24",
"periodFinishDate": "2019-08-24"
}

Get the form to create or update set of deliverabl

Get the form to create or update set of deliverables to duplicate

Responses

Create a set of deliverables to duplicate

Request Body schema: application/json

fromFinishDate	string or null <date>
toFinishDate	string or null <date>
revenueTypeIds	Array of strings or null <id>
departmentIds	Array of strings or null <id>
skipWhenNoNewPriceList	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"fromFinishDate": "2019-08-24",
"toFinishDate": "2019-08-24",
"revenueTypeIds": ["string"
],
"departmentIds": ["string"
],
"skipWhenNoNewPriceList": true
}

Update an item in a set of deliverables to duplica

Update an item in a set of deliverables to duplicate

path Parameters

deliverables_to_duplicate_set_id

required

string

Request Body schema: application/json

selectionType	string or null
isSelected	boolean or null
deliverableId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"selectionType": "string",
"isSelected": true,
"deliverableId": "string"
}

Duplicate set of deliverables

path Parameters

deliverables_to_duplicate_set_id

required

string

Request Body schema: application/json

copyTasks	boolean or null
copyInvoiceSchedule	boolean or null
copySubscriptionLines	boolean or null
applySalesRatesFromPriceList	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"copyTasks": true,
"copyInvoiceSchedule": true,
"copySubscriptionLines": true,
"applySalesRatesFromPriceList": true
}

Get the form to create or update set of deliverabl

Get the form to create or update set of deliverables to duplicate

path Parameters

deliverables_to_duplicate_set_id

required

string

Responses

Get the contributors and time entries of a calcula

Get the contributors and time entries of a calculation line

path Parameters

calculation_line_id

required

string

Responses

Get the costs of a calculation-line

path Parameters

calculation_line_id

required

string

Responses

Insert or update a purchase order

path Parameters

calculation_line_id

required

string

Request Body schema: application/json

id	string or null <id>
supplierId	string or null <id>
contactId	string or null <id>
purchaseOrderAmount	number or null
desc	string or null
orderDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"supplierId": "string",
"contactId": "string",
"purchaseOrderAmount": 0,
"desc": "string",
"orderDate": "2019-08-24"
}

Delete a purchase order

path Parameters

purchase_order_id required	string
calculation_line_id required	string

Responses

Insert or update a purchase order

path Parameters

purchase_order_id required	string
calculation_line_id required	string

Request Body schema: application/json

id	string or null <id>
supplierId	string or null <id>
contactId	string or null <id>
purchaseOrderAmount	number or null
desc	string or null
orderDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"supplierId": "string",
"contactId": "string",
"purchaseOrderAmount": 0,
"desc": "string",
"orderDate": "2019-08-24"
}

Return a purchase order

path Parameters

purchase_order_number

required

string

Responses

Return the purchase order form

path Parameters

calculation_line_id

required

string

Responses

Return the purchase order form

path Parameters

purchase_order_id required	string
calculation_line_id required	string

Responses

Insert a template for a deliverable

Request Body schema: application/json

overwrite	boolean or null
deliverableId	string or null <id>
projectId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"overwrite": true,
"deliverableId": "string",
"projectId": "string"
}

Delete a template for a deliverable

path Parameters

deliverable_template_id

required

string

Responses

Planning

Form to update week planning

Form for adjusting planned hours of a week for an allocation or absence type

path Parameters

planning_id

required

string

Request Body schema: application/json

id	string or null <id>
name	string or null
resourceAllocationId	string or null <id>
absenceTypeId	string or null <id>
year	integer or null Default: 0
weekNr	integer or null Default: 0
resourceId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"resourceAllocationId": "string",
"absenceTypeId": "string",
"year": 0,
"weekNr": 0,
"resourceId": "string"
}

Update week planning

Update or insert planned hours of a week for an allocation or absence type

path Parameters

planning_id

required

string

Request Body schema: application/json

projectId	string or null <id>
deliverableId	string or null <id>
calculatedActivityId	string or null <id>
resourceAllocationId	string or null <id>
absenceTypeId	string or null <id>
resourceId	string or null <id>
taskId	string or null <id>
	Array of objects or null (ResourcePlanningDayWriteSchemaV3) The list of days should have exactly 7 objects in it. The first object is the monday of the week and the last is the sunday.
year	integer or null Default: 0
weekNr	integer or null Default: 0
obeyAbsenceTypePlanBehavior	boolean or null True: VOGSY will factor in the "Plan leave hours" setting. False: VOGSY will generate planned hours without considering the "Plan leave hours" setting.

Responses

Request samples

Payload

Content type

application/json

{"projectId": "string",
"deliverableId": "string",
"calculatedActivityId": "string",
"resourceAllocationId": "string",
"absenceTypeId": "string",
"resourceId": "string",
"taskId": "string",
"days": [{"id": "string",
"name": "string",
"hours": 0,
"reference": ""
}
],
"year": 0,
"weekNr": 0,
"obeyAbsenceTypePlanBehavior": true
}

Form to update week planning

Form for adjusting planned hours of a week for an allocation or absence type

Request Body schema: application/json

id	string or null <id>
name	string or null
resourceAllocationId	string or null <id>
absenceTypeId	string or null <id>
year	integer or null Default: 0
weekNr	integer or null Default: 0
resourceId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"resourceAllocationId": "string",
"absenceTypeId": "string",
"year": 0,
"weekNr": 0,
"resourceId": "string"
}

Update week planning

Update or insert planned hours of a week for an allocation or absence type

Request Body schema: application/json

projectId	string or null <id>
deliverableId	string or null <id>
calculatedActivityId	string or null <id>
resourceAllocationId	string or null <id>
absenceTypeId	string or null <id>
resourceId	string or null <id>
taskId	string or null <id>
	Array of objects or null (ResourcePlanningDayWriteSchemaV3) The list of days should have exactly 7 objects in it. The first object is the monday of the week and the last is the sunday.
year	integer or null Default: 0
weekNr	integer or null Default: 0
obeyAbsenceTypePlanBehavior	boolean or null True: VOGSY will factor in the "Plan leave hours" setting. False: VOGSY will generate planned hours without considering the "Plan leave hours" setting.

Responses

Request samples

Payload

Content type

application/json

{"projectId": "string",
"deliverableId": "string",
"calculatedActivityId": "string",
"resourceAllocationId": "string",
"absenceTypeId": "string",
"resourceId": "string",
"taskId": "string",
"days": [{"id": "string",
"name": "string",
"hours": 0,
"reference": ""
}
],
"year": 0,
"weekNr": 0,
"obeyAbsenceTypePlanBehavior": true
}

Projects

Add an existing board to a project

Request Body schema: application/json

name	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Return a list of projects

Request Body schema: application/json

modifiedAfter	string <date-time>
organizationId	string <id>
cursor	string <cursor>
maxResults	integer

Responses

Request samples

Payload

Content type

application/json

{"modifiedAfter": "2019-08-24T14:15:22Z",
"organizationId": "string",
"cursor": "string",
"maxResults": 0
}

Return a list of projects which need client timesh

Return a list of projects which need client timesheet approval

path Parameters

project_id

required

string

Request Body schema: application/json

startDate	string or null <date>
finishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}

Close a project

path Parameters

project_id

required

string

Responses

Return a list of reasons why a project can't be cl

Return a list of reasons why a project can't be closed

path Parameters

project_id

required

string

Responses

Return a project form

path Parameters

project_id

required

string

Request Body schema: application/json

organizationId	string or null <id>
opportunityId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"organizationId": "string",
"opportunityId": "string"
}

Return the project team form

path Parameters

project_id

required

string

Responses

Insert or update a project member

path Parameters

project_id

required

string

Request Body schema: application/json

roleId	string or null
personId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"roleId": "string",
"personId": "string"
}

Delete a project member

path Parameters

member_id required	string
project_id required	string

Responses

Insert or update a project member

path Parameters

member_id required	string
project_id required	string

Request Body schema: application/json

roleId	string or null
personId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"roleId": "string",
"personId": "string"
}

Reopen a project

path Parameters

project_id

required

string

Responses

Delete a project

path Parameters

project_id

required

string

Responses

Return a project

path Parameters

project_id

required

string

Responses

Insert or update a project

path Parameters

project_id

required

string

Request Body schema: application/json

id	string <id>
name	string
clientId	string <id>
currencyId	string <id>
customerId	string <id>
departmentId	string <id>
paymentConditionId	string <id>
desc	string
startDate	string <date>
finishDate	string <date>
poNumber	string
projectStatusId	string <id>
opportunityId	string <id>
isClosed	boolean
timesheetsApprovedByClient	boolean
timesheetApprovalContactIds	Array of strings <id> [ items <id > ]
discountDescription	string
discountPercentage	integer
surchargeDescription	string
surchargePercentage	integer
useInvoicingScheduleOnProjectLevel	boolean
isProjectBudgetBasedOnAllocations	boolean
revenueTypeId	string <id>
nrOfDeliverables	any
vatTypeId	string <id>
priceListId	string or null <id>
gAccountPercentage	integer
useAlternativeInvoiceAddress	boolean
invoiceAddress	string
invoiceAttention	string
invoiceCity	string
invoiceCountry	string
invoiceEmails	Array of strings
invoiceName	string
invoiceZipCode	string
invoiceNotes	string
projectTemplateId	string <id>
	Array of objects (TemplateDeliverableWrite)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"clientId": "string",
"currencyId": "string",
"customerId": "string",
"departmentId": "string",
"paymentConditionId": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"poNumber": "string",
"projectStatusId": "string",
"opportunityId": "string",
"isClosed": true,
"timesheetsApprovedByClient": true,
"timesheetApprovalContactIds": ["string"
],
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"useInvoicingScheduleOnProjectLevel": true,
"isProjectBudgetBasedOnAllocations": true,
"revenueTypeId": "string",
"nrOfDeliverables": null,
"vatTypeId": "string",
"priceListId": "string",
"gAccountPercentage": 0,
"useAlternativeInvoiceAddress": true,
"invoiceAddress": "string",
"invoiceAttention": "string",
"invoiceCity": "string",
"invoiceCountry": "string",
"invoiceEmails": ["string"
],
"invoiceName": "string",
"invoiceZipCode": "string",
"invoiceNotes": "string",
"projectTemplateId": "string",
"templateDeliverables": [{"name": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}
]
}

Return the detailed margin of a project

path Parameters

project_id

required

string

Responses

Return a list of milestones

path Parameters

project_id

required

string

Responses

Delete a milestone

path Parameters

project_id required	string
milestone_id required	string

Responses

Update or insert a milestone

path Parameters

project_id required	string
milestone_id required	string

Request Body schema: application/json

id	string or null <id>
name	string or null
date	string or null <date>
custom	boolean or null
done	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"date": "2019-08-24",
"custom": true,
"done": true
}

Toggle done of a milestone

path Parameters

project_id required	string
milestone_id required	string

Responses

Ignore a milestone

path Parameters

project_id required	string
milestone_id required	string

Responses

Update or insert a milestone

path Parameters

project_id

required

string

Request Body schema: application/json

id	string or null <id>
name	string or null
date	string or null <date>
custom	boolean or null
done	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"date": "2019-08-24",
"custom": true,
"done": true
}

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters

project_id

required

string

Request Body schema: application/json

id	string or null <id>
canDelete	boolean or null
invoiceAmount	number or null
invoiceDate	string or null <date>
invoiceDesc	string or null
	object or null
periodStartDate	string or null <date>
periodFinishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"canDelete": true,
"invoiceAmount": 0,
"invoiceDate": "2019-08-24",
"invoiceDesc": "string",
"status": {"id": "string",
"name": "string"
},
"periodStartDate": "2019-08-24",
"periodFinishDate": "2019-08-24"
}

Return the invoicing schedules of a project

path Parameters

project_id

required

string

Responses

Delete an invoicing schedule

path Parameters

project_id required	string
billing_period_id required	string

Responses

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters

project_id required	string
billing_period_id required	string

Request Body schema: application/json

id	string or null <id>
canDelete	boolean or null
invoiceAmount	number or null
invoiceDate	string or null <date>
invoiceDesc	string or null
	object or null
periodStartDate	string or null <date>
periodFinishDate	string or null <date>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"canDelete": true,
"invoiceAmount": 0,
"invoiceDate": "2019-08-24",
"invoiceDesc": "string",
"status": {"id": "string",
"name": "string"
},
"periodStartDate": "2019-08-24",
"periodFinishDate": "2019-08-24"
}

Return the available working hours for a specific

Return the available working hours for a specific employee on a project

path Parameters

project_id

required

string

Request Body schema: application/json

timesheetId

string or null

Responses

Request samples

Payload

Content type

application/json

{"timesheetId": "string"
}

Return a list of invoices for a project

path Parameters

project_id

required

string

Request Body schema: application/json

filter

string or null

Responses

Request samples

Payload

Content type

application/json

{"filter": "string"
}

Commit the opening balance for a project

path Parameters

project_id

required

string

Responses

Return the opening balance for a project

path Parameters

project_id

required

string

Responses

Reverse the opening balance for a project

path Parameters

project_id

required

string

Responses

Return a project form

Request Body schema: application/json

organizationId	string or null <id>
opportunityId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"organizationId": "string",
"opportunityId": "string"
}

Insert or update a project

Request Body schema: application/json

id	string <id>
name	string
clientId	string <id>
currencyId	string <id>
customerId	string <id>
departmentId	string <id>
paymentConditionId	string <id>
desc	string
startDate	string <date>
finishDate	string <date>
poNumber	string
projectStatusId	string <id>
opportunityId	string <id>
isClosed	boolean
timesheetsApprovedByClient	boolean
timesheetApprovalContactIds	Array of strings <id> [ items <id > ]
discountDescription	string
discountPercentage	integer
surchargeDescription	string
surchargePercentage	integer
useInvoicingScheduleOnProjectLevel	boolean
isProjectBudgetBasedOnAllocations	boolean
revenueTypeId	string <id>
nrOfDeliverables	any
vatTypeId	string <id>
priceListId	string or null <id>
gAccountPercentage	integer
useAlternativeInvoiceAddress	boolean
invoiceAddress	string
invoiceAttention	string
invoiceCity	string
invoiceCountry	string
invoiceEmails	Array of strings
invoiceName	string
invoiceZipCode	string
invoiceNotes	string
projectTemplateId	string <id>
	Array of objects (TemplateDeliverableWrite)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"clientId": "string",
"currencyId": "string",
"customerId": "string",
"departmentId": "string",
"paymentConditionId": "string",
"desc": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24",
"poNumber": "string",
"projectStatusId": "string",
"opportunityId": "string",
"isClosed": true,
"timesheetsApprovedByClient": true,
"timesheetApprovalContactIds": ["string"
],
"discountDescription": "string",
"discountPercentage": 0,
"surchargeDescription": "string",
"surchargePercentage": 0,
"useInvoicingScheduleOnProjectLevel": true,
"isProjectBudgetBasedOnAllocations": true,
"revenueTypeId": "string",
"nrOfDeliverables": null,
"vatTypeId": "string",
"priceListId": "string",
"gAccountPercentage": 0,
"useAlternativeInvoiceAddress": true,
"invoiceAddress": "string",
"invoiceAttention": "string",
"invoiceCity": "string",
"invoiceCountry": "string",
"invoiceEmails": ["string"
],
"invoiceName": "string",
"invoiceZipCode": "string",
"invoiceNotes": "string",
"projectTemplateId": "string",
"templateDeliverables": [{"name": "string",
"startDate": "2019-08-24",
"finishDate": "2019-08-24"
}
]
}

Return an external board connected to a project

path Parameters

project_id

required

string

Responses

Link an external board to a project

path Parameters

project_id

required

string

Request Body schema: application/json

boardId

string or null

Responses

Request samples

Payload

Content type

application/json

{"boardId": "string"
}

UnLink an external board from a project

path Parameters

project_id

required

string

Request Body schema: application/json

boardId

string or null

Responses

Request samples

Payload

Content type

application/json

{"boardId": "string"
}

Add an existing board to a project

path Parameters

project_id

required

string

Request Body schema: application/json

name	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Mark a billing period as invoiced

path Parameters

billing_period_id

required

string

Request Body schema: application/json

id	string <id>
billingPeriodId	string <id>
invoiceAmount	number
invoiceDate	string <date>
invoiceDesc	string
status	string
	object (Options)
canDelete	boolean
openingBalance	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"billingPeriodId": "string",
"invoiceAmount": 0,
"invoiceDate": "2019-08-24",
"invoiceDesc": "string",
"status": "string",
"statusOption": {"id": "string",
"archived": true,
"name": "string",
"label": "string"
},
"canDelete": true,
"openingBalance": true
}

Insert a template for a project

Request Body schema: application/json

overwrite	boolean or null
projectId	string or null <id>

Responses

Request samples

Payload

Content type

application/json

{"overwrite": true,
"projectId": "string"
}

Delete a template for a project

path Parameters

project_template_id

required

string

Responses

Project planning

Get planning for projects

Request Body schema: application/json

year	integer or null Default: 0
weekNr	integer or null Default: 0
groupSize	integer or null Default: 1
cursor	string or null
maxResults	integer or null
type	string or null Default: "days"
projectId	string or null <id>
departmentIds	Array of strings or null <id>
tagIds	Array of strings or null <id>
statusIds	Array of strings or null <id>
projectManagerIds	Array of strings or null <id>
myProjects	boolean or null
order	string or null

Responses

Request samples

Payload

Content type

application/json

{"year": 0,
"weekNr": 0,
"groupSize": 1,
"cursor": "string",
"maxResults": 0,
"type": "days",
"projectId": "string",
"departmentIds": ["string"
],
"tagIds": ["string"
],
"statusIds": ["string"
],
"projectManagerIds": ["string"
],
"myProjects": true,
"order": "string"
}

Return the project planning filters

Responses

Get planning for deliverables of a project

path Parameters

project_id

required

string

Request Body schema: application/json

year	integer or null Default: 0
weekNr	integer or null Default: 0
groupSize	integer or null Default: 1
type	string or null Default: "days"
planningOnly	boolean or null
timeOffOnly	boolean or null
showOpportunityBookings	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"year": 0,
"weekNr": 0,
"groupSize": 1,
"type": "days",
"planningOnly": true,
"timeOffOnly": true,
"showOpportunityBookings": true
}

Get planning for tasks of a project

path Parameters

project_id

required

string

Responses

Get planning for calculated activities and tasks o

Get planning for calculated activities and tasks of a deliverable

path Parameters

deliverable_id

required

string

Request Body schema: application/json

year	integer or null Default: 0
weekNr	integer or null Default: 0
groupSize	integer or null Default: 1
type	string or null Default: "days"
planningOnly	boolean or null
timeOffOnly	boolean or null
showOpportunityBookings	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"year": 0,
"weekNr": 0,
"groupSize": 1,
"type": "days",
"planningOnly": true,
"timeOffOnly": true,
"showOpportunityBookings": true
}

Resource planning

Return a list of resources with their planning

Request Body schema: application/json

year	integer or null Default: 0
weekNr	integer or null Default: 0
groupSize	integer or null Default: 1
cursor	integer or null
maxResults	integer or null
type	string or null Default: "days"
projectId	string or null <id>
resourceId	string or null <id>
resourceTypeId	string or null
departmentIds	Array of strings or null <id>
activityIds	Array of strings or null <id>
tagIds	Array of strings or null <id>
seniorityIds	Array of strings or null <id>
skillIds	Array of strings or null <id>
skillAndSkillLevelIds	Array of strings or null
withDraftOrSubmittedOnly	boolean or null
personIds	Array of strings or null <id>
showOpportunityBookings	boolean or null
selectedSortOrder	string or null
planningsView	string or null

Responses

Request samples

Payload

Content type

application/json

{"year": 0,
"weekNr": 0,
"groupSize": 1,
"cursor": 0,
"maxResults": 0,
"type": "days",
"projectId": "string",
"resourceId": "string",
"resourceTypeId": "string",
"departmentIds": ["string"
],
"activityIds": ["string"
],
"tagIds": ["string"
],
"seniorityIds": ["string"
],
"skillIds": ["string"
],
"skillAndSkillLevelIds": ["string"
],
"withDraftOrSubmittedOnly": true,
"personIds": ["string"
],
"showOpportunityBookings": true,
"selectedSortOrder": "string",
"planningsView": "string"
}

Return the planned activities of a resource

path Parameters

person_id

required

string

Request Body schema: application/json

year	integer or null Default: 0
weekNr	integer or null Default: 0
groupSize	integer or null Default: 1
type	string or null Default: "days"
planningOnly	boolean or null
timeOffOnly	boolean or null
showOpportunityBookings	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"year": 0,
"weekNr": 0,
"groupSize": 1,
"type": "days",
"planningOnly": true,
"timeOffOnly": true,
"showOpportunityBookings": true
}

Return the resource planning filters

Responses

Project invoices

Return a list of draft invoices

Request Body schema: application/json

modifiedAfter	string <date-time>
cursor	string <cursor>
maxResults	integer

Responses

Request samples

Payload

Content type

application/json

{"modifiedAfter": "2019-08-24T14:15:22Z",
"cursor": "string",
"maxResults": 0
}

Accounts payables

Return form for accounts payable

Responses

Return form for accounts payable

path Parameters

account_payable_id

required

string

Responses

Insert or update accounts payable and purchase inv

Insert or update accounts payable and purchase invoice

Request Body schema: application/json

id	string or null <id>
amount	number or null
amountOtherCurrency	number or null
amountInPaymentSet	number or null
amountInPaymentSetOtherCurrency	number or null
	object or null
creditor_invoice_number	string or null
	object or null
currency_code	string or null
	Array of objects or null (Currency)
	Array of objects or null (MainEntityBase)
	object or null
due_date	string or null <date>
ibanAndBicAvailable	boolean or null
invoice_date	string or null <date>