The Fiscal Year 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.

year string required
disabled boolean

Default: false

year_start_date string required
year_end_date string required
auto_created boolean

Default: false

is_short_year boolean

Default: false

The Fiscal Year object 
{
  "id": "fiscal-year_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "year": "year_example",
  "disabled": false,
  "year_start_date": "2024-01-15",
  "year_end_date": "2024-01-15",
  "auto_created": false,
  "is_short_year": false
}
GET /api/accounts/fiscal-year/{id}

Retrieve a fiscal year

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

Path parameters

id string required

The identifier of the fiscal year to retrieve.

Returns

Returns the fiscal year object if a valid identifier was provided.

GET /api/accounts/fiscal-year/{id} 
curl https://api.overplane.dev/api/accounts/fiscal-year/fiscal-year_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "fiscal-year_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "year": "year_example",
  "disabled": false,
  "year_start_date": "2024-01-15",
  "year_end_date": "2024-01-15",
  "auto_created": false,
  "is_short_year": false
}
GET /api/accounts/fiscal-year

List all fiscal years

Returns a list of fiscal years. 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 fiscal year objects.

GET /api/accounts/fiscal-year 
curl https://api.overplane.dev/api/accounts/fiscal-year \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "fiscal-year_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "year": "year_example",
      "disabled": false,
      "year_start_date": "2024-01-15",
      "year_end_date": "2024-01-15",
      "auto_created": false,
      "is_short_year": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/fiscal-year

Create a fiscal year

Creates a new fiscal year object.

Body parameters

year string required
disabled boolean

Default: false

year_start_date string required
year_end_date string required
auto_created boolean

Default: false

is_short_year boolean

Default: false

Returns

Returns the newly created fiscal year object if the call succeeded.

POST /api/accounts/fiscal-year 
curl https://api.overplane.dev/api/accounts/fiscal-year \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"year":"year_example","year_start_date":"2024-01-15","year_end_date":"2024-01-15"}'
Response 
{
  "id": "fiscal-year_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "year": "year_example",
  "disabled": false,
  "year_start_date": "2024-01-15",
  "year_end_date": "2024-01-15",
  "auto_created": false,
  "is_short_year": false
}
PATCH /api/accounts/fiscal-year/{id}

Update a fiscal year

Updates the specified fiscal year 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 fiscal year to update.

Body parameters

year string
disabled boolean

Default: false

year_start_date string
year_end_date string
auto_created boolean

Default: false

is_short_year boolean

Default: false

Returns

Returns the updated fiscal year object.

PATCH /api/accounts/fiscal-year/{id} 
curl https://api.overplane.dev/api/accounts/fiscal-year/fiscal-year_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"year":"year_example","disabled":false}'
Response 
{
  "id": "fiscal-year_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "year": "year_example",
  "disabled": false,
  "year_start_date": "2024-01-15",
  "year_end_date": "2024-01-15",
  "auto_created": false,
  "is_short_year": false
}
DELETE /api/accounts/fiscal-year/{id}

Delete a fiscal year

Permanently deletes a fiscal year. This cannot be undone.

Path parameters

id string required

The identifier of the fiscal year to delete.

Returns

Returns a confirmation that the fiscal year has been deleted.

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

Line items

Child objects that belong to this fiscal year. These are accessed via the parent's ID.

Fiscal Year Company

Attributes

idx integer
fiscal_year_id string required
company string required

Endpoints

GET /api/accounts/fiscal-year-company?parent_id={id}
POST /api/accounts/fiscal-year-company
PATCH /api/accounts/fiscal-year-company/{id}
DELETE /api/accounts/fiscal-year-company/{id}
POST /api/accounts/fiscal-year-company/reorder
Fiscal Year Company object 
{
  "id": "fiscal-year-company_abc123",
  "idx": 1,
  "fiscal_year_id": "fiscal_year_id_example",
  "company": "Example Corp"
}