API ReferenceEntity

Get entity

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Headers

AuthorizationstringRequired

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

Query parameters

returnMetadatastringOptional

Return simple key/value metadata for the specified keys for the entities. 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.
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.
metadatamap from strings to strings or null

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

Errors