Skip to main content

Setup

EcpPro Setup Card​

Navigate to the EcpPro Setup page from the Business Manager Role Center under the EcpPro Connector group, or by searching for "EcpPro Setup" in the search bar.

The Setup Card is split into General, Invoicing, Purchasing, and Developer Settings sections.

General​

The General section contains the connection settings for EcpPro:

FieldDescription
API Base URLThe EcpPro API endpoint. Default: https://b2b-api.EcpPro.com
Customer IDYour customer or MSP identifier in EcpPro. Required for API authentication.
Secret KeyYour API key provided by EcpPro. This value is encrypted and stored securely. The field is masked for security.
Parent Entity GUIDOptional. A GUID to target a specific parent entity when making API calls. Leave blank to use the default.

Invoicing​

The Invoicing section controls how staged EcpPro invoices are turned into Business Central sales documents:

FieldDescription
Invoice ItemChoose whether lines use EcpPro item mapping or a single default Business Central item.
Default Item No.Required when Invoice Item is set to Default Item.
Invoicing Posting OptionChoose whether the app only creates the sales document or creates and posts it immediately.
Cost Centre Dimension CodeThe dimension code used when the staged cost centre value is copied to created sales lines.
Minimum Margin %Highlights low-margin staged lines before processing so users can review them before continuing.

Purchasing​

The Purchasing section enables the follow-up purchase-document workflow:

FieldDescription
Create Purchase InvoiceEnables purchase document creation from staged EcpPro invoices. Despite the field name, the app creates either a purchase invoice or a purchase credit memo based on the sign of the staged total.
Vendor No.The vendor used on created purchase documents. This must be configured before any purchase document can be created.
Copy Customer DimensionCopies the default dimensions from the customer on the staged invoice onto created purchase lines, then combines them with the staged cost centre dimension.

Developer Settings​

The Developer Settings section controls diagnostics and test actions:

FieldDescription
Developer ModeEnables the test API actions and response viewer so connectivity can be verified directly from the setup page.
Log API CallsEnables audit and troubleshooting logs for all outbound EcpPro requests. Enabled by default.
Important

You will need your Customer ID and Secret Key from EcpPro before proceeding with the setup. Contact your EcpPro account manager if you do not have these credentials.

Step-by-Step Setup​

  1. Open the EcpPro Setup card from the Role Center or search bar.
  2. Verify the API Base URL is correct (the default value should work for most environments).
  3. Enter your Customer ID.
  4. Enter your Secret Key — the value will be masked after entry.
  5. Optionally enter a Parent Entity GUID if you need to scope API calls to a specific parent entity.
  6. Choose your Invoice Item strategy and, if needed, set the Default Item No..
  7. Select the Invoicing Posting Option.
  8. Enter the Cost Centre Dimension Code and optionally define a Minimum Margin % threshold for staged invoice review.
  9. If you want Business Central purchase documents as part of the workflow, enable Create Purchase Invoice, set the Vendor No., and decide whether to enable Copy Customer Dimension.
  10. Leave Log API Calls enabled (recommended).
  11. Optionally enable Developer Mode to test the connection.

Purchase Document Prerequisites​

Before users run Create Purchase Documents, verify the following:

  1. Create Purchase Invoice is enabled on the setup card.
  2. Vendor No. is populated.
  3. The staged invoice has already been processed on the sales side.
  4. At least one staged invoice line contains a Unit Cost.

Purchase creation groups eligible staged invoices by Provider Invoice Number and Currency Code. The app reuses an open purchase invoice or purchase credit memo when another eligible staging record belongs to the same group.

Testing the Connection​

When Developer Mode is enabled, additional test actions become available on the Setup Card:

ActionDescription
Health CheckSends a ping request to verify the API is reachable.
Contact ListTests the Contact List API endpoint.
Group ListTests the Group List API endpoint.
License ListTests the License List API endpoint.
Tenant ListTests the Tenant List API endpoint.
User ListTests the User List API endpoint.
User Subscription Cost ListTests the User Subscription Cost API endpoint.

Each test action sends a request to the corresponding EcpPro API endpoint and displays the response in the API Response Viewer. This helps verify that credentials are correct and connectivity is working.

API Log Entries​

When Log API Calls is enabled, all outbound requests to EcpPro are logged. You can access the log from the API Log Entries action on the Setup Card.

Each log entry records:

FieldDescription
Created AtTimestamp of the API call.
HTTP MethodThe HTTP method used (GET, POST, etc.).
URLThe full request URL.
Is SuccessfulWhether the call succeeded (color-coded: green for success, red for failure).
HTTP Status CodeThe HTTP response status code.
Duration (s)How long the call took in seconds.

You can also view the full Request Body and Response Body for each log entry using the corresponding actions.

tip

Use the Delete All Log Entries action to clear the log when it is no longer needed.

Role Center Integration​

After installation, a new EcpPro Connector group is added to the Business Manager Role Center with quick links to:

  • EcpPro Setup
  • Tenant List
  • User List
  • Contact List
  • Group List
  • License List
  • BC Invoice Mapping

See Also​

tip