Custom fields

What are custom fields for?

In some cases it seems reasonable to provide meta data together with requests for further processing. A usual use case would be to add a document id or tenant id of a third party system to match returned requests to their original source.

In our specific case, you can pass along your internal document id or any other data to the robo accounting engine instead of tracking the id of the robo accounting document in your system.

The custom fields are passed along through the whole process and will be available on every documents endpoint.

How to use custom fields?

You can just pass along a hash of custom fields via the custom_field attribute when submitting documents like so:

{
  "data": {
    "type": "documents",
    "attributes": {
      ...
      "custom_fields": {
        "customer_id": 1234,
        "tenant_id": 20000
      },
      ...
    }
  }
}

Any following request to that document will contain the custom fields for your convenience.