For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
      • GETGet all projects for entity
      • POSTCreate a project
      • GETGet a project by ID
      • DELDelete a project
      • PATCHUpdate a project
  • Accounts payable
  • Accounts receivable
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
CommonProjects

Create a project

POST
/projects
POST
/v1/projects
$curl -X POST https://api.sandbox.monite.com/v1/projects \
>     -H "x-monite-version: 2024-05-25" \
>     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Marketing"
>}'
1{
2  "id": "id",
3  "created_at": "2024-01-15T09:30:00Z",
4  "updated_at": "2024-01-15T09:30:00Z",
5  "entity_id": "entity_id",
6  "name": "Marketing",
7  "code": "code",
8  "color": "red",
9  "created_by_entity_user_id": "created_by_entity_user_id",
10  "description": "description",
11  "end_date": "end_date",
12  "parent_id": "parent_id",
13  "partner_metadata": {
14    "key": "value"
15  },
16  "start_date": "start_date",
17  "tags": [
18    {
19      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
20      "created_at": "2022-09-07T16:35:18Z",
21      "updated_at": "2022-09-07T16:35:18Z",
22      "name": "Marketing",
23      "category": "document_type",
24      "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
25      "description": "Tag for the Marketing Department"
26    }
27  ]
28}
Create a new project.
Was this page helpful?
Previous

Get a project by ID

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
namestringRequired1-255 characters
The project name.
codestringOptionalformat: "^[a-zA-Z0-9]+$"1-20 characters

A user-defined identifier of this project.

colorstringOptional<=128 characters
Project color as a [CSS-compatible](https://developer.mozilla.org/en-US/docs/Web/CSS/color) value. Client applications can use this to color-code the projects or project-related data.
descriptionstringOptional<=1024 characters

A user-defined description of the project.

end_datestringOptionalformat: "date"
Project end date. If specified, must be later than or equal to the start date.
parent_idstringOptionalformat: "uuid"
Unused. Reserved for future use.
partner_metadatamap from strings to anyOptional
[Metadata](https://docs.monite.com/common/metadata) for partner needs.
start_datestringOptionalformat: "date"
Project start date.
tag_idslist of stringsOptional

A list of IDs of user-defined tags (labels) assigned to this project.

Response

Successful Response
idstringformat: "uuid"
A unique ID assigned to this project.
created_atdatetime
UTC date and time when this project was created.
updated_atdatetime
UTC date and time when this project was last updated.
entity_idstringformat: "uuid"
ID of the entity that owns this project.
namestring1-255 characters
The project name.
codestringformat: "^[a-zA-Z0-9]+$"1-20 characters

A user-defined identifier of this project.

colorstring<=128 characters

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

created_by_entity_user_idstringformat: "uuid"

ID of the entity user who created this project, or null if it was created using a partner access token.

descriptionstring<=1024 characters

A user-defined description of the project.

end_datestringformat: "date"
Project end date.
parent_idstringformat: "uuid"
Unused. Reserved for future use.
partner_metadatamap from strings to any

Metadata for partner needs.

start_datestringformat: "date"
Project start date.
tagslist of objects

A list of user-defined tags (labels) assigned to this project.

Errors

400
Post Projects Request Bad Request Error
401
Post Projects Request Unauthorized Error
403
Post Projects Request Forbidden Error
422
Post Projects Request Unprocessable Entity Error
429
Post Projects Request Too Many Requests Error

Project color as a CSS-compatible value. Client applications can use this to color-code the projects or project-related data.

Metadata for partner needs.