AggregationConfigInvoiceSearchableField¶

Example Json Object

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

📄 Description: Data transfer object representing the configurable fields for invoice search functionality, enabling efficient retrieval and management of invoice data within the system.

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	Type of the resource
field	string	false	none	Specifies the searchable field for invoice aggregation configurations, enabling efficient retrieval and analysis of invoice data.
size	integer(int32)	false	none	Number of items per page
missing	string	false	none	Indicates a specific attribute related to the aggregation configuration for invoice searchability within the system.

Enumerated Values

Attribute	Value
field	ANY_INVOICE_PAYMENT_STATE, ANY_LINE_ITEM_BUSINESS_AREA_DISPLAY_ID, ANY_LINE_ITEM_BUSINESS_AREA_ID, ANY_LINE_ITEM_CREATED_AT, ANY_LINE_ITEM_CREATED_BY, ANY_LINE_ITEM_DESCRIPTION, ANY_LINE_ITEM_DISPLAY_ID, ANY_LINE_ITEM_EXPENSE_CATEGORY_DISPLAY_ID, ANY_LINE_ITEM_EXPENSE_CATEGORY_ID, ANY_LINE_ITEM_FUNCTIONAL_AREA_DISPLAY_ID, ANY_LINE_ITEM_FUNCTIONAL_AREA_ID, ANY_LINE_ITEM_ID, ANY_LINE_ITEM_INTERNAL_ORDER_DISPLAY_ID, ANY_LINE_ITEM_INTERNAL_ORDER_ID, ANY_LINE_ITEM_INTERNAL_ORDER_TYPE_DISPLAY_ID, ANY_LINE_ITEM_INTERNAL_ORDER_TYPE_ID, ANY_LINE_ITEM_MODIFIED_AT, ANY_LINE_ITEM_MODIFIED_BY, ANY_LINE_ITEM_NETWORK_DISPLAY_ID, ANY_LINE_ITEM_NETWORK_ID, ANY_LINE_ITEM_PROFIT_CENTER_DISPLAY_ID, ANY_LINE_ITEM_PROFIT_CENTER_ID, ANY_LINE_ITEM_QUANTITY, ANY_LINE_ITEM_SEGMENT_DISPLAY_ID, ANY_LINE_ITEM_SEGMENT_ID, ANY_LINE_ITEM_TAX_CODE_DISPLAY_ID, ANY_LINE_ITEM_TAX_CODE_ID, ANY_LINE_ITEM_TAX_JURISDICTION_DISPLAY_ID, ANY_LINE_ITEM_TAX_JURISDICTION_ID, ANY_LINE_ITEM_UNIT_OF_MEASURE_DISPLAY_ID, ANY_LINE_ITEM_UNIT_OF_MEASURE_ID, ANY_LINE_ITEM_UNIT_PRICE, ANY_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_DISPLAY_ID, ANY_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_ID, BILLING_PERIOD_FROM_DATE, BILLING_PERIOD_TO_DATE, COMPANY_DISPLAY_ID, COMPANY_ID, CREATED_AT, CREATED_BY, CURRENCY_DISPLAY_ID, CURRENCY_ID, DEFAULT_COST_CENTER_DISPLAY_ID, DEFAULT_COST_CENTER_ID, DEFAULT_PROFIT_CENTER_DISPLAY_ID, DEFAULT_PROFIT_CENTER_ID, DISPLAY_ID, DUE_DATE, EXTERNAL_DOCUMENT_NUMBER, ID, INVOICE_DATE, INVOICE_TYPE, LEDGER_TRANSACTION_ACCOUNTING_DOCUMENT_ID, LEDGER_TRANSACTION_DISPLAY_ID, LEDGER_TRANSACTION_ID, LEDGER_TRANSACTION_POSTING_DATE, LINE_ITEMS_NET_AMOUNT_SUM, LINE_ITEMS_TOTAL_AMOUNT_SUM, LINE_ITEM_BALANCE_REMAINING_NET_AMOUNT, LINE_ITEM_BALANCE_REMAINING_TAX_AMOUNT, LINE_ITEM_BALANCE_RESERVED_NET_AMOUNT, LINE_ITEM_BALANCE_TOTAL_NET_AMOUNT, MODIFIED_AT, MODIFIED_BY, NAME, NOTES, PAYMENT_BLOCK_DISPLAY_ID, PAYMENT_BLOCK_ID, PAYMENT_METHOD_DISPLAY_ID, PAYMENT_METHOD_ID, PAYMENT_TERM_DISPLAY_ID, PAYMENT_TERM_ID, PURCHASE_ORDER_COMPANY_DISPLAY_ID, PURCHASE_ORDER_COMPANY_ID, PURCHASE_ORDER_CREATED_AT, PURCHASE_ORDER_CREATED_BY, PURCHASE_ORDER_CURRENCY_DISPLAY_ID, PURCHASE_ORDER_CURRENCY_ID, PURCHASE_ORDER_DISPLAY_ID, PURCHASE_ORDER_EXPECTED_DELIVERY_DATE, PURCHASE_ORDER_EXTERNAL_PURCHASE_ORDER_DISPLAY_ID, PURCHASE_ORDER_ID, PURCHASE_ORDER_ISSUE_DATE, PURCHASE_ORDER_MODIFIED_AT, PURCHASE_ORDER_MODIFIED_BY, PURCHASE_ORDER_NOTES, PURCHASE_ORDER_REFERENCE, PURCHASE_ORDER_SHIPPING_ADDRESS, PURCHASE_ORDER_STATE, PURCHASE_ORDER_VENDOR_DISPLAY_ID, PURCHASE_ORDER_VENDOR_ID, SCHEDULED_PAYMENT_ALLOCATED_AMOUNT, SCHEDULED_PAYMENT_AVAILABLE_NET_AMOUNT, SCHEDULED_PAYMENT_AVAILABLE_TAX_AMOUNT, SCHEDULED_PAYMENT_CLEARING_LEDGER_ENTRY_ID, SCHEDULED_PAYMENT_CLEARING_LEDGER_TRANSACTION_ID, SCHEDULED_PAYMENT_COMPANY_DISPLAY_ID, SCHEDULED_PAYMENT_COMPANY_ID, SCHEDULED_PAYMENT_CREATED_AT, SCHEDULED_PAYMENT_CREATED_BY, SCHEDULED_PAYMENT_CURRENCY_DISPLAY_ID, SCHEDULED_PAYMENT_CURRENCY_ID, SCHEDULED_PAYMENT_DELTA_ADJUSTMENT, SCHEDULED_PAYMENT_DISPLAY_ID, SCHEDULED_PAYMENT_EXPENSE_CATEGORY_DISPLAY_ID, SCHEDULED_PAYMENT_EXPENSE_CATEGORY_ID, SCHEDULED_PAYMENT_FISCAL_PERIOD, SCHEDULED_PAYMENT_FISCAL_YEAR, SCHEDULED_PAYMENT_ID, SCHEDULED_PAYMENT_MATCHED_AMOUNT, SCHEDULED_PAYMENT_MODIFIED_AT, SCHEDULED_PAYMENT_MODIFIED_BY, SCHEDULED_PAYMENT_PAYMENT_METHOD_DISPLAY_ID, SCHEDULED_PAYMENT_PAYMENT_METHOD_ID, SCHEDULED_PAYMENT_POSTED_AMOUNT, SCHEDULED_PAYMENT_POSTING_DATE, SCHEDULED_PAYMENT_REMAINING_AMOUNT, SCHEDULED_PAYMENT_ROUNDED_AMOUNT, SCHEDULED_PAYMENT_UNROUNDED_AMOUNT, SCHEDULED_PAYMENT_VENDOR_DISPLAY_ID, SCHEDULED_PAYMENT_VENDOR_ID, STATE, VENDOR_DISPLAY_ID, VENDOR_ID, WORKSPACE_CREATED_AT, WORKSPACE_CREATED_BY, WORKSPACE_DISPLAY_ID, WORKSPACE_DOCUMENT_DATE, WORKSPACE_ID, WORKSPACE_MODIFIED_AT, WORKSPACE_MODIFIED_BY, WORKSPACE_NAME, WORKSPACE_POSTING_DATE, WORKSPACE_STATE
type	AVG, COUNT, DATE_HISTOGRAM, MAX, MIN, RANGE, SUM, TERMS

