IQ Books — Settlements

Record a customer receipt

Records a customer receipt and posts the settlement double-entry journal (bank to AR, plus FX line where applicable) via the native transactional service. Optional allocations apply the receipt to open sales invoices. Requires scope iqbooks:write.

post/api/v1/iqbooks/organisations/{organisationId}/customer-receipts

Request

  • Base URL: https://api.reconcileiq.com
  • URL: https://api.reconcileiq.com/api/v1/iqbooks/organisations/{organisationId}/customer-receipts
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

organisationIdinteger required

IQ Books organisation id. The caller must be an accepted member; otherwise 404 (no existence leak).

Request body

contact_idinteger required
bank_account_idinteger required
amountnumber required
datestring date
currencystring
referencestring
descriptionstring

Response

A single receipt/payment (with allocations).

Changes

No recorded changes to this operation across all 1 revision of this API.