Search customer payments
brightpearl_search_customer_paymentsSearch payments received against sales orders; each row has paymentId, transactionRef, paymentMethodCode, paymentType, orderId, currencyCode, amountAuthorized, amountPaid, paymentDate, createdOn, journalId. GET /accounting-service/customer-payment-search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_ids | No | Only payments on these orders (one or more ids). | |
| page_size | No | Rows per page, 1-500 (default 25). | |
| created_to | No | Created: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| payment_to | No | Payment date: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| payment_ids | No | Only these payments (one or more ids). | |
| created_from | No | Created: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| first_result | No | Position of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page. | |
| newest_first | No | Newest (highest id) first. Default: oldest first. | |
| payment_from | No | Payment date: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| payment_type | No | Payment type, for example RECEIPT, CAPTURE, AUTH. | |
| transaction_ref | No | The payment gateway's transaction reference. | |
| payment_method_code | No | Payment method code (brightpearl_list_payment_methods). |