The Unreconcile Payment 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
voucher_type string
voucher_no string
The Unreconcile Payment object 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}
GET /api/accounts/unreconcile-payment/{id}

Retrieve a unreconcile payment

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

Path parameters

id string required

The identifier of the unreconcile payment to retrieve.

Returns

Returns the unreconcile payment object if a valid identifier was provided.

GET /api/accounts/unreconcile-payment/{id} 
curl https://api.overplane.dev/api/accounts/unreconcile-payment/unreconcile-payment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}
GET /api/accounts/unreconcile-payment

List all unreconcile payments

Returns a list of unreconcile payments. 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 unreconcile payment objects.

GET /api/accounts/unreconcile-payment 
curl https://api.overplane.dev/api/accounts/unreconcile-payment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "unreconcile-payment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "voucher_type": "voucher_type_example",
      "voucher_no": "voucher_no_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/unreconcile-payment

Create a unreconcile payment

Creates a new unreconcile payment object.

Body parameters

status string

Default: draft

company string
voucher_type string
voucher_no string

Returns

Returns the newly created unreconcile payment object if the call succeeded.

POST /api/accounts/unreconcile-payment 
curl https://api.overplane.dev/api/accounts/unreconcile-payment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}
PATCH /api/accounts/unreconcile-payment/{id}

Update a unreconcile payment

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

Body parameters

status string

Default: draft

company string
voucher_type string
voucher_no string

Returns

Returns the updated unreconcile payment object.

PATCH /api/accounts/unreconcile-payment/{id} 
curl https://api.overplane.dev/api/accounts/unreconcile-payment/unreconcile-payment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}
DELETE /api/accounts/unreconcile-payment/{id}

Delete a unreconcile payment

Permanently deletes a unreconcile payment. This cannot be undone.

Path parameters

id string required

The identifier of the unreconcile payment to delete.

Returns

Returns a confirmation that the unreconcile payment has been deleted.

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

Submit a unreconcile payment

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

Path parameters

id string required

The identifier of the unreconcile payment to act on.

Returns

Returns the unreconcile payment object with updated status.

POST /api/accounts/unreconcile-payment/{id}/submit 
curl https://api.overplane.dev/api/accounts/unreconcile-payment/unreconcile-payment_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}
POST /api/accounts/unreconcile-payment/{id}/cancel

Cancel a unreconcile payment

Cancels a submitted unreconcile payment, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the unreconcile payment to act on.

Returns

Returns the unreconcile payment object with updated status.

POST /api/accounts/unreconcile-payment/{id}/cancel 
curl https://api.overplane.dev/api/accounts/unreconcile-payment/unreconcile-payment_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "unreconcile-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "voucher_type": "voucher_type_example",
  "voucher_no": "voucher_no_example"
}

Line items

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

Unreconcile Payment Entries

Attributes

idx integer
unreconcile_payment_id string required
reference_name string
allocated_amount number
unlinked boolean
reference_doctype string
account string
party_type string
party string
account_currency string

Endpoints

GET /api/accounts/unreconcile-payment-entries?parent_id={id}
POST /api/accounts/unreconcile-payment-entries
PATCH /api/accounts/unreconcile-payment-entries/{id}
DELETE /api/accounts/unreconcile-payment-entries/{id}
POST /api/accounts/unreconcile-payment-entries/reorder
Unreconcile Payment Entries object 
{
  "id": "unreconcile-payment-entries_abc123",
  "idx": 1,
  "unreconcile_payment_id": "unreconcile_payment_id_example",
  "reference_name": "reference_name_example",
  "allocated_amount": 0,
  "unlinked": false,
  "reference_doctype": "reference_doctype_example",
  "account": "account_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "account_currency": "USD"
}