Entity

Update entity

POST
https://api.mercoa.com/entity/:entityId

Path parameters

entityId
string

Request

This endpoint expects an object.
foreignId
optional string

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

emailTo
optional string

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
optional list of strings

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

isCustomer
optional boolean

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
optional enum
Allowed values: businessindividual
profile
optional object
isPayor
optional boolean

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

isPayee
optional boolean

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

logo
optional string

Base64 encoded PNG image data for the entity logo.

Response

This endpoint return 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.

createdAt
datetime
updatedAt
datetime
foreignId
optional string

The ID used to identify this entity in your system

emailTo
optional string

Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.

emailToAlias
optional list of strings

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

POST
/entity/:entityId
curl -X POST https://api.mercoa.com/entity/:entityId \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"id": "string",
"name": "string",
"email": "string",
"isCustomer": true,
"accountType": "business",
"profile": {
"business": {
"legalBusinessName": "string",
"taxIDProvided": true,
"email": "string",
"businessType": "soleProprietorship",
"phone": {
"countryCode": "string",
"number": "string"
},
"doingBusinessAs": "string",
"website": "string",
"description": "string",
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
},
"ownersProvided": true
},
"individual": {
"email": "string",
"name": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"suffix": "string"
},
"birthDateProvided": true,
"governmentIDProvided": true,
"phone": {
"countryCode": "string",
"number": "string"
},
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
}
}
},
"status": "unverified",
"acceptedTos": true,
"isPayor": true,
"isPayee": true,
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"foreignId": "string",
"emailTo": "string",
"emailToAlias": [
"string"
]
}