API docs by Redocly

VOGSY API Reference

Download OpenAPI specification:

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 or https://sandbox.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

Return the cap of a resource allocation

path Parameters
calculation_line_id
required
string
Request Body schema: application/json
optional
personId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "personId": "string"
}

Response samples

Content type
application/json
{
  • "budgetHours": 0,
  • "availableHoursInAllocation": 0,
  • "availableHoursInPlanning": 0,
  • "hoursInTimesheets": 0,
  • "hoursInPlanning": 0,
  • "capLevel": "string"
}

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
optional
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

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
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Delete a resource allocation

Delete a resource allocation

path Parameters
resource_allocation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Get the resource-allocations of a calculation-line

Get the resource-allocations of a calculation-line

path Parameters
calculation_line_id
required
string

Responses

Response samples

Content type
application/json
{
  • "resourceAllocations": [
    ],
  • "resources": [
    ],
  • "departments": {
    },
  • "jobRoleOptions": [
    ]
}

Save the resource allocations

Save the resource allocations

path Parameters
calculation_line_id
required
string
Request Body schema: application/json
optional
Array of objects (ResourceAllocationWrite)

Responses

Request samples

Content type
application/json
{
  • "allocations": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Create or update a resource allocation for a calcu

Create or update a resource allocation for a calculated activity

path Parameters
calculation_line_id
required
string
resource_allocation_id
required
string
Request Body schema: application/json
optional
id
string <id>
personId
string <id>
resourcePlanningId
string or null <id>
hours
number
hasCustomSalesRate
boolean
salesRate
number
salesRateInvoiceCurrency
number
costRate
number
costRateEmployeeCurrency
number
object (Currency)
planMonday
boolean
planTuesday
boolean
planWednesday
boolean
planThursday
boolean
planFriday
boolean
planSaturday
boolean
planSunday
boolean
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
generateNewPlanning
boolean
startDate
string <date>
finishDate
string <date>
jobRoleId
string <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "personId": "string",
  • "resourcePlanningId": "string",
  • "hours": 0,
  • "hasCustomSalesRate": true,
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "costRate": 0,
  • "costRateEmployeeCurrency": 0,
  • "employeeCurrency": {
    },
  • "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"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Create or update a resource allocation for a calcu

Create or update a resource allocation for a calculated activity

path Parameters
calculation_line_id
required
string
Request Body schema: application/json
optional
id
string <id>
personId
string <id>
resourcePlanningId
string or null <id>
hours
number
hasCustomSalesRate
boolean
salesRate
number
salesRateInvoiceCurrency
number
costRate
number
costRateEmployeeCurrency
number
object (Currency)
planMonday
boolean
planTuesday
boolean
planWednesday
boolean
planThursday
boolean
planFriday
boolean
planSaturday
boolean
planSunday
boolean
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
generateNewPlanning
boolean
startDate
string <date>
finishDate
string <date>
jobRoleId
string <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "personId": "string",
  • "resourcePlanningId": "string",
  • "hours": 0,
  • "hasCustomSalesRate": true,
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "costRate": 0,
  • "costRateEmployeeCurrency": 0,
  • "employeeCurrency": {
    },
  • "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"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Deliverables

Insert or update a deliverable

Insert or update a deliverable

path Parameters
project_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
startDate
string <date>
finishDate
string <date>
invoiceMethodId
string
fixedPriceOtherCurrency
number
departmentId
string <id>
revenueTypeId
string <id>
hasCalculationLimit
boolean
calculationLimitOtherCurrency
number or null
poNumber
string
isAutoExtend
boolean
quantity
number
amountPerTerm
number
discountDescription
string
discountPercentage
integer
surchargeDescription
string
surchargePercentage
integer
completePercentage
integer
invoicingFrequencyId
integer or null
momentOfInvoicingId
string or null
vatTypeId
string <id>
opportunityId
string <id>
autoApproveTimesheets
boolean
hasCustomTimesheetApprovalContactIds
boolean
timesheetApprovalContactIds
Array of strings <id> [ items <id > ]
templateId
string or null <id>
copyFromDeliverableId
string <id>
copyAllocations
boolean
copyAllocationHours
boolean
copyTasks
boolean
copyInvoiceSchedule
boolean
copySubscriptionLines
boolean
applySalesRatesFromPriceList
boolean
shouldRecalculateSalesRates
boolean or null
costCenterId
string <id>

Responses

Request samples

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,
  • "hasCustomTimesheetApprovalContactIds": true,
  • "timesheetApprovalContactIds": [
    ],
  • "templateId": "string",
  • "copyFromDeliverableId": "string",
  • "copyAllocations": true,
  • "copyAllocationHours": true,
  • "copyTasks": true,
  • "copyInvoiceSchedule": true,
  • "copySubscriptionLines": true,
  • "applySalesRatesFromPriceList": true,
  • "shouldRecalculateSalesRates": true,
  • "costCenterId": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a list of deliverables for a project

Return a list of deliverables for a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a deliverable form

Return a deliverable form

path Parameters
project_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
startDate
string <date>
finishDate
string <date>
invoiceMethodId
string
fixedPriceOtherCurrency
number
departmentId
string <id>
revenueTypeId
string <id>
hasCalculationLimit
boolean
calculationLimitOtherCurrency
number or null
poNumber
string
isAutoExtend
boolean
quantity
number
amountPerTerm
number
discountDescription
string
discountPercentage
integer
surchargeDescription
string
surchargePercentage
integer
completePercentage
integer
invoicingFrequencyId
integer or null
momentOfInvoicingId
string or null
vatTypeId
string <id>
opportunityId
string <id>
autoApproveTimesheets
boolean
hasCustomTimesheetApprovalContactIds
boolean
timesheetApprovalContactIds
Array of strings <id> [ items <id > ]
templateId
string or null <id>
copyFromDeliverableId
string <id>
copyAllocations
boolean
copyAllocationHours
boolean
copyTasks
boolean
copyInvoiceSchedule
boolean
copySubscriptionLines
boolean
applySalesRatesFromPriceList
boolean
shouldRecalculateSalesRates
boolean or null
costCenterId
string <id>

Responses

Request samples

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,
  • "hasCustomTimesheetApprovalContactIds": true,
  • "timesheetApprovalContactIds": [
    ],
  • "templateId": "string",
  • "copyFromDeliverableId": "string",
  • "copyAllocations": true,
  • "copyAllocationHours": true,
  • "copyTasks": true,
  • "copyInvoiceSchedule": true,
  • "copySubscriptionLines": true,
  • "applySalesRatesFromPriceList": true,
  • "shouldRecalculateSalesRates": true,
  • "costCenterId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "deliverable": {
    },
  • "project": {
    },
  • "currency": {
    },
  • "localCurrency": {
    },
  • "templates": [
    ],
  • "clientOptions": [
    ],
  • "departmentOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "invoiceMethodOptions": [
    ],
  • "revenueTypeOptions": [
    ],
  • "invoiceFrequencyOptions": [
    ],
  • "momentOfInvoicingOptions": [
    ],
  • "isDeletable": true,
  • "isTimesheetsToBeApprovedByClient": true,
  • "hasInvoicedBillingPeriods": true,
  • "hasCalculationActivities": true,
  • "shouldRecalculateSalesRates": true,
  • "isCalculationLimitEnabled": true,
  • "costCenterOptions": [
    ],
  • "defaultTimesheetApprovalContactIds": [
    ]
}

Delete a deliverable

Delete a deliverable

path Parameters
deliverable_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "organizationName": "string",
  • "folderId": "string",
  • "nrOfDeliverables": null,
  • "isClosed": true,
  • "desc": "string",
  • "projectNumber": 0,
  • "permalink": "string",
  • "stateIndicator": 0,
  • "startDate": "string",
  • "finishDate": "string",
  • "hasAlternativeInvoiceAddress": true,
  • "client": {
    },
  • "localCurrency": {
    },
  • "currency": {
    },
  • "canReschedule": true,
  • "customer": {
    },
  • "deliverables": [
    ],
  • "department": {
    },
  • "discountDescription": "string",
  • "discountPercentage": 0,
  • "evaluationFormId": "string",
  • "googleCalendarId": "string",
  • "evaluationsDisabled": true,
  • "useInvoicingScheduleOnProjectLevel": true,
  • "revenueType": {
    },
  • "gAccountPercentage": 0,
  • "lastModifiedAt": "string",
  • "lastActionDatetime": "string",
  • "lockTextConfirmation": "string",
  • "calculated": {
    },
  • "actual": {
    },
  • "forecast": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfOpportunities": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfInvoices": 0,
  • "nrOfDueInvoices": 0,
  • "opportunityPending": true,
  • "opportunity": {
    },
  • "orderDate": "string",
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "preambleConfirmation": "string",
  • "progressionMethodFixedPrice": {
    },
  • "projectMembers": [
    ],
  • "projectStatus": {
    },
  • "surchargeDescription": "string",
  • "surchargePercentage": 0,
  • "target": "string",
  • "useCompletionIndicator": true,
  • "schedulePercentage": 0,
  • "completePercentage": 0,
  • "budgetPercentage": 0,
  • "invoiceNotes": "string",
  • "tags": [
    ],
  • "isProjectBudgetBasedOnAllocations": true
}

Insert or update a deliverable

Insert or update a deliverable

path Parameters
deliverable_id
required
string
project_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
startDate
string <date>
finishDate
string <date>
invoiceMethodId
string
fixedPriceOtherCurrency
number
departmentId
string <id>
revenueTypeId
string <id>
hasCalculationLimit
boolean
calculationLimitOtherCurrency
number or null
poNumber
string
isAutoExtend
boolean
quantity
number
amountPerTerm
number
discountDescription
string
discountPercentage
integer
surchargeDescription
string
surchargePercentage
integer
completePercentage
integer
invoicingFrequencyId
integer or null
momentOfInvoicingId
string or null
vatTypeId
string <id>
opportunityId
string <id>
autoApproveTimesheets
boolean
hasCustomTimesheetApprovalContactIds
boolean
timesheetApprovalContactIds
Array of strings <id> [ items <id > ]
templateId
string or null <id>
copyFromDeliverableId
string <id>
copyAllocations
boolean
copyAllocationHours
boolean
copyTasks
boolean
copyInvoiceSchedule
boolean
copySubscriptionLines
boolean
applySalesRatesFromPriceList
boolean
shouldRecalculateSalesRates
boolean or null
costCenterId
string <id>

Responses

Request samples

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,
  • "hasCustomTimesheetApprovalContactIds": true,
  • "timesheetApprovalContactIds": [
    ],
  • "templateId": "string",
  • "copyFromDeliverableId": "string",
  • "copyAllocations": true,
  • "copyAllocationHours": true,
  • "copyTasks": true,
  • "copyInvoiceSchedule": true,
  • "copySubscriptionLines": true,
  • "applySalesRatesFromPriceList": true,
  • "shouldRecalculateSalesRates": true,
  • "costCenterId": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a deliverable form

Return a deliverable form

path Parameters
deliverable_id
required
string
project_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
startDate
string <date>
finishDate
string <date>
invoiceMethodId
string
fixedPriceOtherCurrency
number
departmentId
string <id>
revenueTypeId
string <id>
hasCalculationLimit
boolean
calculationLimitOtherCurrency
number or null
poNumber
string
isAutoExtend
boolean
quantity
number
amountPerTerm
number
discountDescription
string
discountPercentage
integer
surchargeDescription
string
surchargePercentage
integer
completePercentage
integer
invoicingFrequencyId
integer or null
momentOfInvoicingId
string or null
vatTypeId
string <id>
opportunityId
string <id>
autoApproveTimesheets
boolean
hasCustomTimesheetApprovalContactIds
boolean
timesheetApprovalContactIds
Array of strings <id> [ items <id > ]
templateId
string or null <id>
copyFromDeliverableId
string <id>
copyAllocations
boolean
copyAllocationHours
boolean
copyTasks
boolean
copyInvoiceSchedule
boolean
copySubscriptionLines
boolean
applySalesRatesFromPriceList
boolean
shouldRecalculateSalesRates
boolean or null
costCenterId
string <id>

Responses

Request samples

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,
  • "hasCustomTimesheetApprovalContactIds": true,
  • "timesheetApprovalContactIds": [
    ],
  • "templateId": "string",
  • "copyFromDeliverableId": "string",
  • "copyAllocations": true,
  • "copyAllocationHours": true,
  • "copyTasks": true,
  • "copyInvoiceSchedule": true,
  • "copySubscriptionLines": true,
  • "applySalesRatesFromPriceList": true,
  • "shouldRecalculateSalesRates": true,
  • "costCenterId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "deliverable": {
    },
  • "project": {
    },
  • "currency": {
    },
  • "localCurrency": {
    },
  • "templates": [
    ],
  • "clientOptions": [
    ],
  • "departmentOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "invoiceMethodOptions": [
    ],
  • "revenueTypeOptions": [
    ],
  • "invoiceFrequencyOptions": [
    ],
  • "momentOfInvoicingOptions": [
    ],
  • "isDeletable": true,
  • "isTimesheetsToBeApprovedByClient": true,
  • "hasInvoicedBillingPeriods": true,
  • "hasCalculationActivities": true,
  • "shouldRecalculateSalesRates": true,
  • "isCalculationLimitEnabled": true,
  • "costCenterOptions": [
    ],
  • "defaultTimesheetApprovalContactIds": [
    ]
}

Move down a deliverable within its project

Move down a deliverable within its project

path Parameters
deliverable_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Move up a deliverable within its project

Move up a deliverable within its project

path Parameters
deliverable_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return all calculated activities of a deliverable

Return all calculated activities of a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
employeeId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "employeeId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Return all calculation lines of a deliverable

Return all calculation lines of a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
useCurrency
string or null

Responses

Request samples

Content type
application/json
{
  • "useCurrency": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activities": [
    ],
  • "costs": [
    ]
}

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
optional
id
string or null <id>
deliverableCalculationIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "deliverableCalculationIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return the calculation line form

Return the calculation line form

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
object
object
startDate
string or null <date>
finishDate
string or null <date>
hasCalculationLimit
boolean or null
costRate
number or null
desc
string or null
hours
number or null
object
object
object
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 (PurchaseOrder)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activity": {
    },
  • "cost": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasCalculationLimit": true,
  • "costRate": 0,
  • "desc": "string",
  • "hours": 0,
  • "actual": {
    },
  • "calculated": {
    },
  • "forecast": {
    },
  • "remark": "string",
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "type": "string",
  • "amountPerTerm": 0,
  • "quantity": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfDoingTasks": 0,
  • "purchaseOrders": [
    ]
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "activityOptions": [
    ],
  • "costOptions": [
    ],
  • "memberOptions": [
    ],
  • "typeOptions": [
    ],
  • "calculationLine": {
    },
  • "config": {
    },
  • "isDeletable": true,
  • "isCalculationLimitEnabled": true
}

Return the calculation line form

Return the calculation line form

path Parameters
deliverable_id
required
string
calculation_line_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
object
object
startDate
string or null <date>
finishDate
string or null <date>
hasCalculationLimit
boolean or null
costRate
number or null
desc
string or null
hours
number or null
object
object
object
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 (PurchaseOrder)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activity": {
    },
  • "cost": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasCalculationLimit": true,
  • "costRate": 0,
  • "desc": "string",
  • "hours": 0,
  • "actual": {
    },
  • "calculated": {
    },
  • "forecast": {
    },
  • "remark": "string",
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "type": "string",
  • "amountPerTerm": 0,
  • "quantity": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfDoingTasks": 0,
  • "purchaseOrders": [
    ]
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "activityOptions": [
    ],
  • "costOptions": [
    ],
  • "memberOptions": [
    ],
  • "typeOptions": [
    ],
  • "calculationLine": {
    },
  • "config": {
    },
  • "isDeletable": true,
  • "isCalculationLimitEnabled": true
}

Update or insert a calculation line

Update or insert a calculation line

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
id
string <id>
Array of objects (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 <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 <date>
typeId
string
hasCalculationLimit
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "assignees": [
    ],
  • "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",
  • "hasCalculationLimit": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activity": {
    },
  • "cost": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasCalculationLimit": true,
  • "costRate": 0,
  • "desc": "string",
  • "hours": 0,
  • "actual": {
    },
  • "calculated": {
    },
  • "forecast": {
    },
  • "remark": "string",
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "type": "string",
  • "amountPerTerm": 0,
  • "quantity": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfDoingTasks": 0,
  • "purchaseOrders": [
    ]
}

Delete a calculation line

Delete a calculation line

path Parameters
deliverable_id
required
string
calculation_line_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activities": [
    ],
  • "costs": [
    ]
}

Update or insert a calculation line

Update or insert a calculation line

path Parameters
deliverable_id
required
string
calculation_line_id
required
string
Request Body schema: application/json
optional
id
string <id>
Array of objects (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 <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 <date>
typeId
string
hasCalculationLimit
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "assignees": [
    ],
  • "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",
  • "hasCalculationLimit": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "activity": {
    },
  • "cost": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasCalculationLimit": true,
  • "costRate": 0,
  • "desc": "string",
  • "hours": 0,
  • "actual": {
    },
  • "calculated": {
    },
  • "forecast": {
    },
  • "remark": "string",
  • "salesRate": 0,
  • "salesRateInvoiceCurrency": 0,
  • "type": "string",
  • "amountPerTerm": 0,
  • "quantity": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfDoingTasks": 0,
  • "purchaseOrders": [
    ]
}

Close a deliverable

Close a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

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

Response samples

Content type
application/json
{
  • "deliverable": {
    },
  • "reasons": [
    ]
}

Commit the opening balance for a deliverable

Commit the opening balance for a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Reopen a deliverable

Reopen a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Reverse the opening balance for a deliverable

Reverse the opening balance for a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return all subscription lines of a deliverable

Return all subscription lines of a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the subscription line of a deliverable form

Return the subscription line of a deliverable form

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "deliverableSubscriptionLine": {
    }
}

Return the subscription line of a deliverable form

Return the subscription line of a deliverable form

path Parameters
deliverable_subscription_id
required
string
deliverable_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "deliverableSubscriptionLine": {
    }
}

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
optional
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

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasInvoicedBillingPeriods": true
}

Delete a subscription line of a deliverable

Delete a subscription line of a deliverable

path Parameters
deliverable_subscription_id
required
string
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Update or insert a subscription line of a delivera

Update or insert a subscription line of a deliverable

path Parameters
deliverable_subscription_id
required
string
deliverable_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "quantity": 0,
  • "amountPerTerm": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hasInvoicedBillingPeriods": true
}

Return a list of external issues for a deliverable

Return a list of external issues for a deliverable

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "issueTrackerBaseUrl": "string",
  • "issues": [
    ]
}

Insert an external issue for a deliverable

Insert an external issue for a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "externalProjectId": "string",
  • "issueType": "string",
  • "title": "string",
  • "description": "string",
  • "epicName": "string",
  • "activityId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "issueType": {
    },
  • "externalProject": {
    },
  • "epic": {
    },
  • "sprint": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "issueNumber": "string",
  • "storyPoints": 0,
  • "hours": 0,
  • "children": [
    ],
  • "hasMoreChildren": true,
  • "childrenCursor": 0
}

Return the external issue form

Return the external issue form

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "externalIssue": {
    },
  • "externalProjects": [
    ],
  • "calculatedActivities": [
    ]
}

Link an external issue to a deliverable

Link an external issue to a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
activityId
string or null <id>
issueId
string or null

Responses

Request samples

Content type
application/json
{
  • "activityId": "string",
  • "issueId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "issueType": {
    },
  • "externalProject": {
    },
  • "epic": {
    },
  • "sprint": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "issueNumber": "string",
  • "storyPoints": 0,
  • "hours": 0,
  • "children": [
    ],
  • "hasMoreChildren": true,
  • "childrenCursor": 0
}

