Entity

Update entity

POST

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Request

This endpoint expects an object.
foreignId
stringOptional
The ID used to identify this entity in your system. This ID must be unique across all entities in your system.
emailTo
stringOptional
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
emailToAlias
list of stringsOptional
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. Include the full email address.
isCustomer
booleanOptional
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).
accountType
enumOptional
Allowed values: businessindividual
profile
objectOptional
isPayor
booleanOptional
If this entity will be paying invoices, set this to true.
isPayee
booleanOptional
If this entity will be receiving payments, set this to true.
isNetworkPayor
booleanOptional
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.
isNetworkPayee
booleanOptional
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.
logo
stringOptional
Base64 encoded PNG image data for the entity logo.

Response

This endpoint returns an object
id
string
name
string
email
string
isCustomer
boolean
True if this entity has a direct relationship with your organization.
accountType
enum
Allowed values: businessindividual
profile
object
status
enum
acceptedTos
boolean
True if this entity has accepted the terms of service.
isPayor
boolean
True if this entity can pay invoices.
isPayee
boolean
True if this entity can receive payments.
isNetworkPayor
boolean
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.
isNetworkPayee
boolean
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.
createdAt
datetime
updatedAt
datetime
foreignId
stringOptional
The ID used to identify this entity in your system
emailTo
stringOptional
Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
emailToAlias
list of stringsOptional
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.