API v1
v1
View as Markdown

Add a maintenance record

POST /api/v1/vaults/{vault}/possessions/{possession}/maintenance-records

Record one job done on a possession.

The type, the title and the day performed are required.

The change is written to the account log.

Parameters

Sent as JSON. Anything not listed here is ignored.

vault string Required

The vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.

possession uuid Required

The id of the possession. A possession of another vault or of another account answers 404.

maintenance_type string Required

What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other.

title string Required

What was done, up to 255 characters. Markup is stripped, and a title left empty once it is stripped is refused with “Say what was done.”

performed_on string Required

The day the job was done, written as 2026-03-12. A day after today, in the timezone of the user the key belongs to, is refused with “The job cannot be performed in the future.”

performed_by string Optional

The person or the workshop who did the job, up to 255 characters.

cost number Optional

What the job cost. Zero or more, up to 9999999999.99. A figure below zero is refused.

currency string Optional

The currency of the cost: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny. A cost sent without one is refused with “Choose the currency of the cost.”

condition_before_id uuid Optional

The condition the possession was in before the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404.

condition_after_id uuid Optional

The condition the possession was in after the job. The id of one of the possession conditions of your account, or null for none. A condition of another account answers 404.

next_due_on string Optional

The day the job should be done again, written as 2027-03-12. A day before the job is refused with “The next due date cannot come before the job.”

description string Optional

What was found and what was done, up to 5,000 characters. Markup is stripped.

Returns

The maintenance record object that was added. A condition of another account answers 404.

data object

The possession maintenance record.

data.type string

Always possession_maintenance_record. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.maintenance_type string

What kind of job it was: inspection, cleaning, servicing, repair, restoration, part_replacement, conservation or other.

data.attributes.title string

What was done, as text.

data.attributes.performed_by string

The person or the workshop who did the job, as text, or null.

data.attributes.performed_on string

The day the job was done, written as 2026-03-12.

data.attributes.cost string

What the job cost, as a string with two decimals, or null when it is not recorded. It is never added to the transactions or to the declared value of the possession.

data.attributes.currency string

The currency of the cost, in lower case, or null when there is no cost. Nothing is ever converted.

data.attributes.condition_before object

The possession condition the possession was in before the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.

data.attributes.condition_before.id uuid

The id of the condition, as the possession conditions endpoints give it.

data.attributes.condition_before.name string

What the condition is called.

data.attributes.condition_after object

The possession condition the possession was in after the job, or null when it is not recorded. A condition renamed since gives its new name, and one deleted since leaves null.

data.attributes.condition_after.id uuid

The id of the condition, as the possession conditions endpoints give it.

data.attributes.condition_after.name string

What the condition is called.

data.attributes.next_due_on string

The day the job should be done again, or null when nothing is scheduled.

data.attributes.is_overdue boolean

Whether the job is due again and has not been done. Only the latest record of the possession can be overdue, since a later job replaces the schedule of an earlier one, and it is overdue when its next due date is before today, in the timezone of the user the key belongs to. It is read, never written.

data.attributes.description string

What was found and what was done, or null.

data.attributes.created_at timestamp

When the record was added, as a count of seconds since 1970.

data.attributes.updated_at timestamp

When it last changed, as a count of seconds, or null.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

data.links.web string

The Maintenance section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

POST
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records \
-X POST \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"maintenance_type": "restoration",
"title": "Re-plating",
"performed_on": "2026-03-12",
"performed_by": "Scranton Trophy and Engraving",
"cost": 40,
"currency": "usd",
"condition_before_id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
"condition_after_id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
"next_due_on": "2027-03-12",
"description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies."
}'
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records', {
method: 'POST',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
maintenance_type: 'restoration',
title: 'Re-plating',
performed_on: '2026-03-12',
performed_by: 'Scranton Trophy and Engraving',
cost: 40,
currency: 'usd',
condition_before_id: 'd4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62',
condition_after_id: '6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53',
next_due_on: '2027-03-12',
description: 'The gold finish had worn through on the base. Michael wants it ready for the next Dundies.',
}),
})
const data = await response.json()
$response = Http::withToken($token)->post('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records', [
'maintenance_type' => 'restoration',
'title' => 'Re-plating',
'performed_on' => '2026-03-12',
'performed_by' => 'Scranton Trophy and Engraving',
'cost' => 40,
'currency' => 'usd',
'condition_before_id' => 'd4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62',
'condition_after_id' => '6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53',
'next_due_on' => '2027-03-12',
'description' => 'The gold finish had worn through on the base. Michael wants it ready for the next Dundies.',
]);
Response 201
{
"data": {
"type": "possession_maintenance_record",
"id": "3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
"attributes": {
"maintenance_type": "restoration",
"title": "Re-plating",
"performed_by": "Scranton Trophy and Engraving",
"performed_on": "2026-03-12",
"cost": "40.00",
"currency": "usd",
"condition_before": {
"id": "d4a91f3e-6b27-4c58-8e0d-1f5a7c3b9e62",
"name": "Worn"
},
"condition_after": {
"id": "6e2c8b47-1a95-4d3f-b706-9c4e2f1a8d53",
"name": "Like new"
},
"next_due_on": "2027-03-12",
"is_overdue": false,
"description": "The gold finish had worn through on the base. Michael wants it ready for the next Dundies.",
"created_at": 1773331200,
"updated_at": 1773331200
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance-records/3f8b1d62-7a4c-4e95-b2d0-6c1e9a5f7b38",
"web": "https://my.monicahq.com/vaults/dunder-mifflin/possessions/9c4e2a71-5b38-4f06-8d1e-2a7f3c6b9e15/maintenance"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.