UnLink an external issue from a deliverable

UnLink an external issue from a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
issueId
string or null

Responses

Request samples

Content type
application/json
{
  • "issueId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "issueType": {
    },
  • "externalProject": {
    },
  • "epic": {
    },
  • "sprint": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "issueNumber": "string",
  • "storyPoints": 0,
  • "hours": 0,
  • "children": [
    ],
  • "hasMoreChildren": true,
  • "childrenCursor": 0
}

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

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

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
optional
id
string or null <id>
canDelete
boolean or null
invoiceAmount
number or null
invoiceDate
string or null <date>
invoiceDesc
string or null
object
periodStartDate
string or null <date>
periodFinishDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "canDelete": true,
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": {
    },
  • "periodStartDate": "2019-08-24",
  • "periodFinishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

Delete an invoicing schedule

Delete an invoicing schedule

path Parameters
billing_period_id
required
string
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters
billing_period_id
required
string
deliverable_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
canDelete
boolean or null
invoiceAmount
number or null
invoiceDate
string or null <date>
invoiceDesc
string or null
object
periodStartDate
string or null <date>
periodFinishDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "canDelete": true,
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": {
    },
  • "periodStartDate": "2019-08-24",
  • "periodFinishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

Return a boolean that indicates if the task can ha

Return a boolean that indicates if the task can have a caps

path Parameters
deliverable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "isCalculationLimitEnabled": true
}

Change order of the tasks of a deliverable

Change order of the tasks of a deliverable

path Parameters
deliverable_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
taskIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "taskIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Get the form to create or update set of deliverabl

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

Responses

Response samples

Content type
application/json
{
  • "deliverablesToDuplicateSet": {
    },
  • "departmentOptions": [
    ],
  • "revenueTypeOptions": [
    ]
}

Create a set of deliverables to duplicate

Create a set of deliverables to duplicate

Request Body schema: application/json
optional
fromFinishDate
string or null <date>
toFinishDate
string or null <date>
revenueTypeIds
Array of strings or null <id> [ items <id > ]
departmentIds
Array of strings or null <id> [ items <id > ]
skipWhenNoNewPriceList
boolean or null

Responses

Request samples

Content type
application/json
{
  • "fromFinishDate": "2019-08-24",
  • "toFinishDate": "2019-08-24",
  • "revenueTypeIds": [
    ],
  • "departmentIds": [
    ],
  • "skipWhenNoNewPriceList": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "deliverableDuplicationItems": [
    ]
}

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
optional
selectionType
string or null
isSelected
boolean or null
deliverableId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "selectionType": "string",
  • "isSelected": true,
  • "deliverableId": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Duplicate set of deliverables

Duplicate set of deliverables

path Parameters
deliverables_to_duplicate_set_id
required
string
Request Body schema: application/json
optional
copyTasks
boolean or null
copyInvoiceSchedule
boolean or null
copySubscriptionLines
boolean or null
applySalesRatesFromPriceList
boolean or null

Responses

Request samples

Content type
application/json
{
  • "copyTasks": true,
  • "copyInvoiceSchedule": true,
  • "copySubscriptionLines": true,
  • "applySalesRatesFromPriceList": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

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

Response samples

Content type
application/json
{
  • "deliverablesToDuplicateSet": {
    },
  • "departmentOptions": [
    ],
  • "revenueTypeOptions": [
    ]
}

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

Response samples

Content type
application/json
{
  • "contributors": [
    ],
  • "openingBalanceHours": 0
}

Get the costs of a calculation-line

Get the costs of a calculation-line

path Parameters
calculation_line_id
required
string

Responses

Response samples

Content type
application/json
{
  • "calculationLine": {
    },
  • "costEntriesExpensesPerPerson": [
    ],
  • "costEntriesInvoicesPerSupplier": [
    ],
  • "openingBalanceAmount": 0
}

Insert or update a purchase order

Insert or update a purchase order

path Parameters
calculation_line_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "supplierId": "string",
  • "contactId": "string",
  • "purchaseOrderAmount": 0,
  • "desc": "string",
  • "orderDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "purchaseOrderNumber": 0,
  • "project": {
    },
  • "deliverable": {
    },
  • "cost": {
    },
  • "deliverableCalculationId": "string",
  • "supplier": {
    },
  • "contact": {
    },
  • "department": {
    },
  • "purchaseOrderAmount": 0,
  • "purchaseInvoiceAmount": 0,
  • "desc": "string"
}

Delete a purchase order

Delete a purchase order

path Parameters
calculation_line_id
required
string
purchase_order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Insert or update a purchase order

Insert or update a purchase order

path Parameters
calculation_line_id
required
string
purchase_order_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "supplierId": "string",
  • "contactId": "string",
  • "purchaseOrderAmount": 0,
  • "desc": "string",
  • "orderDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "purchaseOrderNumber": 0,
  • "project": {
    },
  • "deliverable": {
    },
  • "cost": {
    },
  • "deliverableCalculationId": "string",
  • "supplier": {
    },
  • "contact": {
    },
  • "department": {
    },
  • "purchaseOrderAmount": 0,
  • "purchaseInvoiceAmount": 0,
  • "desc": "string"
}

Return a purchase order

Return a purchase order

path Parameters
purchase_order_number
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "purchaseOrderNumber": 0,
  • "project": {
    },
  • "deliverable": {
    },
  • "cost": {
    },
  • "deliverableCalculationId": "string",
  • "supplier": {
    },
  • "contact": {
    },
  • "department": {
    },
  • "purchaseOrderAmount": 0,
  • "purchaseInvoiceAmount": 0,
  • "desc": "string"
}

Return the purchase order form

Return the purchase order form

path Parameters
calculation_line_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "purchaseOrderNumber": 0,
  • "deliverableCalculationId": "string",
  • "supplier": {
    },
  • "contactId": "string",
  • "contactOptions": [
    ],
  • "purchaseOrderAmount": 0,
  • "purchaseInvoiceAmount": 0,
  • "desc": "string",
  • "orderDate": "2019-08-24",
  • "canDelete": true
}

Return the purchase order form

Return the purchase order form

path Parameters
calculation_line_id
required
string
purchase_order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "purchaseOrderNumber": 0,
  • "deliverableCalculationId": "string",
  • "supplier": {
    },
  • "contactId": "string",
  • "contactOptions": [
    ],
  • "purchaseOrderAmount": 0,
  • "purchaseInvoiceAmount": 0,
  • "desc": "string",
  • "orderDate": "2019-08-24",
  • "canDelete": true
}

Insert a template for a deliverable

Insert a template for a deliverable

Request Body schema: application/json
optional
overwrite
boolean or null
deliverableId
string or null <id>
projectId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "overwrite": true,
  • "deliverableId": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "deliverable": {
    },
  • "project": {
    },
  • "currency": {
    },
  • "localCurrency": {
    },
  • "templates": [
    ],
  • "clientOptions": [
    ],
  • "departmentOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "invoiceMethodOptions": [
    ],
  • "revenueTypeOptions": [
    ],
  • "invoiceFrequencyOptions": [
    ],
  • "momentOfInvoicingOptions": [
    ],
  • "isDeletable": true,
  • "isTimesheetsToBeApprovedByClient": true,
  • "hasInvoicedBillingPeriods": true,
  • "hasCalculationActivities": true,
  • "shouldRecalculateSalesRates": true,
  • "isCalculationLimitEnabled": true,
  • "costCenterOptions": [
    ],
  • "defaultTimesheetApprovalContactIds": [
    ]
}

Delete a template for a deliverable

Delete a template for a deliverable

path Parameters
deliverable_template_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Planning

Form to update week planning

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

Authorizations:
ApiKeyAuth
path Parameters
planning_id
required
string
query Parameters
id
string <id>
name
string
resourceAllocationId
string <id>
absenceTypeId
string <id>
year
integer
Default: 0
weekNr
integer
Default: 0
resourceId
string <id>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "resourcePlanningWeek": {
    },
  • "year": 0,
  • "week": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "context": {
    }
}

Update week planning

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

Authorizations:
ApiKeyAuth
path Parameters
planning_id
required
string
Request Body schema: application/json
optional
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 (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

Content type
application/json
{
  • "projectId": "string",
  • "deliverableId": "string",
  • "calculatedActivityId": "string",
  • "resourceAllocationId": "string",
  • "absenceTypeId": "string",
  • "resourceId": "string",
  • "taskId": "string",
  • "days": [
    ],
  • "year": 0,
  • "weekNr": 0,
  • "obeyAbsenceTypePlanBehavior": true
}

Response samples

Content type
application/json
{
  • "days": [
    ],
  • "finishDate": "2019-08-24",
  • "isTimesheetEntry": true,
  • "timesheetId": "string",
  • "timeEntrySetId": "string",
  • "planningId": "string",
  • "plannedHours": 0,
  • "plannedOrActualHours": 0,
  • "startDate": "2019-08-24",
  • "status": "string",
  • "weekNr": 0,
  • "year": 0,
  • "notWorking": true,
  • "occupancyPercentage": 0,
  • "availableHours": 0,
  • "hasSoftBookings": true,
  • "hasOpportunityBookings": true
}

Form to update week planning

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

Authorizations:
ApiKeyAuth
query Parameters
id
string <id>
name
string
resourceAllocationId
string <id>
absenceTypeId
string <id>
year
integer
Default: 0
weekNr
integer
Default: 0
resourceId
string <id>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "resourcePlanningWeek": {
    },
  • "year": 0,
  • "week": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "context": {
    }
}

Update week planning

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

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
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 (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

Content type
application/json
{
  • "projectId": "string",
  • "deliverableId": "string",
  • "calculatedActivityId": "string",
  • "resourceAllocationId": "string",
  • "absenceTypeId": "string",
  • "resourceId": "string",
  • "taskId": "string",
  • "days": [
    ],
  • "year": 0,
  • "weekNr": 0,
  • "obeyAbsenceTypePlanBehavior": true
}

Response samples

Content type
application/json
{
  • "days": [
    ],
  • "finishDate": "2019-08-24",
  • "isTimesheetEntry": true,
  • "timesheetId": "string",
  • "timeEntrySetId": "string",
  • "planningId": "string",
  • "plannedHours": 0,
  • "plannedOrActualHours": 0,
  • "startDate": "2019-08-24",
  • "status": "string",
  • "weekNr": 0,
  • "year": 0,
  • "notWorking": true,
  • "occupancyPercentage": 0,
  • "availableHours": 0,
  • "hasSoftBookings": true,
  • "hasOpportunityBookings": true
}

Projects

Return a list of projects

Return a list of projects

Authorizations:
ApiKeyAuth
query Parameters
modifiedAfter
string <date-time>
organizationId
string <id>
cursor
string <cursor>
maxResults
integer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "more": true
}

Add an existing board to a project

Add an existing board to a project

Request Body schema: application/json
optional
name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lists": [
    ],
  • "members": [
    ],
  • "backgroundImage": "string",
  • "url": "string"
}

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
optional
startDate
string or null <date>
finishDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "project": {
    },
  • "deliverable": {
    },
  • "approvers": [
    ],
  • "timeEntrySets": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "verified": true,
  • "currentUser": {
    },
  • "customerLogo": "string",
  • "customerColor": "string",
  • "useWorkingHoursCheck": true
}

Close a project

Close a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

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

Response samples

Content type
application/json
{
  • "deliverable": {
    },
  • "reasons": [
    ]
}

Return a project form

Return a project form

path Parameters
project_id
required
string
Request Body schema: application/json
optional
organizationId
string or null <id>
opportunityId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "organizationId": "string",
  • "opportunityId": "string"
}

Response samples

Content type
application/json
{
  • "project": {
    },
  • "context": {
    },
  • "OpportunityFormConfiguration": {
    },
  • "clientOptions": [
    ],
  • "currencyOptions": [
    ],
  • "departmentOptions": [
    ],
  • "projectStatusOptions": [
    ],
  • "paymentConditionOptions": [
    ],
  • "revenueTypeOptions": [
    ],
  • "priceListOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "projectTemplates": [
    ],
  • "isDeletable": true
}

Return the project team form

Return the project team form

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "roleOptions": [
    ],
  • "projectMemberOptions": [
    ],
  • "projectTeamMembers": [
    ]
}

Insert or update a project member

Insert or update a project member

path Parameters
project_id
required
string
Request Body schema: application/json
optional
roleId
string or null
personId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "roleId": "string",
  • "personId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "organizationName": "string",
  • "folderId": "string",
  • "nrOfDeliverables": null,
  • "isClosed": true,
  • "desc": "string",
  • "projectNumber": 0,
  • "permalink": "string",
  • "stateIndicator": 0,
  • "startDate": "string",
  • "finishDate": "string",
  • "hasAlternativeInvoiceAddress": true,
  • "client": {
    },
  • "localCurrency": {
    },
  • "currency": {
    },
  • "canReschedule": true,
  • "customer": {
    },
  • "deliverables": [
    ],
  • "department": {
    },
  • "discountDescription": "string",
  • "discountPercentage": 0,
  • "evaluationFormId": "string",
  • "googleCalendarId": "string",
  • "evaluationsDisabled": true,
  • "useInvoicingScheduleOnProjectLevel": true,
  • "revenueType": {
    },
  • "gAccountPercentage": 0,
  • "lastModifiedAt": "string",
  • "lastActionDatetime": "string",
  • "lockTextConfirmation": "string",
  • "calculated": {
    },
  • "actual": {
    },
  • "forecast": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfOpportunities": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfInvoices": 0,
  • "nrOfDueInvoices": 0,
  • "opportunityPending": true,
  • "opportunity": {
    },
  • "orderDate": "string",
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "preambleConfirmation": "string",
  • "progressionMethodFixedPrice": {
    },
  • "projectMembers": [
    ],
  • "projectStatus": {
    },
  • "surchargeDescription": "string",
  • "surchargePercentage": 0,
  • "target": "string",
  • "useCompletionIndicator": true,
  • "schedulePercentage": 0,
  • "completePercentage": 0,
  • "budgetPercentage": 0,
  • "invoiceNotes": "string",
  • "tags": [
    ],
  • "isProjectBudgetBasedOnAllocations": true
}

Delete a project member

Delete a project member

path Parameters
member_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "organizationName": "string",
  • "folderId": "string",
  • "nrOfDeliverables": null,
  • "isClosed": true,
  • "desc": "string",
  • "projectNumber": 0,
  • "permalink": "string",
  • "stateIndicator": 0,
  • "startDate": "string",
  • "finishDate": "string",
  • "hasAlternativeInvoiceAddress": true,
  • "client": {
    },
  • "localCurrency": {
    },
  • "currency": {
    },
  • "canReschedule": true,
  • "customer": {
    },
  • "deliverables": [
    ],
  • "department": {
    },
  • "discountDescription": "string",
  • "discountPercentage": 0,
  • "evaluationFormId": "string",
  • "googleCalendarId": "string",
  • "evaluationsDisabled": true,
  • "useInvoicingScheduleOnProjectLevel": true,
  • "revenueType": {
    },
  • "gAccountPercentage": 0,
  • "lastModifiedAt": "string",
  • "lastActionDatetime": "string",
  • "lockTextConfirmation": "string",
  • "calculated": {
    },
  • "actual": {
    },
  • "forecast": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfOpportunities": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfInvoices": 0,
  • "nrOfDueInvoices": 0,
  • "opportunityPending": true,
  • "opportunity": {
    },
  • "orderDate": "string",
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "preambleConfirmation": "string",
  • "progressionMethodFixedPrice": {
    },
  • "projectMembers": [
    ],
  • "projectStatus": {
    },
  • "surchargeDescription": "string",
  • "surchargePercentage": 0,
  • "target": "string",
  • "useCompletionIndicator": true,
  • "schedulePercentage": 0,
  • "completePercentage": 0,
  • "budgetPercentage": 0,
  • "invoiceNotes": "string",
  • "tags": [
    ],
  • "isProjectBudgetBasedOnAllocations": true
}

Insert or update a project member

Insert or update a project member

path Parameters
member_id
required
string
project_id
required
string
Request Body schema: application/json
optional
roleId
string or null
personId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "roleId": "string",
  • "personId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "organizationName": "string",
  • "folderId": "string",
  • "nrOfDeliverables": null,
  • "isClosed": true,
  • "desc": "string",
  • "projectNumber": 0,
  • "permalink": "string",
  • "stateIndicator": 0,
  • "startDate": "string",
  • "finishDate": "string",
  • "hasAlternativeInvoiceAddress": true,
  • "client": {
    },
  • "localCurrency": {
    },
  • "currency": {
    },
  • "canReschedule": true,
  • "customer": {
    },
  • "deliverables": [
    ],
  • "department": {
    },
  • "discountDescription": "string",
  • "discountPercentage": 0,
  • "evaluationFormId": "string",
  • "googleCalendarId": "string",
  • "evaluationsDisabled": true,
  • "useInvoicingScheduleOnProjectLevel": true,
  • "revenueType": {
    },
  • "gAccountPercentage": 0,
  • "lastModifiedAt": "string",
  • "lastActionDatetime": "string",
  • "lockTextConfirmation": "string",
  • "calculated": {
    },
  • "actual": {
    },
  • "forecast": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfOpportunities": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfInvoices": 0,
  • "nrOfDueInvoices": 0,
  • "opportunityPending": true,
  • "opportunity": {
    },
  • "orderDate": "string",
  • "paymentCondition": {
    },
  • "poNumber": "string",
  • "preambleConfirmation": "string",
  • "progressionMethodFixedPrice": {
    },
  • "projectMembers": [
    ],
  • "projectStatus": {
    },
  • "surchargeDescription": "string",
  • "surchargePercentage": 0,
  • "target": "string",
  • "useCompletionIndicator": true,
  • "schedulePercentage": 0,
  • "completePercentage": 0,
  • "budgetPercentage": 0,
  • "invoiceNotes": "string",
  • "tags": [
    ],
  • "isProjectBudgetBasedOnAllocations": true
}

Reopen a project

Reopen a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Delete a project

Delete a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a project

Return a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "project": {
    }
}

Insert or update a project

Insert or update a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
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
isNoAllocationRequired
boolean
projectTemplateId
string <id>
Array of objects (TemplateDeliverableWrite)

Responses

Request samples

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": [
    ],
  • "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": [
    ],
  • "invoiceName": "string",
  • "invoiceZipCode": "string",
  • "invoiceNotes": "string",
  • "isNoAllocationRequired": true,
  • "projectTemplateId": "string",
  • "templateDeliverables": [
    ]
}

Response samples

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": [
    ],
  • "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": [
    ],
  • "invoiceName": "string",
  • "invoiceZipCode": "string",
  • "invoiceNotes": "string",
  • "hasAllocatedResources": true,
  • "isNoAllocationRequired": true,
  • "projectTemplateId": "string",
  • "templateDeliverables": [
    ]
}

Return the detailed margin of a project

Return the detailed margin of a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "calculated": {
    },
  • "actual": {
    },
  • "forecast": {
    }
}

Return a list of milestones

Return a list of milestones

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a milestone

Delete a milestone

path Parameters
milestone_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update or insert a milestone

Update or insert a milestone

path Parameters
milestone_id
required
string
project_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "date": "2019-08-24",
  • "custom": true,
  • "done": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "date": "2019-08-24",
  • "custom": true,
  • "done": true
}

Toggle done of a milestone

Toggle done of a milestone

Authorizations:
ApiKeyAuth
path Parameters
milestone_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "responseMessage": "string",
  • "item": {
    }
}

Ignore a milestone

Ignore a milestone

Authorizations:
ApiKeyAuth
path Parameters
milestone_id
required
string
project_id
required
string
Request Body schema: application/json
optional
string <id>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Update or insert a milestone

Update or insert a milestone

