API docs by Redocly

Manor API (1.0.3)

Download OpenAPI specification:

Manor: manor@manor.is URL: https://www.manor.is

Provides access to a particular instance (tenant) in Manor. An API key can be provided by a Manor user with administration privileges in the instance.

Knowledge Base

Users

Users (employees) of the Manor instance.

Get user

Retrieves a single user

Authorizations:
BearerAuth
path Parameters
userId
required
integer <int64>

ID of user to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the user, assigned by Manor. Find it via the Users endpoints (GET /user/{userId} or GET /user/{email}) or the user list in the UI.

email
string or null <idn-email>

Email of the user. Required when creating a new user.

mobile
string or null

Mobile phone number of the user.

landline
string or null

Landline phone number of the user.

name
string or null

Name of the user. Required when creating a new user.

Response samples

Content type
application/json
{
  • "id": 10,
  • "email": "john@example.com",
  • "mobile": "+354 123 4567",
  • "landline": "+354 765 4321",
  • "name": "John Doe"
}

Update user

Updates an existing user

Authorizations:
BearerAuth
path Parameters
userId
required
integer <int64>

ID of user to update

Request Body schema: application/json

Update an existing user

email
string or null <idn-email>

Email of the user. Required when creating a new user.

mobile
string or null

Mobile phone number of the user.

landline
string or null

Landline phone number of the user.

name
string or null

Name of the user. Required when creating a new user.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the user, assigned by Manor. Find it via the Users endpoints (GET /user/{userId} or GET /user/{email}) or the user list in the UI.

email
string or null <idn-email>

Email of the user. Required when creating a new user.

mobile
string or null

Mobile phone number of the user.

landline
string or null

Landline phone number of the user.

name
string or null

Name of the user. Required when creating a new user.

Request samples

Content type
application/json
{
  • "email": "john@example.com",
  • "mobile": "+354 123 4567",
  • "landline": "+354 765 4321",
  • "name": "John Doe"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "email": "john@example.com",
  • "mobile": "+354 123 4567",
  • "landline": "+354 765 4321",
  • "name": "John Doe"
}

Get user by email

Retrieves a single user

Authorizations:
BearerAuth
path Parameters
email
required
string

Email of user to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the user, assigned by Manor. Find it via the Users endpoints (GET /user/{userId} or GET /user/{email}) or the user list in the UI.

email
string or null <idn-email>

Email of the user. Required when creating a new user.

mobile
string or null

Mobile phone number of the user.

landline
string or null

Landline phone number of the user.

name
string or null

Name of the user. Required when creating a new user.

Response samples

Content type
application/json
{
  • "id": 10,
  • "email": "john@example.com",
  • "mobile": "+354 123 4567",
  • "landline": "+354 765 4321",
  • "name": "John Doe"
}

Clients

Clients (customers) that projects are created for. These are also payers of invoices.

Create client

Adds a new client

Authorizations:
BearerAuth
Request Body schema: application/json

Create a new client

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the client, assigned by Manor. Use it as client.id when creating projects.

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Get client

Retrieves a single client

Authorizations:
BearerAuth
path Parameters
clientId
required
integer <int64>

ID of client to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the client, assigned by Manor. Use it as client.id when creating projects.

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Update client

Updates an existing client

Authorizations:
BearerAuth
path Parameters
clientId
required
integer <int64>

ID of client to update

Request Body schema: application/json

Update an existing client

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the client, assigned by Manor. Use it as client.id when creating projects.

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Delete client

Deletes an existing client

Authorizations:
BearerAuth
path Parameters
clientId
required
integer <int64>

ID of client to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Get client by national ID

Retrieves a single client by national ID

Authorizations:
BearerAuth
path Parameters
nationalId
required
string

National ID of client to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the client, assigned by Manor. Use it as client.id when creating projects.

name
string or null

Name of the client. Required when creating a client.

national_id
string or null

National ID of the client. Required when creating a client.

object or null (MailingAddress)

Mailing address of the client.

object or null (MailingAddress)

Billing address of the client, used on invoices. Falls back to address when not set.

email
string or null

Email address of the client or a comma separated list of email addresses.

phone
string or null

Phone number of the client.

currency_code
string or null

Currency code of the client. Required when creating a client.

special_attention
boolean or null
Default: false

Whether the client needs a special attention, i.e. to not provide services to etc..

add_transaction_fee
boolean or null
Default: false

Whether the client should be charged a transaction fee on invoices. Defaults to false.

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "John Doe",
  • "national_id": "1234567890",
  • "address": {
    },
  • "billing_address": {
    },
  • "email": "example@manor.is,another.example@manor.is",
  • "phone": "+354 123 4567",
  • "currency_code": "USD",
  • "special_attention": false,
  • "add_transaction_fee": false
}

Projects

Projects, formerly known as matters. These are the contain time entries and other billables items.

List projects

Returns a list of projects

Authorizations:
BearerAuth
query Parameters
page
integer

Page number

per_page
integer

Number of items per page

status
string
Enum: "all" "open" "closed"

Filter by project status

with_activities
boolean

Include activities of each projects

Responses

Response Schema: application/json
Array of objects (Project)

An array of projects.

object

An object containing links to other pages of projects.

object

An object containing metadata about the projects.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

Create project

Adds a new project

Authorizations:
BearerAuth
Request Body schema: application/json

Create a new project

name
string or null

Project name. Required when creating a project.

object or null

An object containing client id.

asset_id
integer or null <int64>

ID of the asset this project belongs to. Find it via the Assets endpoints (GET /asset/{assetId}). Requires the asset feature to be enabled in instance settings.

object or null

An object containing owner id. Required when creating a project.

object or null

An object containing owner id. Optional. Only has an effect if the billing owner feature is enabled. If the feature is disabled, billing owner is automatically equal to the project owner.

description
string or null <= 65535 characters

Free-text description of the project.

open
boolean or null
Default: true

Whether the project is open or not. Defaults to true.

closing_comment
string or null

A comment explaining why the project was closed. Applicable only when open is set to "false".

subject_to_vat
boolean or null

Whether the project is subject to VAT or not. Defaults to false. Only in case the instance is set to always choose VAT in its settings, subject_to_vat property is not provided and the project client's country is same as the country of the project owner, defaults to true.

settlement
boolean or null

Whether the project is a settlement project or not. When a project is saved or updated this field is not considered.

billing
string or null
Default: "enabled"
Enum: "enabled" "internal" "sensitive"

Billing status of the project. enabled means billables are billed normally; internal means the project is not billed to the client; sensitive implies internal, but billables are hidden from users without the sensitive-project permissions.

