Skip to navigation

Get the Journal mapping

This endpoint retrieves your Journal mapping for each Journal Line field, showing the origin of the data used when Fynapse creates a Journal from a Business Event.

There is exactly one mapping. The response carries an ETag. Send that value back as If-Match when replacing the mapping, so a change made by someone else in the meantime is rejected rather than overwritten.

Returns 404 until a mapping has been configured.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Response headers

ETagstringOptional

Current entity tag of the resource. Supply it as If-Match on a subsequent update or deactivation.

Response

OK
fieldMappingslist of objectsOptional
One entry per mapped Journal Line field, in order. A write replaces the whole list, so a field left out is no longer mapped.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
5XX
Server Error