Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Discount Code → Get List

AI-generated

Summary

Retrieve a filtered list of Discount Code records from Acumatica using OData $filter expressions constructed from user-specified criteria.

Inputs

  • Applicable To Filter — Filter Discount Codes by the 'Applicable To' field using operators Equals, Contains, or Starts With.
  • Created Date Time Filter — Filter Discount Codes by their creation date/time using operators such as Equals, After, On or After, Before, or On or Before.
  • Description Filter — Filter Discount Codes by description using operators Equals, Contains, or Starts With.
  • Discount Code ID Filter — Filter Discount Codes by Discount Code ID using operators Equals, Contains, or Starts With.
  • Discount Type Filter — Filter Discount Codes by Discount Type using operators Equals, Contains, or Starts With.
  • Last Modified Date Time Filter — Filter Discount Codes by last modified date/time using operators such as Equals, After, On or After, Before, or On or Before.
  • Custom Filter — Specify an advanced custom OData $filter string to apply additional filtering criteria beyond the predefined filters.

Output shape

a list of Discount Code records matching the filter criteria, returned as JSON objects with fields defined by the Acumatica API schema for Discount Codes.

Filters combine to form an OData $filter expression which is sent to the Acumatica API. Only Discount Codes matching this filter are returned. If no filters are set, all Discount Codes are retrieved. The output does not include pagination or error envelope details by default.

Examples

Example 1: Retrieve all Discount Codes applicable to 'Customer' created after 2023-01-01.

Set 'Applicable To Filter' with operator 'Equals' and value 'Customer', and 'Created Date Time Filter' with operator 'After' and value '2023-01-01T00:00:00'.

Example 2: Retrieve Discount Codes whose description contains 'Summer' ignoring case.

Set 'Description Filter' with operator 'Contains' and value 'Summer'.

Example 3: Use a custom OData filter to retrieve Discount Codes with IDs starting with 'DISC' and last modified on or after 2024-01-01.

Set 'Custom Filter' with value "startswith(DiscountCodeID/value, 'DISC') and LastModifiedDateTime/value ge 2024-01-01T00:00:00".

Links

Discussion