Sign in
Payment

Create

Create a new Payment record.

post/api/cp/payment

Request body

idinteger

Id

company_idinteger required

Company Id

payment_timestring date-time required

Payment Time

descriptionstring

Description

totalnumber required

Total

tax_ratenumber

Tax Rate

invoice_idinteger

Invoice Id

currencystring

Currency

override_xenumber

Override Xe

payment_feenumber

Payment Fee

status'Completed' | 'Pending' | 'Canceled'

Status

payment_idstring

Payment Id

charge_idstring

Charge Id

reconciliation_idstring

Reconciliation Id

tax_paidnumber

Tax Paid

Example request

{
  "id": 12345,
  "company_id": 1,
  "payment_time": "2025-01-17T10:30:00Z",
  "description": "A detailed description of the resource",
  "total": 10,
  "tax_rate": 99.99,
  "invoice_id": 1,
  "currency": "USD",
  "override_xe": 1.5,
  "payment_fee": 99.99,
  "status": "Completed",
  "payment_id": 1,
  "charge_id": 1,
  "reconciliation_id": 1,
  "tax_paid": 99.99
}

Response

Successful response

statusstring

Operation status

Example response

{
  "id": 12345,
  "status": "OK"
}

Changes