Attribute

Value

field

ANY_INVOICE_PAYMENT_STATE, ANY_LINE_ITEM_BUSINESS_AREA_DISPLAY_ID, ANY_LINE_ITEM_BUSINESS_AREA_ID, ANY_LINE_ITEM_CREATED_AT, ANY_LINE_ITEM_CREATED_BY, ANY_LINE_ITEM_DESCRIPTION, ANY_LINE_ITEM_DISPLAY_ID, ANY_LINE_ITEM_EXPENSE_CATEGORY_DISPLAY_ID, ANY_LINE_ITEM_EXPENSE_CATEGORY_ID, ANY_LINE_ITEM_FUNCTIONAL_AREA_DISPLAY_ID, ANY_LINE_ITEM_FUNCTIONAL_AREA_ID, ANY_LINE_ITEM_ID, ANY_LINE_ITEM_INTERNAL_ORDER_DISPLAY_ID, ANY_LINE_ITEM_INTERNAL_ORDER_ID, ANY_LINE_ITEM_INTERNAL_ORDER_TYPE_DISPLAY_ID, ANY_LINE_ITEM_INTERNAL_ORDER_TYPE_ID, ANY_LINE_ITEM_MODIFIED_AT, ANY_LINE_ITEM_MODIFIED_BY, ANY_LINE_ITEM_NETWORK_DISPLAY_ID, ANY_LINE_ITEM_NETWORK_ID, ANY_LINE_ITEM_PROFIT_CENTER_DISPLAY_ID, ANY_LINE_ITEM_PROFIT_CENTER_ID, ANY_LINE_ITEM_QUANTITY, ANY_LINE_ITEM_SEGMENT_DISPLAY_ID, ANY_LINE_ITEM_SEGMENT_ID, ANY_LINE_ITEM_TAX_CODE_DISPLAY_ID, ANY_LINE_ITEM_TAX_CODE_ID, ANY_LINE_ITEM_TAX_JURISDICTION_DISPLAY_ID, ANY_LINE_ITEM_TAX_JURISDICTION_ID, ANY_LINE_ITEM_UNIT_OF_MEASURE_DISPLAY_ID, ANY_LINE_ITEM_UNIT_OF_MEASURE_ID, ANY_LINE_ITEM_UNIT_PRICE, ANY_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_DISPLAY_ID, ANY_LINE_ITEM_WORK_BREAKDOWN_STRUCTURE_ID, BILLING_PERIOD_FROM_DATE, BILLING_PERIOD_TO_DATE, COMPANY_DISPLAY_ID, COMPANY_ID, CREATED_AT, CREATED_BY, CURRENCY_DISPLAY_ID, CURRENCY_ID, DEFAULT_COST_CENTER_DISPLAY_ID, DEFAULT_COST_CENTER_ID, DEFAULT_PROFIT_CENTER_DISPLAY_ID, DEFAULT_PROFIT_CENTER_ID, DISPLAY_ID, DUE_DATE, EXTERNAL_DOCUMENT_NUMBER, ID, INVOICE_DATE, INVOICE_TYPE, LEDGER_TRANSACTION_ACCOUNTING_DOCUMENT_ID, LEDGER_TRANSACTION_DISPLAY_ID, LEDGER_TRANSACTION_ID, LEDGER_TRANSACTION_POSTING_DATE, LINE_ITEMS_NET_AMOUNT_SUM, LINE_ITEMS_TOTAL_AMOUNT_SUM, LINE_ITEM_BALANCE_REMAINING_NET_AMOUNT, LINE_ITEM_BALANCE_REMAINING_TAX_AMOUNT, LINE_ITEM_BALANCE_RESERVED_NET_AMOUNT, LINE_ITEM_BALANCE_TOTAL_NET_AMOUNT, MODIFIED_AT, MODIFIED_BY, NAME, NOTES, PAYMENT_BLOCK_DISPLAY_ID, PAYMENT_BLOCK_ID, PAYMENT_METHOD_DISPLAY_ID, PAYMENT_METHOD_ID, PAYMENT_TERM_DISPLAY_ID, PAYMENT_TERM_ID, PURCHASE_ORDER_COMPANY_DISPLAY_ID, PURCHASE_ORDER_COMPANY_ID, PURCHASE_ORDER_CREATED_AT, PURCHASE_ORDER_CREATED_BY, PURCHASE_ORDER_CURRENCY_DISPLAY_ID, PURCHASE_ORDER_CURRENCY_ID, PURCHASE_ORDER_DISPLAY_ID, PURCHASE_ORDER_EXPECTED_DELIVERY_DATE, PURCHASE_ORDER_EXTERNAL_PURCHASE_ORDER_DISPLAY_ID, PURCHASE_ORDER_ID, PURCHASE_ORDER_ISSUE_DATE, PURCHASE_ORDER_MODIFIED_AT, PURCHASE_ORDER_MODIFIED_BY, PURCHASE_ORDER_NOTES, PURCHASE_ORDER_REFERENCE, PURCHASE_ORDER_SHIPPING_ADDRESS, PURCHASE_ORDER_STATE, PURCHASE_ORDER_VENDOR_DISPLAY_ID, PURCHASE_ORDER_VENDOR_ID, SCHEDULED_PAYMENT_ALLOCATED_AMOUNT, SCHEDULED_PAYMENT_AVAILABLE_NET_AMOUNT, SCHEDULED_PAYMENT_AVAILABLE_TAX_AMOUNT, SCHEDULED_PAYMENT_CLEARING_LEDGER_ENTRY_ID, SCHEDULED_PAYMENT_CLEARING_LEDGER_TRANSACTION_ID, SCHEDULED_PAYMENT_COMPANY_DISPLAY_ID, SCHEDULED_PAYMENT_COMPANY_ID, SCHEDULED_PAYMENT_CREATED_AT, SCHEDULED_PAYMENT_CREATED_BY, SCHEDULED_PAYMENT_CURRENCY_DISPLAY_ID, SCHEDULED_PAYMENT_CURRENCY_ID, SCHEDULED_PAYMENT_DELTA_ADJUSTMENT, SCHEDULED_PAYMENT_DISPLAY_ID, SCHEDULED_PAYMENT_EXPENSE_CATEGORY_DISPLAY_ID, SCHEDULED_PAYMENT_EXPENSE_CATEGORY_ID, SCHEDULED_PAYMENT_FISCAL_PERIOD, SCHEDULED_PAYMENT_FISCAL_YEAR, SCHEDULED_PAYMENT_ID, SCHEDULED_PAYMENT_MATCHED_AMOUNT, SCHEDULED_PAYMENT_MODIFIED_AT, SCHEDULED_PAYMENT_MODIFIED_BY, SCHEDULED_PAYMENT_PAYMENT_METHOD_DISPLAY_ID, SCHEDULED_PAYMENT_PAYMENT_METHOD_ID, SCHEDULED_PAYMENT_POSTED_AMOUNT, SCHEDULED_PAYMENT_POSTING_DATE, SCHEDULED_PAYMENT_REMAINING_AMOUNT, SCHEDULED_PAYMENT_ROUNDED_AMOUNT, SCHEDULED_PAYMENT_UNROUNDED_AMOUNT, SCHEDULED_PAYMENT_VENDOR_DISPLAY_ID, SCHEDULED_PAYMENT_VENDOR_ID, STATE, VENDOR_DISPLAY_ID, VENDOR_ID, WORKSPACE_CREATED_AT, WORKSPACE_CREATED_BY, WORKSPACE_DISPLAY_ID, WORKSPACE_DOCUMENT_DATE, WORKSPACE_ID, WORKSPACE_MODIFIED_AT, WORKSPACE_MODIFIED_BY, WORKSPACE_NAME, WORKSPACE_POSTING_DATE, WORKSPACE_STATE

type

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