The Repost Accounting Ledger 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
delete_cancelled_entries boolean

Default: false

The Repost Accounting Ledger object 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}
GET /api/accounts/repost-accounting-ledger/{id}

Retrieve a repost accounting ledger

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

Path parameters

id string required

The identifier of the repost accounting ledger to retrieve.

Returns

Returns the repost accounting ledger object if a valid identifier was provided.

GET /api/accounts/repost-accounting-ledger/{id} 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger/repost-accounting-ledger_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}
GET /api/accounts/repost-accounting-ledger

List all repost accounting ledgers

Returns a list of repost accounting ledgers. 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 repost accounting ledger objects.

GET /api/accounts/repost-accounting-ledger 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "repost-accounting-ledger_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "delete_cancelled_entries": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/repost-accounting-ledger

Create a repost accounting ledger

Creates a new repost accounting ledger object.

Body parameters

status string

Default: draft

company string
delete_cancelled_entries boolean

Default: false

Returns

Returns the newly created repost accounting ledger object if the call succeeded.

POST /api/accounts/repost-accounting-ledger 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}
PATCH /api/accounts/repost-accounting-ledger/{id}

Update a repost accounting ledger

Updates the specified repost accounting ledger 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 repost accounting ledger to update.

Body parameters

status string

Default: draft

company string
delete_cancelled_entries boolean

Default: false

Returns

Returns the updated repost accounting ledger object.

PATCH /api/accounts/repost-accounting-ledger/{id} 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger/repost-accounting-ledger_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}
DELETE /api/accounts/repost-accounting-ledger/{id}

Delete a repost accounting ledger

Permanently deletes a repost accounting ledger. This cannot be undone.

Path parameters

id string required

The identifier of the repost accounting ledger to delete.

Returns

Returns a confirmation that the repost accounting ledger has been deleted.

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

Submit a repost accounting ledger

Submits a draft repost accounting ledger, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the repost accounting ledger to act on.

Returns

Returns the repost accounting ledger object with updated status.

POST /api/accounts/repost-accounting-ledger/{id}/submit 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger/repost-accounting-ledger_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}
POST /api/accounts/repost-accounting-ledger/{id}/cancel

Cancel a repost accounting ledger

Cancels a submitted repost accounting ledger, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the repost accounting ledger to act on.

Returns

Returns the repost accounting ledger object with updated status.

POST /api/accounts/repost-accounting-ledger/{id}/cancel 
curl https://api.overplane.dev/api/accounts/repost-accounting-ledger/repost-accounting-ledger_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "repost-accounting-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "delete_cancelled_entries": false
}

Line items

Child objects that belong to this repost accounting ledger. These are accessed via the parent's ID.

Repost Accounting Ledger Items

Attributes

idx integer
repost_accounting_ledger_id string required
voucher_type string
voucher_no string

Endpoints

GET /api/accounts/repost-accounting-ledger-items?parent_id={id}
POST /api/accounts/repost-accounting-ledger-items
PATCH /api/accounts/repost-accounting-ledger-items/{id}
DELETE /api/accounts/repost-accounting-ledger-items/{id}
POST /api/accounts/repost-accounting-ledger-items/reorder
Repost Accounting Ledger Items object 
{
  "id": "repost-accounting-ledger-items_abc123",
  "idx": 1,
  "repost_accounting_ledger_id": "repost_accounting_ledger_id_example",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}