Mercoa

https://docs.mercoa.com/home/overview
Admin
Mercoa is an embedded financial automation platform that allows B2B platforms to embed, offer, and...
Tokens:297,784
Snippets:960
Trust Score:5.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Response: Get Entity Metadata

Source: https://docs.mercoa.com/home/overview/api-reference/entity/metadata/get

An example of the successful 200 OK response when retrieving entity metadata, showing a list of string representations of key-value pairs.

```JSON
[
    "{key: 'prop_123', value: 'Beach Rental'}",
    "{key: 'prop_456', value: 'City Rental'}"
]
```

--------------------------------

### API Reference for Get All Notification Configurations

Source: https://docs.mercoa.com/home/overview/api-reference/organization/notification-configuration/get-all

Detailed API documentation for the GET /organization/notification-configurations endpoint. Covers the HTTP method, full URL, required headers, successful response structure, an example JSON response, and a list of possible error codes.

```APIDOC
Endpoint: GET /organization/notification-configurations
Full URL: https://api.mercoa.com/organization/notification-configurations

Description: Retrieve all notification configurations

Headers:
  Authorization:
    Type: string
    Required: Yes
    Description: Bearer authentication of the form Bearer <token>, where token is your auth token.

Response (200 OK):
  Type: array of objects
  Description: A list of notification configuration objects.
  Example:
    [
      {
        "notificationType": "invoice",
        "type": "INVOICE_APPROVAL_NEEDED",
        "url": "url",
        "subject": "subject"
      },
      {
        "notificationType": "invoice",
        "type": "INVOICE_APPROVAL_NEEDED",
        "url": "url",
        "subject": "subject"
      }
    ]
  Properties:
    invoice: object (Show 4 properties)

Errors:
  400: Bad Request
  401: Unauthorized
  403: Forbidden
  404: Not Found
  409: Conflict
  500: Internal Server Error
  501: Unimplemented
```

--------------------------------

### Example JSON Response for Get All Payment Methods

Source: https://docs.mercoa.com/home/overview/api-reference/entity/payment-method/get-all

Illustrates the structure of a successful 200 OK response from the 'Get All Payment Methods' API endpoint, showing a sample bank account object with its properties.

```JSON
[
  {
    "type": "bankAccount",
    "accountName": "My Checking Account",
    "accountNumber": "99988767623",
    "accountType": "CHECKING",
    "bankName": "Chase",
    "createdAt": "2021-01-01T00:00:00Z",
    "frozen": false,
    "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
    "isDefaultDestination": true,
    "isDefaultSource": true,
    "metadata": {},
    "routingNumber": "12345678",
    "status": "VERIFIED",
    "supportedCurrencies": [
      "USD"
    ],
    "updatedAt": "2021-01-01T00:00:00Z",
    "confirmedByEntity": true
  }
]
```

--------------------------------

### Example 200 OK Response: Bank Account Payment Method

Source: https://docs.mercoa.com/home/overview/api-reference/entity/payment-method/get

An example JSON structure representing a successful response for a bank account payment method, showing typical fields and their values returned by the API.

```JSON
{
  "type": "bankAccount",
  "accountName": "My Checking Account",
  "accountNumber": "99988767623",
  "accountType": "CHECKING",
  "bankName": "Chase",
  "createdAt": "2021-01-01T00:00:00Z",
  "frozen": false,
  "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
  "isDefaultDestination": true,
  "isDefaultSource": true,
  "metadata": {},
  "routingNumber": "12345678",
  "status": "VERIFIED",
  "supportedCurrencies": [
    "USD"
  ],
  "updatedAt": "2021-01-01T00:00:00Z",
  "confirmedByEntity": true
}
```

--------------------------------

### Get All Entity Metadata (Python SDK)

Source: https://docs.mercoa.com/home/overview/api-reference/entity/metadata/get-all

Example Python code demonstrating how to retrieve all metadata associated with a specific entity using the Mercoa SDK. It initializes the Mercoa client with an authentication token and calls the `get_all` method on the entity's metadata.

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.metadata.get_all(
    entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
)
```

--------------------------------

### Initialize Mercoa Go Client and Calculate Fees

Source: https://docs.mercoa.com/home/overview/sdks/go

Demonstrates how to import the necessary Mercoa Go client packages, initialize a new client instance with your API key, and make a sample API call to the `Fees.Calculate` endpoint. This example shows how to pass required parameters for fee calculation.

```Go
import (
	mercoa "github.com/mercoa-finance/go"
	mercoaclient "github.com/mercoa-finance/go/client"
	"github.com/mercoa-finance/go/option"
)

