Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Payment → Get List

AI-generated

Summary

Retrieve a list of Payment records from the Acumatica API, applying optional filters to narrow down the results based on multiple Payment fields.

Inputs

  • Application Date Filter — Filter payments by their Application Date using operators like equals, before, after, etc.
  • Applied To Documents Filter — Filter payments based on the number of documents they are applied to using comparison operators.
  • Branch Filter — Filter payments by Branch using operators such as equals, contains, or starts with.
  • Card Account Nbr Filter — Filter payments by Card Account Number with numeric comparison operators.
  • Cash Account Filter — Filter payments by Cash Account using string matching operators.
  • Currency ID Filter — Filter payments by Currency ID using string matching operators.
  • Customer ID Filter — Filter payments by Customer ID using string matching operators.
  • Description Filter — Filter payments by Description text using string matching operators.
  • Hold Filter — Filter payments by Hold status (boolean, equals operator only).
  • Is CC Payment Filter — Filter payments that are credit card payments (boolean, equals operator only).
  • Payment Amount Filter — Filter payments by Payment Amount using numeric comparison operators.
  • Payment Method Filter — Filter payments by Payment Method using string matching operators.
  • Payment Ref Filter — Filter payments by Payment Reference using string matching operators.
  • Reference Nbr Filter — Filter payments by Reference Number using string matching operators.
  • Status Filter — Filter payments by Status using string matching operators.
  • Type Filter — Filter payments by Type using string matching operators.
  • Last Modified Date Time Filter — Filter payments by Last Modified DateTime using date/time comparison operators.
  • Processing Center ID Filter — Filter payments by Processing Center ID using string matching operators.
  • Save Card Filter — Filter payments by Save Card status (boolean, equals operator only).
  • External Ref Filter — Filter payments by External Reference using string matching operators.
  • Orig Transaction Filter — Filter payments by Original Transaction using string matching operators.
  • Branch ID Filter — Filter payments by Branch ID using string matching operators.
  • Customer Location ID Filter — Filter payments by Customer Location ID using string matching operators.
  • Is New Card Filter — Filter payments by Is New Card status (boolean, equals operator only).
  • Available Balance Filter — Filter payments by Available Balance using numeric comparison operators.
  • Applied To Orders Filter — Filter payments by number of orders they are applied to using numeric comparison operators.
  • Custom Filter — Provide a custom OData $filter string expression for advanced filtering beyond the standard fields.

Output shape

a list of Payment records matching the specified filter criteria

Filters are combined into an OData $filter expression applied in the list query. Only Payment resources are returned. The returned data matches the Payment resource schema exposed by the Acumatica API.

Examples

Example 1: Retrieve all Payment records with a Payment Amount greater than 1000 and Status equals 'Open'.

Set 'Payment Amount Filter' operator to 'Greater Than' and value to 1000; set 'Status Filter' operator to 'Equals' and value to 'Open'.

Links

Discussion