<aside> 🔒

Information Classification: Public

</aside>

This document outlines all of the current validation rules applied by the Beacon API when data is sent via an API request.

If an invalid value is passed to a field, Beacon will respond with a 500 error, and return the validation that hasn’t been met:

"error": {
	"code": "server_error"
	"message": "Oh shoot! An unknown error occurred. "
			"raw": "Validation error: \\"external_id\\": Maximum string length is 255 characters",
	"name": "ValidationError"
}

Field types

Boolean (checkbox)

• Must be a boolean: true or false

Currency

• Must be an object in this JSON format:

  {
    "value": 10,
    "currency": "GBP"
  }
  

  • value must be a number (max. 2 decimal places)
  • currency must be a valid ISO currency code

• Note: Beacon auto-attaches a base_value to the currency object, which is the converted value in the account’s base currency. This shouldn’t be passed in API request payloads.

Date

• Can be a date either in the format:
  • A full ISO date string (e.g. 2024-08-23T08:42:05.265Z).
  • YYYY-MM-DD
• We recommend always passing a full ISO string in the payload.