client := mercoaclient.NewClient(
	option.WithToken("<YOUR_API_KEY>"),
)

response, err := client.Fees.Calculate(
	context.TODO(),
	&mercoa.CalculateFeesRequest{
		Amount:               42.0,
		PaymentSourceID:      "pm_c0f9f5e8-516b-4516-9185-0a2c67ed1fe5",
		PaymentDestinationID: "pm_12121928-47a0-488b-9357-70e1fded0568",
	},
)
```

--------------------------------

### API Response Example: Get All Groups

Source: https://docs.mercoa.com/home/overview/api-reference/entity-group/get-all

Example JSON response body for a successful 'Get All Groups' request, showing a list of entity group objects with detailed properties.

```JSON
{
  "count": 3,
  "hasMore": false,
  "data": [
    {
      "id": "entg_a3582b70-fd04-4888-9185-a640ae9048be",
      "entities": [
        {
          "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
          "name": "Acme Inc.",
          "email": "customer@acme.com",
          "isCustomer": true,
          "accountType": "business",
          "profile": {
            "business": {
              "legalBusinessName": "Acme Inc.",
              "taxIDProvided": true,
              "email": "customer@acme.com",
              "businessType": "llc",
              "phone": {
                "countryCode": "1",
                "number": "4155551234"
              },
              "address": {
                "addressLine1": "123 Main St",
                "city": "San Francisco",
                "stateOrProvince": "CA",
                "postalCode": "94105",
                "addressLine2": "Unit 1",
                "country": "US"
              },
              "ownersProvided": true,
              "taxId": {
                "ein": {
                  "number": "12-3456789"
                }
              }
            }
          },
          "status": "verified",
          "acceptedTos": true,
          "isPayor": true,
          "isPayee": false,
          "isNetworkPayor": false,
          "isNetworkPayee": false,
          "createdAt": "2024-01-01T00:00:00Z",
          "updatedAt": "2024-01-02T00:00:00Z",
          "foreignId": "MY-DB-ID-12345"
        },
        {
          "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
          "name": "Big Box Store",
          "email": "vendor@bigboxstore.com",
          "isCustomer": false,
          "accountType": "business",
          "profile": {
            "business": {
              "legalBusinessName": "Big Box Store",
              "taxIDProvided": false,
              "email": "vendor@bigboxstore.com",
              "businessType": "publicCorporation",
              "ownersProvided": false
            }
          },
          "status": "unverified",
          "acceptedTos": false,
          "isPayor": false,
          "isPayee": true,
          "isNetworkPayor": false,
          "isNetworkPayee": false,
          "createdAt": "2024-01-01T00:00:00Z",
          "updatedAt": "2024-01-02T00:00:00Z",
          "foreignId": "MY-DB-ID-90909"
        }
      ],
      "metadata": {
        "key1": "value1"
      },
      "foreignId": "your-group-id",
      "name": "AcmeConglomerate",
      "emailToName": "acmegroup"
    }
  ]
}
```

--------------------------------

### Install Mercoa .NET SDK using NuGet CLI

Source: https://docs.mercoa.com/home/overview/sdks/net

Instructions to install the Mercoa client package using the NuGet Command Line Interface.

```C#
nuget install Mercoa.Client
```

--------------------------------

### JSON Response Example: Get All Invoice Comments

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/comment

An example JSON structure returned by the 'Get All Invoice Comments' endpoint, illustrating the format of individual comment objects and nested user details.

```JSON
[
  {
    "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
    "text": "This is a comment",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "user": {
      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
      "roles": [
        "admin",
        "approver"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "foreignId": "MY-DB-ID-12345",
      "email": "john.doe@acme.com",
      "name": "John Doe"
    }
  }
]
```

--------------------------------

### Install Mercoa Go Library

Source: https://docs.mercoa.com/home/overview/sdks/go

Instructions to install the Mercoa Go library using the standard Go package manager. This command adds the Mercoa SDK to your Go module dependencies.

```Go
go get github.com/mercoa-finance/go
```

--------------------------------

### Get Group User API Response Example

Source: https://docs.mercoa.com/home/overview/api-reference/entity-group/user/get

Example JSON response for a successful 'Get Group User' API call, showing user details, associated entities, roles, and timestamps.

```JSON
{
"foreignId": "MY-DB-ID-12345",
"entities": [
    {
    "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
    "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
    "roles": [
        "admin",
        "approver"
    ]
    },
    {
    "entityId": "ent_9e02a20e-7749-47de-8d8a-f8ff2859fa90",
    "id": "user_3a3aafc8-ea86-408a-a6c1-545497badbbb",
    "roles": [
        "viewer"
    ]
    }
],
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z",
"email": "john.doe@acme.com",
"name": "John Doe"
}
```

--------------------------------

### Instantiate Mercoa .NET SDK Client

Source: https://docs.mercoa.com/home/overview/sdks/net

Example of how to create an instance of the Mercoa SDK client using your API key. Note that all SDK methods are awaitable.

```C#
using Mercoa;

Mercoa mercoa = new Mercoa(
"YOUR_API_KEY"
)
```

--------------------------------

### Example: Get All Email Templates with cURL

Source: https://docs.mercoa.com/home/overview/api-reference/entity/email-template/get-all

A cURL command example demonstrating how to make an authenticated GET request to retrieve all email templates for a specific entity using its ID and a bearer token.

```cURL
curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced \
-H "Authorization: Bearer <token>"
```

--------------------------------

### Example API Response: Get Source Email

Source: https://docs.mercoa.com/home/overview/api-reference/invoice-template/document/get-source-email

An example JSON response body returned by the Get Source Email API endpoint, illustrating the structure and typical values for a successful call, including details about the email content and attachments.

```APIDOC
{
  "count": 1,
  "hasMore": false,
  "data": [
    {
      "id": "1234",
      "status": "PROCESSED",
      "subject": "Invoice #1234",
      "from": "John Doe <john.doe@example.com>",
      "to": "Jane Doe <jane.doe@example.com>",
      "htmlBody": "<html><body><p>Hi Jane,</p><p>Please find attached the invoice for your recent purchase.</p><p>Thanks,</p><p>John</p></body></html>",
      "textBody": "Hi Jane,\n\nPlease find attached the invoice for your recent purchase.\n\nThanks,\nJohn",
      "createdAt": "2021-01-01T00:00:00Z",
      "attachment": {
        "filename": "invoice.pdf",
        "contentType": "application/pdf"
      }
    }
  ]
}
```

--------------------------------

### Configure Mercoa Go Client with Global Options

Source: https://docs.mercoa.com/home/overview/sdks/go

This example illustrates how to initialize the Mercoa Go client with global request options, including an API token for authentication and a custom `http.Client` with a five-second timeout. These options will apply to all subsequent requests made with this client instance.

```Go
client := mercoaclient.NewClient(
option.WithToken("<YOUR_API_KEY>"),
option.WithHTTPClient(
&http.Client{
Timeout: 5 * time.Second,
},
),
)
```

--------------------------------

### Install Mercoa .NET SDK using dotnet CLI

Source: https://docs.mercoa.com/home/overview/sdks/net

Instructions to add the Mercoa client package to your .NET project using the .NET Core command-line interface.

```C#
dotnet add package Mercoa.Client
```

--------------------------------

### Get Documents API Endpoint cURL Example

Source: https://docs.mercoa.com/home/overview/api-reference/entity/document/get-all

Example cURL command to retrieve documents for a specific entity using the Mercoa API. Replace `<token>` with your actual authorization token.

```cURL
curl https://api.mercoa.com/entity/ent_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9/documents \
-H "Authorization: Bearer <token>"
```

--------------------------------

### Install Mercoa Python SDK

Source: https://docs.mercoa.com/home/overview/sdks/python

Instructions to add the Mercoa Python SDK as a dependency to your project. You can use either pip for standard installations or poetry for projects managed with Poetry.

```Python
pip install mercoa
# or
poetry add mercoa
```

--------------------------------

### Install Mercoa Javascript SDK

Source: https://docs.mercoa.com/home/overview/sdks/javascript

Instructions to install the official Mercoa Javascript SDK using npm or yarn package managers.

```Shell
npm install --save @mercoa/javascript
# or
yarn add @mercoa/javascript
```

--------------------------------

### Example Response: Custom Payment Method Schema

Source: https://docs.mercoa.com/home/overview/api-reference/custom-payment-method-schema/get

An example JSON response body returned upon a successful GET request for a custom payment method schema, detailing its structure and fields.

```JSON
{
  "id": "cpms_14f78dcd-4614-426e-a37a-7af262431d41",
  "name": "Check",
  "isSource": false,
  "isDestination": true,
  "supportedCurrencies": [
    "USD"
  ],
  "fields": [
    {
      "name": "payToTheOrderOf",
      "type": "text",
      "optional": false,
      "displayName": "Pay To The Order Of"
    },
    {
      "name": "accountNumber",
      "type": "usBankAccountNumber",
      "optional": false,
      "displayName": "Account Number",
      "useAsAccountNumber": true
    },
    {
      "name": "routingNumber",
      "type": "usBankRoutingNumber",
      "optional": false,
      "displayName": "Routing Number"
    },
    {
      "name": "address",
      "type": "address",
      "optional": false,
      "displayName": "Address"
    }
  ],
  "estimatedProcessingTime": 7,
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "maxAmount": 50000,
  "minAmount": 1
}
```

--------------------------------

### Example Webhook Payload: Counterparty Onboarding Completed

Source: https://docs.mercoa.com/home/overview/api-reference/webhooks/counterparty-onboarding-completed

An example JSON payload for the `counterparty.onboarding.completed` webhook event, showing the structure and typical values for the entity and counterparty IDs.

```json
{
  "eventType": "counterparty.onboarding.completed",
  "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
  "counterpartyId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c"
}
```

--------------------------------

### Example JSON Response: Get All Approval Policies

Source: https://docs.mercoa.com/home/overview/api-reference/entity/approval-policy/get-all

An example of the JSON data returned by the Mercoa API when successfully retrieving a list of approval policies. This illustrates the typical structure and content of each policy object.

```JSON
[
  {
    "id": "apvl_21661ac1-a2a8-4465-a6c0-64474ba8181d",
    "trigger": [],
    "rule": {
      "type": "approver",
      "identifierList": {
        "type": "userList",
        "value": [
          "usr_8545a84e-a45f-41bf-bdf1-33b42a55812c",
          "usr_21661ac1-a2a8-4465-a6c0-64474ba8181d"
        ]
      },
      "numApprovers": 2
    },
    "upstreamPolicyId": "root",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-02T00:00:00Z"
  }
]
```

--------------------------------

### Example Response for Get All Custom Payment Method Schemas

Source: https://docs.mercoa.com/home/overview/api-reference/custom-payment-method-schema/get-all

This JSON snippet provides an example of the successful response from the GET /paymentMethod/schema endpoint. It shows a list of custom payment method schemas, including details like ID, name, source/destination capabilities, supported currencies, and defined fields for each payment method.

```json
[
  {
    "id": "cpms_4794d597-70dc-4fec-b6ec-c5988e759769",
    "name": "Wire",
    "isSource": false,
    "isDestination": true,
    "supportedCurrencies": [
      "USD",
      "EUR"
    ],
    "fields": [
      {
        "name": "bankName",
        "type": "text",
        "optional": false,
        "displayName": "Bank Name"
      },
      {
        "name": "recipientName",
        "type": "text",
        "optional": false,
        "displayName": "Recipient Name"
      },
      {
        "name": "accountNumber",
        "type": "usBankAccountNumber",
        "optional": false,
        "displayName": "Account Number",
        "useAsAccountNumber": true
      },
      {
        "name": "routingNumber",
        "type": "usBankRoutingNumber",
        "optional": false,
        "displayName": "Routing Number"
      }
    ],
    "estimatedProcessingTime": 0,
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "maxAmount": 100000,
    "minAmount": 1
  },
  {
    "id": "cpms_14f78dcd-4614-426e-a37a-7af262431d41",
    "name": "Check",
    "isSource": false,
    "isDestination": true,
    "supportedCurrencies": [
      "USD"
    ],
    "fields": [
      {
        "name": "payToTheOrderOf",
        "type": "text",
        "optional": false,
        "displayName": "Pay To The Order Of"
      },
      {
        "name": "accountNumber",
        "type": "usBankAccountNumber",
        "optional": false,
        "displayName": "Account Number",
        "useAsAccountNumber": true
      },
      {
        "name": "routingNumber",
        "type": "usBankRoutingNumber",
        "optional": false,
        "displayName": "Routing Number"
      },
      {
        "name": "address",
        "type": "address",
        "optional": false,
        "displayName": "Address"
      }
    ],
    "estimatedProcessingTime": 7,
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "maxAmount": 50000,
    "minAmount": 1
  }
]
```

--------------------------------

### Initialize Mercoa Javascript SDK Client

Source: https://docs.mercoa.com/home/overview/sdks/javascript

Demonstrates how to initialize the MercoaClient for both Node.js (server-side) and browser environments, and make a sample API call to retrieve an entity.

```Javascript
import { Mercoa, MercoaClient } from "@mercoa/javascript"

// If using on the server with Node.js
const mercoa = new MercoaClient({
  token: 'YOUR_API_KEY'
});

// If using in the browser
const mercoa = new MercoaClient({
  token: 'YOUR_CLIENT_JWT'
});

const entity = mercoa.entity.get("YOUR_ENTITY_ID")

console.log(entity)
```

--------------------------------

### Install Mercoa Javascript SDK

Source: https://docs.mercoa.com/home/overview/common-concepts/creating-payouts-via-api

Install the Mercoa Javascript SDK using npm or yarn to begin integrating with the Mercoa API for AP Payments.

```Shell
npm install --save @mercoa/javascript
# or
yarn add @mercoa/javascript
```

--------------------------------

### Example JSON Response for Get All Invoice Comments API

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/comment/get-all

This JSON example illustrates the typical structure of a successful response from the 'Get All Invoice Comments' API endpoint. It shows a list containing a single comment object with properties like `id`, `text`, `createdAt`, `updatedAt`, and a nested `user` object detailing the comment's author.

```APIDOC
[
  {
    "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
    "text": "This is a comment",
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "user": {
      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
      "roles": [
        "admin",
        "approver"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "foreignId": "MY-DB-ID-12345",
      "email": "john.doe@acme.com",
      "name": "John Doe"
    }
  }
]
```

--------------------------------

### cURL Example: Get Source Email

Source: https://docs.mercoa.com/home/overview/api-reference/invoice-template/document/get-source-email

A cURL command demonstrating how to call the Get Source Email API endpoint, including the required authorization header with a placeholder token.

```cURL
curl https://api.mercoa.com/invoice-template/invt_13c07096-5848-4aeb-ae7d-6576289034c4/source-email \
-H "Authorization: Bearer <token>"
```

--------------------------------

### Initialize and Use Mercoa Java Client

Source: https://docs.mercoa.com/home/overview/sdks/java

Demonstrates how to initialize the Mercoa Java client with an API key and make a basic API call to retrieve an entity by its ID.

```Java
Mercoa client = Mercoa.builder()
.token("MERCOA_API_KEY")
.build();

var response = client.entity().get("YOUR_ENTITY_ID");

System.out.println(response.getId());
```

--------------------------------

### Python Client Example to Search Transactions

Source: https://docs.mercoa.com/home/overview/api-reference/transaction/find

Example Python code demonstrating how to use the Mercoa client library to search for transactions. The example shows how to initialize the client with a token and use the `find` method with `start_date`, `end_date`, and `limit` parameters.

```Python
import datetime

from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.transaction.find(
    start_date=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
    end_date=datetime.datetime.fromisoformat(
        "2024-01-15 09:30:00+00:00",
    ),
    limit=10,
)
```

--------------------------------

### Get Check PDF API Success Response Example (200 Default)

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/document/generate-check-pdf

An example of the JSON response returned upon a successful request to generate a check PDF. It includes the MIME type, document type, and a URI to the generated PDF file.

```APIDOC
{
  "mimeType": "application/pdf",
  "type": "CHECK",
  "uri": "https://mercoa.com/pdf/not-real.pdf"
}
```

--------------------------------

### Retrieve All Notification Configurations with Python SDK

Source: https://docs.mercoa.com/home/overview/api-reference/organization/notification-configuration/get-all

Example demonstrating how to initialize the Mercoa Python client and call the `get_all()` method to retrieve all notification configurations. An authentication token is required for client initialization.

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.organization.notification_configuration.get_all()
```

--------------------------------

### Get Notification Policy for Entity User

Source: https://docs.mercoa.com/home/overview/api-reference/entity/user/notification-policy/get

Comprehensive documentation and code examples for retrieving notification policies for a specific entity user. This includes the API request method and path, a Python SDK example for making the call, an example of the successful API response, and detailed specifications for path parameters, request headers, and the response object schema.

```APIDOC
GET
https://api.mercoa.com/entity/:entityId/user/:userId/notification-policy/:notificationType

GET
/entity/:entityId/user/:userId/notification-policy/:notificationType
```

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.user.notification_policy.get(
    entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
    user_id="user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
    notification_type="INVOICE_APPROVED",
)
```

```APIDOC
{
  "disabled": true,
  "digest": false,
  "immediate": true,
  "type": "INVOICE_APPROVED"
}
```

```APIDOC
Path parameters:
  entityId: string (Required)
    Entity ID or Entity ForeignID
  userId: string (Required)
    User ID or User ForeignID
  notificationType: enum (Required)
    Show 11 enum values

Headers:
  Authorization: string (Required)
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Response:
  This endpoint returns an object.
  disabled: boolean
    True if the selected notification type is disabled for this user
  digest: boolean
    True if the selected notification type is sent as a digest.
  immediate: boolean
    True if the selected notification type is sent immediately.
  type: enum
    Show 11 enum values
```

--------------------------------

### API Reference: GET /entity/:entityId/onboarding

Source: https://docs.mercoa.com/home/overview/api-reference/entity/get-onboarding-link

Detailed API documentation for the GET /entity/:entityId/onboarding endpoint, which is used to generate a unique onboarding link for a specified entity. This section outlines all path, header, and query parameters, along with their types, requirements, and descriptions, as well as the expected response format.

```APIDOC
GET /entity/:entityId/onboarding

Description: Generate an onboarding link for the entity.

Path Parameters:
  entityId (string, Required): Entity ID or Entity ForeignID

Headers:
  Authorization (string, Required): Bearer authentication of the form Bearer <token>, where token is your auth token.

Query Parameters:
  type (enum, Required): The type of onboarding link to generate. If not provided, the default is payee. The onboarding options are determined by your organization's onboarding configuration. Allowed values: PAYEE, PAYOR
  expiresIn (string, Optional): Expressed in seconds or a string describing a time span. The default is 24h.
  connectedEntityId (string, Optional): The ID of the entity to connect to. If onboarding a payee, this should be the payor entity ID. If onboarding a payor, this should be the payee entity ID. If no connected entity ID is provided, the onboarding link will be for a standalone entity.
  redirectToPortal (boolean, Optional): If true, the onboarding link will redirect to the vendor/customer portal if the entity is already onboarded. If false, the onboarding link will not redirect to the portal. The default is false.
  vendorPortalOptions (object, Optional): The options for the vendor portal. (Show 3 properties)

Response:
  Type: string
  Description: This endpoint returns a string.
  Example 200 Default: "https://mercoa.com/onboarding/payor?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTIzNDU2Nzg5LCJuYW1lIjoiSm9zZXBoIn0.OpOSSw7e485LOP5PrzScxHb7SR6sAOMRckfFwi4rp7o"
```

--------------------------------

### Example JSON Response for Get Source Email API

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/document/get-source-email

A sample JSON object illustrating the structure and typical data returned by a successful call to the 'Get Source Email' API endpoint.

```JSON
{
  "count": 1,
  "hasMore": false,
  "data": [
    {
      "id": "1234",
      "status": "PROCESSED",
      "subject": "Invoice #1234",
      "from": "John Doe <john.doe@example.com>",
      "to": "Jane Doe <jane.doe@example.com>",
      "htmlBody": "<html><body><p>Hi Jane,</p><p>Please find attached the invoice for your recent purchase.</p><p>Thanks,</p><p>John</p></body></html>",
      "textBody": "Hi Jane,\n\nPlease find attached the invoice for your recent purchase.\n\nThanks,\nJohn",
      "createdAt": "2021-01-01T00:00:00Z",
      "attachment": {
        "filename": "invoice.pdf",
        "contentType": "application/pdf"
      }
    }
  ]
}
```

--------------------------------

### cURL Example: Create Bulk Entities

Source: https://docs.mercoa.com/home/overview/api-reference/entity/bulk/create

Example cURL command to send a POST request to the /entities endpoint, demonstrating how to create multiple entities synchronously with authentication and a JSON request body.

```cURL
curl -X POST https://api.mercoa.com/entities \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"connectedEntity": {
"id": "ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
"linkCreatedAsPayor": false,
"linkCreatedAsPayee": true
},
"entities": [
{
"isCustomer": true,
"isPayor": true,
"isPayee": false,
"accountType": "business",
"foreignId": "MY-DB-ID-12345",
"profile": {
"business": {
"email": "customer@acme.com",
"legalBusinessName": "Acme Inc.",
"website": "http://www.acme.com",
"businessType": "llc",
"phone": {
"countryCode": "1",
"number": "4155551234"
},
"address": {
"addressLine1": "123 Main St",
"addressLine2": "Unit 1",
"city": "San Francisco",
"stateOrProvince": "CA",
"postalCode": "94105",
"country": "US"
},
"taxId": {
"ein": {
"number": "12-3456789"
}
}
}
}
}
]
}'
```

--------------------------------

### Get Invoice Template Attachments with cURL

Source: https://docs.mercoa.com/home/overview/api-reference/invoice-template/document/get-all

Example cURL command to retrieve attachments for a specific invoice template using its ID and an authorization token.

```cURL
curl https://api.mercoa.com/invoice-template/invt_13c07096-5848-4aeb-ae7d-6576289034c4/documents \
-H "Authorization: Bearer <token>"
```

--------------------------------

### Python: Get Invoice Attachments

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/document/get-all

Example Python code using the Mercoa SDK to retrieve all documents for a given invoice ID.

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.invoice.document.get_all(
    invoice_id="in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
)
```

