The Journal Entry Template 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.

voucher_type string required
company string required
is_opening string

Default: No

template_title string required
multi_currency boolean

Default: false

The Journal Entry Template object 
{
  "id": "journal-entry-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "is_opening": "No",
  "template_title": "template_title_example",
  "multi_currency": false
}
GET /api/accounts/journal-entry-template/{id}

Retrieve a journal entry template

Retrieves the details of an existing journal entry template. Supply the unique journal entry template ID that was returned from a previous request.

Path parameters

id string required

The identifier of the journal entry template to retrieve.

Returns

Returns the journal entry template object if a valid identifier was provided.

GET /api/accounts/journal-entry-template/{id} 
curl https://api.overplane.dev/api/accounts/journal-entry-template/journal-entry-template_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "journal-entry-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "is_opening": "No",
  "template_title": "template_title_example",
  "multi_currency": false
}
GET /api/accounts/journal-entry-template

List all journal entry templates

Returns a list of journal entry templates. 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 journal entry template objects.

GET /api/accounts/journal-entry-template 
curl https://api.overplane.dev/api/accounts/journal-entry-template \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "journal-entry-template_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "voucher_type": "voucher_type_example",
      "company": "Example Corp",
      "is_opening": "No",
      "template_title": "template_title_example",
      "multi_currency": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/journal-entry-template

Create a journal entry template

Creates a new journal entry template object.

Body parameters

voucher_type string required
company string required
is_opening string

Default: No

template_title string required
multi_currency boolean

Default: false

Returns

Returns the newly created journal entry template object if the call succeeded.

POST /api/accounts/journal-entry-template 
curl https://api.overplane.dev/api/accounts/journal-entry-template \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"voucher_type":"voucher_type_example","company":"Example Corp","template_title":"template_title_example"}'
Response 
{
  "id": "journal-entry-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "is_opening": "No",
  "template_title": "template_title_example",
  "multi_currency": false
}
PATCH /api/accounts/journal-entry-template/{id}

Update a journal entry template

Updates the specified journal entry template 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 journal entry template to update.

Body parameters

voucher_type string
company string
is_opening string

Default: No

template_title string
multi_currency boolean

Default: false

Returns

Returns the updated journal entry template object.

PATCH /api/accounts/journal-entry-template/{id} 
curl https://api.overplane.dev/api/accounts/journal-entry-template/journal-entry-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"voucher_type":"voucher_type_example","company":"Example Corp"}'
Response 
{
  "id": "journal-entry-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "is_opening": "No",
  "template_title": "template_title_example",
  "multi_currency": false
}
DELETE /api/accounts/journal-entry-template/{id}

Delete a journal entry template

Permanently deletes a journal entry template. This cannot be undone.

Path parameters

id string required

The identifier of the journal entry template to delete.

Returns

Returns a confirmation that the journal entry template has been deleted.

DELETE /api/accounts/journal-entry-template/{id} 
curl https://api.overplane.dev/api/accounts/journal-entry-template/journal-entry-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "journal-entry-template_abc123",
  "deleted": true
}

Line items

Child objects that belong to this journal entry template. These are accessed via the parent's ID.

Journal Entry Template Account

Attributes

idx integer
journal_entry_template_id string required
account string required
party_type string
party string
cost_center string
project string

Endpoints

GET /api/accounts/journal-entry-template-account?parent_id={id}
POST /api/accounts/journal-entry-template-account
PATCH /api/accounts/journal-entry-template-account/{id}
DELETE /api/accounts/journal-entry-template-account/{id}
POST /api/accounts/journal-entry-template-account/reorder
Journal Entry Template Account object 
{
  "id": "journal-entry-template-account_abc123",
  "idx": 1,
  "journal_entry_template_id": "journal_entry_template_id_example",
  "account": "account_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "cost_center": "cost_center_example",
  "project": "project_example"
}