Welcome to the Coperniq API release notes. This section highlights noteworthy changes across endpoints, schemas, and docs.
Recent highlights
- New: Labels —
GET /labels(filter bytype),POST /labels,GET /labels/{labelId}.typeisWORK(work orders) orASSET. v2 mirrors these under/v2with the standard success envelope. - New: Assets —
GET /assets(filter byaccount_id),POST /assets,GET/PATCH /assets/{assetId}(setisArchived: truevia PATCH to archive). v2 mirrors these under/v2with the standard success envelope. - New: Invoice payments —
GET /invoices/{invoiceId}/payments,GET /invoices/{invoiceId}/payments/{paymentId}, andPOST /invoices/{invoiceId}/payments(optionalpaymentReferenceon create). - New: Quotes — full CRUD via
GET/POST /quotes,GET/PATCH/DELETE /quotes/{quoteId},GET /quotes/{quoteId}/pdf,POST /quotes/{quoteId}/send, andGET /opportunities/{opportunityId}/quotes. - New: Work order line items —
PUT /work-orders/{workOrderId}/line-itemsreplaces line items on service work orders (account type).GET /work-orders/{workOrderId}now includeslineItemswhen present. - New: Taxes —
GET /taxeslists company tax rates with pagination and archived filtering. - New: Bills — full CRUD for project bills via
GET/POST /bills,GET/PATCH/DELETE /bills/{billId}, andGET /projects/{projectId}/bills. Supports LINE_ITEMS and PERCENTAGE calculation methods. - Improvement: Nullable fields on
PATCH /projects/{projectId},PATCH /accounts/{accountId}, andPATCH /clients/{clientId}— passnullto clear a field (e.g.description,ownerId,primaryEmail) or any custom property.
Looking for a specific date? See the entries below.
Today’s release focuses on improving Work Orders creation, tightening schemas, and cleaning up the docs.
What’s new?
- Create Work Order: You can now create a work order under a specific phase instance using
templateIdandphaseInstanceId. The response includesid,createdAt,updatedAt,description,position,phaseInstanceId,projectId, andcreatedById. - Full CRUD on Catalog Items: You can now, get, create, update, and delete catalog items in your company settings.
- Form Retrieval: You can now get forms on a project and get form details.
- Project Phase Instances: Getting a project by ID now includes the phase instances for that project.
Changes
- Work Orders
- POST
/projects/{projectId}/work-ordersrequirestemplateIdandphaseInstanceId.
- POST
- Catalogs & Catalog Items
- GET
/catalog-itemsreturns catalogs with their catalog items. - GET
/catalog-items/{catalogItemId}returns a catalog item. - POST
/catalog-itemscreates a catalog item. - PATCH
/catalog-items/{catalogItemId}updates a catalog item.
- GET
- Forms
- GET
/projects/{projectId}/formsreturns a list of the forms on a project. - GET
/forms/{formId}returns the form details, including field values.
- GET
- Projects
- GET
/projects/{projectId}includes an array ofphaseInstances.
- GET
Notes
- The provided
phaseInstanceIdmust belong to the project where the work order is created.
