The Repost Payment 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

posting_date string required
voucher_type string
company string required
repost_status string
add_manually boolean

Default: false

repost_error_log string
The Repost Payment Ledger object 
{
  "id": "repost-payment-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "repost_status": "repost_status_example",
  "add_manually": false,
  "repost_error_log": "repost_error_log_example"
}
GET /api/accounts/repost-payment-ledger/{id}

Retrieve a repost payment ledger

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

Path parameters

id string required

The identifier of the repost payment ledger to retrieve.

Returns

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

GET /api/accounts/repost-payment-ledger/{id} 
curl https://api.overplane.dev/api/accounts/repost-payment-ledger/repost-payment-ledger_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "repost-payment-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "repost_status": "repost_status_example",
  "add_manually": false,
  "repost_error_log": "repost_error_log_example"
}
GET /api/accounts/repost-payment-ledger

List all repost payment ledgers

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

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

Create a repost payment ledger

Creates a new repost payment ledger object.

Body parameters

status string

Default: draft

posting_date string required
voucher_type string
company string required
repost_status string
add_manually boolean

Default: false

repost_error_log string

Returns

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

POST /api/accounts/repost-payment-ledger 
curl https://api.overplane.dev/api/accounts/repost-payment-ledger \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"posting_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "repost-payment-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "repost_status": "repost_status_example",
  "add_manually": false,
  "repost_error_log": "repost_error_log_example"
}
PATCH /api/accounts/repost-payment-ledger/{id}

Update a repost payment ledger

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

Body parameters

status string

Default: draft

posting_date string
voucher_type string
company string
repost_status string
add_manually boolean

Default: false

repost_error_log string

Returns

Returns the updated repost payment ledger object.

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

Delete a repost payment ledger

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

Path parameters

id string required

The identifier of the repost payment ledger to delete.

Returns

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

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

Submit a repost payment ledger

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

Path parameters

id string required

The identifier of the repost payment ledger to act on.

Returns

Returns the repost payment ledger object with updated status.

POST /api/accounts/repost-payment-ledger/{id}/submit 
curl https://api.overplane.dev/api/accounts/repost-payment-ledger/repost-payment-ledger_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "repost-payment-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "repost_status": "repost_status_example",
  "add_manually": false,
  "repost_error_log": "repost_error_log_example"
}
POST /api/accounts/repost-payment-ledger/{id}/cancel

Cancel a repost payment ledger

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

Path parameters

id string required

The identifier of the repost payment ledger to act on.

Returns

Returns the repost payment ledger object with updated status.

POST /api/accounts/repost-payment-ledger/{id}/cancel 
curl https://api.overplane.dev/api/accounts/repost-payment-ledger/repost-payment-ledger_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "repost-payment-ledger_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "voucher_type": "voucher_type_example",
  "company": "Example Corp",
  "repost_status": "repost_status_example",
  "add_manually": false,
  "repost_error_log": "repost_error_log_example"
}

Line items

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

Repost Payment Ledger Items

Attributes

idx integer
repost_payment_ledger_id string required
voucher_type string
voucher_no string

Endpoints

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