The Bokio API includes a metadata field on some writable object. It is only applicable for create invoice operation for now. As a developer, you can use this field to add custom key-value data that you might need to build and maintain your integration with the Bokio platform.

As an example, the metadata field would look similar to the json body below:

{
  ..
  "metadata": 
  {
    "key1": "value1",
    "key2": "value2"
  }
}

Filtering

The metadata can be used in filtering when you do GET requests. Metadata are saved as string fields. Refer to filtering documentation for checking allowed operations.

Query syntax uses a prefix 'metadata' before the key as shown in the example below. For the above sample metadata field, you can build a query similar to

query=metadata.key1==value1&&metadata.key2~value2

Usage and Limitations

The metadata feature allows you to attach application-specific information to Bokio objects with the following constraints:

Each writable object can hold up to 10 distinct metadata keys
Keys are limited to a maximum of 25 characters in length
Values can contain up to 250 characters per entry
Both keys and values are stored as strings

Important Considerations

Bokio does not use or process the metadata information internally, and this information will not be displayed to users within the Bokio application interface.

While the metadata field provides flexibility for your integration needs, we strongly recommend against storing any sensitive or personal information in these fields, including but not limited to:

Personal identification numbers
Bank account details
Passwords or credentials
Any other confidential information

The metadata field is ideal for storing references to your own systems, tracking integration-specific states, or maintaining other non-sensitive contextual information.

📘
Support and Community
If you have any questions, issues, or feedback regarding the Bokio API, please reach out to support@bokio.se or join the Developer community. We appreciate any feedback you might have.