confidential
boolean or null
Default: false

Whether the project should be hidden from non-participants, even high privileged users. Defaults to false.

buyer_contact
string or null

Name of the buyer contact.

buyer_contact_email
string <idn-email>

Email address of the buyer contact.

buyer_contact_phone
string or null <= 255 characters

Phone number of the buyer contact.

buyer_reference_number
string or null <= 255 characters

Buyer reference number. Included on invoices, including electronic invoices.

billing_instructions
string or null <= 10000 characters

Billing instructions for the user preparing invoices. For internal use only, never sent to the client or included on invoices.

coordinates
string or null

GPS coordinates in WGS84 decimal degrees format (latitude, longitude). Requires the project coordinates feature to be enabled in instance settings.

Array of objects or null
Default: []

An array of project participants. Project owner is automatically added to this array.

Array of objects or null (Activity)
Default: []

An array of project activities.

Array of objects or null
Deprecated

Deprecated. Alias for labels, which were initially called subjects. Responses will contain the same array under both keys. Requests can set the array using either key.

Array of objects or null

An array of project labels.

budget
number or null <float>

Warnings will be visible when the current project balance gets close to this limit.

time_budget
number or null <float>

Warnings will be visible when time spent on this project reaches this limit.

estimate
number or null <float>

A warning will show in the project if the total amount filed will exceed this estimate.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the project, assigned by Manor. Use it as projectId in project endpoints and as matter_id on billables.

identifier
string or null

An extra field in projects where custom identifier can be stored. Depending on configuration, this may or may not be visible in the UI with a custom label.

name
string or null

Project name. Required when creating a project.

object or null

An object containing client id.

asset_id
integer or null <int64>

ID of the asset this project belongs to. Find it via the Assets endpoints (GET /asset/{assetId}). Requires the asset feature to be enabled in instance settings.

object or null

An object containing owner id. Required when creating a project.

object or null

An object containing owner id. Optional. Only has an effect if the billing owner feature is enabled. If the feature is disabled, billing owner is automatically equal to the project owner.

description
string or null <= 65535 characters

Free-text description of the project.

open
boolean or null
Default: true

Whether the project is open or not. Defaults to true.

closing_comment
string or null

A comment explaining why the project was closed. Applicable only when open is set to "false".

subject_to_vat
boolean or null

Whether the project is subject to VAT or not. Defaults to false. Only in case the instance is set to always choose VAT in its settings, subject_to_vat property is not provided and the project client's country is same as the country of the project owner, defaults to true.

settlement
boolean or null

Whether the project is a settlement project or not. When a project is saved or updated this field is not considered.

billing
string or null
Default: "enabled"
Enum: "enabled" "internal" "sensitive"

Billing status of the project. enabled means billables are billed normally; internal means the project is not billed to the client; sensitive implies internal, but billables are hidden from users without the sensitive-project permissions.

confidential
boolean or null
Default: false

Whether the project should be hidden from non-participants, even high privileged users. Defaults to false.

buyer_contact
string or null

Name of the buyer contact.

buyer_contact_email
string <idn-email>

Email address of the buyer contact.

buyer_contact_phone
string or null <= 255 characters

Phone number of the buyer contact.

buyer_reference_number
string or null <= 255 characters

Buyer reference number. Included on invoices, including electronic invoices.

billing_instructions
string or null <= 10000 characters

Billing instructions for the user preparing invoices. For internal use only, never sent to the client or included on invoices.

coordinates
string or null

GPS coordinates in WGS84 decimal degrees format (latitude, longitude). Requires the project coordinates feature to be enabled in instance settings.

Array of objects or null
Default: []

An array of project participants. Project owner is automatically added to this array.

Array of objects or null (Activity)
Default: []

An array of project activities.

Array of objects or null
Deprecated

Deprecated. Alias for labels, which were initially called subjects. Responses will contain the same array under both keys. Requests can set the array using either key.

Array of objects or null

An array of project labels.

budget
number or null <float>

Warnings will be visible when the current project balance gets close to this limit.

time_budget
number or null <float>

Warnings will be visible when time spent on this project reaches this limit.

estimate
number or null <float>

A warning will show in the project if the total amount filed will exceed this estimate.

object

The firm this project belongs to.

object or null

The department this project belongs to. Null if no department is set.

Request samples

Content type
application/json
{
  • "name": "My Project",
  • "client": {
    },
  • "asset_id": 5,
  • "owner": {
    },
  • "billing_owner": {
    },
  • "description": "A longer description of the project.",
  • "open": true,
  • "closing_comment": "Closing comment for my project.",
  • "subject_to_vat": true,
  • "settlement": true,
  • "billing": "enabled",
  • "confidential": true,
  • "buyer_contact": "John Doe",
  • "buyer_contact_email": "john.doe@manor.is",
  • "buyer_contact_phone": "+354 452 4586",
  • "buyer_reference_number": "PO-12345",
  • "billing_instructions": "string",
  • "coordinates": "64.1265, -21.8174",
  • "participants": [ ],
  • "activities": [ ],
  • "subjects": [
    ],
  • "labels": [
    ],
  • "budget": 0,
  • "time_budget": 0,
  • "estimate": 0
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "identifier": "my-external-identifier",
  • "name": "My Project",
  • "client": {
    },
  • "asset_id": 5,
  • "owner": {
    },
  • "billing_owner": {
    },
  • "description": "A longer description of the project.",
  • "open": true,
  • "closing_comment": "Closing comment for my project.",
  • "subject_to_vat": true,
  • "settlement": true,
  • "billing": "enabled",
  • "confidential": true,
  • "buyer_contact": "John Doe",
  • "buyer_contact_email": "john.doe@manor.is",
  • "buyer_contact_phone": "+354 452 4586",
  • "buyer_reference_number": "PO-12345",
  • "billing_instructions": "string",
  • "coordinates": "64.1265, -21.8174",
  • "participants": [ ],
  • "activities": [ ],
  • "subjects": [
    ],
  • "labels": [
    ],
  • "budget": 0,
  • "time_budget": 0,
  • "estimate": 0,
  • "firm": {
    },
  • "department": {
    }
}

Get project

Retrieves a single project

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the project, assigned by Manor. Use it as projectId in project endpoints and as matter_id on billables.

identifier
string or null

An extra field in projects where custom identifier can be stored. Depending on configuration, this may or may not be visible in the UI with a custom label.

name
string or null

Project name. Required when creating a project.

object or null

An object containing client id.

