The Account Category 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.

account_category_name string required
description string
The Account Category object 
{
  "id": "account-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_category_name": "account_category_name_example",
  "description": "description_example"
}
GET /api/accounts/account-category/{id}

Retrieve a account category

Retrieves the details of an existing account category. Supply the unique account category ID that was returned from a previous request.

Path parameters

id string required

The identifier of the account category to retrieve.

Returns

Returns the account category object if a valid identifier was provided.

GET /api/accounts/account-category/{id} 
curl https://api.overplane.dev/api/accounts/account-category/account-category_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "account-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_category_name": "account_category_name_example",
  "description": "description_example"
}
GET /api/accounts/account-category

List all account categorys

Returns a list of account categorys. 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 account category objects.

GET /api/accounts/account-category 
curl https://api.overplane.dev/api/accounts/account-category \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "account-category_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "account_category_name": "account_category_name_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/account-category

Create a account category

Creates a new account category object.

Body parameters

account_category_name string required
description string

Returns

Returns the newly created account category object if the call succeeded.

POST /api/accounts/account-category 
curl https://api.overplane.dev/api/accounts/account-category \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"account_category_name":"account_category_name_example"}'
Response 
{
  "id": "account-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_category_name": "account_category_name_example",
  "description": "description_example"
}
PATCH /api/accounts/account-category/{id}

Update a account category

Updates the specified account category 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 account category to update.

Body parameters

account_category_name string
description string

Returns

Returns the updated account category object.

PATCH /api/accounts/account-category/{id} 
curl https://api.overplane.dev/api/accounts/account-category/account-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"account_category_name":"account_category_name_example","description":"description_example"}'
Response 
{
  "id": "account-category_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "account_category_name": "account_category_name_example",
  "description": "description_example"
}
DELETE /api/accounts/account-category/{id}

Delete a account category

Permanently deletes a account category. This cannot be undone.

Path parameters

id string required

The identifier of the account category to delete.

Returns

Returns a confirmation that the account category has been deleted.

DELETE /api/accounts/account-category/{id} 
curl https://api.overplane.dev/api/accounts/account-category/account-category_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "account-category_abc123",
  "deleted": true
}