The Process Deferred Accounting 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

type string required
start_date string required
end_date string required
posting_date string required
account string
company string required
The Process Deferred Accounting object 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}
GET /api/accounts/process-deferred-accounting/{id}

Retrieve a process deferred accounting

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

Path parameters

id string required

The identifier of the process deferred accounting to retrieve.

Returns

Returns the process deferred accounting object if a valid identifier was provided.

GET /api/accounts/process-deferred-accounting/{id} 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting/process-deferred-accounting_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}
GET /api/accounts/process-deferred-accounting

List all process deferred accountings

Returns a list of process deferred accountings. 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 process deferred accounting objects.

GET /api/accounts/process-deferred-accounting 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "process-deferred-accounting_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "type": "type_example",
      "start_date": "2024-01-15",
      "end_date": "2024-01-15",
      "posting_date": "2024-01-15",
      "account": "account_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/process-deferred-accounting

Create a process deferred accounting

Creates a new process deferred accounting object.

Body parameters

status string

Default: draft

type string required
start_date string required
end_date string required
posting_date string required
account string
company string required

Returns

Returns the newly created process deferred accounting object if the call succeeded.

POST /api/accounts/process-deferred-accounting 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"type":"type_example","start_date":"2024-01-15","end_date":"2024-01-15","posting_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}
PATCH /api/accounts/process-deferred-accounting/{id}

Update a process deferred accounting

Updates the specified process deferred accounting 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 process deferred accounting to update.

Body parameters

status string

Default: draft

type string
start_date string
end_date string
posting_date string
account string
company string

Returns

Returns the updated process deferred accounting object.

PATCH /api/accounts/process-deferred-accounting/{id} 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting/process-deferred-accounting_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","type":"type_example"}'
Response 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}
DELETE /api/accounts/process-deferred-accounting/{id}

Delete a process deferred accounting

Permanently deletes a process deferred accounting. This cannot be undone.

Path parameters

id string required

The identifier of the process deferred accounting to delete.

Returns

Returns a confirmation that the process deferred accounting has been deleted.

DELETE /api/accounts/process-deferred-accounting/{id} 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting/process-deferred-accounting_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "process-deferred-accounting_abc123",
  "deleted": true
}
POST /api/accounts/process-deferred-accounting/{id}/submit

Submit a process deferred accounting

Submits a draft process deferred accounting, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the process deferred accounting to act on.

Returns

Returns the process deferred accounting object with updated status.

POST /api/accounts/process-deferred-accounting/{id}/submit 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting/process-deferred-accounting_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}
POST /api/accounts/process-deferred-accounting/{id}/cancel

Cancel a process deferred accounting

Cancels a submitted process deferred accounting, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the process deferred accounting to act on.

Returns

Returns the process deferred accounting object with updated status.

POST /api/accounts/process-deferred-accounting/{id}/cancel 
curl https://api.overplane.dev/api/accounts/process-deferred-accounting/process-deferred-accounting_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "process-deferred-accounting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "type": "type_example",
  "start_date": "2024-01-15",
  "end_date": "2024-01-15",
  "posting_date": "2024-01-15",
  "account": "account_example",
  "company": "Example Corp"
}