Entity ID or Entity ForeignID
The ID used to identify this entity in your system. This ID must be unique across all entities in your system.
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
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. Include the full email address.
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).
If this entity will be paying invoices, set this to true.
If this entity will be receiving payments, set this to true.
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.
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.
Base64 encoded PNG image data for the entity logo. Max size 100KB.
Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.
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.
True if this entity has a direct relationship with your organization.
True if this entity has accepted the terms of service.
True if this entity can pay invoices.
True if this entity can receive payments.
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.
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.
The ID used to identify this entity in your system
Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
URL for the entity logo
Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.