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

company string required
party_type string required
party string required
receivable_payable_account string required
bank_cash_account string
from_invoice_date string
to_invoice_date string
minimum_invoice_amount number
invoice_limit integer

Default: 50

from_payment_date string
to_payment_date string
minimum_payment_amount number
maximum_payment_amount number
payment_limit integer

Default: 50

maximum_invoice_amount number
cost_center string
project string
default_advance_account string
invoice_name string
payment_name string
The Payment Reconciliation object 
{
  "id": "payment-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "receivable_payable_account": "receivable_payable_account_example",
  "bank_cash_account": "bank_cash_account_example",
  "from_invoice_date": "2024-01-15",
  "to_invoice_date": "2024-01-15",
  "minimum_invoice_amount": 0,
  "invoice_limit": 50,
  "from_payment_date": "2024-01-15",
  "to_payment_date": "2024-01-15",
  "minimum_payment_amount": 0,
  "maximum_payment_amount": 0,
  "payment_limit": 50,
  "maximum_invoice_amount": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "default_advance_account": "default_advance_account_example",
  "invoice_name": "invoice_name_example",
  "payment_name": "payment_name_example"
}
GET /api/accounts/payment-reconciliation/{id}

Retrieve a payment reconciliation

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

Path parameters

id string required

The identifier of the payment reconciliation to retrieve.

Returns

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

GET /api/accounts/payment-reconciliation/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation/payment-reconciliation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "payment-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "receivable_payable_account": "receivable_payable_account_example",
  "bank_cash_account": "bank_cash_account_example",
  "from_invoice_date": "2024-01-15",
  "to_invoice_date": "2024-01-15",
  "minimum_invoice_amount": 0,
  "invoice_limit": 50,
  "from_payment_date": "2024-01-15",
  "to_payment_date": "2024-01-15",
  "minimum_payment_amount": 0,
  "maximum_payment_amount": 0,
  "payment_limit": 50,
  "maximum_invoice_amount": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "default_advance_account": "default_advance_account_example",
  "invoice_name": "invoice_name_example",
  "payment_name": "payment_name_example"
}
GET /api/accounts/payment-reconciliation

List all payment reconciliations

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

GET /api/accounts/payment-reconciliation 
curl https://api.overplane.dev/api/accounts/payment-reconciliation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "payment-reconciliation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "company": "Example Corp",
      "party_type": "party_type_example",
      "party": "party_example",
      "receivable_payable_account": "receivable_payable_account_example",
      "bank_cash_account": "bank_cash_account_example",
      "from_invoice_date": "2024-01-15",
      "to_invoice_date": "2024-01-15",
      "minimum_invoice_amount": 0,
      "invoice_limit": 50,
      "from_payment_date": "2024-01-15",
      "to_payment_date": "2024-01-15",
      "minimum_payment_amount": 0,
      "maximum_payment_amount": 0,
      "payment_limit": 50,
      "maximum_invoice_amount": 0,
      "cost_center": "cost_center_example",
      "project": "project_example",
      "default_advance_account": "default_advance_account_example",
      "invoice_name": "invoice_name_example",
      "payment_name": "payment_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/payment-reconciliation

Create a payment reconciliation

Creates a new payment reconciliation object.

Body parameters

company string required
party_type string required
party string required
receivable_payable_account string required
bank_cash_account string
from_invoice_date string
to_invoice_date string
minimum_invoice_amount number
invoice_limit integer

Default: 50

from_payment_date string
to_payment_date string
minimum_payment_amount number
maximum_payment_amount number
payment_limit integer

Default: 50

maximum_invoice_amount number
cost_center string
project string
default_advance_account string
invoice_name string
payment_name string

Returns

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

POST /api/accounts/payment-reconciliation 
curl https://api.overplane.dev/api/accounts/payment-reconciliation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","party_type":"party_type_example","party":"party_example","receivable_payable_account":"receivable_payable_account_example"}'
Response 
{
  "id": "payment-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "receivable_payable_account": "receivable_payable_account_example",
  "bank_cash_account": "bank_cash_account_example",
  "from_invoice_date": "2024-01-15",
  "to_invoice_date": "2024-01-15",
  "minimum_invoice_amount": 0,
  "invoice_limit": 50,
  "from_payment_date": "2024-01-15",
  "to_payment_date": "2024-01-15",
  "minimum_payment_amount": 0,
  "maximum_payment_amount": 0,
  "payment_limit": 50,
  "maximum_invoice_amount": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "default_advance_account": "default_advance_account_example",
  "invoice_name": "invoice_name_example",
  "payment_name": "payment_name_example"
}
PATCH /api/accounts/payment-reconciliation/{id}

Update a payment reconciliation

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

Body parameters

company string
party_type string
party string
receivable_payable_account string
bank_cash_account string
from_invoice_date string
to_invoice_date string
minimum_invoice_amount number
invoice_limit integer

Default: 50

from_payment_date string
to_payment_date string
minimum_payment_amount number
maximum_payment_amount number
payment_limit integer

Default: 50

maximum_invoice_amount number
cost_center string
project string
default_advance_account string
invoice_name string
payment_name string

Returns

Returns the updated payment reconciliation object.

PATCH /api/accounts/payment-reconciliation/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation/payment-reconciliation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","party_type":"party_type_example"}'
Response 
{
  "id": "payment-reconciliation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "party_type": "party_type_example",
  "party": "party_example",
  "receivable_payable_account": "receivable_payable_account_example",
  "bank_cash_account": "bank_cash_account_example",
  "from_invoice_date": "2024-01-15",
  "to_invoice_date": "2024-01-15",
  "minimum_invoice_amount": 0,
  "invoice_limit": 50,
  "from_payment_date": "2024-01-15",
  "to_payment_date": "2024-01-15",
  "minimum_payment_amount": 0,
  "maximum_payment_amount": 0,
  "payment_limit": 50,
  "maximum_invoice_amount": 0,
  "cost_center": "cost_center_example",
  "project": "project_example",
  "default_advance_account": "default_advance_account_example",
  "invoice_name": "invoice_name_example",
  "payment_name": "payment_name_example"
}
DELETE /api/accounts/payment-reconciliation/{id}

Delete a payment reconciliation

Permanently deletes a payment reconciliation. This cannot be undone.

Path parameters

id string required

The identifier of the payment reconciliation to delete.

Returns

Returns a confirmation that the payment reconciliation has been deleted.

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