path Parameters
project_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "date": "2019-08-24",
  • "custom": true,
  • "done": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "date": "2019-08-24",
  • "custom": true,
  • "done": true
}

Return the invoicing schedules of a project

Return the invoicing schedules of a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

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
optional
id
string or null <id>
canDelete
boolean or null
invoiceAmount
number or null
invoiceDate
string or null <date>
invoiceDesc
string or null
object
periodStartDate
string or null <date>
periodFinishDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "canDelete": true,
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": {
    },
  • "periodStartDate": "2019-08-24",
  • "periodFinishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

Delete an invoicing schedule

Delete an invoicing schedule

path Parameters
billing_period_id
required
string
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

Insert or update an invoicing schedule for a deliv

Insert or update an invoicing schedule for a deliverable

path Parameters
billing_period_id
required
string
project_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
canDelete
boolean or null
invoiceAmount
number or null
invoiceDate
string or null <date>
invoiceDesc
string or null
object
periodStartDate
string or null <date>
periodFinishDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "canDelete": true,
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": {
    },
  • "periodStartDate": "2019-08-24",
  • "periodFinishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "fixedPriceOtherCurrency": 0,
  • "remainingInvoiceAmount": 0
}

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
optional
timesheetId
string or null

Responses

Request samples

Content type
application/json
{
  • "timesheetId": "string"
}

Response samples

Content type
application/json
{
  • "availableWorkingHours": 0
}

Return a list of invoices for a project

Return a list of invoices for a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
filter
string or null

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "totalInvoicedAmount": 0,
  • "totalOutstandingAmount": 0,
  • "averageDaysOutstanding": 0,
  • "averageDaysPastDueDate": 0,
  • "currency": {
    },
  • "invoices": [
    ]
}

Commit the opening balance for a project

Commit the opening balance for a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Return the opening balance for a project

Return the opening balance for a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "billingPeriods": [
    ],
  • "invoiceMethod": {
    },
  • "project": {
    },
  • "currency": {
    }
}

Reverse the opening balance for a project

Reverse the opening balance for a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a project form

Return a project form

Request Body schema: application/json
optional
organizationId
string or null <id>
opportunityId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "organizationId": "string",
  • "opportunityId": "string"
}

Response samples

Content type
application/json
{
  • "project": {
    },
  • "context": {
    },
  • "OpportunityFormConfiguration": {
    },
  • "clientOptions": [
    ],
  • "currencyOptions": [
    ],
  • "departmentOptions": [
    ],
  • "projectStatusOptions": [
    ],
  • "paymentConditionOptions": [
    ],
  • "revenueTypeOptions": [
    ],
  • "priceListOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "projectTemplates": [
    ],
  • "isDeletable": true
}

Insert or update a project

Insert or update a project

Request Body schema: application/json
optional
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
isNoAllocationRequired
boolean
projectTemplateId
string <id>
Array of objects (TemplateDeliverableWrite)

Responses

Request samples

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": [
    ],
  • "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": [
    ],
  • "invoiceName": "string",
  • "invoiceZipCode": "string",
  • "invoiceNotes": "string",
  • "isNoAllocationRequired": true,
  • "projectTemplateId": "string",
  • "templateDeliverables": [
    ]
}

Response samples

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": [
    ],
  • "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": [
    ],
  • "invoiceName": "string",
  • "invoiceZipCode": "string",
  • "invoiceNotes": "string",
  • "hasAllocatedResources": true,
  • "isNoAllocationRequired": true,
  • "projectTemplateId": "string",
  • "templateDeliverables": [
    ]
}

Return an external board connected to a project

Return an external board connected to a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lists": [
    ],
  • "members": [
    ],
  • "backgroundImage": "string",
  • "url": "string"
}

Link an external board to a project

Link an external board to a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
boardId
string or null

Responses

Request samples

Content type
application/json
{
  • "boardId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lists": [
    ],
  • "members": [
    ],
  • "backgroundImage": "string",
  • "url": "string"
}

UnLink an external board from a project

UnLink an external board from a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
boardId
string or null

Responses

Request samples

Content type
application/json
{
  • "boardId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lists": [
    ],
  • "members": [
    ],
  • "backgroundImage": "string",
  • "url": "string"
}

Add an existing board to a project

Add an existing board to a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
name
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lists": [
    ],
  • "members": [
    ],
  • "backgroundImage": "string",
  • "url": "string"
}

Mark a billing period as invoiced

Mark a billing period as invoiced

path Parameters
billing_period_id
required
string
Request Body schema: application/json
optional
id
string <id>
billingPeriodId
string <id>
invoiceAmount
number
invoiceDate
string <date>
invoiceDesc
string
status
string
object (Options)
canDelete
boolean
openingBalance
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "billingPeriodId": "string",
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": "string",
  • "statusOption": {
    },
  • "canDelete": true,
  • "openingBalance": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "billingPeriodId": "string",
  • "invoiceAmount": 0,
  • "invoiceDate": "2019-08-24",
  • "invoiceDesc": "string",
  • "status": "string",
  • "statusOption": {
    },
  • "canDelete": true,
  • "openingBalance": true
}

Insert a template for a project

Insert a template for a project

Request Body schema: application/json
optional
overwrite
boolean or null
projectId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "overwrite": true,
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Delete a template for a project

Delete a template for a project

path Parameters
project_template_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Project planning

Get planning for projects

Get planning for projects

Request Body schema: application/json
optional
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> [ items <id > ]
tagIds
Array of strings or null <id> [ items <id > ]
statusIds
Array of strings or null <id> [ items <id > ]
projectManagerIds
Array of strings or null <id> [ items <id > ]
myProjects
boolean or null
order
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "order": "string",
  • "more": true,
  • "pageSize": 1,
  • "projects": [
    ],
  • "type": "days",
  • "cursor": "string"
}

Return the project planning filters

Return the project planning filters

Responses

Response samples

Content type
application/json
{
  • "projectManagers": [
    ],
  • "departments": [
    ],
  • "statuses": [
    ],
  • "tagOptions": [
    ]
}

Get planning for deliverables of a project

Get planning for deliverables of a project

path Parameters
project_id
required
string
Request Body schema: application/json
optional
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

Content type
application/json
{
  • "year": 0,
  • "weekNr": 0,
  • "groupSize": 1,
  • "type": "days",
  • "planningOnly": true,
  • "timeOffOnly": true,
  • "showOpportunityBookings": true
}

Response samples

Content type
application/json
{
  • "deliverables": [
    ]
}

Get planning for tasks of a project

Get planning for tasks of a project

path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ]
}

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
optional
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

Content type
application/json
{
  • "year": 0,
  • "weekNr": 0,
  • "groupSize": 1,
  • "type": "days",
  • "planningOnly": true,
  • "timeOffOnly": true,
  • "showOpportunityBookings": true
}

Response samples

Content type
application/json
{
  • "calculatedActivitiesPlanningAndTasks": [
    ]
}

Resource planning

Return the resource planning filters

Return the resource planning filters

Responses

Response samples

Content type
application/json
{
  • "resourceTypeList": [
    ],
  • "activityList": [
    ],
  • "companyWithDepartmentsList": [
    ],
  • "seniorityList": [
    ],
  • "skillList": [
    ],
  • "skillAndSkillLevelList": [
    ],
  • "tagList": [
    ]
}

Project invoices

Approve a draft invoice by the draft number

Approve a draft invoice by the draft number

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
id
string or null <id>
draftNumber
integer or null
invoiceDate
string or null <date>

The invoice date should not be more than 365 days in the future or past.

customInvoiceNumber
string or null

A custom invoice number. This can be any alphanumeric string.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "draftNumber": 0,
  • "invoiceDate": "2019-08-24",
  • "customInvoiceNumber": "string"
}

Response samples

Content type
application/json
{ }

Return a list of draft invoices with draft invoice

Return a list of draft invoices with draft invoice lines

Authorizations:
ApiKeyAuth
query Parameters
modifiedAfter
string <date-time>
companyCode
string
cursor
string <cursor>
maxResults
integer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "more": true
}

Accounts payables

Pay an Account Payable

Pay an Account Payable

path Parameters
account_payable_id
required
string
Request Body schema: application/json
optional
amount
number or null
rate
number or null

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "rate": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "outstandingBalance": 0,
  • "amountOtherCurrency": 0,
  • "outstandingBalanceOtherCurrency": 0,
  • "currency": "string",
  • "otherCurrency": true,
  • "department": "string",
  • "type": "string",
  • "supplierName": "string",
  • "creditorInvoiceNumber": "string",
  • "personName": "string",
  • "expensesDesc": "string",
  • "entityKind": null
}

Return form for accounts payable

Return form for accounts payable

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Return form for accounts payable

Return form for accounts payable

path Parameters
account_payable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Return all accounts payable

Return all accounts payable

Responses

Response samples

Content type
application/json
{
  • "payables": [
    ]
}

Insert or update accounts payable and purchase inv

Insert or update accounts payable and purchase invoice

Request Body schema: application/json
optional
id
string or null <id>
amount
number or null
amountOtherCurrency
number or null
amountInPaymentSet
number or null
amountInPaymentSetOtherCurrency
number or null
object
creditor_invoice_number
string or null
object
currency_code
string or null
Array of objects (Currency)
Array of objects (MainEntityBase)
object
due_date
string or null <date>
ibanAndBicAvailable
boolean or null
invoice_date
string or null <date>
invoice_number
integer or null
note
string or null
outstandingBalanceOtherCurrency
number or null
outstanding_balance
number or null
selectableForPayment
boolean or null
object
object
type
string or null
Array of objects (AccountsPayableApprovers)
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Return all accounts payable

Return all accounts payable

path Parameters
account_payable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "payables": [
    ]
}

Insert or update accounts payable and purchase inv

Insert or update accounts payable and purchase invoice

path Parameters
account_payable_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
amount
number or null
amountOtherCurrency
number or null
amountInPaymentSet
number or null
amountInPaymentSetOtherCurrency
number or null
object
creditor_invoice_number
string or null
object
currency_code
string or null
Array of objects (Currency)
Array of objects (MainEntityBase)
object
due_date
string or null <date>
ibanAndBicAvailable
boolean or null
invoice_date
string or null <date>
invoice_number
integer or null
note
string or null
outstandingBalanceOtherCurrency
number or null
outstanding_balance
number or null
selectableForPayment
boolean or null
object
object
type
string or null
Array of objects (AccountsPayableApprovers)
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "amountInPaymentSet": 0,
  • "amountInPaymentSetOtherCurrency": 0,
  • "creditor": {
    },
  • "creditor_invoice_number": "string",
  • "currency": {
    },
  • "currency_code": "string",
  • "currencyOptions": [
    ],
  • "department_options": [
    ],
  • "department": {
    },
  • "due_date": "2019-08-24",
  • "ibanAndBicAvailable": true,
  • "invoice_date": "2019-08-24",
  • "invoice_number": 0,
  • "note": "string",
  • "outstandingBalanceOtherCurrency": 0,
  • "outstanding_balance": 0,
  • "selectableForPayment": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "type": "string",
  • "approvers": [
    ],
  • "submitter": {
    }
}

Pay an Account Payable

Pay an Account Payable

path Parameters
account_receivable_id
required
string
Request Body schema: application/json
optional
amount
number or null
rate
number or null

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "rate": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerName": "string",
  • "invoiceNumber": "string",
  • "amount": 0,
  • "amountOtherCurrency": 0,
  • "outstandingBalance": 0,
  • "outstandingBalanceOtherCurrency": 0,
  • "currency": "string",
  • "otherCurrency": true,
  • "department": "string",
  • "entityKind": null
}

Accounts receivables

Send a reminder for an overdue account receivable

Send a reminder for an overdue account receivable

Authorizations:
ApiKeyAuth
path Parameters
account_receivable_id
required
string

Responses

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Purchase invoices

Insert or update a purchase invoice

Insert or update a purchase invoice

Request Body schema: application/json
optional
id
string or null <id>
invoice_number
integer or null
invoice_date
string or null <date>
due_date
string or null <date>
book_entry_number
integer or null
posting_date
string or null <date>
object
object
object
object
inclusiveAmountOtherCurrency
number or null
exclusiveAmountOtherCurrency
number or null
vatAmountOtherCurrency
number or null
secondVatAmountOtherCurrency
number or null
vat_distribute
boolean or null
object
object
object
different_periods
boolean or null
creditor_invoice_number
string or null
comment
string or null
object
Array of objects (DriveFile)
period_costs_distribution
integer or null
object
upload_folder_id
string or null
object
object
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "reject_person": {
    },
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "files": [
    ],
  • "period_costs_distribution": 0,
  • "vat_type": {
    },
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "department": {
    },
  • "currency": {
    }
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_options": [
    ],
  • "accounting_period_options": [
    ],
  • "accounting_year_costs_distribution_options": [
    ],
  • "accounting_period_costs_distribution_options": [
    ],
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "imported": true,
  • "status": {
    },
  • "status_options": [
    ],
  • "statusApproval": {
    },
  • "canDelete": true,
  • "reject_person": {
    },
  • "entries_invoice_distribution": [
    ],
  • "entries_vat_distribution": [
    ],
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "file": {
    },
  • "period_costs_distribution": 0,
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "vat_type": {
    },
  • "vat_type_options": [
    ],
  • "department": {
    },
  • "department_options": [
    ],
  • "currency": {
    },
  • "currencyOptions": [
    ]
}

Delete a purchase invoice

Delete a purchase invoice

path Parameters
purchase_invoice_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Insert or update a purchase invoice

Insert or update a purchase invoice

path Parameters
purchase_invoice_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
invoice_number
integer or null
invoice_date
string or null <date>
due_date
string or null <date>
book_entry_number
integer or null
posting_date
string or null <date>
object
object
object
object
inclusiveAmountOtherCurrency
number or null
exclusiveAmountOtherCurrency
number or null
vatAmountOtherCurrency
number or null
secondVatAmountOtherCurrency
number or null
vat_distribute
boolean or null
object
object
object
different_periods
boolean or null
creditor_invoice_number
string or null
comment
string or null
object
Array of objects (DriveFile)
period_costs_distribution
integer or null
object
upload_folder_id
string or null
object
object
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "status": {
    },
  • "status_approval": {
    },
  • "reject_person": {
    },
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "files": [
    ],
  • "period_costs_distribution": 0,
  • "vat_type": {
    },
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "department": {
    },
  • "currency": {
    }
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_options": [
    ],
  • "accounting_period_options": [
    ],
  • "accounting_year_costs_distribution_options": [
    ],
  • "accounting_period_costs_distribution_options": [
    ],
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "imported": true,
  • "status": {
    },
  • "status_options": [
    ],
  • "statusApproval": {
    },
  • "canDelete": true,
  • "reject_person": {
    },
  • "entries_invoice_distribution": [
    ],
  • "entries_vat_distribution": [
    ],
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "file": {
    },
  • "period_costs_distribution": 0,
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "vat_type": {
    },
  • "vat_type_options": [
    ],
  • "department": {
    },
  • "department_options": [
    ],
  • "currency": {
    },
  • "currencyOptions": [
    ]
}

Return a purchase invoice form

Return a purchase invoice form

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_options": [
    ],
  • "accounting_period_options": [
    ],
  • "accounting_year_costs_distribution_options": [
    ],
  • "accounting_period_costs_distribution_options": [
    ],
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "imported": true,
  • "status": {
    },
  • "status_options": [
    ],
  • "statusApproval": {
    },
  • "canDelete": true,
  • "reject_person": {
    },
  • "entries_invoice_distribution": [
    ],
  • "entries_vat_distribution": [
    ],
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "file": {
    },
  • "period_costs_distribution": 0,
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "vat_type": {
    },
  • "vat_type_options": [
    ],
  • "department": {
    },
  • "department_options": [
    ],
  • "currency": {
    },
  • "currencyOptions": [
    ]
}

Return a purchase invoice form

Return a purchase invoice form

path Parameters
purchase_invoice_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "book_entry_number": 0,
  • "posting_date": "2019-08-24",
  • "accounting_year": {
    },
  • "accounting_period": {
    },
  • "accounting_year_options": [
    ],
  • "accounting_period_options": [
    ],
  • "accounting_year_costs_distribution_options": [
    ],
  • "accounting_period_costs_distribution_options": [
    ],
  • "accounting_year_costs_distribution": {
    },
  • "accounting_period_costs_distribution": {
    },
  • "inclusiveAmountOtherCurrency": 0,
  • "exclusiveAmountOtherCurrency": 0,
  • "vatAmountOtherCurrency": 0,
  • "secondVatAmountOtherCurrency": 0,
  • "vat_distribute": true,
  • "imported": true,
  • "status": {
    },
  • "status_options": [
    ],
  • "statusApproval": {
    },
  • "canDelete": true,
  • "reject_person": {
    },
  • "entries_invoice_distribution": [
    ],
  • "entries_vat_distribution": [
    ],
  • "different_periods": true,
  • "creditor_invoice_number": "string",
  • "comment": "string",
  • "purchaseOrder": {
    },
  • "file": {
    },
  • "period_costs_distribution": 0,
  • "upload_folder_id": "string",
  • "supplier": {
    },
  • "vat_type": {
    },
  • "vat_type_options": [
    ],
  • "department": {
    },
  • "department_options": [
    ],
  • "currency": {
    },
  • "currencyOptions": [
    ]
}

Return a list of purchase invoices

Return a list of purchase invoices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for a purchase invoice

Search for a purchase invoice

Request Body schema: application/json
optional
supplierId
string or null <id>
creditorInvoiceNumber
string or null

Responses

Request samples

Content type
application/json
{
  • "supplierId": "string",
  • "creditorInvoiceNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Financial transactions

Return a list of financial transactions

Return a list of financial transactions

Authorizations:
ApiKeyAuth
query Parameters
modifiedAfter
string <date-time>
onlyRevenueLedgerAccounts
boolean
year
integer
period
integer
cursor
string <cursor>
maxResults
integer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "more": true
}

Opportunities

Delete an opportunity

Delete an opportunity

Authorizations:
ApiKeyAuth
path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return an opportunity

Return an opportunity

Authorizations:
ApiKeyAuth
path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "opportunity": {
    },
  • "config": {
    },
  • "stageOptions": {
    }
}

Update or insert an opportunity

Update or insert an opportunity

Authorizations:
ApiKeyAuth
path Parameters
opportunity_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
organizationId
string <id>
contactId
string <id>
accountManagerId
string <id>
sourceId
string or null <id>
typeId
string or null <id>
pipelineId
string <id>
stageId
string <id>
templateProjectId
string or null <id>
departmentId
string <id>
salesProbability
integer
revenue
number
recurringRevenue
number or null
opportunityCurrencyId
string <id>
date
string <date>
expectedOrderDate
string <date>
startDate
string or null <date>
completionDate
string or null <date>
revenueTypeId
string <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "organizationId": "string",
  • "contactId": "string",
  • "accountManagerId": "string",
  • "sourceId": "string",
  • "typeId": "string",
  • "pipelineId": "string",
  • "stageId": "string",
  • "templateProjectId": "string",
  • "departmentId": "string",
  • "salesProbability": 0,
  • "revenue": 0,
  • "recurringRevenue": 0,
  • "opportunityCurrencyId": "string",
  • "date": "2019-08-24",
  • "expectedOrderDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "completionDate": "2019-08-24",
  • "revenueTypeId": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Update or insert an opportunity