asset_id
integer or null <int64>

ID of the asset this project belongs to. Find it via the Assets endpoints (GET /asset/{assetId}). Requires the asset feature to be enabled in instance settings.

object or null

An object containing owner id. Required when creating a project.

object or null

An object containing owner id. Optional. Only has an effect if the billing owner feature is enabled. If the feature is disabled, billing owner is automatically equal to the project owner.

description
string or null <= 65535 characters

Free-text description of the project.

open
boolean or null
Default: true

Whether the project is open or not. Defaults to true.

closing_comment
string or null

A comment explaining why the project was closed. Applicable only when open is set to "false".

subject_to_vat
boolean or null

Whether the project is subject to VAT or not. Defaults to false. Only in case the instance is set to always choose VAT in its settings, subject_to_vat property is not provided and the project client's country is same as the country of the project owner, defaults to true.

settlement
boolean or null

Whether the project is a settlement project or not. When a project is saved or updated this field is not considered.

billing
string or null
Default: "enabled"
Enum: "enabled" "internal" "sensitive"

Billing status of the project. enabled means billables are billed normally; internal means the project is not billed to the client; sensitive implies internal, but billables are hidden from users without the sensitive-project permissions.

confidential
boolean or null
Default: false

Whether the project should be hidden from non-participants, even high privileged users. Defaults to false.

buyer_contact
string or null

Name of the buyer contact.

buyer_contact_email
string <idn-email>

Email address of the buyer contact.

buyer_contact_phone
string or null <= 255 characters

Phone number of the buyer contact.

buyer_reference_number
string or null <= 255 characters

Buyer reference number. Included on invoices, including electronic invoices.

billing_instructions
string or null <= 10000 characters

Billing instructions for the user preparing invoices. For internal use only, never sent to the client or included on invoices.

coordinates
string or null

GPS coordinates in WGS84 decimal degrees format (latitude, longitude). Requires the project coordinates feature to be enabled in instance settings.

Array of objects or null
Default: []

An array of project participants. Project owner is automatically added to this array.

Array of objects or null (Activity)
Default: []

An array of project activities.

Array of objects or null
Deprecated

Deprecated. Alias for labels, which were initially called subjects. Responses will contain the same array under both keys. Requests can set the array using either key.

Array of objects or null

An array of project labels.

budget
number or null <float>

Warnings will be visible when the current project balance gets close to this limit.

time_budget
number or null <float>

Warnings will be visible when time spent on this project reaches this limit.

estimate
number or null <float>

A warning will show in the project if the total amount filed will exceed this estimate.

object

The firm this project belongs to.

object or null

The department this project belongs to. Null if no department is set.

Response samples

Content type
application/json
{
  • "id": 10,
  • "identifier": "my-external-identifier",
  • "name": "My Project",
  • "client": {
    },
  • "asset_id": 5,
  • "owner": {
    },
  • "billing_owner": {
    },
  • "description": "A longer description of the project.",
  • "open": true,
  • "closing_comment": "Closing comment for my project.",
  • "subject_to_vat": true,
  • "settlement": true,
  • "billing": "enabled",
  • "confidential": true,
  • "buyer_contact": "John Doe",
  • "buyer_contact_email": "john.doe@manor.is",
  • "buyer_contact_phone": "+354 452 4586",
  • "buyer_reference_number": "PO-12345",
  • "billing_instructions": "string",
  • "coordinates": "64.1265, -21.8174",
  • "participants": [ ],
  • "activities": [ ],
  • "subjects": [
    ],
  • "labels": [
    ],
  • "budget": 0,
  • "time_budget": 0,
  • "estimate": 0,
  • "firm": {
    },
  • "department": {
    }
}

Update project

Updates an existing project

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project to update

Request Body schema: application/json

Update an existing project

name
string or null

Project name. Required when creating a project.

object or null

An object containing client id.

asset_id
integer or null <int64>

ID of the asset this project belongs to. Find it via the Assets endpoints (GET /asset/{assetId}). Requires the asset feature to be enabled in instance settings.

object or null

An object containing owner id. Required when creating a project.

object or null

An object containing owner id. Optional. Only has an effect if the billing owner feature is enabled. If the feature is disabled, billing owner is automatically equal to the project owner.

description
string or null <= 65535 characters

Free-text description of the project.

open
boolean or null
Default: true

Whether the project is open or not. Defaults to true.

closing_comment
string or null

A comment explaining why the project was closed. Applicable only when open is set to "false".

subject_to_vat
boolean or null

Whether the project is subject to VAT or not. Defaults to false. Only in case the instance is set to always choose VAT in its settings, subject_to_vat property is not provided and the project client's country is same as the country of the project owner, defaults to true.

settlement
boolean or null

Whether the project is a settlement project or not. When a project is saved or updated this field is not considered.

billing
string or null
Default: "enabled"
Enum: "enabled" "internal" "sensitive"

Billing status of the project. enabled means billables are billed normally; internal means the project is not billed to the client; sensitive implies internal, but billables are hidden from users without the sensitive-project permissions.

confidential
boolean or null
Default: false

Whether the project should be hidden from non-participants, even high privileged users. Defaults to false.

buyer_contact
string or null

Name of the buyer contact.

buyer_contact_email
string <idn-email>

Email address of the buyer contact.

buyer_contact_phone
string or null <= 255 characters

Phone number of the buyer contact.

buyer_reference_number
string or null <= 255 characters

Buyer reference number. Included on invoices, including electronic invoices.

billing_instructions
string or null <= 10000 characters

Billing instructions for the user preparing invoices. For internal use only, never sent to the client or included on invoices.

coordinates
string or null

GPS coordinates in WGS84 decimal degrees format (latitude, longitude). Requires the project coordinates feature to be enabled in instance settings.

Array of objects or null
Default: []

An array of project participants. Project owner is automatically added to this array.

Array of objects or null (Activity)
Default: []

An array of project activities.

Array of objects or null
Deprecated

Deprecated. Alias for labels, which were initially called subjects. Responses will contain the same array under both keys. Requests can set the array using either key.

Array of objects or null

An array of project labels.

budget
number or null <float>

Warnings will be visible when the current project balance gets close to this limit.

time_budget
number or null <float>

Warnings will be visible when time spent on this project reaches this limit.

estimate
number or null <float>

A warning will show in the project if the total amount filed will exceed this estimate.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the project, assigned by Manor. Use it as projectId in project endpoints and as matter_id on billables.

identifier
string or null

An extra field in projects where custom identifier can be stored. Depending on configuration, this may or may not be visible in the UI with a custom label.

