CompanyCustomFields
List the custom fields of a company
Returns the invoice custom fields of this company, each one with the options that apply to the query, ordered by key. A field with suggest_values: false carries no options.
- Options per customer: with customer_id, each field carries the common options and those of that customer, which is what an invoice for that customer can offer. Without it, only the common options. To page through every option of a field, use GET /v1/companies/{company_id}/custom-fields/{key}/options.
- Archived: archived fields and options are left out unless include_archived=true.
Closed catalogue. A company defines a small set of fields: this collection carries no pagination, takes no page/limit, and every response holds the whole set.
get/v1/companies/{company_id}/custom-fields
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/custom-fields
- Auth: HTTP bearer
Query parameters
customer_idstring uuid
Adds the options of this customer to the common ones. A value that names no customer of this company is not an error: only the common options come back.
include_archivedboolean
Include archived fields and archived options.
Response
Custom fields of the company.
Example response
{
"success": true,
"data": {
"custom_fields": [
{
"id": "7d2f8a40-3c1e-4b6a-9f0d-2e5b8c1a4d77",
"key": "store",
"label": "Store",
"show_on_pdf": true,
"suggest_values": true,
"is_archived": false,
"options": [
{
"id": "0b6c1e2f-5a4d-4c3b-8e7f-1a2b3c4d5e6f",
"value": "Online store",
"customer_id": null,
"is_archived": false
},
{
"id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
"value": "Gran Vía 12",
"customer_id": "4f244735-980b-4d9c-80e8-6331fa0b1958",
"is_archived": false
}
]
}
]
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.