The Finance Book 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.

finance_book_name string
The Finance Book object 
{
  "id": "finance-book_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "finance_book_name": "finance_book_name_example"
}
GET /api/accounts/finance-book/{id}

Retrieve a finance book

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

Path parameters

id string required

The identifier of the finance book to retrieve.

Returns

Returns the finance book object if a valid identifier was provided.

GET /api/accounts/finance-book/{id} 
curl https://api.overplane.dev/api/accounts/finance-book/finance-book_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "finance-book_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "finance_book_name": "finance_book_name_example"
}
GET /api/accounts/finance-book

List all finance books

Returns a list of finance books. 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 finance book objects.

GET /api/accounts/finance-book 
curl https://api.overplane.dev/api/accounts/finance-book \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "finance-book_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "finance_book_name": "finance_book_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/finance-book

Create a finance book

Creates a new finance book object.

Body parameters

finance_book_name string

Returns

Returns the newly created finance book object if the call succeeded.

POST /api/accounts/finance-book 
curl https://api.overplane.dev/api/accounts/finance-book \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "finance-book_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "finance_book_name": "finance_book_name_example"
}
PATCH /api/accounts/finance-book/{id}

Update a finance book

Updates the specified finance book 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 finance book to update.

Body parameters

finance_book_name string

Returns

Returns the updated finance book object.

PATCH /api/accounts/finance-book/{id} 
curl https://api.overplane.dev/api/accounts/finance-book/finance-book_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"finance_book_name":"finance_book_name_example"}'
Response 
{
  "id": "finance-book_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "finance_book_name": "finance_book_name_example"
}
DELETE /api/accounts/finance-book/{id}

Delete a finance book

Permanently deletes a finance book. This cannot be undone.

Path parameters

id string required

The identifier of the finance book to delete.

Returns

Returns a confirmation that the finance book has been deleted.

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