--------------------------------

### Webhook Payload Schema: Counterparty Onboarding Completed

Source: https://docs.mercoa.com/home/overview/api-reference/webhooks/counterparty-onboarding-completed

Detailed schema for the `counterparty.onboarding.completed` webhook payload, including required fields, their types, and descriptions explaining their purpose.

```APIDOC
Payload:
  eventType: string (Required)
    The type of the event.
  entityId: string (Required)
    The ID of the entity that owns the counterparty relationship.
  counterpartyId: string (Required)
    The ID of the counterparty.
```

--------------------------------

### Install Mercoa Java SDK with Gradle

Source: https://docs.mercoa.com/home/overview/sdks/java

Add the Mercoa SDK dependency to your Gradle project's build file to include it in your application.

```Gradle
implementation 'com.mercoa:mercoa:0.6.4'
```

--------------------------------

### Python: Get All Entity Groups

Source: https://docs.mercoa.com/home/overview/api-reference/entity-group/get-all

Example Python code to retrieve all entity groups using the Mercoa client library. Requires an API token for authentication.

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity_group.get_all()
```

--------------------------------

### Example Response for Get All Entity Representatives

Source: https://docs.mercoa.com/home/overview/api-reference/entity/representative/get-all

An example JSON array representing the successful response when fetching entity representatives. Each object in the array contains detailed information such as ID, name, address, birth date, government ID status, responsibilities, creation/update timestamps, phone, email, and disabled status.

```json
[
  {
    "id": "rep_958c4ffb-dc06-494c-a0e0-1b4946c6bb0f",
    "name": {
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "address": {
      "addressLine1": "456 Main St",
      "city": "New York",
      "stateOrProvince": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "birthDateProvided": true,
    "governmentIDProvided": true,
    "responsibilities": {
      "isOwner": true,
      "ownershipPercentage": 40
    },
    "createdOn": "2024-01-01T00:00:00Z",
    "updatedOn": "2024-01-01T00:00:00Z",
    "phone": {
      "countryCode": "1",
      "number": "2075551234"
    },
    "email": "jane.smith@acme.com",
    "disabledOn": null
  },
  {
    "id": "rep_7df2974a-4069-454c-912f-7e58ebe030fb",
    "name": {
      "firstName": "John",
      "lastName": "Adams",
      "middleName": "Quincy",
      "suffix": "Jr."
    },
    "address": {
      "addressLine1": "123 Main St",
      "city": "San Francisco",
      "stateOrProvince": "CA",
      "postalCode": "94105",
      "addressLine2": "Unit 1",
      "country": "US"
    },
    "birthDateProvided": true,
    "governmentIDProvided": true,
    "responsibilities": {
      "isController": true,
      "isOwner": true,
      "ownershipPercentage": 40
    },
    "createdOn": "2024-01-01T00:00:00Z",
    "updatedOn": "2024-01-01T00:00:00Z",
    "phone": {
      "countryCode": "1",
      "number": "4155551234"
    },
    "email": "john.doe@acme.com",
    "disabledOn": null
  }
]
```

--------------------------------

### Synchronous Mercoa Python Client Usage

Source: https://docs.mercoa.com/home/overview/sdks/python

Demonstrates how to initialize the synchronous Mercoa client with your API key and make a basic API call to retrieve an entity by its ID. The retrieved entity object is then printed to the console.

```Python
from mercoa.client import Mercoa

mercoa_client = Mercoa(token="YOUR_API_KEY")

entity = mercoa_client.entity.get(entity_id='YOUR_ENTITY_ID')

print(entity)
```

--------------------------------

### API Response: Get Invoice Attachments

Source: https://docs.mercoa.com/home/overview/api-reference/invoice/document/get-all

Example JSON response for a successful request to retrieve invoice attachments, showing the structure of document objects.

```APIDOC
[
  {
    "mimeType": "application/pdf",
    "type": "INVOICE",
    "uri": "https://mercoa.com/pdf/not-real.pdf",
    "id": "doc_37e6af0a-e637-48fd-b825-d6947b38c4e2"
  }
]
```

--------------------------------

### Install Mercoa Java SDK with Maven

Source: https://docs.mercoa.com/home/overview/sdks/java

Add the Mercoa SDK dependency to your Maven project's POM file to include it in your application.

```Maven
<dependency>
<groupId>com.mercoa</groupId>
<artifactId>mercoa</artifactId>
<version>0.6.4</version>
</dependency>
```

--------------------------------

### Webhook Response: Counterparty Onboarding Completed

Source: https://docs.mercoa.com/home/overview/api-reference/webhooks/counterparty-onboarding-completed

Expected HTTP response for the `counterparty.onboarding.completed` webhook, indicating successful receipt of the data by the webhook listener.

```APIDOC
Response:
  200: any
    Return a 200 status to indicate that the data was received successfully.
```

--------------------------------

### Example Response for Get Entity Email Template

Source: https://docs.mercoa.com/home/overview/api-reference/entity/email-template/get

A sample JSON object representing a successful response (HTTP 200) from the 'Get entity email template' endpoint, showing the structure and typical values of the returned email template object.

```JSON
{
  "id": "emt_8545a84e-a45f-41bf-bdf1-33b42a55812c",
  "entityId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
  "templateType": "PAYMENT",
  "name": "Generic Payment Email",
  "subject": "Action Required - Your payment is due",
  "content": "<h1>Your invoice has been sent.</h1>",
  "isDefault": true
}
```

--------------------------------

### Example Response: Get All User Notifications (200 Default)

Source: https://docs.mercoa.com/home/overview/api-reference/entity/user/notifications/find

A sample JSON response for a successful 'Get All User Notifications' API call, showing the structure of notification data including ID, type, status, creation timestamp, and associated invoice ID.

```json
{
  "count": 2,
  "hasMore": false,
  "data": [
    {
      "id": "notif_7df2974a-4069-454c-912f-7e58ebe030fb",
      "type": "INVOICE_APPROVAL_NEEDED",
      "status": "SENT",
      "createdAt": "2024-01-01T00:00:00Z",
      "invoiceId": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9"
    },
    {
      "id": "notif_958c4ffb-dc06-494c-a0e0-1b4946c6bb0f",
      "type": "INVOICE_APPROVED",
      "status": "SENT",
      "createdAt": "2024-01-01T00:00:00Z",
      "invoiceId": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9"
    }
  ]
}
```

--------------------------------

### Example JSON Payload for Bulk Invoices Created Webhook

Source: https://docs.mercoa.com/home/overview/api-reference/webhooks/bulk-invoices-created

Illustrates the structure of the `invoice.bulk.created` webhook payload, showing successful and failed invoice creation responses.

```JSON
{
  "eventType": "invoice.bulk.created",
  "data": [
    {
      "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
      "foreignId": "YOUR-INVOICE-ID"
    },
    {
      "foreignId": "YOUR-SECOND-INVOICE-ID",
      "error": "Invoice creation failed"
    }
  ]
}
```

--------------------------------

### Get Entity Representative using Python SDK

Source: https://docs.mercoa.com/home/overview/api-reference/entity/representative/get

Example of how to retrieve a specific business representative for an entity using the Mercoa Python SDK. This snippet demonstrates client initialization with an API token and calling the 'get' method with required entity and representative IDs.

```Python
from mercoa import Mercoa

client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.representative.get(
    entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
    representative_id="rep_7df2974a-4069-454c-912f-7e58ebe030fb",
)
```
Tokens:
Raw