name
string or null

Project name. Required when creating a project.

object or null

An object containing client id.

asset_id
integer or null <int64>

ID of the asset this project belongs to. Find it via the Assets endpoints (GET /asset/{assetId}). Requires the asset feature to be enabled in instance settings.

object or null

An object containing owner id. Required when creating a project.

object or null

An object containing owner id. Optional. Only has an effect if the billing owner feature is enabled. If the feature is disabled, billing owner is automatically equal to the project owner.

description
string or null <= 65535 characters

Free-text description of the project.

open
boolean or null
Default: true

Whether the project is open or not. Defaults to true.

closing_comment
string or null

A comment explaining why the project was closed. Applicable only when open is set to "false".

subject_to_vat
boolean or null

Whether the project is subject to VAT or not. Defaults to false. Only in case the instance is set to always choose VAT in its settings, subject_to_vat property is not provided and the project client's country is same as the country of the project owner, defaults to true.

settlement
boolean or null

Whether the project is a settlement project or not. When a project is saved or updated this field is not considered.

billing
string or null
Default: "enabled"
Enum: "enabled" "internal" "sensitive"

Billing status of the project. enabled means billables are billed normally; internal means the project is not billed to the client; sensitive implies internal, but billables are hidden from users without the sensitive-project permissions.

confidential
boolean or null
Default: false

Whether the project should be hidden from non-participants, even high privileged users. Defaults to false.

buyer_contact
string or null

Name of the buyer contact.

buyer_contact_email
string <idn-email>

Email address of the buyer contact.

buyer_contact_phone
string or null <= 255 characters

Phone number of the buyer contact.

buyer_reference_number
string or null <= 255 characters

Buyer reference number. Included on invoices, including electronic invoices.

billing_instructions
string or null <= 10000 characters

Billing instructions for the user preparing invoices. For internal use only, never sent to the client or included on invoices.

coordinates
string or null

GPS coordinates in WGS84 decimal degrees format (latitude, longitude). Requires the project coordinates feature to be enabled in instance settings.

Array of objects or null
Default: []

An array of project participants. Project owner is automatically added to this array.

Array of objects or null (Activity)
Default: []

An array of project activities.

Array of objects or null
Deprecated

Deprecated. Alias for labels, which were initially called subjects. Responses will contain the same array under both keys. Requests can set the array using either key.

Array of objects or null

An array of project labels.

budget
number or null <float>

Warnings will be visible when the current project balance gets close to this limit.

time_budget
number or null <float>

Warnings will be visible when time spent on this project reaches this limit.

estimate
number or null <float>

A warning will show in the project if the total amount filed will exceed this estimate.

object

The firm this project belongs to.

object or null

The department this project belongs to. Null if no department is set.

Request samples

Content type
application/json
{
  • "name": "My Project",
  • "client": {
    },
  • "asset_id": 5,
  • "owner": {
    },
  • "billing_owner": {
    },
  • "description": "A longer description of the project.",
  • "open": true,
  • "closing_comment": "Closing comment for my project.",
  • "subject_to_vat": true,
  • "settlement": true,
  • "billing": "enabled",
  • "confidential": true,
  • "buyer_contact": "John Doe",
  • "buyer_contact_email": "john.doe@manor.is",
  • "buyer_contact_phone": "+354 452 4586",
  • "buyer_reference_number": "PO-12345",
  • "billing_instructions": "string",
  • "coordinates": "64.1265, -21.8174",
  • "participants": [ ],
  • "activities": [ ],
  • "subjects": [
    ],
  • "labels": [
    ],
  • "budget": 0,
  • "time_budget": 0,
  • "estimate": 0
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "identifier": "my-external-identifier",
  • "name": "My Project",
  • "client": {
    },
  • "asset_id": 5,
  • "owner": {
    },
  • "billing_owner": {
    },
  • "description": "A longer description of the project.",
  • "open": true,
  • "closing_comment": "Closing comment for my project.",
  • "subject_to_vat": true,
  • "settlement": true,
  • "billing": "enabled",
  • "confidential": true,
  • "buyer_contact": "John Doe",
  • "buyer_contact_email": "john.doe@manor.is",
  • "buyer_contact_phone": "+354 452 4586",
  • "buyer_reference_number": "PO-12345",
  • "billing_instructions": "string",
  • "coordinates": "64.1265, -21.8174",
  • "participants": [ ],
  • "activities": [ ],
  • "subjects": [
    ],
  • "labels": [
    ],
  • "budget": 0,
  • "time_budget": 0,
  • "estimate": 0,
  • "firm": {
    },
  • "department": {
    }
}

Webhooks subscriptions

Set up callback URLs that handle events originating in Manor.

Project saved Webhook

Triggered when a project is created, updated, or deleted in Manor.

Request Body schema: application/json
required
trigger
required
string
Enum: "project_saved" "activity_saved" "client_saved" "user_saved"

The webhook subscription type that triggered this payload.

type
required
string
Enum: "created" "updated" "deleted"

The type of event that triggered this payload.

required
object (Project)

The project that was created, updated, or deleted.

Responses

Request samples

Content type
application/json
{
  • "trigger": "project_saved",
  • "type": "updated",
  • "source": {
    }
}

Activity saved Webhook

Triggered when a project activity is created, updated, or deleted in Manor.

Request Body schema: application/json
required
trigger
required
string
Enum: "activity_saved" "project_saved" "client_saved" "user_saved"

The webhook subscription type that triggered this payload.

type
required
string
Enum: "created" "updated" "deleted"

The type of event that triggered this payload.

required
object (Activity)

The activity that was created, updated, or deleted.

Responses

Request samples

Content type
application/json
{
  • "trigger": "activity_saved",
  • "type": "updated",
  • "source": {
    }
}

Client saved Webhook

Triggered when a client is created, updated, or deleted in Manor.

Request Body schema: application/json
required
trigger
required
string
Enum: "client_saved" "project_saved" "activity_saved" "user_saved"

The webhook subscription type that triggered this payload.

type
required
string
Enum: "created" "updated" "deleted"

The type of event that triggered this payload.

required
object (Client)

The client that was created, updated, or deleted.

Responses

Request samples

Content type
application/json
{
  • "trigger": "client_saved",
  • "type": "updated",
  • "source": {
    }
}

User saved Webhook

Triggered when a user (employee) is created, updated, or deleted in Manor.

Request Body schema: application/json
required
trigger
required
string
Enum: "user_saved" "project_saved" "activity_saved" "client_saved"

