Manage custom fields

There are 3 APIs to help you manage custom fields:

  • CreateOrUpdateCustomFields - Creates, updates or deletes custom fields of all custom field types

    • For custom fields of type ListOfValues or MultipleValues, any value that is not included in the request will be deleted. If you don't know all the values to include, you can call the GetCustomFields API. If the custom field is for bills and is of type ListOfValues, and you don't want to worry about which values may be deleted, use the CreateOrUpdateCustomFieldValue API.

  • CreateOrUpdateCustomFieldValue - Creates or updates a single custom field value (applies only to bill custom fields of type ListOfValues)

    • Custom field values deleted via this API are kept on all bills that were approved already. Bills in a "Pending approval" status are sent back to AP so that AP can assign a new value to the bill.

  • GetCustomFields - Returns the payer's defined custom fields

Custom Field Types

Tipalti supports the following custom field types:

  • FreeText - Used for text entries
  • UniqueText - Used to prevent duplicate values from being entered
  • ListOfValues - Allows the user to select a single value from a predefined list of values
  • MultipleValues - Allows the user to select multiple values from a predefined list of values

The table below shows the custom field types supported for each entity An entity can be a subsidiary, division, business unit, brand, etc. of your organization. Entities can have similar or different AP processes and workflows. and sub-entity.

Entity

Sub-entity

custom field Type

Payment order — Free text
Payee

—
  • Free text
  • Unique text
  • Multiple values
  • List of values
Invoice Bill
  • Free text
  • List of values
Invoice Bill line
  • Free text
  • List of values
PurchaseOrder —
  • Free text
  • List of values
Invoice + PurchaseOrder —
  • Free text
  • List of values