Customer Payment Search

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/customer-payment-search

Refer to our documentation on URI syntax for more information on how to construct URIs.

Columns

Name Required Sortable Filterable Data type Reference data Description
paymentId IDSET None The payment id.
transactionRef STRING None Unique reference provided by the payment gateway.
transactionCode STRING None A code shared between linked transactions (eg AUTH with VOID).
paymentMethodCode STRING None The code corresponding to the payment method type.
paymentType STRING None The type of payment.
orderId IDSET None The ID of the order related to the payment.
currencyId IDSET None The ID of the payment currency. Returns null if the currency has not been set up in Brightpearl.
currencyCode STRING None The ISO code of the payment currency.
amountAuthorized STRING None The amount authorized for the order (AUTHs - VOIDs).
amountPaid STRING None The amount paid (RECEIPTs + CAPTUREs - PAYMENTs).
expires PERIOD None The expiry date of the authorization
paymentDate PERIOD None The payment date as chosen by the creator of the payment.
createdOn PERIOD None The date the payment was added to Brightpearl.
journalId IDSET None The journal ID associated with this payment, if there is one.

Sorting

Sorted by Sort Direction
paymentId ASC

More information

Instructions for working with resources can be found in Resource search design