The webhook subscription type that triggered this payload.

type
required
string
Enum: "created" "updated" "deleted"

The type of event that triggered this payload.

required
object (User)

The user that was created, updated, or deleted.

Responses

Request samples

Content type
application/json
{
  • "trigger": "user_saved",
  • "type": "updated",
  • "source": {
    }
}

Create webhook subscription

Adds a new webhook subscription

Authorizations:
BearerAuth
Request Body schema: application/json

Create a new webhook subscription

type
string or null
Enum: "project_saved" "activity_saved" "user_saved" "client_saved"

Type of the webhook, controls what actions trigger this webhook. Required when creating a webhook subscription.

url
string or null

URL the webhook should call when triggered. Required when creating a webhook subscription.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the webhook subscription, assigned by Manor.

type
string or null
Enum: "project_saved" "activity_saved" "user_saved" "client_saved"

Type of the webhook, controls what actions trigger this webhook. Required when creating a webhook subscription.

url
string or null

URL the webhook should call when triggered. Required when creating a webhook subscription.

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get webhook subscription

Retrieves a single webhook subscription

Authorizations:
BearerAuth
path Parameters
webhookId
required
integer <int64>

ID of the webhook subscription to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the webhook subscription, assigned by Manor.

type
string or null
Enum: "project_saved" "activity_saved" "user_saved" "client_saved"

Type of the webhook, controls what actions trigger this webhook. Required when creating a webhook subscription.

url
string or null

URL the webhook should call when triggered. Required when creating a webhook subscription.

Response samples

Content type
application/json
{}

Update webhook subscription

Updates an existing webhook subscription

Authorizations:
BearerAuth
path Parameters
webhookId
required
integer <int64>

ID of webhook subscription to update

Request Body schema: application/json

Update an existing webhook subscription

type
string or null
Enum: "project_saved" "activity_saved" "user_saved" "client_saved"

Type of the webhook, controls what actions trigger this webhook. Required when creating a webhook subscription.

url
string or null

URL the webhook should call when triggered. Required when creating a webhook subscription.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the webhook subscription, assigned by Manor.

type
string or null
Enum: "project_saved" "activity_saved" "user_saved" "client_saved"

Type of the webhook, controls what actions trigger this webhook. Required when creating a webhook subscription.

url
string or null

URL the webhook should call when triggered. Required when creating a webhook subscription.

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete webhook subscription

Deletes an existing webhook subscription

Authorizations:
BearerAuth
path Parameters
webhookId
required
integer <int64>

ID of webhook subscription to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Utility

Utility calls, not related to any particular database models.

Ping

Returns a simple message to test connectivity to the API.

Authorizations:
BearerAuth

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Project activities

Activities are used to group time entries and other billable items within a project.

Create activity for project

Adds a new project activity

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

Request Body schema: application/json

Create a new project activity

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the activity, assigned by Manor. Use it as activity_id on billables.

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Request samples

