AggregationConfigScheduledPaymentSearchableField¶

Example Json Object

{
  "type": "TERMS",
  "field": "ID",
  "size": 0,
  "missing": "string"
}

📄 Description: Data transfer object representing the configurable fields for scheduled payment searches, enabling users to efficiently filter and retrieve relevant payment information within the aggregation framework.

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	Type of the resource
field	string	false	none	Specifies the searchable field for scheduled payment aggregation configurations within the API.
size	integer(int32)	false	none	Number of items per page
missing	string	false	none	Indicates the absence of a specified value within the scheduled payment aggregation configuration.

Enumerated Values

Attribute	Value
field	AVAILABLE_NET_AMOUNT, AVAILABLE_TAX_AMOUNT, CLEARING_LEDGER_ENTRY_ID, CLEARING_LEDGER_TRANSACTION_ID, COMPANY_DISPLAY_ID, COMPANY_ID, CREATED_AT, CREATED_BY, CURRENCY_DISPLAY_ID, CURRENCY_ID, DELTA_ADJUSTMENT, DISPLAY_ID, EXPENSE_CATEGORY_DISPLAY_ID, EXPENSE_CATEGORY_ID, FISCAL_PERIOD, FISCAL_YEAR, ID, INVOICE_BILLING_PERIOD_FROM_DATE, INVOICE_BILLING_PERIOD_TO_DATE, INVOICE_COMPANY_DISPLAY_ID, INVOICE_COMPANY_ID, INVOICE_CREATED_AT, INVOICE_CREATED_BY, INVOICE_CURRENCY_DISPLAY_ID, INVOICE_CURRENCY_ID, INVOICE_DISPLAY_ID, INVOICE_DUE_DATE, INVOICE_EXTERNAL_DOCUMENT_NUMBER, INVOICE_ID, INVOICE_INVOICE_DATE, INVOICE_INVOICE_TYPE, INVOICE_LINE_ITEM_COST_CENTER_DISPLAY_ID, INVOICE_LINE_ITEM_COST_CENTER_ID, INVOICE_LINE_ITEM_CREATED_AT, INVOICE_LINE_ITEM_CREATED_BY, INVOICE_LINE_ITEM_DESCRIPTION, INVOICE_LINE_ITEM_DISPLAY_ID, INVOICE_LINE_ITEM_EXPENSE_CATEGORY_DISPLAY_ID, INVOICE_LINE_ITEM_EXPENSE_CATEGORY_ID, INVOICE_LINE_ITEM_ID, INVOICE_LINE_ITEM_INVOICE_DISPLAY_ID, INVOICE_LINE_ITEM_INVOICE_ID, INVOICE_LINE_ITEM_INVOICE_NAME, INVOICE_LINE_ITEM_INVOICE_STATE, INVOICE_LINE_ITEM_INVOICE_VENDOR_DISPLAY_ID, INVOICE_LINE_ITEM_INVOICE_VENDOR_ID, INVOICE_LINE_ITEM_MODIFIED_AT, INVOICE_LINE_ITEM_MODIFIED_BY, INVOICE_LINE_ITEM_PROFIT_CENTER_DISPLAY_ID, INVOICE_LINE_ITEM_PROFIT_CENTER_ID, INVOICE_LINE_ITEM_QUANTITY, INVOICE_LINE_ITEM_TAX_CODE_DISPLAY_ID, INVOICE_LINE_ITEM_TAX_CODE_ID, INVOICE_LINE_ITEM_TAX_JURISDICTION_DISPLAY_ID, INVOICE_LINE_ITEM_TAX_JURISDICTION_ID, INVOICE_LINE_ITEM_UNIT_PRICE, INVOICE_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_DISPLAY_ID, INVOICE_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_ID, INVOICE_MODIFIED_AT, INVOICE_MODIFIED_BY, INVOICE_NAME, INVOICE_NOTES, INVOICE_PAYMENT_BLOCK_DISPLAY_ID, INVOICE_PAYMENT_BLOCK_ID, INVOICE_PAYMENT_METHOD_DISPLAY_ID, INVOICE_PAYMENT_METHOD_ID, INVOICE_PAYMENT_TERM_DISPLAY_ID, INVOICE_PAYMENT_TERM_ID, INVOICE_PURCHASE_ORDER_REFERENCE, INVOICE_STATE, INVOICE_VENDOR_DISPLAY_ID, INVOICE_VENDOR_ID, INVOICE_WORKSPACE_DISPLAY_ID, INVOICE_WORKSPACE_ID, INVOICE_WORKSPACE_NAME, INVOICE_WORKSPACE_STATE, MODIFIED_AT, MODIFIED_BY, PAYMENT_METHOD_DISPLAY_ID, PAYMENT_METHOD_ID, POSTING_DATE, ROUNDED_AMOUNT, UNROUNDED_AMOUNT, VENDOR_DISPLAY_ID, VENDOR_ID
type	AVG, COUNT, DATE_HISTOGRAM, MAX, MIN, RANGE, SUM, TERMS

