Overview

Jonas provides the ability to import and export data to external third-party applications (such as Salesforce or QuickBooks) through a SOAP web service. The service exchanges data for a variety of business objects using JSON payloads that comply with a well-defined schema.

Endpoint

https://websvcazure.jonasportal.com/jonasAPI/japi.asmx

WSDL & introspection

The service publishes a WSDL document for client code generation:

https://websvcazure.jonasportal.com/jonasAPI/japi.asmx?WSDL

HTTPS is required for all calls; HTTP is not accepted. The service uses jonas.jonasportal.com/ as its SOAP/XML namespace — the per-endpoint pages on this portal use the correct namespace in their request samples.

For interactive testing, consider importing this WSDL into SoapUI. SoapUI can generate request templates and submit SOAP calls while you develop and troubleshoot integrations.

Web service operations

1. Login

<securityToken>string</securityToken>
<username>string</username>
<password>string</password>

Returns a serialized JSON object:

{ "isAuthenticated": true, "isValid": true, "data": "...", "message": "..." }

2. JonasAPI

<securityToken>string</securityToken>
<username>string</username>
<password>string</password>
<apiParams>string</apiParams>

Returns a serialized JSON object:

{ "isAuthenticated": true, "isValid": true, "data": "...", "message": "..." }

Login and JonasAPI are independent — every JonasAPI call re-authenticates from the supplied credentials, so calling Login first is optional and does not establish a session. See Authentication & tenancy below.

Parameters

Authentication & tenancy

Every call carries three credentials in the SOAP envelope: securityToken, username, and password.

• The securityToken identifies the tenant — one token maps to exactly one Jonas customer environment, and the service routes requests to that tenant's on-premise Jonas engine. Tokens are issued by Jonas and rotation requires contacting Jonas support; clients cannot rotate tokens themselves.
• username and password are the user's Jonas system credentials. They are forwarded to the tenant's engine and validated on every call; there is no session, token, or cookie that persists between requests.
• HTTPS is required for every call. The internal hop from the public service to the tenant's engine runs over a separate mutual-TLS channel pinned to a per-tenant client certificate.

Functions

Options

Each call object supports the following options; each returns a different result set:

Response shape

Both Login and JonasAPI return a SOAP body whose JonasAPIResult element contains a serialized JSON object:

{
  "isAuthenticated": true,
  "isValid": true,
  "data": "{\"WebMethod\":\"GJZJ6J\",\"Option\":\"scan\",...,\"ErrorsFound\":\"0\"}",
  "message": "Login Successful : UserID GJSYSTEM ..."
}

Decode the body in two steps: parse the outer object, then if data is non-empty, parse data as JSON to read the business result.

Errors

Errors arrive in two layers, both delivered inside a normal HTTP 200 SOAP response — there are no SOAP faults under regular operation.

For scan and update operations, overall business-operation success is generally based on the parsed JSON result's error count. Responses document this field as either ErrorsFound (often the string "0") or errorsFound (often the number 0). Read whichever documented spelling is present, normalize its value to a number, and consider the operation successful only when that number equals 0. A missing, non-numeric, or nonzero error count means the operation did not complete successfully. The outer isValid field reports only web-service-layer validity.

Envelope-level errors

Returned with isAuthenticated=false and/or isValid=false, with a short fixed string in message. These cover misconfigured calls and transport-level failures before the request reaches the Jonas engine.

Business-rule errors

When isAuthenticated is true but the engine rejects the payload — for example, an unknown CompanyCode, a missing required field, or a duplicate primary key — the failure surfaces inside the parsed data JSON:

{
  "WebMethod": "GJZJ6J",
  "Option": "scan",
  "CompanyCode": "TT",
  "ARSubledgerCode": "AR",
  "errors": ["Invalid CompanyCode"],
  "ErrorsFound": "1",
  "RecordsProcessed": "0"
}

Always send an Option: scan request first to surface validation errors without committing data, then resend with Option: update once ErrorsFound is 0.

Limits, timeouts & concurrency

For datasets that exceed the size limits, prefer GJZJ82J datamart reads with PageSize pagination, and chunk large upload arrays (AR_CustomerMaster_tbl, WO_Headers_tbl, etc.) into multiple update calls of a few hundred rows each. The service does not support resuming a partially-applied update; if a chunk fails, resend the same chunk after correcting the errors reported in errors[].

Sample method calls

Each endpoint page in the sidebar documents the available SOAP request/response samples for that function's Template, Download, Scan, and Update options. A typical SOAP call wraps the JSON apiParams payload inside the standard authentication envelope. Enclose the JSON payload in a <![CDATA[ ... ]]> section so its contents are not interpreted as XML markup, for example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <JonasAPI xmlns="jonas.jonasportal.com/">
      <securityToken>...</securityToken>
      <username>...</username>
      <password>...</password>
      <apiParams><![CDATA[
        { "WebMethod": "GJZJ6J", "Option": "Template", "CompanyCode": "JC" }
      ]]></apiParams>
    </JonasAPI>
  </soap:Body>
</soap:Envelope>

Next steps

• Reading Data — simple datamart queries.
• Customers — scan / update samples.
• Work Orders — import request / response pairs.
• Job Master — create jobs.