Get entity

GET

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Query parameters

returnMetadatabooleanOptional
If true, will return simple key/value metadata for the entity. For more complex metadata, use the Metadata API.

Response

This endpoint returns an object
idstring
namestring
emailstring
isCustomerboolean
True if this entity has a direct relationship with your organization.
accountType"business" or "individual"
Allowed values: businessindividual
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
foreignIdstringOptional
The ID used to identify this entity in your system
emailTostringOptional
Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
emailToAliaslist of stringsOptional
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
metadatamap from strings to stringsOptional
Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.