Content type
application/json
{
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Deprecated. Create activity for project Deprecated

Adds a new project activity

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

Request Body schema: application/json

Create a new project activity

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the activity, assigned by Manor. Use it as activity_id on billables.

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Request samples

Content type
application/json
{
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Update project activity

Updates an existing project activity

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

activityId
required
integer <int64>

ID of activity to update

Request Body schema: application/json

Update an existing project activity

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the activity, assigned by Manor. Use it as activity_id on billables.

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Request samples

Content type
application/json
{
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Deprecated. Update project activity Deprecated

Updates an existing project activity

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

activityId
required
integer <int64>

ID of activity to update

Request Body schema: application/json

Update an existing project activity

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the activity, assigned by Manor. Use it as activity_id on billables.

name
string or null

Activity name. Required when creating an activity.

internal
boolean or null
Default: false

Whether the activity is internal. Internal activities are not billed to the client.

description
string or null

Activity description.

project_id
integer or null

ID of the project this activity belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

begins_at
string or null <date-time>

When the activity begins.

ends_at
string or null <date-time>

When the activity ends. Must be after begins_at.

closed_at
string or null <date-time>

When the activity was closed, if closed. For a sub-activity, whether it is open or closed must match that of its nearest closed or locked ancestor, if any; otherwise it can be set independently.

Request samples

Content type
application/json
{
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "My Activity",
  • "internal": false,
  • "description": "The description of my activity.",
  • "project_id": 10,
  • "begins_at": "2019-08-24T14:15:22Z",
  • "ends_at": "2019-08-24T14:15:22Z",
  • "closed_at": "2019-08-24T14:15:22Z"
}

Time entries

Time entries are used to track hours worked on projects.

List time entries

Retrieves a list of time entries for a project. Only returns time entries that are accessible to the authenticated user according to their permissions.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

query Parameters
user_id
integer <int64>

Filter time entries by user ID

date
string <date>

Filter time entries by date (YYYY-MM-DD format)

page
integer <int32>
Default: 1

Page number for pagination

per_page
integer <int32>
Default: 100

Number of items per page (max 100)

Responses

Response Schema: application/json
Array of objects (Time)

An array of time entries.

meta
object

Pagination metadata for the result set.

links
object

Links to other pages of time entries.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": { },
  • "links": { }
}

Create time entry

Adds a new time entry to a project. To create a time entry, "set_alternative_user_of_times" permission is required. Time entries can only be added for enabled users.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

Request Body schema: application/json

Create a new time entry

activity_id
integer or null <int64>

ID of the activity the time entry belongs to. Find it via the project's activities array (GET /project/{projectId}).

begins_at
string <date-time>

Date and time when the time entry begins in UTC. Required when creating a time entry. Must be in ISO 8601 format.

hours
number <float>

Duration of the time entry in hours. Required when creating a time entry.

billable_hours
number or null <float>

Billable hours for the time entry. If not provided, defaults to the value of hours.

description
string

Description of the time entry. Required when creating a time entry.

internal_note
string or null

Internal note for the time entry, not visible on invoices.

user_id
integer <int64>

ID of the user who created the time entry. Find it via the Users endpoints (GET /user/{userId}). Required when creating a time entry. User must be enabled.

rate_id
integer or null <int64>

ID of the rate applied to the time entry. Find it via the Rates endpoints (GET /rate). If not provided, the default rate will be used based on the user and project.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the time entry, assigned by Manor.

matter_id
integer <int64>

ID of the project the time entry belongs to. This is set from the URL parameter, not the request body.

activity_id
integer or null <int64>

ID of the activity the time entry belongs to. Find it via the project's activities array (GET /project/{projectId}).

begins_at
string <date-time>

Date and time when the time entry begins in UTC. Required when creating a time entry. Must be in ISO 8601 format.

hours
number <float>

Duration of the time entry in hours. Required when creating a time entry.

billable_hours
number or null <float>

Billable hours for the time entry. If not provided, defaults to the value of hours.

description
string

Description of the time entry. Required when creating a time entry.

internal_note
string or null

Internal note for the time entry, not visible on invoices.

user_id
integer <int64>

ID of the user who created the time entry. Find it via the Users endpoints (GET /user/{userId}). Required when creating a time entry. User must be enabled.

rate_id
integer or null <int64>

ID of the rate applied to the time entry. Find it via the Rates endpoints (GET /rate). If not provided, the default rate will be used based on the user and project.

Request samples

Content type
application/json
{
  • "activity_id": 5,
  • "begins_at": "2024-01-15T09:00:00Z",
  • "hours": 2.5,
  • "billable_hours": 2.5,
  • "description": "Meeting with client to discuss project requirements.",
  • "internal_note": "Client requested additional features.",
  • "user_id": 1,
  • "rate_id": 3
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "matter_id": 10,
  • "activity_id": 5,
  • "begins_at": "2024-01-15T09:00:00Z",
  • "hours": 2.5,
  • "billable_hours": 2.5,
  • "description": "Meeting with client to discuss project requirements.",
  • "internal_note": "Client requested additional features.",
  • "user_id": 1,
  • "rate_id": 3
}

Get time entry

Retrieves a single time entry by ID. Only returns the time entry if it's accessible to the authenticated user according to their permissions.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

timeId
required
integer <int64>

ID of time entry

Responses

Response Schema: application/json
object (Time)

The requested time entry.

Response samples

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

Products

Products are billable items with a price and quantity, such as goods or services that aren't time, travel or per diem.

List products

Retrieves a list of products for a project. Only returns products that are accessible to the authenticated user according to their permissions. Requires "manage_products" permission.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

query Parameters
user_id
integer <int64>

Filter products by user ID

date
string <date>

Filter products by date (YYYY-MM-DD format)

page
integer <int32>
Default: 1

Page number for pagination

per_page
integer <int32>
Default: 100

Number of items per page (max 100)

Responses

Response Schema: application/json
Array of objects (Product)

An array of products.

meta
object

Pagination metadata for the result set.

links
object

Links to other pages of products.

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": { },
  • "links": { }
}

Create product

Adds a new product to a project. Requires "manage_products" permission.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

Request Body schema: application/json

Create a new product

activity_id
integer or null <int64>

ID of the activity the product belongs to. Find it via the project's activities array (GET /project/{projectId}).

date
string <date>

Date of the product. Required when creating a product. Must be in YYYY-MM-DD format.

description
string

Description of the product. Required when creating a product.

internal_note
string or null

Internal note for the product, not visible on invoices.

quantity
number <float>

Quantity of the product. Required when creating a product.

billable_quantity
number or null <float>

Billable quantity for the product. If not provided, defaults to the value of quantity.

price
number or null <float>

Custom unit price for the product. If not provided, the rate price will be used.

custom_discount
number or null <float>

Custom discount percentage for the product.

user_id
integer <int64>

ID of the user who created the product. Find it via the Users endpoints (GET /user/{userId}). Required when creating a product.

rate_id
integer <int64>

ID of the rate applied to the product. Find it via the Rates endpoints (GET /rate). Required when creating a product.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the product, assigned by Manor.

matter_id
integer <int64>

ID of the project the product belongs to. This is set from the URL parameter, not the request body.

activity_id
integer or null <int64>

ID of the activity the product belongs to. Find it via the project's activities array (GET /project/{projectId}).

date
string <date>

Date of the product. Required when creating a product. Must be in YYYY-MM-DD format.

description
string

Description of the product. Required when creating a product.

internal_note
string or null

Internal note for the product, not visible on invoices.

quantity
number <float>

Quantity of the product. Required when creating a product.

billable_quantity
number or null <float>

Billable quantity for the product. If not provided, defaults to the value of quantity.

price
number or null <float>

Custom unit price for the product. If not provided, the rate price will be used.

custom_discount
number or null <float>

Custom discount percentage for the product.

user_id
integer <int64>

ID of the user who created the product. Find it via the Users endpoints (GET /user/{userId}). Required when creating a product.

rate_id
integer <int64>

ID of the rate applied to the product. Find it via the Rates endpoints (GET /rate). Required when creating a product.

Request samples

Content type
application/json
{
  • "activity_id": 5,
  • "date": "2024-01-15",
  • "description": "Consulting services for project setup.",
  • "internal_note": "Internal tracking note.",
  • "quantity": 2.5,
  • "billable_quantity": 2.5,
  • "price": 100,
  • "custom_discount": 10,
  • "user_id": 1,
  • "rate_id": 3
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "matter_id": 10,
  • "activity_id": 5,
  • "date": "2024-01-15",
  • "description": "Consulting services for project setup.",
  • "internal_note": "Internal tracking note.",
  • "quantity": 2.5,
  • "billable_quantity": 2.5,
  • "price": 100,
  • "custom_discount": 10,
  • "user_id": 1,
  • "rate_id": 3
}

Get product

Retrieves a single product by ID. Only returns the product if it's accessible to the authenticated user according to their permissions.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

productId
required
integer <int64>

ID of product

Responses

Response Schema: application/json
object (Product)

The requested product.

Response samples

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

Update product

Updates an existing product

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

productId
required
integer <int64>

ID of product to update

Request Body schema: application/json

Update an existing product

activity_id
integer or null <int64>

ID of the activity the product belongs to. Find it via the project's activities array (GET /project/{projectId}).

date
string <date>

Date of the product. Required when creating a product. Must be in YYYY-MM-DD format.

description
string

Description of the product. Required when creating a product.

internal_note
string or null

Internal note for the product, not visible on invoices.

quantity
number <float>

Quantity of the product. Required when creating a product.

billable_quantity
number or null <float>

Billable quantity for the product. If not provided, defaults to the value of quantity.

price
number or null <float>

Custom unit price for the product. If not provided, the rate price will be used.

custom_discount
number or null <float>

Custom discount percentage for the product.

user_id
integer <int64>

ID of the user who created the product. Find it via the Users endpoints (GET /user/{userId}). Required when creating a product.

rate_id
integer <int64>

ID of the rate applied to the product. Find it via the Rates endpoints (GET /rate). Required when creating a product.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the product, assigned by Manor.

matter_id
integer <int64>

ID of the project the product belongs to. This is set from the URL parameter, not the request body.

activity_id
integer or null <int64>

ID of the activity the product belongs to. Find it via the project's activities array (GET /project/{projectId}).

date
string <date>

Date of the product. Required when creating a product. Must be in YYYY-MM-DD format.

description
string

Description of the product. Required when creating a product.

internal_note
string or null

Internal note for the product, not visible on invoices.

quantity
number <float>

Quantity of the product. Required when creating a product.

billable_quantity
number or null <float>

Billable quantity for the product. If not provided, defaults to the value of quantity.

price
number or null <float>

Custom unit price for the product. If not provided, the rate price will be used.

custom_discount
number or null <float>

Custom discount percentage for the product.

user_id
integer <int64>

ID of the user who created the product. Find it via the Users endpoints (GET /user/{userId}). Required when creating a product.

rate_id
integer <int64>

ID of the rate applied to the product. Find it via the Rates endpoints (GET /rate). Required when creating a product.

Request samples

Content type
application/json
{
  • "activity_id": 5,
  • "date": "2024-01-15",
  • "description": "Consulting services for project setup.",
  • "internal_note": "Internal tracking note.",
  • "quantity": 2.5,
  • "billable_quantity": 2.5,
  • "price": 100,
  • "custom_discount": 10,
  • "user_id": 1,
  • "rate_id": 3
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "matter_id": 10,
  • "activity_id": 5,
  • "date": "2024-01-15",
  • "description": "Consulting services for project setup.",
  • "internal_note": "Internal tracking note.",
  • "quantity": 2.5,
  • "billable_quantity": 2.5,
  • "price": 100,
  • "custom_discount": 10,
  • "user_id": 1,
  • "rate_id": 3
}

Delete product

Deletes an existing product

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

productId
required
integer <int64>

ID of product to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Rates

Rates define the pricing for billable work. They may be user-specific, department-specific, or general.

List rates

Returns a list of rates. Requires the "manage_rates" permission.

Authorizations:
BearerAuth
query Parameters
page
integer

Page number

per_page
integer

Number of items per page

Responses

Response Schema: application/json
Array of objects (Rate)

An array of rates.

object

An object containing links to other pages of rates.

object

An object containing metadata about the rates.

Response samples

Content type
application/json
{}

Assets

Assets group related projects, typically within a specific geographical area.

List assets

Returns a list of assets

Authorizations:
BearerAuth
query Parameters
page
integer

Page number

per_page
integer

Number of items per page

Responses

Response Schema: application/json
Array of objects (Asset)

An array of assets.

Response samples

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

Create asset

Adds a new asset

Authorizations:
BearerAuth
Request Body schema: application/json

Create a new asset

name
string or null

Name of the asset. Required when creating an asset.

identifier
string or null

External identifier for the asset, such as a number from an older or another system. Only letters, numbers, dashes and underscores are allowed.

country_code
string

Two-letter country code of the asset. Defaults to IS.

postal_code
string or null

Postal code of the asset.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the asset, assigned by Manor. Use it as asset_id on a project.

name
string or null

Name of the asset. Required when creating an asset.

identifier
string or null

External identifier for the asset, such as a number from an older or another system. Only letters, numbers, dashes and underscores are allowed.

country_code
string

Two-letter country code of the asset. Defaults to IS.

postal_code
string or null

Postal code of the asset.

Request samples

Content type
application/json
{
  • "name": "Downtown campus",
  • "identifier": "my-external-identifier",
  • "country_code": "IS",
  • "postal_code": "101"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "Downtown campus",
  • "identifier": "my-external-identifier",
  • "country_code": "IS",
  • "postal_code": "101"
}

Get asset by ID

Retrieves a single asset

Authorizations:
BearerAuth
path Parameters
assetId
required
integer <int64>

ID of asset to retrieve

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the asset, assigned by Manor. Use it as asset_id on a project.

name
string or null

Name of the asset. Required when creating an asset.

identifier
string or null

External identifier for the asset, such as a number from an older or another system. Only letters, numbers, dashes and underscores are allowed.

country_code
string

Two-letter country code of the asset. Defaults to IS.

postal_code
string or null

Postal code of the asset.

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "Downtown campus",
  • "identifier": "my-external-identifier",
  • "country_code": "IS",
  • "postal_code": "101"
}