Update or insert an opportunity

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
organizationId
string <id>
contactId
string <id>
accountManagerId
string <id>
sourceId
string or null <id>
typeId
string or null <id>
pipelineId
string <id>
stageId
string <id>
templateProjectId
string or null <id>
departmentId
string <id>
salesProbability
integer
revenue
number
recurringRevenue
number or null
opportunityCurrencyId
string <id>
date
string <date>
expectedOrderDate
string <date>
startDate
string or null <date>
completionDate
string or null <date>
revenueTypeId
string <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "organizationId": "string",
  • "contactId": "string",
  • "accountManagerId": "string",
  • "sourceId": "string",
  • "typeId": "string",
  • "pipelineId": "string",
  • "stageId": "string",
  • "templateProjectId": "string",
  • "departmentId": "string",
  • "salesProbability": 0,
  • "revenue": 0,
  • "recurringRevenue": 0,
  • "opportunityCurrencyId": "string",
  • "date": "2019-08-24",
  • "expectedOrderDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "completionDate": "2019-08-24",
  • "revenueTypeId": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Get an opportunity bookings form

Get an opportunity bookings form

path Parameters
opportunity_id
required
string
opportunity_bookings_id
required
string

Responses

Response samples

Content type
application/json
{
  • "activityOptions": {
    },
  • "seniorityOptions": {
    },
  • "skillsAndSkillLevels": {
    },
  • "skills": {
    },
  • "opportunityBookings": {
    },
  • "companyWithDepartments": {
    }
}

Get an opportunity bookings form

Get an opportunity bookings form

path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "activityOptions": {
    },
  • "seniorityOptions": {
    },
  • "skillsAndSkillLevels": {
    },
  • "skills": {
    },
  • "opportunityBookings": {
    },
  • "companyWithDepartments": {
    }
}

Get a list of opportunity bookings

Get a list of opportunity bookings

path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    }
}

Save opportunity bookings

Save opportunity bookings

path Parameters
opportunity_id
required
string
Request Body schema: application/json
optional
activityId
string or null <id>
seniorityIds
Array of strings or null <id> [ items <id > ]
skillsAndSkillLevelIds
Array of strings or null
skillIds
Array of strings or null <id> [ items <id > ]
resourceIds
Array of strings or null <id> [ items <id > ]
totalFte
number or null

Responses

Request samples

Content type
application/json
{
  • "activityId": "string",
  • "seniorityIds": [
    ],
  • "skillsAndSkillLevelIds": [
    ],
  • "skillIds": [
    ],
  • "resourceIds": [
    ],
  • "totalFte": 0
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    }
}

Delete opportunity bookings

Delete opportunity bookings

path Parameters
opportunity_id
required
string
opportunity_bookings_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Save opportunity bookings

Save opportunity bookings

path Parameters
opportunity_id
required
string
opportunity_bookings_id
required
string
Request Body schema: application/json
optional
activityId
string or null <id>
seniorityIds
Array of strings or null <id> [ items <id > ]
skillsAndSkillLevelIds
Array of strings or null
skillIds
Array of strings or null <id> [ items <id > ]
resourceIds
Array of strings or null <id> [ items <id > ]
totalFte
number or null

Responses

Request samples

Content type
application/json
{
  • "activityId": "string",
  • "seniorityIds": [
    ],
  • "skillsAndSkillLevelIds": [
    ],
  • "skillIds": [
    ],
  • "resourceIds": [
    ],
  • "totalFte": 0
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    }
}

Return an opportunity based on an external_id

Return an opportunity based on an external_id

path Parameters
external_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "opportunity": {
    },
  • "config": {
    },
  • "stageOptions": {
    }
}

Return an opportunity team form

Return an opportunity team form

path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "opportunity": {
    },
  • "employeeOptions": [
    ]
}

Update an opportunity team

Update an opportunity team

path Parameters
opportunity_id
required
string
Request Body schema: application/json
optional
teamIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "teamIds": [
    ]
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Return an opportunity form

Return an opportunity form

path Parameters
opportunity_id
required
string
Request Body schema: application/json
optional
organizationId
string or null <id>
personId
string or null <id>
templateProjectId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "organizationId": "string",
  • "personId": "string",
  • "templateProjectId": "string"
}

Response samples

Content type
application/json
{
  • "opportunity": {
    },
  • "formConfiguration": {
    },
  • "sourceOptions": {
    },
  • "typeOptions": {
    },
  • "pipelineOptions": {
    },
  • "departmentOptions": {
    },
  • "accountManagerOptions": {
    },
  • "contactOptions": {
    },
  • "revenueTypeOptions": {
    },
  • "currencyOptions": {
    },
  • "preFilledOpportunity": {
    },
  • "opportunityCurrency": {
    },
  • "isImported": true,
  • "context": {
    }
}

Return an opportunity form

Return an opportunity form

Request Body schema: application/json
optional
organizationId
string or null <id>
personId
string or null <id>
templateProjectId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "organizationId": "string",
  • "personId": "string",
  • "templateProjectId": "string"
}

Response samples

Content type
application/json
{
  • "opportunity": {
    },
  • "formConfiguration": {
    },
  • "sourceOptions": {
    },
  • "typeOptions": {
    },
  • "pipelineOptions": {
    },
  • "departmentOptions": {
    },
  • "accountManagerOptions": {
    },
  • "contactOptions": {
    },
  • "revenueTypeOptions": {
    },
  • "currencyOptions": {
    },
  • "preFilledOpportunity": {
    },
  • "opportunityCurrency": {
    },
  • "isImported": true,
  • "context": {
    }
}

Return a list of opportunities

Return a list of opportunities

Request Body schema: application/json
optional
maxResults
integer or null
cursor
string or null
organizationId
string or null <id>
projectId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "maxResults": 0,
  • "cursor": "string",
  • "organizationId": "string",
  • "projectId": "string"
}

Response samples

Content type
application/json
{
  • "items": {
    },
  • "nextCursor": "string",
  • "more": true,
  • "startDate": "2019-08-24",
  • "completionDate": "2019-08-24"
}

Organizations

Return a list of organization contacts

Return a list of organization contacts

Authorizations:
ApiKeyAuth
path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert an organization contact

Insert an organization contact

Authorizations:
ApiKeyAuth
path Parameters
organization_id
required
string
Request Body schema: application/json
optional
personId
string <id>

Responses

Request samples

Content type
application/json
{
  • "personId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Delete an organization contact

Delete an organization contact

Authorizations:
ApiKeyAuth
path Parameters
contact_id
required
string
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Delete an organization

Delete an organization

Authorizations:
ApiKeyAuth
path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return an organization

Return an organization

Authorizations:
ApiKeyAuth
path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "organization": {
    }
}

Update or insert an organization

Update or insert an organization

Authorizations:
ApiKeyAuth
path Parameters
organization_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
email
string
website
string
avatar
string
countryCode
string
coverImage
string
phoneNumber
string
marketSegmentId
string <id>
sourceId
string <id>
companyId
string
accountManagerId
string <id>
languageId
string <id>
isCustomer
boolean
isSupplier
boolean
paymentConditionId
string <id>
vatNumber
string
vatTypeId
string <id>
useDailyRates
boolean
stripeCustomerId
string
billingCountryId
string
debtorNumber
integer
invoiceEmails
Array of strings
invoiceAttn
string
invoiceCountry
string
invoiceAddress
string
invoiceCity
string
invoiceAddressName
string
invoiceZipcode
string
levelOfDetailInvoiceLinesId
string
combinePdfs
boolean
invoiceNotes
string
isTimesheetsApprovedByClientDefault
boolean
priceListId
string or null <id>
placeId
string
streetName
string
streetNumber
string
city
string
country
string
postalCode
string
supplierNumber
string
iban
string
bic
string
uploadedAvatarFileName
string
uploadedCoverFileName
string
uploadFolderId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "email": "string",
  • "website": "string",
  • "avatar": "string",
  • "countryCode": "string",
  • "coverImage": "string",
  • "phoneNumber": "string",
  • "marketSegmentId": "string",
  • "sourceId": "string",
  • "companyId": "string",
  • "accountManagerId": "string",
  • "languageId": "string",
  • "isCustomer": true,
  • "isSupplier": true,
  • "paymentConditionId": "string",
  • "vatNumber": "string",
  • "vatTypeId": "string",
  • "useDailyRates": true,
  • "stripeCustomerId": "string",
  • "billingCountryId": "string",
  • "debtorNumber": 0,
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceAddress": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "levelOfDetailInvoiceLinesId": "string",
  • "combinePdfs": true,
  • "invoiceNotes": "string",
  • "isTimesheetsApprovedByClientDefault": true,
  • "priceListId": "string",
  • "placeId": "string",
  • "streetName": "string",
  • "streetNumber": "string",
  • "city": "string",
  • "country": "string",
  • "postalCode": "string",
  • "supplierNumber": "string",
  • "iban": "string",
  • "bic": "string",
  • "uploadedAvatarFileName": "string",
  • "uploadedCoverFileName": "string",
  • "uploadFolderId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Update or insert an organization

Update or insert an organization

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
id
string <id>
name
string
desc
string
email
string
website
string
avatar
string
countryCode
string
coverImage
string
phoneNumber
string
marketSegmentId
string <id>
sourceId
string <id>
companyId
string
accountManagerId
string <id>
languageId
string <id>
isCustomer
boolean
isSupplier
boolean
paymentConditionId
string <id>
vatNumber
string
vatTypeId
string <id>
useDailyRates
boolean
stripeCustomerId
string
billingCountryId
string
debtorNumber
integer
invoiceEmails
Array of strings
invoiceAttn
string
invoiceCountry
string
invoiceAddress
string
invoiceCity
string
invoiceAddressName
string
invoiceZipcode
string
levelOfDetailInvoiceLinesId
string
combinePdfs
boolean
invoiceNotes
string
isTimesheetsApprovedByClientDefault
boolean
priceListId
string or null <id>
placeId
string
streetName
string
streetNumber
string
city
string
country
string
postalCode
string
supplierNumber
string
iban
string
bic
string
uploadedAvatarFileName
string
uploadedCoverFileName
string
uploadFolderId
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "email": "string",
  • "website": "string",
  • "avatar": "string",
  • "countryCode": "string",
  • "coverImage": "string",
  • "phoneNumber": "string",
  • "marketSegmentId": "string",
  • "sourceId": "string",
  • "companyId": "string",
  • "accountManagerId": "string",
  • "languageId": "string",
  • "isCustomer": true,
  • "isSupplier": true,
  • "paymentConditionId": "string",
  • "vatNumber": "string",
  • "vatTypeId": "string",
  • "useDailyRates": true,
  • "stripeCustomerId": "string",
  • "billingCountryId": "string",
  • "debtorNumber": 0,
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceAddress": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "levelOfDetailInvoiceLinesId": "string",
  • "combinePdfs": true,
  • "invoiceNotes": "string",
  • "isTimesheetsApprovedByClientDefault": true,
  • "priceListId": "string",
  • "placeId": "string",
  • "streetName": "string",
  • "streetNumber": "string",
  • "city": "string",
  • "country": "string",
  • "postalCode": "string",
  • "supplierNumber": "string",
  • "iban": "string",
  • "bic": "string",
  • "uploadedAvatarFileName": "string",
  • "uploadedCoverFileName": "string",
  • "uploadFolderId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Insert or update a customer

When supplying a customerCode of an existing organization we perform an update instead of an insert.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
customerCode
required
string

Customer code

name
required
string

Customer name

paymentConditionId
string or null <id>

Payment condition

vatTypeId
string or null <id>

Sales tax code

invoiceAddress
required
string

Address

invoiceZipcode
required
string

Zip code

invoiceCity
required
string

City

country
required
string

Country

countryCode
required
string

Country flag

invoiceEmails
required
Array of strings

Invoicing emails

Responses

Request samples

Content type
application/json
{
  • "customerCode": "string",
  • "name": "string",
  • "paymentConditionId": "string",
  • "vatTypeId": "string",
  • "invoiceAddress": "string",
  • "invoiceZipcode": "string",
  • "invoiceCity": "string",
  • "country": "string",
  • "countryCode": "string",
  • "invoiceEmails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Return an organization form

Return an organization form

path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "accountManagerOptions": [
    ],
  • "languageOptions": [
    ],
  • "levelOfDetailInvoiceLinesOptions": [
    ],
  • "marketSegmentOptions": [
    ],
  • "paymentConditionOptions": [
    ],
  • "sourceOptions": [
    ],
  • "salesVatTypeOptions": [
    ],
  • "purchasesVatTypeOptions": [
    ],
  • "priceListOptions": [
    ],
  • "countryOptions": [
    ],
  • "context": {
    }
}

Return an organization team form

Return an organization team form

path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "personOptions": [
    ],
  • "roleOptions": [
    ]
}

Delete an organization team member

Delete an organization team member

path Parameters
team_member_id
required
string
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Insert or update an organization team member

Insert or update an organization team member

path Parameters
team_member_id
required
string
organization_id
required
string
Request Body schema: application/json
optional
personId
string or null <id>
roleId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "personId": "string",
  • "roleId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Insert or update an organization team member

Insert or update an organization team member

path Parameters
organization_id
required
string
Request Body schema: application/json
optional
personId
string or null <id>
roleId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "personId": "string",
  • "roleId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Delete an organization address

Delete an organization address

path Parameters
address_id
required
string
organization_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Insert or update an organization address

Insert or update an organization address

path Parameters
address_id
required
string
organization_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
line1
string or null
line2
string or null
line3
string or null
line4
string or null
line5
string or null
typeId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "line3": "string",
  • "line4": "string",
  • "line5": "string",
  • "typeId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Insert or update an organization address

Insert or update an organization address

path Parameters
organization_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
line1
string or null
line2
string or null
line3
string or null
line4
string or null
line5
string or null
typeId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "line3": "string",
  • "line4": "string",
  • "line5": "string",
  • "typeId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "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",
  • "accountManager": {
    },
  • "addressTypes": [
    ],
  • "addressInvoice": "string",
  • "addresses": [
    ],
  • "marketSegment": {
    },
  • "source": {
    },
  • "companyId": "string",
  • "contacts": [
    ],
  • "language": {
    },
  • "lastModifiedAt": "string",
  • "mailing": "string",
  • "invoiceEmails": [
    ],
  • "invoiceAttn": "string",
  • "invoiceCountry": "string",
  • "invoiceCity": "string",
  • "invoiceAddressName": "string",
  • "invoiceZipcode": "string",
  • "invoiceNotes": "string",
  • "team": [
    ],
  • "priceList": {
    },
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveProjects": 0,
  • "nrOfActiveOpportunities": 0,
  • "externalCRMService": {
    },
  • "tags": [
    ]
}

Return a list of entities of an organization

Return a list of entities of an organization

path Parameters
organization_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return an organization form

Return an organization form

Responses

Response samples

Content type
application/json
{
  • "organization": {
    },
  • "accountManagerOptions": [
    ],
  • "languageOptions": [
    ],
  • "levelOfDetailInvoiceLinesOptions": [
    ],
  • "marketSegmentOptions": [
    ],
  • "paymentConditionOptions": [
    ],
  • "sourceOptions": [
    ],
  • "salesVatTypeOptions": [
    ],
  • "purchasesVatTypeOptions": [
    ],
  • "priceListOptions": [
    ],
  • "countryOptions": [
    ],
  • "context": {
    }
}

Return a list of invoices for a customer

Return a list of invoices for a customer

path Parameters
customer_id
required
string
Request Body schema: application/json
optional
filter
string or null

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "totalInvoicedAmount": 0,
  • "totalOutstandingAmount": 0,
  • "averageDaysOutstanding": 0,
  • "averageDaysPastDueDate": 0,
  • "currency": {
    },
  • "invoices": [
    ]
}

Return a list of organizations to add the contact

Return a list of organizations to add the contact to

Request Body schema: application/json
optional
email
string or null

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/v3/customer/list

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Sends the request to the client containing the tim

Sends the request to the client containing the timesheets that need approval

path Parameters
project_id
required
string
Request Body schema: application/json
optional
Array of objects (SendRequestForClientApprovalTimesheetEntrySet)
startDate
string or null <date>
finishDate
string or null <date>
approverIds
Array of strings or null <id> [ items <id > ]
message
string or null

Responses

Request samples

Content type
application/json
{
  • "timeEntrySets": [
    ],
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "approverIds": [
    ],
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Persons

Insert or update a person

Insert or update a person

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
id
string <id>
name
string
firstName
string
lastName
string
email
string
salutation
string
jobTitle
string
jobRoleId
string or null <id>
address
string
city
string
postcode
string
country
string
isEmployee
boolean
uploadFolderId
string
uploadedAvatarFileName
string
uploadedCoverFileName
string
avatar
string
coverImage
string
Array of objects (ExtraEmail)
Array of objects (PhoneNumber)
sourceId
string or null <id>
leadStageId
string or null <id>
leadDescription
string
isLead
boolean
organizationId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "salutation": "string",
  • "jobTitle": "string",
  • "jobRoleId": "string",
  • "address": "string",
  • "city": "string",
  • "postcode": "string",
  • "country": "string",
  • "isEmployee": true,
  • "uploadFolderId": "string",
  • "uploadedAvatarFileName": "string",
  • "uploadedCoverFileName": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "extraEmails": [
    ],
  • "phoneNumbers": [
    ],
  • "sourceId": "string",
  • "leadStageId": "string",
  • "leadDescription": "string",
  • "isLead": true,
  • "organizationId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "jobTitle": "string",
  • "jobRole": {
    },
  • "source": {
    },
  • "leadStage": {
    },
  • "folderId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "address": "string",
  • "city": "string",
  • "postcode": "string",
  • "country": "string",
  • "isEmployee": true,
  • "isPlaceholder": true,
  • "isContact": true,
  • "isExternal": true,
  • "googlePlusId": "string",
  • "permalink": "string",
  • "lastPlannedDate": "2019-08-24",
  • "extraEmails": [
    ],
  • "phoneNumbers": [
    ],
  • "archived": true,
  • "activeDepartmentId": "string",
  • "countryCode": "string",
  • "isSupportUser": true,
  • "employeeCode": "string",
  • "organizations": [
    ],
  • "roles": [
    ],
  • "activeDepartment": {
    },
  • "lastModifiedAt": "string",
  • "salutation": "string",
  • "skillLevel": {
    },
  • "seniority": {
    },
  • "isLead": true,
  • "leadOpportunityIds": [
    ],
  • "leadDescription": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveOpportunities": 0,
  • "nrOfTotalOpportunities": 0,
  • "isAutoSubmitTimeEntriesActive": true,
  • "tags": [
    ]
}

Get a person

Get a person

Authorizations:
ApiKeyAuth
path Parameters
person_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "person": {
    }
}

Insert or update a person

Insert or update a person

Authorizations:
ApiKeyAuth
path Parameters
person_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
firstName
string
lastName
string
email
string
salutation
string
jobTitle
string
jobRoleId
string or null <id>
address
string
city
string
postcode
string
country
string
isEmployee
boolean
uploadFolderId
string
uploadedAvatarFileName
string
uploadedCoverFileName
string
avatar
string
coverImage
string
Array of objects (ExtraEmail)
Array of objects (PhoneNumber)
sourceId
string or null <id>
leadStageId
string or null <id>
leadDescription
string
isLead
boolean
organizationId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "salutation": "string",
  • "jobTitle": "string",
  • "jobRoleId": "string",
  • "address": "string",
  • "city": "string",
  • "postcode": "string",
  • "country": "string",
  • "isEmployee": true,
  • "uploadFolderId": "string",
  • "uploadedAvatarFileName": "string",
  • "uploadedCoverFileName": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "extraEmails": [
    ],
  • "phoneNumbers": [
    ],
  • "sourceId": "string",
  • "leadStageId": "string",
  • "leadDescription": "string",
  • "isLead": true,
  • "organizationId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "coverImage": "string",
  • "entityKind": "string",
  • "jobTitle": "string",
  • "jobRole": {
    },
  • "source": {
    },
  • "leadStage": {
    },
  • "folderId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "address": "string",
  • "city": "string",
  • "postcode": "string",
  • "country": "string",
  • "isEmployee": true,
  • "isPlaceholder": true,
  • "isContact": true,
  • "isExternal": true,
  • "googlePlusId": "string",
  • "permalink": "string",
  • "lastPlannedDate": "2019-08-24",
  • "extraEmails": [
    ],
  • "phoneNumbers": [
    ],
  • "archived": true,
  • "activeDepartmentId": "string",
  • "countryCode": "string",
  • "isSupportUser": true,
  • "employeeCode": "string",
  • "organizations": [
    ],
  • "roles": [
    ],
  • "activeDepartment": {
    },
  • "lastModifiedAt": "string",
  • "salutation": "string",
  • "skillLevel": {
    },
  • "seniority": {
    },
  • "isLead": true,
  • "leadOpportunityIds": [
    ],
  • "leadDescription": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "nrOfActiveOpportunities": 0,
  • "nrOfTotalOpportunities": 0,
  • "isAutoSubmitTimeEntriesActive": true,
  • "tags": [
    ]
}

