Skip to content

Custom Fields

Manage your Custom Fields in Moneybird.

Working with Custom Fields

This section covers how to interact with Moneybird’s Custom Fields API. You can retrieve custom fields information.

Basic Operations

Get a Custom Field

Retrieve a custom field by its ID.

$customField = $client->customFields()->get('123456789');

List Custom Fields

Get a list of all custom fields.

$customFields = $client->customFields()->all();
// Iterate through the custom fields
foreach ($customFields as $customField) {
echo $customField->name;
}

Custom Field Properties

When working with custom fields, you’ll have access to the following properties:

PropertyTypeDescription
idstringUnique identifier
administration_idstringID of the administration the custom field belongs to
namestringName of the custom field
sourcestringSource of the custom field (e.g., ‘sales_invoice’, ‘contact’)
created_atstringISO 8601 timestamp of when the custom field was created
updated_atstringISO 8601 timestamp of when the custom field was last updated

Note: See the official API reference for the complete list of available properties.

Further reading