The UOM Conversion Factor object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

category string required
from_uom string required
to_uom string required
value number required
The UOM Conversion Factor object 
{
  "id": "u-o-m-conversion-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "category": "category_example",
  "from_uom": "from_uom_example",
  "to_uom": "to_uom_example",
  "value": 0
}
GET /api/setup/u-o-m-conversion-factor/{id}

Retrieve a uom conversion factor

Retrieves the details of an existing uom conversion factor. Supply the unique uom conversion factor ID that was returned from a previous request.

Path parameters

id string required

The identifier of the uom conversion factor to retrieve.

Returns

Returns the uom conversion factor object if a valid identifier was provided.

GET /api/setup/u-o-m-conversion-factor/{id} 
curl https://api.overplane.dev/api/setup/u-o-m-conversion-factor/u-o-m-conversion-factor_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "u-o-m-conversion-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "category": "category_example",
  "from_uom": "from_uom_example",
  "to_uom": "to_uom_example",
  "value": 0
}
GET /api/setup/u-o-m-conversion-factor

List all uom conversion factors

Returns a list of uom conversion factors. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of uom conversion factor objects.

GET /api/setup/u-o-m-conversion-factor 
curl https://api.overplane.dev/api/setup/u-o-m-conversion-factor \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "u-o-m-conversion-factor_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "category": "category_example",
      "from_uom": "from_uom_example",
      "to_uom": "to_uom_example",
      "value": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/u-o-m-conversion-factor

Create a uom conversion factor

Creates a new uom conversion factor object.

Body parameters

category string required
from_uom string required
to_uom string required
value number required

Returns

Returns the newly created uom conversion factor object if the call succeeded.

POST /api/setup/u-o-m-conversion-factor 
curl https://api.overplane.dev/api/setup/u-o-m-conversion-factor \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"category":"category_example","from_uom":"from_uom_example","to_uom":"to_uom_example","value":0}'
Response 
{
  "id": "u-o-m-conversion-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "category": "category_example",
  "from_uom": "from_uom_example",
  "to_uom": "to_uom_example",
  "value": 0
}
PATCH /api/setup/u-o-m-conversion-factor/{id}

Update a uom conversion factor

Updates the specified uom conversion factor by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the uom conversion factor to update.

Body parameters

category string
from_uom string
to_uom string
value number

Returns

Returns the updated uom conversion factor object.

PATCH /api/setup/u-o-m-conversion-factor/{id} 
curl https://api.overplane.dev/api/setup/u-o-m-conversion-factor/u-o-m-conversion-factor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"category":"category_example","from_uom":"from_uom_example"}'
Response 
{
  "id": "u-o-m-conversion-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "category": "category_example",
  "from_uom": "from_uom_example",
  "to_uom": "to_uom_example",
  "value": 0
}
DELETE /api/setup/u-o-m-conversion-factor/{id}

Delete a uom conversion factor

Permanently deletes a uom conversion factor. This cannot be undone.

Path parameters

id string required

The identifier of the uom conversion factor to delete.

Returns

Returns a confirmation that the uom conversion factor has been deleted.

DELETE /api/setup/u-o-m-conversion-factor/{id} 
curl https://api.overplane.dev/api/setup/u-o-m-conversion-factor/u-o-m-conversion-factor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "u-o-m-conversion-factor_abc123",
  "deleted": true
}