Quotes

Submit a quote

Submit a quote

path Parameters
quote_id
required
string
opportunity_id
required
string
Request Body schema: application/json
optional
approverIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "approverIds": [
    ]
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Approve a quote by manager

Approve a quote by manager

path Parameters
quote_id
required
string
opportunity_id
required
string
Request Body schema: application/json
optional
eventPerSubscriptionId
string or null <id>
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "eventPerSubscriptionId": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Approve a quote

Approve a quote

path Parameters
quote_id
required
string
opportunity_id
required
string
Request Body schema: application/json
optional
eventPerSubscriptionId
string or null <id>
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "eventPerSubscriptionId": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Reject a quote

Reject a quote

path Parameters
quote_id
required
string
opportunity_id
required
string
Request Body schema: application/json
optional
eventPerSubscriptionId
string or null <id>
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "eventPerSubscriptionId": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Send a quote

Send a quote

path Parameters
quote_id
required
string
opportunity_id
required
string
Request Body schema: application/json
optional
eventPerSubscriptionId
string or null <id>
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "eventPerSubscriptionId": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Get a quote form

Get a quote form

path Parameters
quote_id
required
string
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "approverOptions": {
    },
  • "quote": {
    }
}

Delete a quote

Delete a quote

path Parameters
quote_id
required
string
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Get a quote

Get a quote

path Parameters
quote_id
required
string
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "approvers": {
    },
  • "canDelete": true,
  • "entityKind": null,
  • "editor": {
    },
  • "file": {
    },
  • "fileModified": "string",
  • "status": {
    }
}

Create a quote

Create a quote

path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
{
  • "opportunityBookings": {
    },
  • "grandTotalFtes": 0,
  • "context": {
    },
  • "id": "string",
  • "name": "string",
  • "age": 0,
  • "avatar": "string",
  • "coverImage": "string",
  • "completionDate": "string",
  • "expectedOrderDate": "string",
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "folderId": "string",
  • "hasProject": true,
  • "lastModifiedAt": "string",
  • "recurringRevenue": 0,
  • "recurringRevenueLocalCurrency": 0,
  • "revenue": 0,
  • "revenueLocalCurrency": 0,
  • "localCurrency": {
    },
  • "salesProbability": 0,
  • "startDate": "string",
  • "stateIndicator": 0,
  • "permalink": "string",
  • "nrOfConversations": 0,
  • "nrOfDoingTasks": 0,
  • "nrOfEmails": 0,
  • "nrOfNotes": 0,
  • "nrOfTasks": 0,
  • "nrOfTodoTasks": 0,
  • "nrOfFiles": 0,
  • "recurringRevenueWeighted": 0,
  • "recurringRevenueWeightedLocalCurrency": 0,
  • "revenueWeighted": 0,
  • "revenueWeightedLocalCurrency": 0,
  • "organization": {
    },
  • "project": {
    },
  • "team": [
    ],
  • "contact": {
    },
  • "accountManager": {
    },
  • "department": {
    },
  • "pipeline": {
    },
  • "stage": {
    },
  • "source": {
    },
  • "type": {
    },
  • "revenueType": {
    },
  • "externalCRMService": {
    },
  • "tags": {
    }
}

Get the quotes of an opportunity

Get the quotes of an opportunity

path Parameters
opportunity_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Timer

Start a new timer

Start a new timer

Request Body schema: application/json
optional
timesheetEntrySetId
string or null <id>
taskId
string or null <id>
calculationLineId
string or null <id>
issueId
string or null
issueKey
string or null

Responses

Request samples

Content type
application/json
{
  • "timesheetEntrySetId": "string",
  • "taskId": "string",
  • "calculationLineId": "string",
  • "issueId": "string",
  • "issueKey": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "employee": {
    },
  • "entityKind": "string",
  • "finishDate": "string",
  • "startDate": "string",
  • "week": 0,
  • "year": 0,
  • "status": {
    },
  • "totalHours": 0,
  • "permalink": "string",
  • "isOvertimeFullySpecified": true,
  • "hasOvertime": true,
  • "days": [
    ],
  • "activities": [
    ],
  • "isSubmitted": true,
  • "timesheetsLockedUntil": "string",
  • "useReferencePerDay": true
}

Timesheets

Return a list of timesheets

Return a list of timesheets

Authorizations:
ApiKeyAuth
query Parameters
cursor
string
maxResults
integer
personId
string <id>

Responses

Response samples

Content type
application/json
{
  • "timesheets": [
    ],
  • "nextCursor": "string",
  • "more": true
}

Return a timesheet

Return a timesheet

Authorizations:
ApiKeyAuth
path Parameters
timesheet_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "timesheet": {
    }
}

Submits a timesheet

Submits a timesheet

Authorizations:
ApiKeyAuth
path Parameters
timesheet_id
required
string
Request Body schema: application/json
optional
Array
id
string or null <id>
name
string or null
date
string or null <date>
hours
number or null
reference
string or null
isSubmitted
boolean or null
isPublicHoliday
boolean or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "employee": {
    },
  • "entityKind": "string",
  • "finishDate": "string",
  • "startDate": "string",
  • "week": 0,
  • "year": 0,
  • "status": {
    },
  • "totalHours": 0,
  • "permalink": "string",
  • "isOvertimeFullySpecified": true,
  • "hasOvertime": true,
  • "days": [
    ],
  • "activities": [
    ],
  • "isSubmitted": true,
  • "timesheetsLockedUntil": "string",
  • "useReferencePerDay": true
}

Return a list of time entries for an approval requ

Return a list of time entries for an approval request

Authorizations:
ApiKeyAuth
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "project": {
    },
  • "deliverable": {
    },
  • "approvers": [
    ],
  • "timeEntrySets": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "verified": true,
  • "currentUser": {
    },
  • "customerLogo": "string",
  • "customerColor": "string",
  • "useWorkingHoursCheck": true
}

Submit the timesheets of a month

Submit the timesheets of a month

Request Body schema: application/json
optional
year
integer or null
month
integer or null

Responses

Request samples

Content type
application/json
{
  • "year": 0,
  • "month": 0
}

Response samples

Content type
application/json
{
  • "year": 0,
  • "month": 0
}

Get list of overtime entries

Get list of overtime entries

path Parameters
timesheet_id
required
string
weekday
required
string

Responses

Response samples

Content type
application/json
{
  • "overtimeEntries": [
    ],
  • "overtimeCategoryOptions": [
    ]
}

Insert or update an overtime entry

Insert or update an overtime entry

path Parameters
timesheet_id
required
string
weekday
required
string
Request Body schema: application/json
optional
Array of objects (OvertimeEntry)

Responses

Request samples

Content type
application/json
{
  • "overtimeEntries": [
    ]
}

Response samples

Content type
application/json
{
  • "overtimeEntries": [
    ],
  • "overtimeCategoryOptions": [
    ]
}

Return a time-entry set form

Return a time-entry set form

path Parameters
set_id
required
string
timesheet_id
required
string
Request Body schema: application/json
optional
resourceAllocationId
string or null <id>
absenceTypeId
string or null <id>
issueId
string or null

Responses

Request samples

Content type
application/json
{
  • "resourceAllocationId": "string",
  • "absenceTypeId": "string",
  • "issueId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "timeEntrySet": {
    },
  • "absenceTypeOptions": [
    ],
  • "timesheetsLockedUntil": "2019-08-24",
  • "timesheetAllocatedHoursCheck": "string",
  • "totalHours": 0,
  • "workingHours": [
    ],
  • "availableWorkingHours": 0,
  • "hasCalculationLimit": true
}

Return a time-entry set form

Return a time-entry set form

path Parameters
timesheet_id
required
string
Request Body schema: application/json
optional
resourceAllocationId
string or null <id>
absenceTypeId
string or null <id>
issueId
string or null

Responses

Request samples

Content type
application/json
{
  • "resourceAllocationId": "string",
  • "absenceTypeId": "string",
  • "issueId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "timeEntrySet": {
    },
  • "absenceTypeOptions": [
    ],
  • "timesheetsLockedUntil": "2019-08-24",
  • "timesheetAllocatedHoursCheck": "string",
  • "totalHours": 0,
  • "workingHours": [
    ],
  • "availableWorkingHours": 0,
  • "hasCalculationLimit": true
}

Return a time-entry set based on a year, week, emp

Return a time-entry set based on a year, week, employee and calculation

Request Body schema: application/json
optional
week
integer or null
year
integer or null
employeeId
string or null <id>
calculationLineId
string or null <id>
issueId
string or null

Responses

Request samples

Content type
application/json
{
  • "week": 0,
  • "year": 0,
  • "employeeId": "string",
  • "calculationLineId": "string",
  • "issueId": "string"
}

Response samples

Content type
application/json
{
  • "timesheetEntrySetId": "string",
  • "timesheetId": "string"
}

Reject a set of timesheet entries

Reject a set of timesheet entries

Authorizations:
ApiKeyAuth
path Parameters
timesheet_submit_set_id
required
string
Request Body schema: application/json
optional
string <id>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Approve a set of overtime entries

Approve a set of overtime entries

Authorizations:
ApiKeyAuth
path Parameters
timesheet_overtime_submit_set_id
required
string
Request Body schema: application/json
optional
string <id>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Reject a set of overtime entries

Reject a set of overtime entries

Authorizations:
ApiKeyAuth
path Parameters
timesheet_overtime_submit_set_id
required
string
Request Body schema: application/json
optional
string <id>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Approve a set of timesheet entries

Approve a set of timesheet entries

Authorizations:
ApiKeyAuth
path Parameters
timesheet_submit_set_id
required
string
Request Body schema: application/json
optional
string <id>

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Insert or update a time-entry set

Insert or update a time-entry set

path Parameters
set_id
required
string
Request Body schema: application/json
optional
setId
string or null
calculatedActivityId
string or null <id>
resourceAllocationId
string or null <id>
deliverableId
string or null <id>
projectId
string or null <id>
taskId
string or null <id>
absenceTypeId
string or null <id>
Array of objects (TimesheetEntryDaySchemaV3)
reference
string or null
personId
string or null <id>
timesheetId
string or null
useReferencePerDay
boolean or null
issueId
string or null
issueKey
string or null

Responses

Request samples

Content type
application/json
{
  • "setId": "string",
  • "calculatedActivityId": "string",
  • "resourceAllocationId": "string",
  • "deliverableId": "string",
  • "projectId": "string",
  • "taskId": "string",
  • "absenceTypeId": "string",
  • "days": [
    ],
  • "reference": "string",
  • "personId": "string",
  • "timesheetId": "string",
  • "useReferencePerDay": true,
  • "issueId": "string",
  • "issueKey": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "employee": {
    },
  • "entityKind": "string",
  • "finishDate": "string",
  • "startDate": "string",
  • "week": 0,
  • "year": 0,
  • "status": {
    },
  • "totalHours": 0,
  • "permalink": "string",
  • "isOvertimeFullySpecified": true,
  • "hasOvertime": true,
  • "days": [
    ],
  • "activities": [
    ],
  • "isSubmitted": true,
  • "timesheetsLockedUntil": "string",
  • "useReferencePerDay": true
}

Insert or update a time-entry set

Insert or update a time-entry set

Request Body schema: application/json
optional
setId
string or null
calculatedActivityId
string or null <id>
resourceAllocationId
string or null <id>
deliverableId
string or null <id>
projectId
string or null <id>
taskId
string or null <id>
absenceTypeId
string or null <id>
Array of objects (TimesheetEntryDaySchemaV3)
reference
string or null
personId
string or null <id>
timesheetId
string or null
useReferencePerDay
boolean or null
issueId
string or null
issueKey
string or null

Responses

Request samples

Content type
application/json
{
  • "setId": "string",
  • "calculatedActivityId": "string",
  • "resourceAllocationId": "string",
  • "deliverableId": "string",
  • "projectId": "string",
  • "taskId": "string",
  • "absenceTypeId": "string",
  • "days": [
    ],
  • "reference": "string",
  • "personId": "string",
  • "timesheetId": "string",
  • "useReferencePerDay": true,
  • "issueId": "string",
  • "issueKey": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "employee": {
    },
  • "entityKind": "string",
  • "finishDate": "string",
  • "startDate": "string",
  • "week": 0,
  • "year": 0,
  • "status": {
    },
  • "totalHours": 0,
  • "permalink": "string",
  • "isOvertimeFullySpecified": true,
  • "hasOvertime": true,
  • "days": [
    ],
  • "activities": [
    ],
  • "isSubmitted": true,
  • "timesheetsLockedUntil": "string",
  • "useReferencePerDay": true
}

Timesheet client approval requests

Retrieve a list of pending timesheet client approv

Retrieve a list of pending timesheet client approval requests

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single pending timesheet client approva

Retrieve a single pending timesheet client approval request

Authorizations:
ApiKeyAuth
path Parameters
pending_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "project": {
    },
  • "deliverable": {
    },
  • "approvers": [
    ],
  • "timeEntrySets": {
    },
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "verified": true,
  • "hours": 0,
  • "hoursToApprove": 0
}

Approve an entire approval request by the client

Approve an entire approval request by the client

Authorizations:
ApiKeyAuth
path Parameters
request_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Approve a set of timesheet entries from an approva

Approve a set of timesheet entries from an approval request by the client

Authorizations:
ApiKeyAuth
path Parameters
set_id
required
string
request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "setId": "string"
}

Approve a set of timesheet entries from an approva

Approve a set of timesheet entries from an approval request by the client

Authorizations:
ApiKeyAuth
path Parameters
set_id
required
string
request_id
required
string
Request Body schema: application/json
optional
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "setId": "string"
}

Custom fields

Get custom fields

Get custom fields

path Parameters
entity_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update custom fields

Update custom fields

path Parameters
entity_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
Array of objects (CustomField)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "customFields": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Return a list of employees

Return a list of employees

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an employee form

Get an employee form

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "departments": [
    ],
  • "rates": [
    ],
  • "workingHours": [
    ],
  • "billabilityPercentages": [
    ],
  • "skills": [
    ],
  • "leaveBudgets": [
    ],
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string",
  • "isSupportUser": true,
  • "isExternal": true,
  • "canChangeContractor": true,
  • "userTypeOptions": [
    ],
  • "roleOptions": [
    ],
  • "absenceApprovalOptions": [
    ],
  • "activityOptions": [
    ],
  • "absenceTypeOptions": [
    ],
  • "seniorityOptions": [
    ],
  • "managerOptions": [
    ],
  • "holidayCalendarOptions": [
    ],
  • "customFields": [
    ],
  • "overtimePolicyOptions": [
    ]
}

Get an employee form

Get an employee form

Authorizations:
ApiKeyAuth
path Parameters
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "departments": [
    ],
  • "rates": [
    ],
  • "workingHours": [
    ],
  • "billabilityPercentages": [
    ],
  • "skills": [
    ],
  • "leaveBudgets": [
    ],
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string",
  • "isSupportUser": true,
  • "isExternal": true,
  • "canChangeContractor": true,
  • "userTypeOptions": [
    ],
  • "roleOptions": [
    ],
  • "absenceApprovalOptions": [
    ],
  • "activityOptions": [
    ],
  • "absenceTypeOptions": [
    ],
  • "seniorityOptions": [
    ],
  • "managerOptions": [
    ],
  • "holidayCalendarOptions": [
    ],
  • "customFields": [
    ],
  • "overtimePolicyOptions": [
    ]
}

Update or insert an employee

Update or insert an employee

Request Body schema: application/json
optional
id
string <id>
name
string
iban
string
bic
string
userType
string
archived
boolean
roleIds
Array of strings
activeDepartmentId
string or null <id>
seniorityId
string or null <id>
holidayCalendarId
string or null <id>
activityIds
Array of strings or null <id> [ items <id > ]
absenceTypeIds
Array of strings or null <id> [ items <id > ]
absenceApprovalId
string
overtimePolicyId
string or null <id>
managerId
string or null <id>
firstName
string
lastName
string
email
string
googlePlusId
string or null
idProvider
string
lastLoginDate
string <date>
avatar
string or null
isPlaceholder
boolean
canInsertAndSubmitTimeFromOtherUsers
boolean
isAutoSubmitTimeEntriesActive
boolean
fillTimeEntriesFromPlanning
boolean
showFinancialProjectData
boolean
Array of objects (PhoneNumber)
hasPendingInvite
boolean
employeeCode
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "departments": [
    ],
  • "rates": [
    ],
  • "workingHours": [
    ],
  • "billabilityPercentages": [
    ],
  • "skills": [
    ],
  • "leaveBudgets": [
    ],
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string",
  • "isSupportUser": true,
  • "isExternal": true,
  • "canChangeContractor": true
}

Update or insert an employee

Update or insert an employee

path Parameters
employee_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
string
iban
string
bic
string
userType
string
archived
boolean
roleIds
Array of strings
activeDepartmentId
string or null <id>
seniorityId
string or null <id>
holidayCalendarId
string or null <id>
activityIds
Array of strings or null <id> [ items <id > ]
absenceTypeIds
Array of strings or null <id> [ items <id > ]
absenceApprovalId
string
overtimePolicyId
string or null <id>
managerId
string or null <id>
firstName
string
lastName
string
email
string
googlePlusId
string or null
idProvider
string
lastLoginDate
string <date>
avatar
string or null
isPlaceholder
boolean
canInsertAndSubmitTimeFromOtherUsers
boolean
isAutoSubmitTimeEntriesActive
boolean
fillTimeEntriesFromPlanning
boolean
showFinancialProjectData
boolean
Array of objects (PhoneNumber)
hasPendingInvite
boolean
employeeCode
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "departments": [
    ],
  • "rates": [
    ],
  • "workingHours": [
    ],
  • "billabilityPercentages": [
    ],
  • "skills": [
    ],
  • "leaveBudgets": [
    ],
  • "iban": "string",
  • "bic": "string",
  • "userType": "string",
  • "archived": true,
  • "roleIds": [
    ],
  • "activeDepartmentId": "string",
  • "seniorityId": "string",
  • "holidayCalendarId": "string",
  • "activityIds": [
    ],
  • "absenceTypeIds": [
    ],
  • "absenceApprovalId": "string",
  • "overtimePolicyId": "string",
  • "managerId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "googlePlusId": "string",
  • "idProvider": "string",
  • "lastLoginDate": "2019-08-24",
  • "avatar": "string",
  • "isPlaceholder": true,
  • "canInsertAndSubmitTimeFromOtherUsers": true,
  • "isAutoSubmitTimeEntriesActive": true,
  • "fillTimeEntriesFromPlanning": true,
  • "showFinancialProjectData": true,
  • "phoneNumbers": [
    ],
  • "hasPendingInvite": true,
  • "employeeCode": "string",
  • "isSupportUser": true,
  • "isExternal": true,
  • "canChangeContractor": true
}

