'CommSvcConnector' web service for external messages

You use web services for transporting information to and from a Profit database. For importing external messages and status information you use the 'CommSvcConnector.asmx’ web service.

You have to place the web service in the correct location in a local installation. You have to develop software yourself to read messages in Profit via the web service and to read status information from Profit. You can upload message statuses once you have read messages in Profit.

The web service URLs:

• Local installation

  https://<<server name>>/Profitservices/CommSvcConnector.asmx

• AFAS Online

  https://profitweb.afasonline.nl/profitservices/CommSvcConnector.asmx

• Early adopters

  https://ota.afasonline.nl/profitservices/CommSvcConnector.asmx

You can request the web service via a browser. For each method, you can see which information you need to supply.

This web service supports three methods:

• GetMessageStatus

  Retrieve the status of a specific message from Profit.

• GetUpdatedMessages

  Retrieve message IDs for messages whose status has changed since the last time that you uploaded statuses.

• UploadMessage

  Read messages in Profit.

You can run methods 'GetMessageStatus' and GetUpdatedMessages' via a browser to test them (if you call up the web service via a ‘local host'). Enter the test values in the form and click on 'Invoke'. In the 'UploadMessage' method, there is no form. You cannot test this method by calling the web service from a browser.

See also:

• Call a connector using Profit Web Services

Notes on the 'GetMessageStatus’ method

Retrieving a message status from an environment on the basis of a message code (‘messageId').

Fields:

• environmentId: Environment name
• userId: Connector user in Profit.
• password: Password of the connector user in Profit.
• messageId: code of the message that you want to retrieve. This is an internal code from Profit.

Notes on the 'GetMessageStatus’ method

Upload message codes that have changed since the last times that you uploaded message statuses. After you have uploaded these codes, you can upload the statuses for each message using the 'GetMessageStatus'’ method.

Fields:

• environmentId: Environment name
• userId: Connector user in Profit.
• password: Password of the connector user in Profit.
• messageStatusFilter: Filter by status code. This field is optional. If you leave this field empty, you upload all changed messages. If you enter a status code in the field, you only upload changed messages with the relevant status.

Notes on the 'UploadMessage’ method

Read declaration messages in Profit. After reading, you need to process the messages using the 'COMMCONNPROCES‘ command line option.

Fields:

• environmentId: Environment name
• userId: Connector user in Profit.
• password: Password of the connector user in Profit.
• messageType:

  Type of declaration Use one of these values:

  • BTW
  • ICP
  • LH
  • KVK
• externalMessageId: You can specify the ID yourself.
• messageContent: Declaration in XML format or XBRL format, zipped ('deflate', as base64 coded string).

  Use the correct version of 'Nederlandse taxonomie' (NT):

  • KVK: NT 7.0 / 8.0
  • Btwicp and NT 8.0.
  • LH: n/a Only tax declarations from the 2014 wage year can be filed.
• messagePDF: PDF file of the declarations, zipped ('deflate', as base64 coded string).

The fields 'externalMessageId' and 'messagePDF' are optional, but you cannot deduce this from the WSDL. The other fields are mandatory.