The Process Payment Reconciliation Log 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.

reconciled boolean

Default: false

total_allocations integer
allocated boolean

Default: false

reconciled_entries integer
error_log string
process_pr string required
status string
The Process Payment Reconciliation Log object 
{
  "id": "process-payment-reconciliation-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reconciled": false,
  "total_allocations": 0,
  "allocated": false,
  "reconciled_entries": 0,
  "error_log": "error_log_example",
  "process_pr": "process_pr_example",
  "status": "draft"
}
GET /api/accounts/process-payment-reconciliation-log/{id}

Retrieve a process payment reconciliation log

Retrieves the details of an existing process payment reconciliation log. Supply the unique process payment reconciliation log ID that was returned from a previous request.

Path parameters

id string required

The identifier of the process payment reconciliation log to retrieve.

Returns

Returns the process payment reconciliation log object if a valid identifier was provided.

GET /api/accounts/process-payment-reconciliation-log/{id} 
curl https://api.overplane.dev/api/accounts/process-payment-reconciliation-log/process-payment-reconciliation-log_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "process-payment-reconciliation-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reconciled": false,
  "total_allocations": 0,
  "allocated": false,
  "reconciled_entries": 0,
  "error_log": "error_log_example",
  "process_pr": "process_pr_example",
  "status": "draft"
}
GET /api/accounts/process-payment-reconciliation-log

List all process payment reconciliation logs

Returns a list of process payment reconciliation logs. 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 payment reconciliation log objects.

GET /api/accounts/process-payment-reconciliation-log 
curl https://api.overplane.dev/api/accounts/process-payment-reconciliation-log \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "process-payment-reconciliation-log_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "reconciled": false,
      "total_allocations": 0,
      "allocated": false,
      "reconciled_entries": 0,
      "error_log": "error_log_example",
      "process_pr": "process_pr_example",
      "status": "draft"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/process-payment-reconciliation-log

Create a process payment reconciliation log

Creates a new process payment reconciliation log object.

Body parameters

reconciled boolean

Default: false

total_allocations integer
allocated boolean

Default: false

reconciled_entries integer
error_log string
process_pr string required
status string

Returns

Returns the newly created process payment reconciliation log object if the call succeeded.

POST /api/accounts/process-payment-reconciliation-log 
curl https://api.overplane.dev/api/accounts/process-payment-reconciliation-log \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"process_pr":"process_pr_example"}'
Response 
{
  "id": "process-payment-reconciliation-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reconciled": false,
  "total_allocations": 0,
  "allocated": false,
  "reconciled_entries": 0,
  "error_log": "error_log_example",
  "process_pr": "process_pr_example",
  "status": "draft"
}
PATCH /api/accounts/process-payment-reconciliation-log/{id}

Update a process payment reconciliation log

Updates the specified process payment reconciliation log 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 payment reconciliation log to update.

Body parameters

reconciled boolean

Default: false

total_allocations integer
allocated boolean

Default: false

reconciled_entries integer
error_log string
process_pr string
status string

Returns

Returns the updated process payment reconciliation log object.

PATCH /api/accounts/process-payment-reconciliation-log/{id} 
curl https://api.overplane.dev/api/accounts/process-payment-reconciliation-log/process-payment-reconciliation-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"reconciled":false,"total_allocations":0}'
Response 
{
  "id": "process-payment-reconciliation-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reconciled": false,
  "total_allocations": 0,
  "allocated": false,
  "reconciled_entries": 0,
  "error_log": "error_log_example",
  "process_pr": "process_pr_example",
  "status": "draft"
}
DELETE /api/accounts/process-payment-reconciliation-log/{id}

Delete a process payment reconciliation log

Permanently deletes a process payment reconciliation log. This cannot be undone.

Path parameters

id string required

The identifier of the process payment reconciliation log to delete.

Returns

Returns a confirmation that the process payment reconciliation log has been deleted.

DELETE /api/accounts/process-payment-reconciliation-log/{id} 
curl https://api.overplane.dev/api/accounts/process-payment-reconciliation-log/process-payment-reconciliation-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "process-payment-reconciliation-log_abc123",
  "deleted": true
}

Line items

Child objects that belong to this process payment reconciliation log. These are accessed via the parent's ID.

Process Payment Reconciliation Log Allocations

Attributes

idx integer
process_payment_reconciliation_log_id string required
reference_type string required
reference_name string required
reference_row string
invoice_type string required
invoice_number string required
allocated_amount number required
unreconciled_amount number
amount number
is_advance string
difference_amount number
difference_account string
exchange_rate number
currency string
reconciled boolean
gain_loss_posting_date string

Endpoints

GET /api/accounts/process-payment-reconciliation-log-allocations?parent_id={id}
POST /api/accounts/process-payment-reconciliation-log-allocations
PATCH /api/accounts/process-payment-reconciliation-log-allocations/{id}
DELETE /api/accounts/process-payment-reconciliation-log-allocations/{id}
POST /api/accounts/process-payment-reconciliation-log-allocations/reorder
Process Payment Reconciliation Log Allocations object 
{
  "id": "process-payment-reconciliation-log-allocations_abc123",
  "idx": 1,
  "process_payment_reconciliation_log_id": "process_payment_reconciliation_log_id_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "reference_row": "reference_row_example",
  "invoice_type": "invoice_type_example",
  "invoice_number": "invoice_number_example",
  "allocated_amount": 0,
  "unreconciled_amount": 0,
  "amount": 0,
  "is_advance": "is_advance_example",
  "difference_amount": 0,
  "difference_account": "difference_account_example",
  "exchange_rate": 0,
  "currency": "USD",
  "reconciled": false,
  "gain_loss_posting_date": "2024-01-15"
}