The Accounting Dimension Filter 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.

accounting_dimension string required
allow_or_restrict string required
disabled boolean

Default: false

company string required
apply_restriction_on_values boolean

Default: true

fieldname string
The Accounting Dimension Filter object 
{
  "id": "accounting-dimension-filter_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "accounting_dimension": "accounting_dimension_example",
  "allow_or_restrict": "allow_or_restrict_example",
  "disabled": false,
  "company": "Example Corp",
  "apply_restriction_on_values": true,
  "fieldname": "fieldname_example"
}
GET /api/accounts/accounting-dimension-filter/{id}

Retrieve a accounting dimension filter

Retrieves the details of an existing accounting dimension filter. Supply the unique accounting dimension filter ID that was returned from a previous request.

Path parameters

id string required

The identifier of the accounting dimension filter to retrieve.

Returns

Returns the accounting dimension filter object if a valid identifier was provided.

GET /api/accounts/accounting-dimension-filter/{id} 
curl https://api.overplane.dev/api/accounts/accounting-dimension-filter/accounting-dimension-filter_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "accounting-dimension-filter_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "accounting_dimension": "accounting_dimension_example",
  "allow_or_restrict": "allow_or_restrict_example",
  "disabled": false,
  "company": "Example Corp",
  "apply_restriction_on_values": true,
  "fieldname": "fieldname_example"
}
GET /api/accounts/accounting-dimension-filter

List all accounting dimension filters

Returns a list of accounting dimension filters. 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 accounting dimension filter objects.

GET /api/accounts/accounting-dimension-filter 
curl https://api.overplane.dev/api/accounts/accounting-dimension-filter \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "accounting-dimension-filter_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "accounting_dimension": "accounting_dimension_example",
      "allow_or_restrict": "allow_or_restrict_example",
      "disabled": false,
      "company": "Example Corp",
      "apply_restriction_on_values": true,
      "fieldname": "fieldname_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/accounting-dimension-filter

Create a accounting dimension filter

Creates a new accounting dimension filter object.

Body parameters

accounting_dimension string required
allow_or_restrict string required
disabled boolean

Default: false

company string required
apply_restriction_on_values boolean

Default: true

fieldname string

Returns

Returns the newly created accounting dimension filter object if the call succeeded.

POST /api/accounts/accounting-dimension-filter 
curl https://api.overplane.dev/api/accounts/accounting-dimension-filter \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"accounting_dimension":"accounting_dimension_example","allow_or_restrict":"allow_or_restrict_example","company":"Example Corp"}'
Response 
{
  "id": "accounting-dimension-filter_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "accounting_dimension": "accounting_dimension_example",
  "allow_or_restrict": "allow_or_restrict_example",
  "disabled": false,
  "company": "Example Corp",
  "apply_restriction_on_values": true,
  "fieldname": "fieldname_example"
}
PATCH /api/accounts/accounting-dimension-filter/{id}

Update a accounting dimension filter

Updates the specified accounting dimension filter 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 accounting dimension filter to update.

Body parameters

accounting_dimension string
allow_or_restrict string
disabled boolean

Default: false

company string
apply_restriction_on_values boolean

Default: true

fieldname string

Returns

Returns the updated accounting dimension filter object.

PATCH /api/accounts/accounting-dimension-filter/{id} 
curl https://api.overplane.dev/api/accounts/accounting-dimension-filter/accounting-dimension-filter_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"accounting_dimension":"accounting_dimension_example","allow_or_restrict":"allow_or_restrict_example"}'
Response 
{
  "id": "accounting-dimension-filter_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "accounting_dimension": "accounting_dimension_example",
  "allow_or_restrict": "allow_or_restrict_example",
  "disabled": false,
  "company": "Example Corp",
  "apply_restriction_on_values": true,
  "fieldname": "fieldname_example"
}
DELETE /api/accounts/accounting-dimension-filter/{id}

Delete a accounting dimension filter

Permanently deletes a accounting dimension filter. This cannot be undone.

Path parameters

id string required

The identifier of the accounting dimension filter to delete.

Returns

Returns a confirmation that the accounting dimension filter has been deleted.

DELETE /api/accounts/accounting-dimension-filter/{id} 
curl https://api.overplane.dev/api/accounts/accounting-dimension-filter/accounting-dimension-filter_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "accounting-dimension-filter_abc123",
  "deleted": true
}

Line items

Child objects that belong to this accounting dimension filter. These are accessed via the parent's ID.

Allowed Dimension

Attributes

idx integer
accounting_dimension_filter_id string required
accounting_dimension string
dimension_value string

Endpoints

GET /api/accounts/allowed-dimension?parent_id={id}
POST /api/accounts/allowed-dimension
PATCH /api/accounts/allowed-dimension/{id}
DELETE /api/accounts/allowed-dimension/{id}
POST /api/accounts/allowed-dimension/reorder
Allowed Dimension object 
{
  "id": "allowed-dimension_abc123",
  "idx": 1,
  "accounting_dimension_filter_id": "accounting_dimension_filter_id_example",
  "accounting_dimension": "accounting_dimension_example",
  "dimension_value": "dimension_value_example"
}

Applicable On Account

Attributes

idx integer
accounting_dimension_filter_id string required
applicable_on_account string required
is_mandatory boolean

Endpoints

GET /api/accounts/applicable-on-account?parent_id={id}
POST /api/accounts/applicable-on-account
PATCH /api/accounts/applicable-on-account/{id}
DELETE /api/accounts/applicable-on-account/{id}
POST /api/accounts/applicable-on-account/reorder
Applicable On Account object 
{
  "id": "applicable-on-account_abc123",
  "idx": 1,
  "accounting_dimension_filter_id": "accounting_dimension_filter_id_example",
  "applicable_on_account": "applicable_on_account_example",
  "is_mandatory": false
}