foreignIdstring
The ID used to identify this entity in your system
emailTostring
Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
emailToAliasstring[]
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
isCustomerboolean required
True if this entity has a direct relationship with your organization.
accountType'business' | 'individual' required
status'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed' required
oatfiStatusstring
The OatFi status of this entity
oatfiUnderwritingResponseobject
The OatFi underwriting response of this entity
acceptedTosboolean required
True if this entity has accepted the terms of service.
isPayorboolean required
True if this entity can pay invoices.
isPayeeboolean required
True if this entity can receive payments.
isNetworkPayorboolean required
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 required
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.
metadataobject
Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.
createdAtstring date-time required
updatedAtstring date-time required