The Period Closing Voucher 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.

status string

Default: draft

transaction_date string
fiscal_year string required
company string required
closing_account_head string required
remarks string required
gle_processing_status string
error_message string
period_end_date string required
period_start_date string required
The Period Closing Voucher object 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}
GET /api/accounts/period-closing-voucher/{id}

Retrieve a period closing voucher

Retrieves the details of an existing period closing voucher. Supply the unique period closing voucher ID that was returned from a previous request.

Path parameters

id string required

The identifier of the period closing voucher to retrieve.

Returns

Returns the period closing voucher object if a valid identifier was provided.

GET /api/accounts/period-closing-voucher/{id} 
curl https://api.overplane.dev/api/accounts/period-closing-voucher/period-closing-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}
GET /api/accounts/period-closing-voucher

List all period closing vouchers

Returns a list of period closing vouchers. 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 period closing voucher objects.

GET /api/accounts/period-closing-voucher 
curl https://api.overplane.dev/api/accounts/period-closing-voucher \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "period-closing-voucher_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "transaction_date": "2024-01-15",
      "fiscal_year": "fiscal_year_example",
      "company": "Example Corp",
      "closing_account_head": "closing_account_head_example",
      "remarks": "remarks_example",
      "gle_processing_status": "gle_processing_status_example",
      "error_message": "error_message_example",
      "period_end_date": "2024-01-15",
      "period_start_date": "2024-01-15"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/period-closing-voucher

Create a period closing voucher

Creates a new period closing voucher object.

Body parameters

status string

Default: draft

transaction_date string
fiscal_year string required
company string required
closing_account_head string required
remarks string required
gle_processing_status string
error_message string
period_end_date string required
period_start_date string required

Returns

Returns the newly created period closing voucher object if the call succeeded.

POST /api/accounts/period-closing-voucher 
curl https://api.overplane.dev/api/accounts/period-closing-voucher \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"fiscal_year":"fiscal_year_example","company":"Example Corp","closing_account_head":"closing_account_head_example","remarks":"remarks_example","period_end_date":"2024-01-15","period_start_date":"2024-01-15"}'
Response 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}
PATCH /api/accounts/period-closing-voucher/{id}

Update a period closing voucher

Updates the specified period closing voucher 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 period closing voucher to update.

Body parameters

status string

Default: draft

transaction_date string
fiscal_year string
company string
closing_account_head string
remarks string
gle_processing_status string
error_message string
period_end_date string
period_start_date string

Returns

Returns the updated period closing voucher object.

PATCH /api/accounts/period-closing-voucher/{id} 
curl https://api.overplane.dev/api/accounts/period-closing-voucher/period-closing-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","transaction_date":"2024-01-15"}'
Response 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}
DELETE /api/accounts/period-closing-voucher/{id}

Delete a period closing voucher

Permanently deletes a period closing voucher. This cannot be undone.

Path parameters

id string required

The identifier of the period closing voucher to delete.

Returns

Returns a confirmation that the period closing voucher has been deleted.

DELETE /api/accounts/period-closing-voucher/{id} 
curl https://api.overplane.dev/api/accounts/period-closing-voucher/period-closing-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "period-closing-voucher_abc123",
  "deleted": true
}
POST /api/accounts/period-closing-voucher/{id}/submit

Submit a period closing voucher

Submits a draft period closing voucher, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the period closing voucher to act on.

Returns

Returns the period closing voucher object with updated status.

POST /api/accounts/period-closing-voucher/{id}/submit 
curl https://api.overplane.dev/api/accounts/period-closing-voucher/period-closing-voucher_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}
POST /api/accounts/period-closing-voucher/{id}/cancel

Cancel a period closing voucher

Cancels a submitted period closing voucher, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the period closing voucher to act on.

Returns

Returns the period closing voucher object with updated status.

POST /api/accounts/period-closing-voucher/{id}/cancel 
curl https://api.overplane.dev/api/accounts/period-closing-voucher/period-closing-voucher_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "period-closing-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "transaction_date": "2024-01-15",
  "fiscal_year": "fiscal_year_example",
  "company": "Example Corp",
  "closing_account_head": "closing_account_head_example",
  "remarks": "remarks_example",
  "gle_processing_status": "gle_processing_status_example",
  "error_message": "error_message_example",
  "period_end_date": "2024-01-15",
  "period_start_date": "2024-01-15"
}