Employee leave budgets

Update or insert an employee leave budget

Update or insert an employee leave budget

path Parameters
employee_id
required
string
Request Body schema: application/json
optional
id
string <id>
startDate
required
string <date>
finishDate
required
string <date>
icon
required
string
name
required
string
absenceTypeId
required
string <id>
startBudgetHours
required
number
allowOvertime
required
boolean
allowExceedingBudget
required
boolean
note
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "icon": "string",
  • "name": "string",
  • "absenceTypeId": "string",
  • "startBudgetHours": 0,
  • "allowOvertime": true,
  • "allowExceedingBudget": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "icon": "string",
  • "name": "string",
  • "employee": {
    },
  • "absenceType": {
    },
  • "startBudgetHours": 0,
  • "takenLeaveHours": 0,
  • "plannedLeaveHours": 0,
  • "pendingRequestsHours": 0,
  • "budgetLeftHours": 0,
  • "overtimeHours": 0,
  • "allowOvertime": true,
  • "allowExceedingBudget": true,
  • "takenLeaveDateHours": [
    ],
  • "plannedLeaveDateHours": [
    ],
  • "pendingRequestedDateHours": [
    ],
  • "overtimeEntries": [
    ]
}

Get the form of an employee leave budget

Get the form of an employee leave budget

path Parameters
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "employeeLeaveBudget": {
    },
  • "absenceTypeOptions": [
    ]
}

Delete an employee leave budget

Delete an employee leave budget

path Parameters
employee_leave_budget_id
required
string
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Update or insert an employee leave budget

Update or insert an employee leave budget

path Parameters
employee_leave_budget_id
required
string
employee_id
required
string
Request Body schema: application/json
optional
id
string <id>
startDate
required
string <date>
finishDate
required
string <date>
icon
required
string
name
required
string
absenceTypeId
required
string <id>
startBudgetHours
required
number
allowOvertime
required
boolean
allowExceedingBudget
required
boolean
note
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "icon": "string",
  • "name": "string",
  • "absenceTypeId": "string",
  • "startBudgetHours": 0,
  • "allowOvertime": true,
  • "allowExceedingBudget": true,
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "icon": "string",
  • "name": "string",
  • "employee": {
    },
  • "absenceType": {
    },
  • "startBudgetHours": 0,
  • "takenLeaveHours": 0,
  • "plannedLeaveHours": 0,
  • "pendingRequestsHours": 0,
  • "budgetLeftHours": 0,
  • "overtimeHours": 0,
  • "allowOvertime": true,
  • "allowExceedingBudget": true,
  • "takenLeaveDateHours": [
    ],
  • "plannedLeaveDateHours": [
    ],
  • "pendingRequestedDateHours": [
    ],
  • "overtimeEntries": [
    ]
}

Get the form of an employee leave budget

Get the form of an employee leave budget

path Parameters
employee_leave_budget_id
required
string
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "employeeLeaveBudget": {
    },
  • "absenceTypeOptions": [
    ]
}

Get a list of employee leave budgets

Get a list of employee leave budgets

path Parameters
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "leaveBudgets": {
    }
}

Get a list of employee leave requests

Get a list of employee leave requests

path Parameters
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "pendingLeaveRequests": [
    ],
  • "approvedLeaveRequests": [
    ]
}

Get the total requested hours of a period of an em

Get the total requested hours of a period of an employee

path Parameters
employee_id
required
string
Request Body schema: application/json
optional
id
string <id>
startDate
required
string <date>
finishDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "requestedHours": 0,
  • "budgetLeftExRequested": 0,
  • "leaveBudget": {
    }
}

Update or insert an employee leave request

Update or insert an employee leave request

path Parameters
employee_leave_budget_id
required
string
Request Body schema: application/json
optional
id
string <id>
desc
string
startDate
required
string <date>
finishDate
required
string <date>
hours
required
number

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hours": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "leaveBudget": {
    },
  • "desc": "string",
  • "status": "string",
  • "reasonForRejection": "string",
  • "rejectedByPerson": {
    },
  • "approvedByPerson": {
    },
  • "dateTimeOfStatusChange": "2019-08-24T14:15:22Z",
  • "requestedHours": 0,
  • "requestedDateHours": [
    ],
  • "canApproveAndReject": true,
  • "canRevoke": true
}

Get the form of an employee leave request

Get the form of an employee leave request

path Parameters
employee_leave_budget_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "requestedHours": 0,
  • "budgetLeftExRequested": 0,
  • "leaveBudget": {
    }
}

Delete an employee leave request

Delete an employee leave request

path Parameters
employee_leave_budget_id
required
string
employee_leave_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Update or insert an employee leave request

Update or insert an employee leave request

path Parameters
employee_leave_budget_id
required
string
employee_leave_request_id
required
string
Request Body schema: application/json
optional
id
string <id>
desc
string
startDate
required
string <date>
finishDate
required
string <date>
hours
required
number

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "hours": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "leaveBudget": {
    },
  • "desc": "string",
  • "status": "string",
  • "reasonForRejection": "string",
  • "rejectedByPerson": {
    },
  • "approvedByPerson": {
    },
  • "dateTimeOfStatusChange": "2019-08-24T14:15:22Z",
  • "requestedHours": 0,
  • "requestedDateHours": [
    ],
  • "canApproveAndReject": true,
  • "canRevoke": true
}

Get the form of an employee leave request

Get the form of an employee leave request

path Parameters
employee_leave_budget_id
required
string
employee_leave_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "desc": "string",
  • "status": "string",
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "requestedHours": 0,
  • "budgetLeftExRequested": 0,
  • "leaveBudget": {
    }
}

Approve an employee leave request

Approve an employee leave request

Authorizations:
ApiKeyAuth
path Parameters
leave_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Reject an employee leave request

Reject an employee leave request

Authorizations:
ApiKeyAuth
path Parameters
leave_request_id
required
string
Request Body schema: application/json
optional
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Revoke an employee leave request

Revoke an employee leave request

path Parameters
leave_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Employee skills

Update or insert an employee skill

Update or insert an employee skill

path Parameters
employee_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
skillId
string or null <id>
skillLevelId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "skillId": "string",
  • "skillLevelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "skill": {
    },
  • "skillLevel": {
    }
}

Get the form of an employee skill

Get the form of an employee skill

path Parameters
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "employeeSkill": {
    },
  • "skillLevelOptions": [
    ]
}

Delete an employee skill

Delete an employee skill

path Parameters
employee_skill_id
required
string
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Update or insert an employee skill

Update or insert an employee skill

path Parameters
employee_skill_id
required
string
employee_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
skillId
string or null <id>
skillLevelId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "skillId": "string",
  • "skillLevelId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "skill": {
    },
  • "skillLevel": {
    }
}

Get the form of an employee skill

Get the form of an employee skill

path Parameters
employee_skill_id
required
string
employee_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "employeeSkill": {
    },
  • "skillLevelOptions": [
    ]
}

Expenses

Return the expenses form

Return the expenses form

path Parameters
expenses_id
required
string

Responses

Response samples

Content type
application/json
{
  • "expenses": {
    },
  • "uploadFolderId": "string",
  • "deliverableOptions": [
    ],
  • "currencyOptions": [
    ],
  • "expensesTypeOptions": [
    ],
  • "projectOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "driveIntegrationEnabled": true,
  • "specifySalesTax": true,
  • "verificationBySupportStaff": true
}

Approve expenses

Approve expenses

Authorizations:
ApiKeyAuth
path Parameters
expenses_id
required
string
Request Body schema: application/json
optional
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Reject expenses

Reject expenses

Authorizations:
ApiKeyAuth
path Parameters
expenses_id
required
string
Request Body schema: application/json
optional
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "responseMessage": "string"
}

Return expenses

Return expenses

path Parameters
expenses_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "expenses": {
    }
}

Update or insert expenses

Update or insert expenses

path Parameters
expenses_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
object
date
string or null <date>
amount
number or null
currencyId
string or null <id>
expensesTypeId
string or null <id>
desc
string or null
vatAmount
number or null
secondVatAmount
number or null
salesAmount
number or null
personId
string or null <id>
projectId
string or null <id>
statusId
string or null
vatTypeId
string or null <id>
costId
string or null <id>
deliverableId
string or null <id>
reimburse
boolean or null
folderId
string or null
uploadFolderId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "file": {
    },
  • "date": "2019-08-24",
  • "amount": 0,
  • "currencyId": "string",
  • "expensesTypeId": "string",
  • "desc": "string",
  • "vatAmount": 0,
  • "secondVatAmount": 0,
  • "salesAmount": 0,
  • "personId": "string",
  • "projectId": "string",
  • "statusId": "string",
  • "vatTypeId": "string",
  • "costId": "string",
  • "deliverableId": "string",
  • "reimburse": true,
  • "folderId": "string",
  • "uploadFolderId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "amount": 0,
  • "comment": "string",
  • "currency": {
    },
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "permalink": "string",
  • "folderId": "string",
  • "expensesType": {
    },
  • "numberOfFiles": 0,
  • "person": {
    },
  • "reimburse": true,
  • "netAmountProjectLocalCurrency": 0,
  • "salesAmount": 0,
  • "status": {
    },
  • "reimbursedDate": "2019-08-24",
  • "vatAmount": 0,
  • "secondVatAmount": 0,
  • "vatType": {
    },
  • "cost": {
    },
  • "project": {
    },
  • "deliverable": {
    },
  • "personReject": {
    }
}

Return the expenses list

Return the expenses list

Request Body schema: application/json
optional
cursor
string or null
maxResults
integer or null
status
string or null

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "maxResults": 0,
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "more": true,
  • "statusOptions": [
    ]
}

Return the expenses form

Return the expenses form

Responses

Response samples

Content type
application/json
{
  • "expenses": {
    },
  • "uploadFolderId": "string",
  • "deliverableOptions": [
    ],
  • "currencyOptions": [
    ],
  • "expensesTypeOptions": [
    ],
  • "projectOptions": [
    ],
  • "vatTypeOptions": [
    ],
  • "driveIntegrationEnabled": true,
  • "specifySalesTax": true,
  • "verificationBySupportStaff": true
}

Update or insert expenses

Update or insert expenses

Request Body schema: application/json
optional
id
string or null <id>
object
date
string or null <date>
amount
number or null
currencyId
string or null <id>
expensesTypeId
string or null <id>
desc
string or null
vatAmount
number or null
secondVatAmount
number or null
salesAmount
number or null
personId
string or null <id>
projectId
string or null <id>
statusId
string or null
vatTypeId
string or null <id>
costId
string or null <id>
deliverableId
string or null <id>
reimburse
boolean or null
folderId
string or null
uploadFolderId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "file": {
    },
  • "date": "2019-08-24",
  • "amount": 0,
  • "currencyId": "string",
  • "expensesTypeId": "string",
  • "desc": "string",
  • "vatAmount": 0,
  • "secondVatAmount": 0,
  • "salesAmount": 0,
  • "personId": "string",
  • "projectId": "string",
  • "statusId": "string",
  • "vatTypeId": "string",
  • "costId": "string",
  • "deliverableId": "string",
  • "reimburse": true,
  • "folderId": "string",
  • "uploadFolderId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "amount": 0,
  • "comment": "string",
  • "currency": {
    },
  • "date": "string",
  • "desc": "string",
  • "entityKind": "string",
  • "permalink": "string",
  • "folderId": "string",
  • "expensesType": {
    },
  • "numberOfFiles": 0,
  • "person": {
    },
  • "reimburse": true,
  • "netAmountProjectLocalCurrency": 0,
  • "salesAmount": 0,
  • "status": {
    },
  • "reimbursedDate": "2019-08-24",
  • "vatAmount": 0,
  • "secondVatAmount": 0,
  • "vatType": {
    },
  • "cost": {
    },
  • "project": {
    },
  • "deliverable": {
    },
  • "personReject": {
    }
}

Verify expenses

Verify expenses

path Parameters
expenses_id
required
string
Request Body schema: application/json
optional
id
string
name
string
verified
required
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "verified": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Get expenses with the form options

Get expenses with the form options

Responses

Response samples

Content type
application/json
{
  • "expenses": {
    },
  • "expenses_type_options": [
    ],
  • "vat_type_options": [
    ],
  • "currencyOptions": [
    ],
  • "projectOptions": [
    ],
  • "deliverableOptions": [
    ],
  • "upload_folder_id": "string",
  • "is_verifier": true,
  • "manager_found": true,
  • "message": "string",
  • "person": {
    },
  • "department_name": "string",
  • "folderId": "string"
}

Get expenses with the form options

Get expenses with the form options

path Parameters
expenses_id
required
string

Responses

Response samples

Content type
application/json
{
  • "expenses": {
    },
  • "expenses_type_options": [
    ],
  • "vat_type_options": [
    ],
  • "currencyOptions": [
    ],
  • "projectOptions": [
    ],
  • "deliverableOptions": [
    ],
  • "upload_folder_id": "string",
  • "is_verifier": true,
  • "manager_found": true,
  • "message": "string",
  • "person": {
    },
  • "department_name": "string",
  • "folderId": "string"
}

Return the expense claims list

Return the expense claims list

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "cursor": "string",
  • "more": true,
  • "statusOptions": [
    ]
}

Boards

Update or insert a board

Update or insert a board

Request Body schema: application/json
optional
name
string or null
desc
string or null
coverImage
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "desc": "string",
  • "coverImage": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "coverImage": "string",
  • "coverImageSmall": "string",
  • "desc": "string",
  • "lastUpdated": "2019-08-24",
  • "entityKind": "string",
  • "permalink": "string",
  • "actions": [
    ],
  • "folderId": "string",
  • "sharedWithPersons": [
    ],
  • "isArchived": true,
  • "isOwner": true,
  • "nrOfFiles": 0,
  • "owner": {
    }
}

Delete a board

Delete a board

path Parameters
board_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a board

Return a board

path Parameters
board_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "board": {
    }
}

Update or insert a board

Update or insert a board

path Parameters
board_id
required
string
Request Body schema: application/json
optional
name
string or null
desc
string or null
coverImage
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "desc": "string",
  • "coverImage": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "coverImage": "string",
  • "coverImageSmall": "string",
  • "desc": "string",
  • "lastUpdated": "2019-08-24",
  • "entityKind": "string",
  • "permalink": "string",
  • "actions": [
    ],
  • "folderId": "string",
  • "sharedWithPersons": [
    ],
  • "isArchived": true,
  • "isOwner": true,
  • "nrOfFiles": 0,
  • "owner": {
    }
}

Add a custom board item

Add a custom board item

path Parameters
board_id
required
string
Request Body schema: application/json
optional
title
string or null
desc
string or null
source
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "desc": "string",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "entityKind": null,
  • "desc": "string",
  • "source": "string"
}

Delete a custom board item

Delete a custom board item

path Parameters
custom_board_item_id
required
string
board_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Add a custom board item

Add a custom board item

path Parameters
custom_board_item_id
required
string
board_id
required
string
Request Body schema: application/json
optional
title
string or null
desc
string or null
source
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "desc": "string",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "entityKind": null,
  • "desc": "string",
  • "source": "string"
}

Return board items in a paged list

Return board items in a paged list

path Parameters
board_id
required
string
Request Body schema: application/json
optional
cursor
integer or null
maxResults
integer or null

Responses

Request samples

Content type
application/json
{
  • "cursor": 0,
  • "maxResults": 0
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": 0,
  • "more": true
}

Share a board with other persons

Share a board with other persons

path Parameters
board_id
required
string
Request Body schema: application/json
optional
personIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "personIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "coverImage": "string",
  • "coverImageSmall": "string",
  • "desc": "string",
  • "lastUpdated": "2019-08-24",
  • "entityKind": "string",
  • "permalink": "string",
  • "actions": [
    ],
  • "folderId": "string",
  • "sharedWithPersons": [
    ],
  • "isArchived": true,
  • "isOwner": true,
  • "nrOfFiles": 0,
  • "owner": {
    }
}

Pin an entity to a board

Pin an entity to a board

path Parameters
entity_id
required
string
board_id
required
string
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Unpin an entity from a board

Unpin an entity from a board

path Parameters
entity_id
required
string
board_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return board items in a paged list

Return board items in a paged list

Request Body schema: application/json
optional
type
string or null
cursor
string or null
maxResults
integer or null

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "cursor": "string",
  • "maxResults": 0
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "more": true
}

Return board items for pinning the chart

Return board items for pinning the chart

Request Body schema: application/json
optional
entityId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "entityId": "string"
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Charts

Return a list containing the charts

Return a list containing the charts

Request Body schema: application/json
optional
cursor
integer or null
maxResults
integer or null

Responses

Request samples

Content type
application/json
{
  • "cursor": 0,
  • "maxResults": 0
}

Response samples

Content type
application/json
{
  • "metaCompanyOptions": [
    ],
  • "nextCursor": 0,
  • "more": true,
  • "items": [
    ]
}

Return the sales pipeline progression chart

Return the sales pipeline progression chart

path Parameters
chart_id
required
string
Request Body schema: application/json
optional
selectedDepartmentIds
Array of strings or null <id> [ items <id > ]
selectedCustomerIds
Array of strings or null <id> [ items <id > ]
selectedRevenueTypeIds
Array of strings or null <id> [ items <id > ]
selectedAccountManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectStatusIds
Array of strings or null <id> [ items <id > ]
selectedActivityIds
Array of strings or null <id> [ items <id > ]
selectedSeniorityIds
Array of strings or null <id> [ items <id > ]
selectedResourceFilter
string or null
selectedTagIds
Array of strings or null <id> [ items <id > ]
selectedSkillIds
Array of strings or null <id> [ items <id > ]
selectedSkillAndSkillLevelIds
Array of strings or null
selectedMetaCompanyId
string or null <id>
selectedPipelineId
string or null <id>
useLocalCurrency
boolean or null
personId
string or null <id>
year
integer or null
month
integer or null
offset
integer or null
ytd
boolean or null
yoy
boolean or null
startMonthYtd
integer or null
sortOrder
string or null
sortField
string or null
periodId
string or null
nextCursor
string or null
pageSize
integer or null
unit
string or null
scale
string or null
today
string or null <date>
cacheId
string or null

Responses

Request samples

Content type
application/json
{
  • "selectedDepartmentIds": [
    ],
  • "selectedCustomerIds": [
    ],
  • "selectedRevenueTypeIds": [
    ],
  • "selectedAccountManagerIds": [
    ],
  • "selectedProjectManagerIds": [
    ],
  • "selectedProjectStatusIds": [
    ],
  • "selectedActivityIds": [
    ],
  • "selectedSeniorityIds": [
    ],
  • "selectedResourceFilter": "string",
  • "selectedTagIds": [
    ],
  • "selectedSkillIds": [
    ],
  • "selectedSkillAndSkillLevelIds": [
    ],
  • "selectedMetaCompanyId": "string",
  • "selectedPipelineId": "string",
  • "useLocalCurrency": true,
  • "personId": "string",
  • "year": 0,
  • "month": 0,
  • "offset": 0,
  • "ytd": true,
  • "yoy": true,
  • "startMonthYtd": 0,
  • "sortOrder": "string",
  • "sortField": "string",
  • "periodId": "string",
  • "nextCursor": "string",
  • "pageSize": 0,
  • "unit": "string",
  • "scale": "string",
  • "today": "2019-08-24",
  • "cacheId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "chart": {
    }
}

Return the stages for the sales pipeline progressi

Return the stages for the sales pipeline progression chart

path Parameters
chart_id
required
string
Request Body schema: application/json
optional
periodId
string or null
pipelineId
string or null <id>
opportunityStageId
string or null <id>
departmentIds
Array of strings or null <id> [ items <id > ]
accountManagerIds
Array of strings or null <id> [ items <id > ]
periodSetting
string or null
useLocalCurrency
boolean or null

