Create an invoice
POST/api/invoices
Required permissions:
- invoices.create: required to create invoices for projects where the user is PM or Account.
- invoices.create_other: required to create invoices for projects where the user is not PM or Account.
Request
Header Parameters
The company you want to interact with
The API version you want to use
- application/json
Body
Possible values: <= 255 characters
The invoice number
The invoice purchase order reference
The invoice value
The invoice custom exchange rate
The invoice issue date
The invoice notes
The ID of the project to associate with this invoice
The UID of the budget area to associate with this invoice
The ID of the VAT rate to associate with this invoice
The ID of the payment term to associate with this invoice
Responses
- 201
- 400
- 401
- 403
- 412
Returns the invoice created.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: >= 1
The unique identifier of the resource
The date and time when the resource was created
The date and time when the resource was last updated
Possible values: [draft, sent, paid]
The invoice status
The invoice number
The invoice purchase order reference
The invoice value
The invoice custom exchange rate
The invoice issue date
The invoice payment date
The invoice notes
Possible values: >= 1
The ID of the project associated with this invoice
The UID of the budget area associated with this invoice
The ID of the VAT rate associated with this invoice
The ID of the payment term associated with this invoice
{
"id": 1,
"created_at": "2026-03-10T18:18:59.374Z",
"updated_at": "2026-03-10T18:18:59.374Z",
"status": "draft",
"invoice_number": "INV-2024-001",
"purchase_order": "string",
"value": 1000,
"exchange_rate": 0,
"issue_date": "2024-06-15",
"notes": "string",
"project_id": 1,
"budget_area_uid": "string",
"vat_rate_id": 0,
"payment_term_id": 0
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Error unique key
Human-readable message describing the error
failures
object[]
List of validation errors
Name of the field causing the error
Human-readable description of the error
{
"key": "invalid_data",
"message": "You provided invalid data. Check 'failures' for details.",
"failures": [
{
"field": "string",
"message": "string"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "string",
"message": "string"
}
Precondition failed
- application/json
- Schema
- Example (from schema)
Schema
Error unique key
Human-readable message describing the error
{
"key": "precondition_failure",
"message": "string"
}