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

reference_type string
reference_name string
posting_date string
is_advance string
reference_row string
amount number
currency string
difference_amount number
exchange_rate number
cost_center string
remarks string
The Payment Reconciliation Payment object 
{
  "id": "payment-reconciliation-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15",
  "is_advance": "is_advance_example",
  "reference_row": "reference_row_example",
  "amount": 0,
  "currency": "USD",
  "difference_amount": 0,
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "remarks": "remarks_example"
}
GET /api/accounts/payment-reconciliation-payment/{id}

Retrieve a payment reconciliation payment

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

Path parameters

id string required

The identifier of the payment reconciliation payment to retrieve.

Returns

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

GET /api/accounts/payment-reconciliation-payment/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-payment/payment-reconciliation-payment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "payment-reconciliation-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15",
  "is_advance": "is_advance_example",
  "reference_row": "reference_row_example",
  "amount": 0,
  "currency": "USD",
  "difference_amount": 0,
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "remarks": "remarks_example"
}
GET /api/accounts/payment-reconciliation-payment

List all payment reconciliation payments

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

GET /api/accounts/payment-reconciliation-payment 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-payment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "payment-reconciliation-payment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "reference_type": "reference_type_example",
      "reference_name": "reference_name_example",
      "posting_date": "2024-01-15",
      "is_advance": "is_advance_example",
      "reference_row": "reference_row_example",
      "amount": 0,
      "currency": "USD",
      "difference_amount": 0,
      "exchange_rate": 0,
      "cost_center": "cost_center_example",
      "remarks": "remarks_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/payment-reconciliation-payment

Create a payment reconciliation payment

Creates a new payment reconciliation payment object.

Body parameters

reference_type string
reference_name string
posting_date string
is_advance string
reference_row string
amount number
currency string
difference_amount number
exchange_rate number
cost_center string
remarks string

Returns

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

POST /api/accounts/payment-reconciliation-payment 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-payment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "payment-reconciliation-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15",
  "is_advance": "is_advance_example",
  "reference_row": "reference_row_example",
  "amount": 0,
  "currency": "USD",
  "difference_amount": 0,
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "remarks": "remarks_example"
}
PATCH /api/accounts/payment-reconciliation-payment/{id}

Update a payment reconciliation payment

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

Body parameters

reference_type string
reference_name string
posting_date string
is_advance string
reference_row string
amount number
currency string
difference_amount number
exchange_rate number
cost_center string
remarks string

Returns

Returns the updated payment reconciliation payment object.

PATCH /api/accounts/payment-reconciliation-payment/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-payment/payment-reconciliation-payment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"reference_type":"reference_type_example","reference_name":"reference_name_example"}'
Response 
{
  "id": "payment-reconciliation-payment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "posting_date": "2024-01-15",
  "is_advance": "is_advance_example",
  "reference_row": "reference_row_example",
  "amount": 0,
  "currency": "USD",
  "difference_amount": 0,
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "remarks": "remarks_example"
}
DELETE /api/accounts/payment-reconciliation-payment/{id}

Delete a payment reconciliation payment

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

Path parameters

id string required

The identifier of the payment reconciliation payment to delete.

Returns

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

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