Responses

Request samples

Content type
application/json
{
  • "periodId": "string",
  • "pipelineId": "string",
  • "opportunityStageId": "string",
  • "departmentIds": [
    ],
  • "accountManagerIds": [
    ],
  • "periodSetting": "string",
  • "useLocalCurrency": true
}

Response samples

Content type
application/json
{
  • "showFormFields": {
    },
  • "opportunities": [
    ]
}

Return the opportunity weather chart

Return the opportunity weather chart

path Parameters
chart_id
required
string
Request Body schema: application/json
optional
selectedDepartmentIds
Array of strings or null <id> [ items <id > ]
selectedCustomerIds
Array of strings or null <id> [ items <id > ]
selectedRevenueTypeIds
Array of strings or null <id> [ items <id > ]
selectedAccountManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectStatusIds
Array of strings or null <id> [ items <id > ]
selectedActivityIds
Array of strings or null <id> [ items <id > ]
selectedSeniorityIds
Array of strings or null <id> [ items <id > ]
selectedResourceFilter
string or null
selectedTagIds
Array of strings or null <id> [ items <id > ]
selectedSkillIds
Array of strings or null <id> [ items <id > ]
selectedSkillAndSkillLevelIds
Array of strings or null
selectedMetaCompanyId
string or null <id>
selectedPipelineId
string or null <id>
useLocalCurrency
boolean or null
personId
string or null <id>
year
integer or null
month
integer or null
offset
integer or null
ytd
boolean or null
yoy
boolean or null
startMonthYtd
integer or null
sortOrder
string or null
sortField
string or null
periodId
string or null
nextCursor
string or null
pageSize
integer or null
unit
string or null
scale
string or null
today
string or null <date>
cacheId
string or null

Responses

Request samples

Content type
application/json
{
  • "selectedDepartmentIds": [
    ],
  • "selectedCustomerIds": [
    ],
  • "selectedRevenueTypeIds": [
    ],
  • "selectedAccountManagerIds": [
    ],
  • "selectedProjectManagerIds": [
    ],
  • "selectedProjectStatusIds": [
    ],
  • "selectedActivityIds": [
    ],
  • "selectedSeniorityIds": [
    ],
  • "selectedResourceFilter": "string",
  • "selectedTagIds": [
    ],
  • "selectedSkillIds": [
    ],
  • "selectedSkillAndSkillLevelIds": [
    ],
  • "selectedMetaCompanyId": "string",
  • "selectedPipelineId": "string",
  • "useLocalCurrency": true,
  • "personId": "string",
  • "year": 0,
  • "month": 0,
  • "offset": 0,
  • "ytd": true,
  • "yoy": true,
  • "startMonthYtd": 0,
  • "sortOrder": "string",
  • "sortField": "string",
  • "periodId": "string",
  • "nextCursor": "string",
  • "pageSize": 0,
  • "unit": "string",
  • "scale": "string",
  • "today": "2019-08-24",
  • "cacheId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "chart": {
    }
}

Return the sales funnel chart

Return the sales funnel chart

path Parameters
chart_id
required
string
Request Body schema: application/json
optional
selectedDepartmentIds
Array of strings or null <id> [ items <id > ]
selectedCustomerIds
Array of strings or null <id> [ items <id > ]
selectedRevenueTypeIds
Array of strings or null <id> [ items <id > ]
selectedAccountManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectManagerIds
Array of strings or null <id> [ items <id > ]
selectedProjectStatusIds
Array of strings or null <id> [ items <id > ]
selectedActivityIds
Array of strings or null <id> [ items <id > ]
selectedSeniorityIds
Array of strings or null <id> [ items <id > ]
selectedResourceFilter
string or null
selectedTagIds
Array of strings or null <id> [ items <id > ]
selectedSkillIds
Array of strings or null <id> [ items <id > ]
selectedSkillAndSkillLevelIds
Array of strings or null
selectedMetaCompanyId
string or null <id>
selectedPipelineId
string or null <id>
useLocalCurrency
boolean or null
personId
string or null <id>
year
integer or null
month
integer or null
offset
integer or null
ytd
boolean or null
yoy
boolean or null
startMonthYtd
integer or null
sortOrder
string or null
sortField
string or null
periodId
string or null
nextCursor
string or null
pageSize
integer or null
unit
string or null
scale
string or null
today
string or null <date>
cacheId
string or null

Responses

Request samples

Content type
application/json
{
  • "selectedDepartmentIds": [
    ],
  • "selectedCustomerIds": [
    ],
  • "selectedRevenueTypeIds": [
    ],
  • "selectedAccountManagerIds": [
    ],
  • "selectedProjectManagerIds": [
    ],
  • "selectedProjectStatusIds": [
    ],
  • "selectedActivityIds": [
    ],
  • "selectedSeniorityIds": [
    ],
  • "selectedResourceFilter": "string",
  • "selectedTagIds": [
    ],
  • "selectedSkillIds": [
    ],
  • "selectedSkillAndSkillLevelIds": [
    ],
  • "selectedMetaCompanyId": "string",
  • "selectedPipelineId": "string",
  • "useLocalCurrency": true,
  • "personId": "string",
  • "year": 0,
  • "month": 0,
  • "offset": 0,
  • "ytd": true,
  • "yoy": true,
  • "startMonthYtd": 0,
  • "sortOrder": "string",
  • "sortField": "string",
  • "periodId": "string",
  • "nextCursor": "string",
  • "pageSize": 0,
  • "unit": "string",
  • "scale": "string",
  • "today": "2019-08-24",
  • "cacheId": "string"
}

Response samples

Content type
application/json
{
  • "context": {
    },
  • "chart": {
    }
}

Conversations

Insert a comment and a conversation

Insert a comment and a conversation

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Insert a comment on a conversation

Insert a comment on a conversation

Authorizations:
ApiKeyAuth
path Parameters
conversation_id
required
string
Request Body schema: application/json
optional
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Like a notification

Like a notification

Request Body schema: application/json
optional
entityId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "entityId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Like a conversation

Like a conversation

path Parameters
conversation_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Get a paged list of conversations

Get a paged list of conversations

Authorizations:
ApiKeyAuth
path Parameters
entity_id
required
string
Request Body schema: application/json
optional
cursor
string or null <cursor>
maxResults
integer or null

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "maxResults": 0
}

Response samples

Content type
application/json
{
  • "toCursor": "string",
  • "more": true,
  • "items": [
    ]
}

Insert a conversation

Insert a conversation

Authorizations:
ApiKeyAuth
path Parameters
entity_id
required
string
Request Body schema: application/json
optional
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Get a paged list of conversations

Get a paged list of conversations

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
cursor
string or null <cursor>
maxResults
integer or null

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "maxResults": 0
}

Response samples

Content type
application/json
{
  • "toCursor": "string",
  • "more": true,
  • "items": [
    ]
}

Insert a conversation

Insert a conversation

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
boolean

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "id": "string",
  • "author": {
    },
  • "subject": "string",
  • "text": "string",
  • "datetime": "2019-08-24T14:15:22Z",
  • "comments": [
    ],
  • "likers": [
    ],
  • "gmailMessageId": "string",
  • "task": {
    }
}

Notes

Get note

Get note

Authorizations:
ApiKeyAuth
path Parameters
note_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "text": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityKind": "string",
  • "avatar": "string",
  • "entity": null,
  • "createdBy": {
    }
}

Update note

Update note

Authorizations:
ApiKeyAuth
path Parameters
note_id
required
string
Request Body schema: application/json
optional
entityId
string <id>

The id of the entity to which the note is attached.

entityKind
string
title
string or null

The title of the note.

text
string

The text of the note

Responses

Request samples

Content type
application/json
{
  • "entityId": "string",
  • "entityKind": "string",
  • "title": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "text": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityKind": "string",
  • "avatar": "string",
  • "entity": null,
  • "createdBy": {
    }
}

Update note

Update note

Authorizations:
ApiKeyAuth
Request Body schema: application/json
optional
entityId
string <id>

The id of the entity to which the note is attached.

entityKind
string
title
string or null

The title of the note.

text
string

The text of the note

Responses

Request samples

Content type
application/json
{
  • "entityId": "string",
  • "entityKind": "string",
  • "title": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "text": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "entityKind": "string",
  • "avatar": "string",
  • "entity": null,
  • "createdBy": {
    }
}

Get notes

Get notes

Request Body schema: application/json
optional
cursor
string or null
maxResults
integer or null
entityId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "maxResults": 0,
  • "entityId": "string"
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "more": true,
  • "items": [
    ]
}

Price lists

Update or insert a price list

Update or insert a price list

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
archived
boolean or null
currencyId
string or null <id>
object
Array of objects (PriceListPeriodWrite)
Array of objects (Currency)
Array of objects (MainEntityBase)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Return a price list

Return a price list

path Parameters
price_list_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true,
  • "desc": "string",
  • "currency": {
    },
  • "periods": [
    ]
}

Update or insert a price list

Update or insert a price list

path Parameters
price_list_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
archived
boolean or null
currencyId
string or null <id>
object
Array of objects (PriceListPeriodWrite)
Array of objects (Currency)
Array of objects (MainEntityBase)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Return a list of price lists

Return a list of price lists

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a price list form

Return a price list form

path Parameters
price_list_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Return a price list form

Return a price list form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Update or insert a price list period

Update or insert a price list period

path Parameters
price_list_id
required
string
Request Body schema: application/json
optional
periodId
integer or null
startDate
string or null <date>
finishDate
string or null <date>
Array of objects (PriceListActivityWrite)

Responses

Request samples

Content type
application/json
{
  • "periodId": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Delete a price list period

Delete a price list period

path Parameters
price_list_id
required
string
period_id
required
string
Request Body schema: application/json
optional
periodId
integer or null
startDate
string or null <date>
finishDate
string or null <date>
Array of objects (PriceListActivityWrite)

Responses

Request samples

Content type
application/json
{
  • "periodId": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Update or insert a price list period

Update or insert a price list period

path Parameters
price_list_id
required
string
period_id
required
string
Request Body schema: application/json
optional
periodId
integer or null
startDate
string or null <date>
finishDate
string or null <date>
Array of objects (PriceListActivityWrite)

Responses

Request samples

Content type
application/json
{
  • "periodId": 0,
  • "startDate": "2019-08-24",
  • "finishDate": "2019-08-24",
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Update the calculated sales rates

Update the calculated sales rates

path Parameters
price_list_id
required
string
period_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true,
  • "currencyId": "string",
  • "currency": {
    },
  • "periods": [
    ],
  • "currencyOptions": [
    ],
  • "activityOptions": [
    ]
}

Tasks

Insert or update a task

Insert or update a task

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
title
string or null
description
string or null
hoursCalculated
number or null
startDate
string or null <date>
dueDate
string or null <date>
dueDateTime
string or null <date-time>
assigneeId
string or null <id>
statusId
string or null <id>
status
string or null
statusType
string or null
entityId
string or null <id>
entityKind
string or null
deliverableId
string or null <id>
calculatedActivityId
string or null <id>
gmailMessageId
string or null <id>
Array of objects (DriveFile)
Array of objects (TaskCalculationLinesWrite)
hasCalculationLimit
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "hoursCalculated": 0,
  • "startDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "dueDateTime": "2019-08-24T14:15:22Z",
  • "assigneeId": "string",
  • "statusId": "string",
  • "status": "string",
  • "statusType": "string",
  • "entityId": "string",
  • "entityKind": "string",
  • "deliverableId": "string",
  • "calculatedActivityId": "string",
  • "gmailMessageId": "string",
  • "files": [
    ],
  • "taskCalculationLines": [
    ],
  • "hasCalculationLimit": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "hours_calculated": 0,
  • "startDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "dueDateTime": "2019-08-24T14:15:22Z",
  • "entityKind": "string",
  • "createdAt": "2019-08-24",
  • "lastEditedAt": "2019-08-24",
  • "permalink": "string",
  • "status": {
    },
  • "associatedEntity": null,
  • "assignee": {
    },
  • "assignees": [
    ],
  • "creator": {
    },
  • "project": {
    },
  • "deliverable": {
    },
  • "deliverableCalculation": {
    },
  • "timer": {
    },
  • "activity": {
    },
  • "opportunity": {
    },
  • "department": {
    },
  • "organization": {
    },
  • "lastEditor": {
    },
  • "actual": {
    },
  • "calculated": {
    },
  • "taskCalculationLines": [
    ]
}

Delete a task

Delete a task

path Parameters
task_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a task

Return a task

path Parameters
task_id
required
string

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "task": {
    }
}

Insert or update a task

Insert or update a task

path Parameters
task_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
title
string or null
description
string or null
hoursCalculated
number or null
startDate
string or null <date>
dueDate
string or null <date>
dueDateTime
string or null <date-time>
assigneeId
string or null <id>
statusId
string or null <id>
status
string or null
statusType
string or null
entityId
string or null <id>
entityKind
string or null
deliverableId
string or null <id>
calculatedActivityId
string or null <id>
gmailMessageId
string or null <id>
Array of objects (DriveFile)
Array of objects (TaskCalculationLinesWrite)
hasCalculationLimit
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "hoursCalculated": 0,
  • "startDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "dueDateTime": "2019-08-24T14:15:22Z",
  • "assigneeId": "string",
  • "statusId": "string",
  • "status": "string",
  • "statusType": "string",
  • "entityId": "string",
  • "entityKind": "string",
  • "deliverableId": "string",
  • "calculatedActivityId": "string",
  • "gmailMessageId": "string",
  • "files": [
    ],
  • "taskCalculationLines": [
    ],
  • "hasCalculationLimit": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "hours_calculated": 0,
  • "startDate": "2019-08-24",
  • "dueDate": "2019-08-24",
  • "dueDateTime": "2019-08-24T14:15:22Z",
  • "entityKind": "string",
  • "createdAt": "2019-08-24",
  • "lastEditedAt": "2019-08-24",
  • "permalink": "string",
  • "status": {
    },
  • "associatedEntity": null,
  • "assignee": {
    },
  • "assignees": [
    ],
  • "creator": {
    },
  • "project": {
    },
  • "deliverable": {
    },
  • "deliverableCalculation": {
    },
  • "timer": {
    },
  • "activity": {
    },
  • "opportunity": {
    },
  • "department": {
    },
  • "organization": {
    },
  • "lastEditor": {
    },
  • "actual": {
    },
  • "calculated": {
    },
  • "taskCalculationLines": [
    ]
}

Get a task with the form options

Get a task with the form options

path Parameters
task_id
required
string

Responses

Response samples

Content type
application/json
{
  • "task": {
    },
  • "assignee": {
    },
  • "creator": {
    },
  • "department": {
    },
  • "entity": null,
  • "activity": {
    },
  • "calculationLine": {
    },
  • "taskCalculationLines": [
    ],
  • "deliverable": {
    },
  • "conversation": {
    },
  • "taskStatusOptions": [
    ],
  • "timer": {
    },
  • "folderId": "string",
  • "nrOfHours": 0,
  • "uploadFolderId": "string",
  • "canDelete": true,
  • "hasTimesheetEntry": true,
  • "hasCalculationLimit": true,
  • "isCalculationLimitEnabled": true
}

Get a task with the form options

Get a task with the form options

Responses

Response samples

Content type
application/json
{
  • "task": {
    },
  • "assignee": {
    },
  • "creator": {
    },
  • "department": {
    },
  • "entity": null,
  • "activity": {
    },
  • "calculationLine": {
    },
  • "taskCalculationLines": [
    ],
  • "deliverable": {
    },
  • "conversation": {
    },
  • "taskStatusOptions": [
    ],
  • "timer": {
    },
  • "folderId": "string",
  • "nrOfHours": 0,
  • "uploadFolderId": "string",
  • "canDelete": true,
  • "hasTimesheetEntry": true,
  • "hasCalculationLimit": true,
  • "isCalculationLimitEnabled": true
}

Get a list of tasks

Get a list of tasks

Request Body schema: application/json
optional
deliverableId
string or null <id>
calculationLineId
string or null <id>
assigneeId
string or null <id>
employeeId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "deliverableId": "string",
  • "calculationLineId": "string",
  • "assigneeId": "string",
  • "employeeId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the time entries for a task

Get the time entries for a task

path Parameters
task_id
required
string

Responses

Response samples

Content type
application/json
{
  • "contributors": [
    ],
  • "openingBalanceHours": 0
}

Search entities

Return the result from the search as a suggest. Th

Return the result from the search as a suggest. This can be used to find an item and check if something exists.

Authorizations:
ApiKeyAuth
query Parameters
search
string
cursor
string
maxResults
integer
entityKind
string
sort
string
accountManagerIds
any
activityIds
any
departmentIds
any
isActive
boolean
isArchived
boolean
isContact
boolean
isCustomer
boolean
organizationOfProjectIsCustomer
boolean
isEmployee
boolean
isUser
boolean
isFullUser
boolean
isMine
boolean
isSupplier
boolean
isLead
boolean
marketSegmentIds
any
newSince
any
employeeSince
any
opportunityStageIds
any
pipelineIds
any
projectManagerIds
any
projectStatusIds
any
leadStageIds
any
seniorityIds
any
skillIds
any
skillsAndSkillLevelIds
any
tagIds
any
fromExpectedOrderDate
string <date>
toExpectedOrderDate
string <date>
assigneeIds
any
entityId
string
leadId
string
fromDueDate
string <date>
toDueDate
string <date>
isAssignedToMe
boolean
isAssociatedWithOpportunity
boolean
isAssociatedWithOrganization
boolean
isAssociatedWithProject
boolean
isAssociatedWithLead
boolean
isCreatedByMe
boolean
statusType
string
taskStatusIds
string
opportunityIds
any
organizationIds
any
projectIds
any
account_type
string
closed
string
customer
string
employee
string
finishDate
string <date>
isInvoicedOnProjectLevel
boolean
projectMemberIds
any
isNoAllocationRequired
boolean
isPayed
boolean
organizationId
string <id>
deliverableId
string <id>
resourcePlanningActive
boolean
startDate
string <date>
supplier
string

Responses

Response samples

Content type
application/json
{
  • "items": null
}

Search in the main entities

Search in the main entities

Request Body schema: application/json
optional
search
string or null
cursor
string or null
maxResults
integer or null
entityKind
string or null
sort
string or null
accountManagerIds
null
activityIds
null
departmentIds
null
isActive
boolean or null
isArchived
boolean or null
isContact
boolean or null
isCustomer
boolean or null
organizationOfProjectIsCustomer
boolean or null
isEmployee
boolean or null
isUser
boolean or null
isFullUser
boolean or null
isMine
boolean or null
isSupplier
boolean or null
isLead
boolean or null
marketSegmentIds
null
newSince
null
employeeSince
null
opportunityStageIds
null
pipelineIds
null
projectManagerIds
null
projectStatusIds
null
leadStageIds
null
seniorityIds
null
skillIds
null
skillsAndSkillLevelIds
null
tagIds
null
fromExpectedOrderDate
string or null <date>
toExpectedOrderDate
string or null <date>
assigneeIds
null
entityId
string or null
leadId
string or null
fromDueDate
string or null <date>
toDueDate
string or null <date>
isAssignedToMe
boolean or null
isAssociatedWithOpportunity
boolean or null
isAssociatedWithOrganization
boolean or null
isAssociatedWithProject
boolean or null
isAssociatedWithLead
boolean or null
isCreatedByMe
boolean or null
statusType
string or null
taskStatusIds
string or null
opportunityIds
null
organizationIds
null
projectIds
null

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "cursor": "string",
  • "maxResults": 0,
  • "entityKind": "string",
  • "sort": "string",
  • "accountManagerIds": null,
  • "activityIds": null,
  • "departmentIds": null,
  • "isActive": true,
  • "isArchived": true,
  • "isContact": true,
  • "isCustomer": true,
  • "organizationOfProjectIsCustomer": true,
  • "isEmployee": true,
  • "isUser": true,
  • "isFullUser": true,
  • "isMine": true,
  • "isSupplier": true,
  • "isLead": true,
  • "marketSegmentIds": null,
  • "newSince": null,
  • "employeeSince": null,
  • "opportunityStageIds": null,
  • "pipelineIds": null,
  • "projectManagerIds": null,
  • "projectStatusIds": null,
  • "leadStageIds": null,
  • "seniorityIds": null,
  • "skillIds": null,
  • "skillsAndSkillLevelIds": null,
  • "tagIds": null,
  • "fromExpectedOrderDate": "2019-08-24",
  • "toExpectedOrderDate": "2019-08-24",
  • "assigneeIds": null,
  • "entityId": "string",
  • "leadId": "string",
  • "fromDueDate": "2019-08-24",
  • "toDueDate": "2019-08-24",
  • "isAssignedToMe": true,
  • "isAssociatedWithOpportunity": true,
  • "isAssociatedWithOrganization": true,
  • "isAssociatedWithProject": true,
  • "isAssociatedWithLead": true,
  • "isCreatedByMe": true,
  • "statusType": "string",
  • "taskStatusIds": "string",
  • "opportunityIds": null,
  • "organizationIds": null,
  • "projectIds": null
}