Update asset

Updates an existing asset

Authorizations:
BearerAuth
path Parameters
assetId
required
integer <int64>

ID of asset to update

Request Body schema: application/json

Asset data to update

name
string or null

Name of the asset. Required when creating an asset.

identifier
string or null

External identifier for the asset, such as a number from an older or another system. Only letters, numbers, dashes and underscores are allowed.

country_code
string

Two-letter country code of the asset. Defaults to IS.

postal_code
string or null

Postal code of the asset.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the asset, assigned by Manor. Use it as asset_id on a project.

name
string or null

Name of the asset. Required when creating an asset.

identifier
string or null

External identifier for the asset, such as a number from an older or another system. Only letters, numbers, dashes and underscores are allowed.

country_code
string

Two-letter country code of the asset. Defaults to IS.

postal_code
string or null

Postal code of the asset.

Request samples

Content type
application/json
{
  • "name": "Downtown campus",
  • "identifier": "my-external-identifier",
  • "country_code": "IS",
  • "postal_code": "101"
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "name": "Downtown campus",
  • "identifier": "my-external-identifier",
  • "country_code": "IS",
  • "postal_code": "101"
}

Delete asset

Deletes an asset

Authorizations:
BearerAuth
path Parameters
assetId
required
integer <int64>

ID of asset to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Expenses

Expenses are billable items paid out on behalf of a client. They differ from other billables in some ways and don't have a rate attached.

Create expense

Adds a new expense. To create an expense, "set_alternative_user_of_expenses" permission is required.

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

Request Body schema: application/json

Create a new expense

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the expense, assigned by Manor.

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Request samples

Content type
application/json
{
  • "description": "Travel expenses to client meeting.",
  • "amount": 150.75,
  • "billable_amount": 150.75,
  • "recipient": "John Doe",
  • "paid_at": "2024-01-15T09:00:00Z",
  • "firm_id": 1,
  • "matter_id": 10,
  • "activity_id": 5,
  • "vat_rate_id": 2,
  • "paid_in_currency_code": "USD",
  • "document_number": "EXP-2024-001",
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "description": "Travel expenses to client meeting.",
  • "amount": 150.75,
  • "billable_amount": 150.75,
  • "recipient": "John Doe",
  • "paid_at": "2024-01-15T09:00:00Z",
  • "firm_id": 1,
  • "matter_id": 10,
  • "activity_id": 5,
  • "vat_rate_id": 2,
  • "paid_in_currency_code": "USD",
  • "document_number": "EXP-2024-001",
  • "user_id": 1
}

