Metadata

A number of objects in Sivo support a metadata property. This property can be used to inject additional data that is useful to your application. For example, when you create an invoice you may want to associate the internal ID that your application uses. This can be useful for debugging or to be able to connect with application data when you retrieve the object from Sivo.

Metadata properties must have string keys and scalar values that are either string, number, boolean, or null.

Updating metadata

metadata behaves like any other upsert field: omit it to leave the stored value unchanged, send an object to replace the stored metadata wholesale, or send null to clear it. To change a single key, send the full object with that key updated.

Filtering by metadata

List endpoints that support metadata (like List all receivables) can filter on it with one query parameter per key, matched exactly:

curl "https://core.sivo.com/receivables?metadata[po_number]=PO-1234" \
  -H "Authorization: Bearer $SIVO_API_KEY"

Multiple metadata parameters combine with AND — every key must match.