Custom Fields

List custom fields

Changed on

Retrieve a paginated list of custom field definitions with filtering and ordering options.

get/public/v1/custom-fields/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v1/custom-fields/
  • Auth: none declared

Query parameters

searchstring nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
idinteger[] nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph'
is_activeboolean nullable
namestring nullable
record_type'invoice' | 'bill' | 'direct_expense' | 'journal_entry' | 'vendor_prepayment' | 'vendor_credit' | 'vendor_payment' | 'vendor_refund' | 'customer_payment' | 'customer_prepayment' | 'customer_refund' | 'customer_deposit' | 'currency_revaluation' | 'contract' | 'fixed_asset' | 'customer' | 'vendor' | 'company' | 'sales_order' | 'cash_sale' | 'customer_credit'

Filter to fields that apply to this record type (e.g. customer, invoice).

layer'transaction' | 'entry'

Filter on header (transaction) vs line (entry) applicability.

company_idinteger nullable

Include both org-level fields and fields scoped to this company id.

is_requiredboolean nullable

Filter on the is_required flag of the applies_to entry (needs record_type).

is_active_recordboolean nullable

Filter on the is_active flag of the applies_to entry (needs record_type).

orderingstring nullable
limitinteger

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Response

OK

countinteger required

Changes

  • a74a611f93bbRevision changes
    • info

      added the new optional query request parameter layer

    • info

      added the optional property //// to the response with the status

  • 074797834e54Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status