Update expense

Updates an existing expense

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

expenseId
required
integer <int64>

ID of expense to update

Request Body schema: application/json

Update an existing expense

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the expense, assigned by Manor.

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Request samples

Content type
application/json
{
  • "description": "Travel expenses to client meeting.",
  • "amount": 150.75,
  • "billable_amount": 150.75,
  • "recipient": "John Doe",
  • "paid_at": "2024-01-15T09:00:00Z",
  • "firm_id": 1,
  • "matter_id": 10,
  • "activity_id": 5,
  • "vat_rate_id": 2,
  • "paid_in_currency_code": "USD",
  • "document_number": "EXP-2024-001",
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "id": 10,
  • "description": "Travel expenses to client meeting.",
  • "amount": 150.75,
  • "billable_amount": 150.75,
  • "recipient": "John Doe",
  • "paid_at": "2024-01-15T09:00:00Z",
  • "firm_id": 1,
  • "matter_id": 10,
  • "activity_id": 5,
  • "vat_rate_id": 2,
  • "paid_in_currency_code": "USD",
  • "document_number": "EXP-2024-001",
  • "user_id": 1
}

Delete expense

Deletes an existing expense

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

expenseId
required
integer <int64>

ID of expense to delete

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Upload expense attachment

Uploads an attachment file to an existing expense

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

expenseId
required
integer <int64>

ID of expense

Request Body schema: multipart/form-data

Attachment file to upload

attachment
string <binary>

The attachment file to upload for the expense.

Responses

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the expense, assigned by Manor.

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Response Schema: application/json
id
integer or null <int64>

Unique identifier of the expense, assigned by Manor.

description
string or null

Description of the expense. Required when creating an expense.

amount
number <float>

Amount of the expense. Required when creating an expense.

billable_amount
number or null <float>

Billable amount of the expense.

recipient
string

Recipient of the expense.

paid_at
string <date-time>

Date when the expense was paid. Required when creating an expense. Must be in ISO 8601 format with timezone (e.g., "2024-01-15T09:00:00Z" or "2024-01-15T14:00:00+05:00").

firm_id
integer <int64>

ID of the firm the expense belongs to. Find it via the firm settings in the UI.

matter_id
integer <int64>

ID of the project the expense belongs to. Find it via the Projects endpoints (GET /project/{projectId}).

activity_id
integer or null <int64>

ID of the activity the expense belongs to. Find it via the project's activities array (GET /project/{projectId}).

vat_rate_id
integer <int64>

ID of the VAT rate applied to the expense. Find it via the VAT rate settings in the UI. Required when creating an expense.

paid_in_currency_code
string

Currency code of the expense. Required when creating an expense.

document_number
string or null

Document number of the expense.

user_id
integer <int64>

ID of the user who created the expense. Find it via the Users endpoints (GET /user/{userId}).

Response samples

Content type
application/json
{
  • "id": 10,
  • "description": "Travel expenses to client meeting.",
  • "amount": 150.75,
  • "billable_amount": 150.75,
  • "recipient": "John Doe",
  • "paid_at": "2024-01-15T09:00:00Z",
  • "firm_id": 1,
  • "matter_id": 10,
  • "activity_id": 5,
  • "vat_rate_id": 2,
  • "paid_in_currency_code": "USD",
  • "document_number": "EXP-2024-001",
  • "user_id": 1
}

Delete expense attachment

Deletes an attachment file from an existing expense

Authorizations:
BearerAuth
path Parameters
projectId
required
integer <int64>

ID of project

expenseId
required
integer <int64>

ID of expense

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthenticated."
}

Extensions

Instance extensions and the actions they expose through this API.

List all enabled extensions

Retrieves all available extensions with their actions and parameters

Authorizations:
BearerAuth

Responses

Response Schema: application/json
Array
name
string

The name of the extension

description
string

Description of the extension

Array of objects or null (Action)
Default: []

An array of extension actions.

Response samples

Content type
application/json
[
  • {
    }
]

Execute an extension action

Triggers a specific action on a given extension

Authorizations:
BearerAuth
path Parameters
extension
required
string

Name of the extension

action
required
string

Name of the action to execute

Request Body schema: application/json

Parameters for the action

object

Responses

Response Schema: application/json
property name*
additional property
any

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Invoices

Sales invoices issued by the firm. This part of the API is in development in partnership with another software vendor and may have breaking changes.

BetaList invoices

Lists sales invoices visible to the current user.

Authorizations:
BearerAuth
query Parameters
firm_id
integer <int64>

Only return invoices issued by this firm.

from
string <date>

Only return invoices with this invoice date or later.

to
string <date>

Only return invoices with this invoice date or earlier.

page
integer >= 1

Page number.

per_page
integer [ 1 .. 100 ]

Number of invoices per page (maximum 100).

Responses

Response Schema: application/json
Array of objects (Invoice)
links
object
meta
object

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": { },
  • "meta": { }
}

BetaGet invoice by ID

Retrieves an invoice, including invoice lines and their billable_invoice_line accounting snapshots, populated synchronously during invoicing.

Authorizations:
BearerAuth
path Parameters
invoiceId
required
integer <int64>

ID of the invoice to retrieve.

Responses

Response Schema: application/json
required
object (Invoice)

An invoice with its issuer, recipient, payment, and line details.

Response samples

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

BetaGet invoice by firm and invoice number

Retrieves an invoice, including invoice lines and their billable_invoice_line accounting snapshots, populated synchronously during invoicing.

Authorizations:
BearerAuth
path Parameters
firmId
required
integer <int64>

ID of the firm that issued the invoice.

invoiceNumber
required
string

Invoice number assigned by the firm.

Responses

Response Schema: application/json
required
object (Invoice)

An invoice with its issuer, recipient, payment, and line details.

Response samples

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

Firms

Firms are the organizations using Manor. Their details include basic information such as name, address, and contact information.

List firms

Lists all firms with the basic details shown in the firm form.

Authorizations:
BearerAuth
query Parameters
page
integer >= 1

Page number.

per_page
integer [ 1 .. 100 ]

Number of firms per page (maximum 100).

Responses

Response Schema: application/json
Array of objects (Firm)
links
object
meta
object

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": { },
  • "meta": { }
}