Attribute

Value

field

AVAILABLE_NET_AMOUNT, AVAILABLE_TAX_AMOUNT, CLEARING_LEDGER_ENTRY_ID, CLEARING_LEDGER_TRANSACTION_ID, COMPANY_DISPLAY_ID, COMPANY_ID, CREATED_AT, CREATED_BY, CURRENCY_DISPLAY_ID, CURRENCY_ID, DELTA_ADJUSTMENT, DISPLAY_ID, EXPENSE_CATEGORY_DISPLAY_ID, EXPENSE_CATEGORY_ID, FISCAL_PERIOD, FISCAL_YEAR, ID, INVOICE_BILLING_PERIOD_FROM_DATE, INVOICE_BILLING_PERIOD_TO_DATE, INVOICE_COMPANY_DISPLAY_ID, INVOICE_COMPANY_ID, INVOICE_CREATED_AT, INVOICE_CREATED_BY, INVOICE_CURRENCY_DISPLAY_ID, INVOICE_CURRENCY_ID, INVOICE_DISPLAY_ID, INVOICE_DUE_DATE, INVOICE_EXTERNAL_DOCUMENT_NUMBER, INVOICE_ID, INVOICE_INVOICE_DATE, INVOICE_INVOICE_TYPE, INVOICE_LINE_ITEM_COST_CENTER_DISPLAY_ID, INVOICE_LINE_ITEM_COST_CENTER_ID, INVOICE_LINE_ITEM_CREATED_AT, INVOICE_LINE_ITEM_CREATED_BY, INVOICE_LINE_ITEM_DESCRIPTION, INVOICE_LINE_ITEM_DISPLAY_ID, INVOICE_LINE_ITEM_EXPENSE_CATEGORY_DISPLAY_ID, INVOICE_LINE_ITEM_EXPENSE_CATEGORY_ID, INVOICE_LINE_ITEM_ID, INVOICE_LINE_ITEM_INVOICE_DISPLAY_ID, INVOICE_LINE_ITEM_INVOICE_ID, INVOICE_LINE_ITEM_INVOICE_NAME, INVOICE_LINE_ITEM_INVOICE_STATE, INVOICE_LINE_ITEM_INVOICE_VENDOR_DISPLAY_ID, INVOICE_LINE_ITEM_INVOICE_VENDOR_ID, INVOICE_LINE_ITEM_MODIFIED_AT, INVOICE_LINE_ITEM_MODIFIED_BY, INVOICE_LINE_ITEM_PROFIT_CENTER_DISPLAY_ID, INVOICE_LINE_ITEM_PROFIT_CENTER_ID, INVOICE_LINE_ITEM_QUANTITY, INVOICE_LINE_ITEM_TAX_CODE_DISPLAY_ID, INVOICE_LINE_ITEM_TAX_CODE_ID, INVOICE_LINE_ITEM_TAX_JURISDICTION_DISPLAY_ID, INVOICE_LINE_ITEM_TAX_JURISDICTION_ID, INVOICE_LINE_ITEM_UNIT_PRICE, INVOICE_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_DISPLAY_ID, INVOICE_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_ID, INVOICE_MODIFIED_AT, INVOICE_MODIFIED_BY, INVOICE_NAME, INVOICE_NOTES, INVOICE_PAYMENT_BLOCK_DISPLAY_ID, INVOICE_PAYMENT_BLOCK_ID, INVOICE_PAYMENT_METHOD_DISPLAY_ID, INVOICE_PAYMENT_METHOD_ID, INVOICE_PAYMENT_TERM_DISPLAY_ID, INVOICE_PAYMENT_TERM_ID, INVOICE_PURCHASE_ORDER_REFERENCE, INVOICE_STATE, INVOICE_VENDOR_DISPLAY_ID, INVOICE_VENDOR_ID, INVOICE_WORKSPACE_DISPLAY_ID, INVOICE_WORKSPACE_ID, INVOICE_WORKSPACE_NAME, INVOICE_WORKSPACE_STATE, MODIFIED_AT, MODIFIED_BY, PAYMENT_METHOD_DISPLAY_ID, PAYMENT_METHOD_ID, POSTING_DATE, ROUNDED_AMOUNT, UNROUNDED_AMOUNT, VENDOR_DISPLAY_ID, VENDOR_ID

type

AVG, COUNT, DATE_HISTOGRAM, MAX, MIN, RANGE, SUM, TERMS