entity

Update entity

post/entity/{entityId}

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Request body

foreignIdstring

The ID used to identify this entity in your system. This ID must be unique across all entities in your system.

emailTostring

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

emailToAliasstring[]

Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. Include the full email address.

isCustomerboolean

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'business' | 'individual'
isPayorboolean

If this entity will be paying invoices, set this to true.

isPayeeboolean

If this entity will be receiving payments, set this to true.

isNetworkPayorboolean

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.

isNetworkPayeeboolean

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.

logostring

Base64 data URL of the entity logo. Must be in the data:image/*;base64,XXXX format. We recommend a PNG image under 100KB. Supported file types are png, jpeg, gif, svg.

metadataobject

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

connectedEntityIdstring

Response

Response with status 200

idstring required
namestring required
emailstring required
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
logostring

URL for the entity logo

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

Changes

No recorded changes to this operation across all 1 revision of this API.