Body

• Owner

  Not set directly. Can be set as belonging to: the main client (ClientGUID from Household) ; the related client (RelatedClientGUID from Household); jointly owned by the main client and the related client. To set owned by the main client set ClientGUID as ClientGUID. To set owned by the related client set ClientGUID as RelatedClientGUID. To set as jointly owned set ClientGUID as ClientGUID, set JointOwnerClientGUID as RelatedClientGUID.

• ClientGUID string(uuid) Required

  ClientGUID must be in the household. See Owner for details on what to set.

• AssetDescription string Required

  The following characters are not permitted: \:*"<>|'

  Maximum length is 50.

• AssetType integer Required

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• CurrentValue number(float) Required
• JointOwnerClientGUID string(uuid) | null

  JointOwnerClientGUID must be in the household. See Owner for details on what to set.

• AssetPurchased integer Required

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• StartBasis integer | null

  This field is required if the value of AssetPurchased = 2. Determines the basis of the timing of the Asset Purchase.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• StartEventGUID string(uuid) | null

  This field is required if the value of StartBasis = 4 and the value of AssetPurchased = 2.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• StartAge integer | null

  This field is required if the value of StartBasis = 2 or 7 and the value of AssetPurchased = 2.

  StartAge must be in the future.

  Determines the age at which the Asset is to be Purchased.

  Minimum value is 0, maximum value is 130.

• StartDate string | null

  This field is required if the value of StartBasis = 3 and the value of AssetPurchased = 2.

  StartDate should be in the future.

  Determines the Asset Purchase date.

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.

• PurchasedValue integer | null
• AssetDisposal integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• EndBasis integer | null

  This field is required if the value of AssetDisposal = 1.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• EndEventGUID string(uuid) | null

  This field is required if any of the following conditions are met:

  • The value of AssetDisposal = 1 and the value of AssetPurchased = 1 and the value of EndBasis = 4 (EndEventGUID must be in the future).
  • The value of AssetDisposal = 1 and the value of AssetPurchased = 2 and the value of EndBasis = 4 (EndEventGUID must be after starting).

  Determines the date at which the Asset is to be disposed of.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• EndAge integer | null

  This field is required if any of the following conditions are met:

  • The value of AssetDisposal = 1 and the value of AssetPurchased = 1 and the value of EndBasis = 2 or 7 (EndAge must be in the future).
  • The value of AssetDisposal = 1 and the value of AssetPurchased = 2 and the value of EndBasis = 2 or 7 (EndAge must be after starting).

  Determines the age at which the Asset is to be disposed of.

  Minimum value is 0, maximum value is 130.

• EndDate string | null

  This field is required if any of the following conditions are met:

  • The value of AssetDisposal = 1 and the value of AssetPurchased = 1 and the value of EndBasis = 3 (EndAge must be in the future).
  • The value of AssetDisposal = 1 and the value of AssetPurchased = 2 and the value of EndBasis = 3 (EndAge must be after starting).

  Determines the Asset Disposal date.

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.

• ClearLiabilities integer | null

  This field is required if the value of AssetDisposal = 1.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• TaxBasis integer | null

  This field is required if the value of AssetDisposal = 1 or 3.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/assets/options

• DisposalCosts number(float)
• ValueDate string(date) Required
  • The value of AssetPurchased = 1 (ValueDate must be before or equal to now).
  • The value of AssetPurchased = 2 (ValueDate must be on or before the asset purchase date).

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.

• BackOfficeID string | null

  Maximum length is 255.

• BackOfficeSync integer | null

  An integer representing the status of the back office sync:

  • 1: Yes
  • 2: No
  • 3: Only update from back office