> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.useopenwrench.com/llms.txt > Use this file to discover all available pages before exploring further. # Create an asset > Creates an asset. buyerFacilityId/buyerCompanyId are derived from the location (never from the body). refrigerantTypeCode, fullChargeLb, applianceCategory and refrigerantRequiresProcessShutdown are CLEARABLE per-unit overrides of the asset type's defaults: omitting the key keeps the stored value, an explicit null (or blank string) clears it back to inheriting from the type. fullChargeLb must be positive; applianceCategory and refrigerantTypeCode are validated. A parentId requires sub-assets enabled for the company and the same location as the parent. ## OpenAPI ````yaml /openapi/buyer.json post /v1/buyer/asset/assets openapi: 3.1.0 info: title: OpenWrench Buyer API version: 1.0.0 description: >- External REST API for OpenWrench buyers (facilities-management side). Generated from the application source (Play routes, controllers and models). ## Authentication Every request must carry a buyer API key in the `X-API-KEY` header. The key resolves to a buyer contact, and all reads/writes are tenant-scoped to that contact's buyer company (plus, on several endpoints, role-based location/brand restrictions). Endpoints under `/v1/buyer/super_admin/...` (and a few others noted per-operation) additionally require the key's contact to be a buyer super admin. ## Rate limiting 10 requests per 20-second window per API key; requests beyond that receive **429**. A handful of operations noted per-operation bypass the rate limiter. ## Response envelope Single-entity responses: `{ "type": "", "data": { ... }, "status": "ok" }`. List responses: `{ "type": "", "data": [ ... ], "count": , "status": "ok" }`. count_by responses: `{ "type": "CountBy", "data": , "status": "ok" }`. Errors: `{ "message": "...", "type": "", "status": "error", "traceId": "..." }` — 401 missing/invalid key, 400 bad input, 404 not found, 429 rate limit. ## Pagination & filtering List endpoints accept `offset`, `limit` (default 10, max 25 — the locations list clamps to 10), `sort_by` and `order` (asc|desc). Every other query parameter is treated as a filter and matched against the entity's indexed columns (multi-value filters are comma-separated strings); these are combined with the tenant-security filters derived from the API key. Timestamps are ISO 8601 strings unless noted otherwise. ## Date formats Date-time fields serialize as strings in one of two shapes depending on the underlying type: ISO 8601 with offset (e.g. `2026-08-14T13:05:22.000-07:00`) for most timestamps, or `yyyy-MM-dd HH:mm:ss.S` (space-separated, no offset) for database timestamp fields. Plain dates are `yyyy-MM-dd`. When sending date-times, ISO 8601 is accepted. ## Required headers Every request must carry BOTH `X-API-KEY` (your API key) and `OW-KEY` (the OpenWrench shared secret issued with it). Requests missing either return 401. servers: - url: https://api.useopenwrench.com/api/external security: - ApiKeyAuth: [] OwKeyAuth: [] tags: - name: Ping - name: Me - name: Locations - name: Regions - name: Asset Types - name: Asset Meters - name: Assets - name: Asset Labels description: Read the asset label catalog and replace the labels applied to an asset. - name: Asset Models - name: Work Orders - name: Work Order Notes - name: Work Order Labels description: >- Read your work order label catalog and replace the labels applied to a work order. - name: Service Calls - name: Site Survey Walkthroughs - name: Invoices - name: Proposals - name: Files - name: Planned Maintenance - name: Currency Exchange - name: Supplier Network - name: User Provisioning paths: /v1/buyer/asset/assets: post: tags: - Assets summary: Create an asset description: >- Creates an asset. buyerFacilityId/buyerCompanyId are derived from the location (never from the body). refrigerantTypeCode, fullChargeLb, applianceCategory and refrigerantRequiresProcessShutdown are CLEARABLE per-unit overrides of the asset type's defaults: omitting the key keeps the stored value, an explicit null (or blank string) clears it back to inheriting from the type. fullChargeLb must be positive; applianceCategory and refrigerantTypeCode are validated. A parentId requires sub-assets enabled for the company and the same location as the parent. operationId: createAsset requestBody: required: true content: application/json: schema: type: object properties: id: type: - integer - 'null' description: Present only when upserting an existing asset. name: type: string assetTypeId: type: integer locationId: type: integer isActive: type: boolean isLeased: type: boolean assetUUID: type: - string - 'null' assetNumber: type: - string - 'null' description: type: - string - 'null' images: type: - array - 'null' items: type: string attachments: type: - array - 'null' items: $ref: '#/components/schemas/FileDetails' qrCodeImages: type: - array - 'null' items: $ref: '#/components/schemas/FileDetails' serialNumberImages: type: - array - 'null' items: $ref: '#/components/schemas/FileDetails' manufacturer: type: - string - 'null' upcNumber: type: - string - 'null' modelNumber: type: - string - 'null' serialNumber: type: - string - 'null' assetModelId: type: - integer - 'null' assetTypeDetails: type: - array - 'null' items: $ref: '#/components/schemas/FieldTypeDetails' areaId: type: - integer - 'null' brand: type: - string - 'null' installDate: type: - string - 'null' format: date-time purchaseDate: type: - string - 'null' format: date-time leaseStartDate: type: - string - 'null' format: date-time leaseEndDate: type: - string - 'null' format: date-time warrantyIds: type: - array - 'null' items: type: integer partWarrantyId: type: - integer - 'null' lifeExpectancyInMonths: type: - integer - 'null' originalPrice: type: - number - 'null' capitalisedCost: type: - number - 'null' isReplacementEquipment: type: - boolean - 'null' replacementEquipmentTypeId: type: - integer - 'null' lastTaggedAt: type: - string - 'null' format: date-time assetTags: type: - array - 'null' items: type: string parentId: type: - integer - 'null' description: >- Parent asset id (sub-asset). Must not equal the asset's own id. checkInNotes: type: - object - 'null' properties: imageRequired: type: boolean notes: type: array items: type: string required: - imageRequired - notes checkOutNotes: type: - object - 'null' properties: imageRequired: type: boolean notes: type: array items: type: string required: - imageRequired - notes availabilityStatus: type: - string - 'null' description: Defaults to "available". downtimeStatus: type: - string - 'null' description: Defaults to "online". additionalAssetDetails: anyOf: - $ref: '#/components/schemas/AdditionalAssetDetails' - type: 'null' partsVendorId: type: - integer - 'null' vendorId: type: - integer - 'null' externalSpend: type: - number - 'null' userOverrideReplacementRecommendation: type: - string - 'null' userOverrideReplacementRecommendationNotes: type: - string - 'null' isRefrigerantTracked: type: - boolean - 'null' description: >- Omitted or null keeps the stored value; enrolment is turned off only by an explicit false. refrigerantTypeCode: type: - string - 'null' fullChargeLb: type: - number - 'null' applianceCategory: type: - string - 'null' refrigerantRequiresProcessShutdown: type: - boolean - 'null' required: - name - assetTypeId - locationId - isActive - isLeased responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/AssetResponse' '400': description: >- Bad input, parse failure, or the API key's contact could not be resolved. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid X-API-KEY. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded (10 requests per 20-second window per key). content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: FileDetails: type: object properties: fileName: type: string description: Original file name (non-ASCII characters stripped on upload). fileId: type: string description: Opaque file identifier used for later download. required: - fileName - fileId description: 'File reference: name plus storage identifier.' FieldTypeDetails: type: object properties: key: type: string valueAsString: type: string valueType: type: string required: - key - valueAsString - valueType AdditionalAssetDetails: type: object properties: energyEfficiencyDetails: type: - string - 'null' capacityDetails: type: - string - 'null' hasLeakDetector: type: - boolean - 'null' usesRefrigerant: type: - boolean - 'null' refrigerantDetails: type: - string - 'null' AssetResponse: type: object properties: type: type: string description: Entity type marker, e.g. "Asset". data: $ref: '#/components/schemas/Asset' status: type: string enum: - ok required: - type - data - status Error: type: object properties: message: type: string type: type: string description: >- Exception type, e.g. unauthorizedException, NotFoundException, BadRequestException, ParseException, InvalidInputDataException, ConflictException, UnexpectedException. status: type: string enum: - error traceId: type: string description: >- Trace id (a random 11-char alphanumeric string when no explicit trace applies). required: - message - type - status - traceId description: >- Standard error envelope. 401 = missing/invalid API key, 400 = bad input, 404 = not found, 429 = rate limit exceeded. Asset: type: object properties: id: type: - integer - 'null' buyerSpecificAssetId: type: - string - 'null' assetUUID: type: - string - 'null' isUserAssignedUUID: type: boolean assetNumber: type: - string - 'null' name: type: string description: type: - string - 'null' images: type: array items: type: string attachments: type: array items: $ref: '#/components/schemas/FileDetails' manufacturer: type: - string - 'null' upcNumber: type: - string - 'null' modelNumber: type: - string - 'null' serialNumber: type: - string - 'null' assetTypeId: type: integer assetType: anyOf: - $ref: '#/components/schemas/AssetType' - type: 'null' assetModelId: type: - integer - 'null' assetModel: anyOf: - $ref: '#/components/schemas/AssetModel' - type: 'null' assetTypeDetails: type: array items: $ref: '#/components/schemas/FieldTypeDetails' locationId: type: integer location: anyOf: - $ref: '#/components/schemas/Location' - type: 'null' areaId: type: - integer - 'null' brand: type: - string - 'null' installDate: type: - string - 'null' format: date-time purchaseDate: type: - string - 'null' format: date-time isActive: type: boolean isLeased: type: boolean leaseStartDate: type: - string - 'null' format: date-time leaseEndDate: type: - string - 'null' format: date-time warrantyIds: type: array items: type: integer lifeExpectancyInMonths: type: - integer - 'null' originalPrice: type: - number - 'null' capitalisedCost: type: - number - 'null' assetTags: type: array items: type: string parentId: type: - integer - 'null' availabilityStatus: type: - string - 'null' downtimeStatus: type: - string - 'null' enum: - online - offline additionalAssetDetails: anyOf: - $ref: '#/components/schemas/AdditionalAssetDetails' - type: 'null' daysInUse: type: - integer - 'null' isRefrigerantTracked: type: boolean refrigerantTypeCode: type: - string - 'null' fullChargeLb: type: - number - 'null' applianceCategory: type: - string - 'null' buyerFacilityId: type: integer buyerCompanyId: type: integer subAssetCount: type: - integer - 'null' totalWOCount: type: - integer - 'null' totalNotClosedWOCount: type: - integer - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - assetTypeId - locationId - isUserAssignedUUID - isActive - isLeased - isRefrigerantTracked - buyerFacilityId - buyerCompanyId - isDeleted additionalProperties: true description: >- Asset. ABRIDGED: the full case class carries further fields (warranties, depreciation, spend rollups, meters, refrigerant retrofit plan, equipment/purchase-order links, etc.) that may appear in responses. AssetType: type: object properties: id: type: - integer - 'null' name: type: string primarySpendCategory: type: - integer - 'null' attachments: type: array items: $ref: '#/components/schemas/FileDetails' allProblemTypeIds: type: array items: type: integer allProblemTypeIdsAsString: type: string allProblemTypes: type: - array - 'null' items: $ref: '#/components/schemas/ProblemType' allProblemTypesName: type: - string - 'null' allSpendCategories: type: array items: type: integer depreciationClassId: type: - integer - 'null' depreciationClassName: type: - string - 'null' requiredFields: type: array items: $ref: '#/components/schemas/FieldType' optionalFields: type: array items: $ref: '#/components/schemas/FieldType' replaceMarkupOnOriginalCost: type: - number - 'null' replacementThreshold: type: - number - 'null' usesRefrigerant: type: boolean applianceCategory: type: - string - 'null' refrigerantTypeCode: type: - string - 'null' fullChargeLb: type: - number - 'null' buyerCompanyId: type: integer createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - buyerCompanyId - usesRefrigerant - isDeleted additionalProperties: true AssetModel: type: object properties: id: type: - integer - 'null' modelName: type: string manuals: type: array items: $ref: '#/components/schemas/FileDetails' specs: type: array items: $ref: '#/components/schemas/AssetSpec' assetTypeId: type: integer assetType: anyOf: - $ref: '#/components/schemas/AssetType' - type: 'null' buyerCompanyId: type: integer createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - modelName - assetTypeId - buyerCompanyId - isDeleted Location: type: object properties: id: type: - integer - 'null' storeId: type: - string - 'null' name: type: string brandId: type: - integer - 'null' brandAssetGroupId: type: - integer - 'null' allAssetCount: type: - integer - 'null' description: type: - string - 'null' isActive: type: boolean openDate: type: - string - 'null' format: date-time closeDate: type: - string - 'null' format: date-time operatingHours: anyOf: - $ref: '#/components/schemas/OperatingHours' - type: 'null' phoneNumber: type: - string - 'null' locationTypeId: type: integer locationTypeDetails: type: array items: $ref: '#/components/schemas/FieldTypeDetails' notes: type: - string - 'null' notesNonFormatted: type: - string - 'null' internalNotes: type: - string - 'null' images: type: array items: type: string internalAttachments: type: array items: $ref: '#/components/schemas/FileDetails' primaryContactsEmails: type: array items: type: string facilityInChargeEmails: type: array items: type: string sendApprovedInvoicesToEmails: type: array items: type: string sendApprovedQuotesToEmails: type: array items: type: string storeAssociateEmails: type: array items: type: string fieldTechEmails: type: array items: type: string timeZoneId: type: - string - 'null' hasPresetAssetUUID: type: - boolean - 'null' regionId: type: - integer - 'null' region: anyOf: - $ref: '#/components/schemas/Region' - type: 'null' purchaseOrderPrefix: type: - string - 'null' isLeased: type: - boolean - 'null' leaseStartDate: type: - string - 'null' format: date-time leaseEndDate: type: - string - 'null' format: date-time taxRate: type: - string - 'null' customFieldDetails: type: - array - 'null' items: $ref: '#/components/schemas/FieldTypeDetails' buildingWarrantyStartDate: type: - string - 'null' format: date-time buildingWarrantyExpirationDate: type: - string - 'null' format: date-time buildingWarrantyProblemTypeIds: type: - array - 'null' items: type: integer buildingWarrantyServiceProviderId: type: - integer - 'null' invoicesBillTo: anyOf: - $ref: '#/components/schemas/InvoicesBillTo' - type: 'null' countryCode: type: - string - 'null' buyerFacilityId: type: integer buyerCompanyId: type: integer totalWOCount: type: - integer - 'null' totalNotClosedWOCount: type: - integer - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - isActive - locationTypeId - buyerFacilityId - buyerCompanyId - isDeleted additionalProperties: true description: >- Location. Abridged: hydrated contact/settings arrays and brand/facility/company objects may also appear in responses. ProblemType: type: object properties: id: type: - integer - 'null' name: type: string additionalProperties: true description: >- Work order problem type. Abridged: full model not in the provided sources. FieldType: type: object properties: {} additionalProperties: true description: >- Field type definition for asset type required/optional fields. Shape abridged (model not in provided sources). AssetSpec: type: object properties: key: type: string value: type: - string - 'null' required: - key OperatingHours: type: object properties: timeZoneId: type: - string - 'null' timeZoneName: type: - string - 'null' Monday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Tuesday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Wednesday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Thursday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Friday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Saturday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Sunday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Region: type: object properties: id: type: - integer - 'null' name: type: string buyerCompanyId: type: integer hierarchyName: type: - string - 'null' parentId: type: - integer - 'null' hasChildren: type: boolean createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - buyerCompanyId - hasChildren - isDeleted InvoicesBillTo: type: object properties: billTo: type: string serviceAddress: type: object properties: {} additionalProperties: true required: - billTo - serviceAddress Timings: type: object properties: {} additionalProperties: true description: Opening/closing timings for one weekday. Shape abridged. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY OwKeyAuth: type: apiKey in: header name: OW-KEY description: >- OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key. ````