Metadata

Updatable Ophelos objects—including Debts, Customers, and Organisations has a metadata parameter.
You can use this parameter to attach key-value data to these objects.

You can use metadata to store additional, structured information on an object. For example, you could store your own unqiue identifier from your system for the object. Ophelos doesn't use this data for its own purposes, but you can retrieve it when you retrieve the object. It is not displayed to customers.

Shell

curl https://api.ophelos.com/debts \
  -u sk_prod_H4x0rN0t4R3alAPiK3y: \
  -d "metadata[case_id]=3012345"

JSON

{
  "id": "deb_123",
  ...
  "metadata": {
    "case_id": "3012345"
  }
}

Some objects support a description parameter. You can use description parameter to annotate the object with a human-readable description. This is displayed to customers.

Do not store any sensitive information (customer bank details, etc.) in the metadata field.

Sample metadata use cases

• External IDs: Attach your system's unique IDs to a object to simplify lookups. For example, you could store your customer ID in the metadata field of a customer object.