API ReferenceEntity

Update entity

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
foreignIdstringOptional
The ID used to identify this entity in your system. This ID must be unique across all entities in your system.
emailTostringOptional

Sets the email address to which to send invoices to be added to the Invoice Inbox. Only provide the local-part/username of the email address, do not include the @domain.com

emailToAliaslist of stringsOptional
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. Include the full email address.
isCustomerbooleanOptional

If this entity has a direct relationship with your organization (e.g your direct customer or client), set this to true. Otherwise, set to false (e.g your customer’s vendors).

accountTypeenumOptional
Allowed values:
profileobjectOptional
isPayorbooleanOptional
If this entity will be paying invoices, set this to true.
isPayeebooleanOptional
If this entity will be receiving payments, set this to true.
isNetworkPayorbooleanOptional
Control if this entity should be available as a payor to any entity on your platform. If set to false, this entity will only be available as a payor to entities that have a direct relationship with this entity. Defaults to false.
isNetworkPayeebooleanOptional
Control if this entity should be available as a payee to any entity on your platform. If set to false, this entity will only be available as a payee to entities that have a direct relationship with this entity. Defaults to false.
metadatamap from strings to stringsOptional

Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.

connectedEntityIdstringOptional
The ID of the entity that this entity is connected to. This is used to trigger notifications to the connected entity when this entity is updated.

Response

This endpoint returns an object.
idstring
namestring
emailstring
isCustomerboolean
True if this entity has a direct relationship with your organization.
accountTypeenum
Allowed values:
profileobject
statusenum
acceptedTosboolean
True if this entity has accepted the terms of service.
isPayorboolean
True if this entity can pay invoices.
isPayeeboolean
True if this entity can receive payments.
isNetworkPayorboolean
True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity.
isNetworkPayeeboolean
True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity.
createdAtdatetime
updatedAtdatetime
foreignIdstring or null
The ID used to identify this entity in your system
emailTostring or null

Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.

emailToAliaslist of strings or null
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
oatfiStatusstring or null
The OatFi status of this entity
oatfiUnderwritingResponsemap from strings to strings or null
The OatFi underwriting response of this entity
metadatamap from strings to strings or null

Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.

Errors