REST API
Fixed Assets API
Generated from the Celerp 2.9.0 OpenAPI schema, 11 November 2026 .
GET /fixed-assets/api/assetsList Assets
Parameters Name In Required Type Description class_idquery -- string, optional Keeps only assets in this asset class. qquery -- string, optional Search text used to filter matching assets. limitquery -- integer Number of assets in each page, from 1 to 500. The default is 50. offsetquery -- integer Number of rows to skip before the page starts. The default is 0.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assetsCreate Asset
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}Get Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id \
-H "Authorization: Bearer $TOKEN"PATCH /fixed-assets/api/assets/{asset_id}Update Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/assets/:asset_id \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/addAdd To Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/add \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/componentsList Components
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/components \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/correctCorrect
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/correct \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/correct-fieldsCorrect Fields
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/correct-fields \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/correctionsRequest Correction
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/corrections \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/disposeDispose Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/dispose \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/filesList Files
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/files \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/filesUpload File
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/files \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/assets/{asset_id}/files/{file_id}Download File
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. file_idpath yes string Identifier of the file held on the asset.
Responses Status Description Body 200Successful Response -- 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/files/:file_id \
-H "Authorization: Bearer $TOKEN"DELETE /fixed-assets/api/assets/{asset_id}/files/{file_id}Delete File
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. file_idpath yes string Identifier of the file to remove.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X DELETE http://localhost:8000/fixed-assets/api/assets/:asset_id/files/:file_id \
-H "Authorization: Bearer $TOKEN"PATCH /fixed-assets/api/assets/{asset_id}/files/{file_id}/descriptionDescribe File
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. file_idpath yes string Identifier of the file to describe.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/assets/:asset_id/files/:file_id/description \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/files/{file_id}/tagTag File
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. file_idpath yes string Identifier of the file to tag.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/files/:file_id/tag \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/financial-detailsFinancial Details
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/financial-details \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/impairImpair
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/impair \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/maintenanceCreate Entry
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/maintenance \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/moveMove Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/move \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/movementsList Movements
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. limitquery -- integer Number of movements in each page, from 1 to 500. The default is 50. offsetquery -- integer Number of rows to skip before the page starts. The default is 0.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/movements \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/place-in-servicePlace In Service
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/place-in-service \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/readingsRecord Reading
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/readings \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/reclassifyReclassify Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/reclassify \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/remindersCreate Reminder
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/reminders \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/revalueRevalue
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/revalue \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/reverse-impairmentReverse Impairment
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/reverse-impairment \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/reviewsList Reviews
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/reviews \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/reviewsRecord Review
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/reviews \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/reviews/{review_id}/withdrawWithdraw Review
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. review_idpath yes string Identifier of the review to withdraw.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/reviews/:review_id/withdraw \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/assets/{asset_id}/saleGet Sale
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/sale \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/sale/{action}Change Sale
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. actionpath yes string Change to make to the sale: credit, reissue, or cancel. Any other value returns 404.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/sale/:action \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/sellSell Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/sell \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/skipSkip Month
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/skip \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'DELETE /fixed-assets/api/assets/{asset_id}/skip/{month}Withdraw Skip
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. monthpath yes string Month whose skip is withdrawn, as YYYY-MM, such as 2026-09.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X DELETE http://localhost:8000/fixed-assets/api/assets/:asset_id/skip/:month \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/assets/{asset_id}/transferTransfer Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/transfer \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/undoUndo Asset
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/undo-disposalUndo Disposal
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/undo-disposal \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/undo-latestUndo Latest
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/undo-latest \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/assets/{asset_id}/undo-moveUndo Move
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/assets/:asset_id/undo-move \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/assets/{asset_id}/upkeepGet Upkeep
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/assets/:asset_id/upkeep \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/attentionAttention
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/attention \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/checksList Checks
The standing checks, each with the asset's name as it reads now.
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/checks \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/checksCreate Check
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/checks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/checks/not-seenReport Not Seen
Parameters Name In Required Type Description sincequery yes string Day to check from, as YYYY-MM-DD. Lists assets with no check on or after this day.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/checks/not-seen \
-H "Authorization: Bearer $TOKEN"DELETE /fixed-assets/api/checks/{check_id}Remove Check
Its author removes a check recorded by mistake, on the day it was recorded.
Parameters Name In Required Type Description check_idpath yes string Identifier of the asset check.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X DELETE http://localhost:8000/fixed-assets/api/checks/:check_id \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/class-tableApply Class Table
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/class-table \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/class-table/{op_key}/undoUndo Class Table
Parameters Name In Required Type Description op_keypath yes string Key of the class table change to undo.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/class-table/:op_key/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/classesList Classes
Parameters Name In Required Type Description include_archivedquery -- boolean Set to true to include archived asset classes. The default is false, which lists only active classes.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/classes \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/classesCreate Class
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'PATCH /fixed-assets/api/classes/{class_id}Update Class
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/classes/:class_id \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/classes/{class_id}/apply-to-assetsApply To Assets
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/apply-to-assets \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/classes/{class_id}/fix-accountFix Account
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/fix-account \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/classes/{class_id}/fix-account/undoUndo Fix Account
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/fix-account/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/classes/{class_id}/revalueRevalue Class
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/revalue \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/classes/{class_id}/valuer-reportAttach Valuer Report
The valuer's report behind a class revaluation, kept on every asset in use in the class.
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/valuer-report \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/classes/{class_id}/valuer-report/removeRemove Valuer Report
Take a valuer's report attached by mistake off every asset it was kept on.
Parameters Name In Required Type Description class_idpath yes string Identifier of the asset class.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/classes/:class_id/valuer-report/remove \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/correctionsList Corrections
Parameters Name In Required Type Description asset_idquery -- string, optional Keeps only corrections for this asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/corrections \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/corrections/{correction_id}Get Correction
Parameters Name In Required Type Description correction_idpath yes string Identifier of the asset correction.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/corrections/:correction_id \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/corrections/{correction_id}/applyApply Correction
Parameters Name In Required Type Description correction_idpath yes string Identifier of the asset correction.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/corrections/:correction_id/apply \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/corrections/{correction_id}/undoUndo Correction
Parameters Name In Required Type Description correction_idpath yes string Identifier of the asset correction.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/corrections/:correction_id/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/corrections/{correction_id}/withdrawWithdraw Correction
Parameters Name In Required Type Description correction_idpath yes string Identifier of the asset correction.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/corrections/:correction_id/withdraw \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/disposeDispose Assets
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/dispose \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/importsList Imports
Parameters Name In Required Type Description limitquery -- integer Number of imports in each page, from 1 to 500. The default is 50. offsetquery -- integer Number of rows to skip before the page starts. The default is 0.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/imports \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/importsImport Register
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/imports \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/imports/{batch_id}Get Import
Parameters Name In Required Type Description batch_idpath yes string Identifier of the asset import. statusquery -- string, optional Keeps only import rows with this status: imported, rejected, or history. Omit it to list every row. limitquery -- integer Number of rows in each page. The default is 100. offsetquery -- integer Number of rows to skip before the page starts. The default is 0.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/imports/:batch_id \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/imports/{batch_id}/rowsImport Rows
Parameters Name In Required Type Description batch_idpath yes string Identifier of the asset import.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/imports/:batch_id/rows \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/imports/{batch_id}/undoUndo Import
Parameters Name In Required Type Description batch_idpath yes string Identifier of the asset import.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/imports/:batch_id/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/intakeIntake
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/intake \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/keep-lineKeep Line
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/keep-line \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/link-depreciationLink Depreciation
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/link-depreciation \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/maintenance/{maint_id}Get Entry
Parameters Name In Required Type Description maint_idpath yes string Identifier of the maintenance record.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/maintenance/:maint_id \
-H "Authorization: Bearer $TOKEN"PATCH /fixed-assets/api/maintenance/{maint_id}Entry Edit
Parameters Name In Required Type Description maint_idpath yes string Identifier of the maintenance record.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/maintenance/:maint_id \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/maintenance/{maint_id}/filesEntry File
Parameters Name In Required Type Description maint_idpath yes string Identifier of the maintenance record.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/maintenance/:maint_id/files \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/maintenance/{maint_id}/removeEntry Remove
Parameters Name In Required Type Description maint_idpath yes string Identifier of the maintenance record.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/maintenance/:maint_id/remove \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/maintenance/{maint_id}/restoreEntry Restore
Parameters Name In Required Type Description maint_idpath yes string Identifier of the maintenance record.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/maintenance/:maint_id/restore \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/mineList Mine
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/mine \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/mine/{asset_id}Get Mine
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/mine/:asset_id \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/mine/{asset_id}/confirmConfirm
The custodian confirms they still hold the asset, today.
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/mine/:asset_id/confirm \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/mine/{asset_id}/files/{file_id}Download Mine
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. file_idpath yes string Identifier of the file held on the asset.
Responses Status Description Body 200Successful Response -- 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/mine/:asset_id/files/:file_id \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/mine/{asset_id}/problemsReport Problem
The custodian reports a problem, with a photo if they have one; the asset's responsible
person is told, or the whole company when no one is responsible.
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/mine/:asset_id/problems \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/moveMove Assets
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/move \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/not-acquisitionNot Acquisition
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/not-acquisition \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/openingGet Opening
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/opening \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/opening/finishFinish Opening
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/opening/finish \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/reconciliationGet Reconciliation
Parameters Name In Required Type Description atquery -- string, optional Date to reconcile at, as YYYY-MM-DD. Defaults to today in the company's time zone. It cannot be earlier than the cutover date.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reconciliation \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/reconciliation/acknowledgeAcknowledge
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/reconciliation/acknowledge \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/registerRegister
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/register \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/remindersList Due
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/reminders \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reminders/{reminder_id}Get Reminder
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reminders/:reminder_id \
-H "Authorization: Bearer $TOKEN"PATCH /fixed-assets/api/reminders/{reminder_id}Reminder Edit
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/reminders/:reminder_id \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/reminders/{reminder_id}/doneReminder Done
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/reminders/:reminder_id/done \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/reminders/{reminder_id}/postponeReminder Postpone
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/reminders/:reminder_id/postpone \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/reminders/{reminder_id}/removeReminder Remove
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/reminders/:reminder_id/remove \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/reminders/{reminder_id}/undoReminder Undo
Parameters Name In Required Type Description reminder_idpath yes string Identifier of the asset reminder.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/reminders/:reminder_id/undo \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/book-taxBook Tax Report
Parameters Name In Required Type Description regimequery yes string Key of the tax regime. It must be one of the regimes the company has chosen. yearquery yes integer Tax year, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/book-tax \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/depreciationDepreciation Report
Parameters Name In Required Type Description date_fromquery yes string First day of the report period, as YYYY-MM-DD. date_toquery yes string Last day of the report period, as YYYY-MM-DD.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/depreciation \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/disposalsDisposals Report
Parameters Name In Required Type Description date_fromquery yes string First day of the report period, as YYYY-MM-DD. date_toquery yes string Last day of the report period, as YYYY-MM-DD.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/disposals \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/prior-period-adjustmentsPrior Period Adjustments
Parameters Name In Required Type Description yearquery yes integer Year the adjustments are reported for, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/prior-period-adjustments \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/scheduleSchedule Report
Parameters Name In Required Type Description date_fromquery yes string First day of the report period, as YYYY-MM-DD. date_toquery yes string Last day of the report period, as YYYY-MM-DD.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/schedule \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reports/statutory/{report_key}Statutory Report
Parameters Name In Required Type Description report_keypath yes string Key of the statutory report. A report that is unavailable to the company returns 404. yearquery yes integer Tax year, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/reports/statutory/:report_key \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/reviewsDue Reviews
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/reviews \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/runsList Runs
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/runs \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/runsRun
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/runs \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/runs/{month}/reverseReverse Run
Parameters Name In Required Type Description monthpath yes string Month of the depreciation run, as YYYY-MM, such as 2026-09.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/runs/:month/reverse \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'PATCH /fixed-assets/api/settingsUpdate Settings
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/settings \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/setupGet Setup
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/setup \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/source-lineSource Line
One source line, waiting or not, with what became of it.
Parameters Name In Required Type Description sourcequery -- string Identifier of the posted source line, in the form `<document or journal id>:<line>`, as listed by the intake route.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/source-line \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/sources/undoUndo Source
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/sources/undo \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/startStart
Responses Status Description Body 200Successful Response object
Example curl -X POST http://localhost:8000/fixed-assets/api/start \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/tax-booksGet Tax Book
Parameters Name In Required Type Description regimequery yes string Key of the tax regime. It must be one of the regimes the company has chosen. yearquery yes integer Tax year, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/tax-books \
-H "Authorization: Bearer $TOKEN"PATCH /fixed-assets/api/tax-books/{asset_id}/{regime}Set Tax Book
Parameters Name In Required Type Description asset_idpath yes string Identifier of the fixed asset. regimepath yes string Key of the tax regime. It must be one of the regimes the company has chosen.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X PATCH http://localhost:8000/fixed-assets/api/tax-books/:asset_id/:regime \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /fixed-assets/api/tax-years/{regime}/{year}/closeClose Tax Year
Parameters Name In Required Type Description regimepath yes string Key of the tax regime. It must be one of the regimes the company has chosen. yearpath yes integer Tax year, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/tax-years/:regime/:year/close \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/tax-years/{regime}/{year}/reopenReopen Tax Year
Parameters Name In Required Type Description regimepath yes string Key of the tax regime. It must be one of the regimes the company has chosen. yearpath yes integer Tax year, as a four-digit year such as 2026.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/tax-years/:regime/:year/reopen \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /fixed-assets/api/transfer-targetsTransfer Targets
Responses Status Description Body 200Successful Response object
Example curl -X GET http://localhost:8000/fixed-assets/api/transfer-targets \
-H "Authorization: Bearer $TOKEN"GET /fixed-assets/api/year-endGet Year End
Parameters Name In Required Type Description yearquery yes integer Year to review, as a four-digit year such as 2026.
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X GET http://localhost:8000/fixed-assets/api/year-end \
-H "Authorization: Bearer $TOKEN"POST /fixed-assets/api/year-end/{year}/marksMark Year End
Parameters Name In Required Type Description yearpath yes integer Year the marks are recorded for, as a four-digit year such as 2026.
Request body object
Responses Status Description Body 200Successful Response object 422Validation Error HTTPValidationError
Example curl -X POST http://localhost:8000/fixed-assets/api/year-end/:year/marks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'