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

invoice_number string required
allocated_amount number required
difference_account string
difference_amount number
reference_name string required
is_advance string
reference_type string required
invoice_type string required
unreconciled_amount number
amount number
reference_row string
currency string
exchange_rate number
cost_center string
gain_loss_posting_date string
debit_or_credit_note_posting_date string
The Payment Reconciliation Allocation object 
{
  "id": "payment-reconciliation-allocation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_number": "invoice_number_example",
  "allocated_amount": 0,
  "difference_account": "difference_account_example",
  "difference_amount": 0,
  "reference_name": "reference_name_example",
  "is_advance": "is_advance_example",
  "reference_type": "reference_type_example",
  "invoice_type": "invoice_type_example",
  "unreconciled_amount": 0,
  "amount": 0,
  "reference_row": "reference_row_example",
  "currency": "USD",
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "gain_loss_posting_date": "2024-01-15",
  "debit_or_credit_note_posting_date": "2024-01-15"
}
GET /api/accounts/payment-reconciliation-allocation/{id}

Retrieve a payment reconciliation allocation

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

Path parameters

id string required

The identifier of the payment reconciliation allocation to retrieve.

Returns

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

GET /api/accounts/payment-reconciliation-allocation/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-allocation/payment-reconciliation-allocation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "payment-reconciliation-allocation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_number": "invoice_number_example",
  "allocated_amount": 0,
  "difference_account": "difference_account_example",
  "difference_amount": 0,
  "reference_name": "reference_name_example",
  "is_advance": "is_advance_example",
  "reference_type": "reference_type_example",
  "invoice_type": "invoice_type_example",
  "unreconciled_amount": 0,
  "amount": 0,
  "reference_row": "reference_row_example",
  "currency": "USD",
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "gain_loss_posting_date": "2024-01-15",
  "debit_or_credit_note_posting_date": "2024-01-15"
}
GET /api/accounts/payment-reconciliation-allocation

List all payment reconciliation allocations

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

GET /api/accounts/payment-reconciliation-allocation 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-allocation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "payment-reconciliation-allocation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "invoice_number": "invoice_number_example",
      "allocated_amount": 0,
      "difference_account": "difference_account_example",
      "difference_amount": 0,
      "reference_name": "reference_name_example",
      "is_advance": "is_advance_example",
      "reference_type": "reference_type_example",
      "invoice_type": "invoice_type_example",
      "unreconciled_amount": 0,
      "amount": 0,
      "reference_row": "reference_row_example",
      "currency": "USD",
      "exchange_rate": 0,
      "cost_center": "cost_center_example",
      "gain_loss_posting_date": "2024-01-15",
      "debit_or_credit_note_posting_date": "2024-01-15"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/payment-reconciliation-allocation

Create a payment reconciliation allocation

Creates a new payment reconciliation allocation object.

Body parameters

invoice_number string required
allocated_amount number required
difference_account string
difference_amount number
reference_name string required
is_advance string
reference_type string required
invoice_type string required
unreconciled_amount number
amount number
reference_row string
currency string
exchange_rate number
cost_center string
gain_loss_posting_date string
debit_or_credit_note_posting_date string

Returns

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

POST /api/accounts/payment-reconciliation-allocation 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-allocation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"invoice_number":"invoice_number_example","allocated_amount":0,"reference_name":"reference_name_example","reference_type":"reference_type_example","invoice_type":"invoice_type_example"}'
Response 
{
  "id": "payment-reconciliation-allocation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_number": "invoice_number_example",
  "allocated_amount": 0,
  "difference_account": "difference_account_example",
  "difference_amount": 0,
  "reference_name": "reference_name_example",
  "is_advance": "is_advance_example",
  "reference_type": "reference_type_example",
  "invoice_type": "invoice_type_example",
  "unreconciled_amount": 0,
  "amount": 0,
  "reference_row": "reference_row_example",
  "currency": "USD",
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "gain_loss_posting_date": "2024-01-15",
  "debit_or_credit_note_posting_date": "2024-01-15"
}
PATCH /api/accounts/payment-reconciliation-allocation/{id}

Update a payment reconciliation allocation

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

Body parameters

invoice_number string
allocated_amount number
difference_account string
difference_amount number
reference_name string
is_advance string
reference_type string
invoice_type string
unreconciled_amount number
amount number
reference_row string
currency string
exchange_rate number
cost_center string
gain_loss_posting_date string
debit_or_credit_note_posting_date string

Returns

Returns the updated payment reconciliation allocation object.

PATCH /api/accounts/payment-reconciliation-allocation/{id} 
curl https://api.overplane.dev/api/accounts/payment-reconciliation-allocation/payment-reconciliation-allocation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"invoice_number":"invoice_number_example","allocated_amount":0}'
Response 
{
  "id": "payment-reconciliation-allocation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "invoice_number": "invoice_number_example",
  "allocated_amount": 0,
  "difference_account": "difference_account_example",
  "difference_amount": 0,
  "reference_name": "reference_name_example",
  "is_advance": "is_advance_example",
  "reference_type": "reference_type_example",
  "invoice_type": "invoice_type_example",
  "unreconciled_amount": 0,
  "amount": 0,
  "reference_row": "reference_row_example",
  "currency": "USD",
  "exchange_rate": 0,
  "cost_center": "cost_center_example",
  "gain_loss_posting_date": "2024-01-15",
  "debit_or_credit_note_posting_date": "2024-01-15"
}
DELETE /api/accounts/payment-reconciliation-allocation/{id}

Delete a payment reconciliation allocation

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

Path parameters

id string required

The identifier of the payment reconciliation allocation to delete.

Returns

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

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