Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-07 12:34:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update the documentation relating to how we assemble custom fields on the company object

Browse Source
This commit is contained in:
David Bomba 2024-09-11 11:31:26 +10:00
parent 3703ec1b36
commit 730d55a31e
2 changed files with 76 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
openapi/api-docs.yaml
View File

@ -15927,7 +15927,44 @@ components:
type: boolean type: boolean
example: true example: true
custom_fields: custom_fields:
description: "A mapping of custom fields for various objects within the company" description: |
A mapping of custom fields for various objects within the company
**note**
The custom fields object is formatted as follows
key : value
entity(integer) : label|type
for example:
"company1": "Number|single_line_text",
This defines the first company custom field, with label Number which has a custom field type of a single text line
Supported entity types
invoice
product
client
contact
task
user
project
vendor
expense
payment
Supported input types values
single_line_text
date
switch
For text areas, you only need to supply the label ie "TextArea", the | and type values are not required.
For the dropdown the data format is as follows:
label|your,drop,down,values,in,comma,separated,format
type: object type: object
enable_product_cost: enable_product_cost:
description: "A flag determining whether to show or hide the product cost field in the user interface" description: "A flag determining whether to show or hide the product cost field in the user interface"

39
openapi/components/schemas/company.yaml
View File

@ -57,7 +57,44 @@
type: boolean type: boolean
example: true example: true
custom_fields: custom_fields:
description: "A mapping of custom fields for various objects within the company" description: |
A mapping of custom fields for various objects within the company
**note**
The custom fields object is formatted as follows
key : value
entity(integer) : label|type
for example:
"company1": "Number|single_line_text",
This defines the first company custom field, with label Number which has a custom field type of a single text line
Supported entity types
invoice
product
client
contact
task
user
project
vendor
expense
payment
Supported input types values
single_line_text
date
switch
For text areas, you only need to supply the label ie "TextArea", the | and type values are not required.
For the dropdown the data format is as follows:
label|your,drop,down,values,in,comma,separated,format
type: object type: object
enable_product_cost: enable_product_cost:
description: "A flag determining whether to show or hide the product cost field in the user interface" description: "A flag determining whether to show or hide the product cost field in the user interface"