Response samples

Content type
application/json
{
  • "items": null,
  • "filters": {
    },
  • "more": true,
  • "nextCursor": "string"
}

Expenses settings

Return a list of expenses settings

Return a list of expenses settings

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "expensesVerifiersOptions": [
    ],
  • "expensesVerifiers": [
    ],
  • "specifySalesTax": true,
  • "approvalMethod": "string",
  • "verificationBySupportStaff": true
}

Return a list of expenses settings for verifiers

Return a list of expenses settings for verifiers

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
Array of objects or null (MainEntityBase)
Array of objects or null (MainEntityBase)
specifySalesTax
boolean or null
approvalMethod
string or null
verificationBySupportStaff
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "expensesVerifiersOptions": [
    ],
  • "expensesVerifiers": [
    ],
  • "specifySalesTax": true,
  • "approvalMethod": "string",
  • "verificationBySupportStaff": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "expensesVerifiersOptions": [
    ],
  • "expensesVerifiers": [
    ],
  • "specifySalesTax": true,
  • "approvalMethod": "string",
  • "verificationBySupportStaff": true
}

Timesheet settings

Get timesheet settings

Get timesheet settings

Responses

Response samples

Content type
application/json
{
  • "lockedUntil": "2019-08-24",
  • "roundToQuarters": true,
  • "useWorkingHoursCheck": true,
  • "createTimeEntriesForDueTasksEnabled": true,
  • "leaveRequestsEnabled": true
}

Update timesheet settings

Update timesheet settings

Request Body schema: application/json
optional
lockedUntil
string or null <date>
roundToQuarters
boolean or null
useWorkingHoursCheck
boolean or null
createTimeEntriesForDueTasksEnabled
boolean or null
leaveRequestsEnabled
boolean or null

Responses

Request samples

Content type
application/json
{
  • "lockedUntil": "2019-08-24",
  • "roundToQuarters": true,
  • "useWorkingHoursCheck": true,
  • "createTimeEntriesForDueTasksEnabled": true,
  • "leaveRequestsEnabled": true
}

Response samples

Content type
application/json
{
  • "lockedUntil": "2019-08-24",
  • "roundToQuarters": true,
  • "useWorkingHoursCheck": true,
  • "createTimeEntriesForDueTasksEnabled": true,
  • "leaveRequestsEnabled": true
}

Absence types

Return a list with non-billable types

Return a list with non-billable types

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the form of a non-billable type

Return the form of a non-billable type

path Parameters
absence_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Return the form of a non-billable type

Return the form of a non-billable type

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Reads and writes a given absence type

Reads and writes a given absence type

path Parameters
absence_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Reads and writes a given absence type

Reads and writes a given absence type

path Parameters
absence_type_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
planLeaveHours
string or null
isTimeOff
boolean or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Reads and writes a given absence type

Reads and writes a given absence type

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Reads and writes a given absence type

Reads and writes a given absence type

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
planLeaveHours
string or null
isTimeOff
boolean or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "planLeaveHours": "string",
  • "isTimeOff": true,
  • "archived": true
}

Countries

Return a list of all countries

Return a list of all countries

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Currencies

Update or insert a currency

Update or insert a currency

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
code
required
string or null
decimals
required
integer or null
symbol
required
string or null
rate
required
number or null
required
object
inverse
required
boolean or null
exchangeDifferenceLedgerAccount
null
roundingDifferenceLedgerAccount
null
archived
required
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "rateUnit": {
    },
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "codeOptions": [
    ],
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "lastRateChangedDate": "2019-08-24",
  • "rateUnit": {
    },
  • "rateUnitOptions": [
    ],
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "baseCurrencyId": "string",
  • "archived": true
}

Update or insert a currency

Update or insert a currency

path Parameters
currency_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
code
required
string or null
decimals
required
integer or null
symbol
required
string or null
rate
required
number or null
required
object
inverse
required
boolean or null
exchangeDifferenceLedgerAccount
null
roundingDifferenceLedgerAccount
null
archived
required
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "rateUnit": {
    },
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "codeOptions": [
    ],
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "lastRateChangedDate": "2019-08-24",
  • "rateUnit": {
    },
  • "rateUnitOptions": [
    ],
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "baseCurrencyId": "string",
  • "archived": true
}

Get a list of currencies

Get a list of currencies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a currency form

Return a currency form

path Parameters
currency_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "codeOptions": [
    ],
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "lastRateChangedDate": "2019-08-24",
  • "rateUnit": {
    },
  • "rateUnitOptions": [
    ],
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "baseCurrencyId": "string",
  • "archived": true
}

Return a currency rate as a float

Return a currency rate as a float

path Parameters
currency_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error_messages": "string",
  • "error": {
    }
}

Return a currency form

Return a currency form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string",
  • "codeOptions": [
    ],
  • "decimals": 0,
  • "symbol": "string",
  • "rate": 0,
  • "lastRateChangedDate": "2019-08-24",
  • "rateUnit": {
    },
  • "rateUnitOptions": [
    ],
  • "inverse": true,
  • "exchangeDifferenceLedgerAccount": null,
  • "roundingDifferenceLedgerAccount": null,
  • "baseCurrencyId": "string",
  • "archived": true
}

Return a list of all available currencies

Return a list of all available currencies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Converts an amount from one currency to another

Converts an amount from one currency to another

Request Body schema: application/json
optional
fromCurrencyId
null
toCurrencyId
null
amount
number or null

Responses

Request samples

Content type
application/json
{
  • "fromCurrencyId": null,
  • "toCurrencyId": null,
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "fromCurrencyId": null,
  • "toCurrencyId": null,
  • "amount": 0
}

Expenses types

/api/v3/expensestype/{expenses_type_id}/archive

path Parameters
expenses_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype/{expenses_type_id}/restore

path Parameters
expenses_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype/{expenses_type_id}

path Parameters
expenses_type_id
required
string
Request Body schema: application/json
optional
desc
string or null
name
string or null
distributeToProject
boolean or null
ledgerAccount
null
cost
null
itemCode
string or null

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "name": "string",
  • "distributeToProject": true,
  • "ledgerAccount": null,
  • "cost": null,
  • "itemCode": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype/{expenses_type_id}/form

path Parameters
expenses_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype

Request Body schema: application/json
optional
desc
string or null
name
string or null
distributeToProject
boolean or null
ledgerAccount
null
cost
null
itemCode
string or null

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "name": "string",
  • "distributeToProject": true,
  • "ledgerAccount": null,
  • "cost": null,
  • "itemCode": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype/form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "distributeToProject": true,
  • "ledgerAccount": {
    },
  • "cost": {
    },
  • "archived": true,
  • "costOptions": {
    },
  • "itemCode": "string"
}

/api/v3/expensestype/list

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job roles

Get an job role

Get an job role

path Parameters
job_role_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true
}

Insert or update a job role

Insert or update a job role

path Parameters
job_role_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true
}

Insert or update a job role

Insert or update a job role

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
desc
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "archived": true
}

Get a list of job roles

Get a list of job roles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Labels

Return a list of labels

Return a list of labels

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
isForOpportunity
boolean or null
isForOrganization
boolean or null
isForPerson
boolean or null
isForProject
boolean or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Return a label form

Return a label form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Update or insert a label

Update or insert a label

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
isForOpportunity
boolean or null
isForOrganization
boolean or null
isForPerson
boolean or null
isForProject
boolean or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Return a label form

Return a label form

path Parameters
tag_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Update or insert a label

Update or insert a label

path Parameters
tag_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
isForOpportunity
boolean or null
isForOrganization
boolean or null
isForPerson
boolean or null
isForProject
boolean or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isForOpportunity": true,
  • "isForOrganization": true,
  • "isForPerson": true,
  • "isForProject": true,
  • "archived": true
}

Return all labels for an entity

Return all labels for an entity

path Parameters
entity_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates all labels for an entity

Updates all labels for an entity

path Parameters
entity_id
required
string
Request Body schema: application/json
optional
tagIds
Array of strings or null <id> [ items <id > ]

Responses

Request samples

Content type
application/json
{
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Lead stages

Return a list of lead stages

Return a list of lead stages

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return the form of a lead stage

Return the form of a lead stage

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Return the form of a lead stage

Return the form of a lead stage

path Parameters
lead_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Insert or update a lead stage

Insert or update a lead stage

path Parameters
lead_stage_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
description
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Archive a lead stage

Archive a lead stage

path Parameters
lead_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Restore a lead stage

Restore a lead stage

path Parameters
lead_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Insert or update a lead stage

Insert or update a lead stage

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
description
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Opportunity stages

Insert or update an opportunity stage

Insert or update an opportunity stage

path Parameters
pipeline_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
salesProbability
integer or null
desc
string or null
isShownInSalesFunnel
boolean or null
pipelineId
string or null <id>
archived
boolean or null
win
boolean or null
lost
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "salesProbability": 0,
  • "desc": "string",
  • "isShownInSalesFunnel": true,
  • "pipelineId": "string",
  • "archived": true,
  • "win": true,
  • "lost": true
}

Response samples

Content type
application/json
{
  • "lostAvailable": true,
  • "winAvailable": true,
  • "opportunityStage": {
    }
}

Return the form output of an opportunity stage

Return the form output of an opportunity stage

path Parameters
pipeline_id
required
string

Responses

Response samples

Content type
application/json
{
  • "lostAvailable": true,
  • "winAvailable": true,
  • "opportunityStage": {
    }
}

Return a list of opportunity stages

Return a list of opportunity stages

path Parameters
pipeline_id
required
string
Request Body schema: application/json
optional
includeArchived
boolean or null
pipelineId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "includeArchived": true,
  • "pipelineId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Insert or update an opportunity stage

Insert or update an opportunity stage

path Parameters
pipeline_id
required
string
opportunity_stage_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
salesProbability
integer or null
desc
string or null
isShownInSalesFunnel
boolean or null
pipelineId
string or null <id>
archived
boolean or null
win
boolean or null
lost
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "salesProbability": 0,
  • "desc": "string",
  • "isShownInSalesFunnel": true,
  • "pipelineId": "string",
  • "archived": true,
  • "win": true,
  • "lost": true
}

Response samples

Content type
application/json
{
  • "lostAvailable": true,
  • "winAvailable": true,
  • "opportunityStage": {
    }
}

Return the form output of an opportunity stage

Return the form output of an opportunity stage

path Parameters
pipeline_id
required
string
opportunity_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "lostAvailable": true,
  • "winAvailable": true,
  • "opportunityStage": {
    }
}

Archive an opportunity stage

Archive an opportunity stage

path Parameters
pipeline_id
required
string
opportunity_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "salesProbability": 0,
  • "desc": "string",
  • "isShownInSalesFunnel": true,
  • "pipelineId": "string",
  • "archived": true,
  • "win": true,
  • "lost": true
}

Restore a opportunity stage

Restore a opportunity stage

path Parameters
pipeline_id
required
string
opportunity_stage_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "salesProbability": 0,
  • "desc": "string",
  • "isShownInSalesFunnel": true,
  • "pipelineId": "string",
  • "archived": true,
  • "win": true,
  • "lost": true
}

Return a list of opportunity stages

Return a list of opportunity stages

Request Body schema: application/json
optional
includeArchived
boolean or null
pipelineId
string or null <id>

Responses

Request samples

Content type
application/json
{
  • "includeArchived": true,
  • "pipelineId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Overtime categories

Get a form for an overtime category

Get a form for an overtime category

path Parameters
overtime_category_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true,
  • "absenceTypeOptions": [
    ]
}

Insert or update a overtime category

Insert or update a overtime category

path Parameters
overtime_category_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
required
string
description
string
absenceTypeId
string or null <id>
isTimeOffInLieu
boolean
externalPayrollCode
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true,
  • "budgetLeftHours": 0
}

Get a form for an overtime category

Get a form for an overtime category

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true,
  • "absenceTypeOptions": [
    ]
}

Insert or update a overtime category

Insert or update a overtime category

Request Body schema: application/json
optional
id
string <id>
name
required
string
description
string
absenceTypeId
string or null <id>
isTimeOffInLieu
boolean
externalPayrollCode
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "absenceTypeId": "string",
  • "isTimeOffInLieu": true,
  • "externalPayrollCode": "string",
  • "archived": true,
  • "budgetLeftHours": 0
}

Get a list of overtime categories

Get a list of overtime categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Overtime policies

Get a form for an overtime policy

Get a form for an overtime policy

path Parameters
overtime_policy_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true,
  • "overtimeCategoryOptions": [
    ]
}

Insert or update a overtime policy

Insert or update a overtime policy

path Parameters
overtime_policy_id
required
string
Request Body schema: application/json
optional
id
string <id>
name
required
string
description
string
Array of objects (OvertimePolicyCategory)
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true
}

Get a form for an overtime policy

Get a form for an overtime policy

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true,
  • "overtimeCategoryOptions": [
    ]
}

Insert or update a overtime policy

Insert or update a overtime policy

Request Body schema: application/json
optional
id
string <id>
name
required
string
description
string
Array of objects (OvertimePolicyCategory)
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "overtimePolicyCategories": [
    ],
  • "archived": true
}

Get a list of overtime policies

Get a list of overtime policies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Seniorities

Update or insert a seniority

Update or insert a seniority

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Update or insert a seniority

Update or insert a seniority

path Parameters
seniority_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Get a list of seniorities

Get a list of seniorities

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a seniority form

Return a seniority form

path Parameters
seniority_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Return a seniority form

Return a seniority form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Skills

Update or insert a skill

Update or insert a skill

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Update or insert a skill

Update or insert a skill

path Parameters
skill_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Get a list of skills

Get a list of skills

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of skills

Get a list of skills

Request Body schema: application/json
optional
search
string or null
cursor
string or null
maxResults
integer or null
entityKind
string or null
sort
string or null
accountManagerIds
null
activityIds
null
departmentIds
null
isActive
boolean or null
isArchived
boolean or null
isContact
boolean or null
isCustomer
boolean or null
organizationOfProjectIsCustomer
boolean or null
isEmployee
boolean or null
isUser
boolean or null
isFullUser
boolean or null
isMine
boolean or null
isSupplier
boolean or null
isLead
boolean or null
marketSegmentIds
null
newSince
null
employeeSince
null
opportunityStageIds
null
pipelineIds
null
projectManagerIds
null
projectStatusIds
null
leadStageIds
null
seniorityIds
null
skillIds
null
skillsAndSkillLevelIds
null
tagIds
null
fromExpectedOrderDate
string or null <date>
toExpectedOrderDate
string or null <date>
assigneeIds
null
entityId
string or null
leadId
string or null
fromDueDate
string or null <date>
toDueDate
string or null <date>
isAssignedToMe
boolean or null
isAssociatedWithOpportunity
boolean or null
isAssociatedWithOrganization
boolean or null
isAssociatedWithProject
boolean or null
isAssociatedWithLead
boolean or null
isCreatedByMe
boolean or null
statusType
string or null
taskStatusIds
string or null
opportunityIds
null
organizationIds
null
projectIds
null

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "cursor": "string",
  • "maxResults": 0,
  • "entityKind": "string",
  • "sort": "string",
  • "accountManagerIds": null,
  • "activityIds": null,
  • "departmentIds": null,
  • "isActive": true,
  • "isArchived": true,
  • "isContact": true,
  • "isCustomer": true,
  • "organizationOfProjectIsCustomer": true,
  • "isEmployee": true,
  • "isUser": true,
  • "isFullUser": true,
  • "isMine": true,
  • "isSupplier": true,
  • "isLead": true,
  • "marketSegmentIds": null,
  • "newSince": null,
  • "employeeSince": null,
  • "opportunityStageIds": null,
  • "pipelineIds": null,
  • "projectManagerIds": null,
  • "projectStatusIds": null,
  • "leadStageIds": null,
  • "seniorityIds": null,
  • "skillIds": null,
  • "skillsAndSkillLevelIds": null,
  • "tagIds": null,
  • "fromExpectedOrderDate": "2019-08-24",
  • "toExpectedOrderDate": "2019-08-24",
  • "assigneeIds": null,
  • "entityId": "string",
  • "leadId": "string",
  • "fromDueDate": "2019-08-24",
  • "toDueDate": "2019-08-24",
  • "isAssignedToMe": true,
  • "isAssociatedWithOpportunity": true,
  • "isAssociatedWithOrganization": true,
  • "isAssociatedWithProject": true,
  • "isAssociatedWithLead": true,
  • "isCreatedByMe": true,
  • "statusType": "string",
  • "taskStatusIds": "string",
  • "opportunityIds": null,
  • "organizationIds": null,
  • "projectIds": null
}

Response samples

Content type
application/json
[
  • {
    }
]

Return a skill form

Return a skill form

path Parameters
skill_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Return a skill form

Return a skill form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Skill levels

Update or insert a skill level

Update or insert a skill level

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Update or insert a skill level

Update or insert a skill level

path Parameters
skill_level_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Get a list of skill levels

Get a list of skill levels

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a skill level form

Return a skill level form

path Parameters
skill_level_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Return a skill level form

Return a skill level form

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true
}

Task statuses

Create or update a task status

Create or update a task status

Request Body schema: application/json
optional
id
string or null <id>
name
string or null
statusTypeId
string or null
archived
boolean or null
setId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "statusTypeId": "string",
  • "archived": true,
  • "setId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true,
  • "statusType": {
    },
  • "statusTypeId": "string"
}

Create or update a task status

Create or update a task status

path Parameters
status_id
required
string
Request Body schema: application/json
optional
id
string or null <id>
name
string or null
statusTypeId
string or null
archived
boolean or null
setId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "statusTypeId": "string",
  • "archived": true,
  • "setId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true,
  • "statusType": {
    },
  • "statusTypeId": "string"
}

Return a form for a task status

Return a form for a task status

path Parameters
status_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true,
  • "statusType": {
    },
  • "statusTypeId": "string",
  • "statusTypeOptions": [
    ]
}

Return a form for a task status

Return a form for a task status

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "archived": true,
  • "statusType": {
    },
  • "statusTypeId": "string",
  • "statusTypeOptions": [
    ]
}

Return a list of task statuses

Return a list of task statuses

Request Body schema: application/json
optional
setId
string or null
archivedIncluded
boolean or null

Responses

Request samples

Content type
application/json
{
  • "setId": "string",
  • "archivedIncluded": true
}

Response samples

Content type
application/json
[
  • {
    }
]