The Transaction Deletion Record 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

company string required
delete_bin_data_status string

Default: Pending

delete_leads_and_addresses_status string

Default: Pending

reset_company_default_values_status string

Default: Pending

clear_notifications_status string

Default: Pending

initialize_doctypes_table_status string

Default: Pending

delete_transactions_status string

Default: Pending

error_log string
process_in_single_transaction boolean

Default: false

The Transaction Deletion Record object 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}
GET /api/setup/transaction-deletion-record/{id}

Retrieve a transaction deletion record

Retrieves the details of an existing transaction deletion record. Supply the unique transaction deletion record ID that was returned from a previous request.

Path parameters

id string required

The identifier of the transaction deletion record to retrieve.

Returns

Returns the transaction deletion record object if a valid identifier was provided.

GET /api/setup/transaction-deletion-record/{id} 
curl https://api.overplane.dev/api/setup/transaction-deletion-record/transaction-deletion-record_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}
GET /api/setup/transaction-deletion-record

List all transaction deletion records

Returns a list of transaction deletion records. 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 transaction deletion record objects.

GET /api/setup/transaction-deletion-record 
curl https://api.overplane.dev/api/setup/transaction-deletion-record \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "transaction-deletion-record_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "delete_bin_data_status": "Pending",
      "delete_leads_and_addresses_status": "Pending",
      "reset_company_default_values_status": "Pending",
      "clear_notifications_status": "Pending",
      "initialize_doctypes_table_status": "Pending",
      "delete_transactions_status": "Pending",
      "error_log": "error_log_example",
      "process_in_single_transaction": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/transaction-deletion-record

Create a transaction deletion record

Creates a new transaction deletion record object.

Body parameters

status string

Default: draft

company string required
delete_bin_data_status string

Default: Pending

delete_leads_and_addresses_status string

Default: Pending

reset_company_default_values_status string

Default: Pending

clear_notifications_status string

Default: Pending

initialize_doctypes_table_status string

Default: Pending

delete_transactions_status string

Default: Pending

error_log string
process_in_single_transaction boolean

Default: false

Returns

Returns the newly created transaction deletion record object if the call succeeded.

POST /api/setup/transaction-deletion-record 
curl https://api.overplane.dev/api/setup/transaction-deletion-record \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp"}'
Response 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}
PATCH /api/setup/transaction-deletion-record/{id}

Update a transaction deletion record

Updates the specified transaction deletion record 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 transaction deletion record to update.

Body parameters

status string

Default: draft

company string
delete_bin_data_status string

Default: Pending

delete_leads_and_addresses_status string

Default: Pending

reset_company_default_values_status string

Default: Pending

clear_notifications_status string

Default: Pending

initialize_doctypes_table_status string

Default: Pending

delete_transactions_status string

Default: Pending

error_log string
process_in_single_transaction boolean

Default: false

Returns

Returns the updated transaction deletion record object.

PATCH /api/setup/transaction-deletion-record/{id} 
curl https://api.overplane.dev/api/setup/transaction-deletion-record/transaction-deletion-record_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}
DELETE /api/setup/transaction-deletion-record/{id}

Delete a transaction deletion record

Permanently deletes a transaction deletion record. This cannot be undone.

Path parameters

id string required

The identifier of the transaction deletion record to delete.

Returns

Returns a confirmation that the transaction deletion record has been deleted.

DELETE /api/setup/transaction-deletion-record/{id} 
curl https://api.overplane.dev/api/setup/transaction-deletion-record/transaction-deletion-record_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "transaction-deletion-record_abc123",
  "deleted": true
}
POST /api/setup/transaction-deletion-record/{id}/submit

Submit a transaction deletion record

Submits a draft transaction deletion record, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the transaction deletion record to act on.

Returns

Returns the transaction deletion record object with updated status.

POST /api/setup/transaction-deletion-record/{id}/submit 
curl https://api.overplane.dev/api/setup/transaction-deletion-record/transaction-deletion-record_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}
POST /api/setup/transaction-deletion-record/{id}/cancel

Cancel a transaction deletion record

Cancels a submitted transaction deletion record, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the transaction deletion record to act on.

Returns

Returns the transaction deletion record object with updated status.

POST /api/setup/transaction-deletion-record/{id}/cancel 
curl https://api.overplane.dev/api/setup/transaction-deletion-record/transaction-deletion-record_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "transaction-deletion-record_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_bin_data_status": "Pending",
  "delete_leads_and_addresses_status": "Pending",
  "reset_company_default_values_status": "Pending",
  "clear_notifications_status": "Pending",
  "initialize_doctypes_table_status": "Pending",
  "delete_transactions_status": "Pending",
  "error_log": "error_log_example",
  "process_in_single_transaction": false
}

Line items

Child objects that belong to this transaction deletion record. These are accessed via the parent's ID.

Transaction Deletion Record Details

Attributes

idx integer
transaction_deletion_record_id string required
doctype_name string required
docfield_name string
no_of_docs integer
done boolean

Endpoints

GET /api/setup/transaction-deletion-record-details?parent_id={id}
POST /api/setup/transaction-deletion-record-details
PATCH /api/setup/transaction-deletion-record-details/{id}
DELETE /api/setup/transaction-deletion-record-details/{id}
POST /api/setup/transaction-deletion-record-details/reorder
Transaction Deletion Record Details object 
{
  "id": "transaction-deletion-record-details_abc123",
  "idx": 1,
  "transaction_deletion_record_id": "transaction_deletion_record_id_example",
  "doctype_name": "doctype_name_example",
  "docfield_name": "docfield_name_example",
  "no_of_docs": 0,
  "done": false
}

Transaction Deletion Record Item

Attributes

idx integer
transaction_deletion_record_id string required
doctype_name string required

Endpoints

GET /api/setup/transaction-deletion-record-item?parent_id={id}
POST /api/setup/transaction-deletion-record-item
PATCH /api/setup/transaction-deletion-record-item/{id}
DELETE /api/setup/transaction-deletion-record-item/{id}
POST /api/setup/transaction-deletion-record-item/reorder
Transaction Deletion Record Item object 
{
  "id": "transaction-deletion-record-item_abc123",
  "idx": 1,
  "transaction_deletion_record_id": "transaction_deletion_record_id_example",
  "doctype_name": "doctype_name_example"
}

Transaction Deletion Record To Delete

Attributes

idx integer
transaction_deletion_record_id string required
doctype_name string
company_field string
document_count integer
child_doctypes string
deleted boolean

Endpoints

GET /api/setup/transaction-deletion-record-to-delete?parent_id={id}
POST /api/setup/transaction-deletion-record-to-delete
PATCH /api/setup/transaction-deletion-record-to-delete/{id}
DELETE /api/setup/transaction-deletion-record-to-delete/{id}
POST /api/setup/transaction-deletion-record-to-delete/reorder
Transaction Deletion Record To Delete object 
{
  "id": "transaction-deletion-record-to-delete_abc123",
  "idx": 1,
  "transaction_deletion_record_id": "transaction_deletion_record_id_example",
  "doctype_name": "doctype_name_example",
  "company_field": "Example Corp",
  "document_count": 0,
  "child_doctypes": "child_doctypes_example",
  "deleted": false
}