Skip to main content

autessa.acumatica

8 methods in the acumatica namespace.

autessa.acumatica.connectors.allREAD

autessa.acumatica.connectors.all()

List every Acumatica connector you can access in your company.

Returns all Acumatica connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other acumatica.connectors.* methods. Credentials are never included in the returned DTOs.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectors
    Type
    AcumaticaConnectorDto[]
    Description

autessa.acumatica.connectors.apiVersionsMUTATE

autessa.acumatica.connectors.apiVersions({ connectorId })

List the contract API versions the connected Acumatica instance supports.

Queries the connected Acumatica instance for connectorId and returns the contract API versions it supports. Use it to confirm the instance is reachable and to pick a compatible API version before making other calls.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    apiVersions
    Type
    string[]
    Description

autessa.acumatica.connectors.deleteMUTATE

autessa.acumatica.connectors.delete({ connectorId })

Permanently delete a Acumatica connector and its stored credential.

Removes the Acumatica connector for connectorId, revoking every tool and script that relied on it. The stored credential is destroyed and cannot be recovered — reconnecting requires the full auth flow again. Requires WRITE (owner-level) access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    success
    Type
    boolean
    Description

autessa.acumatica.connectors.getREAD

autessa.acumatica.connectors.get({ connectorId })

Fetch one Acumatica connector by id.

Returns the full Acumatica connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    AcumaticaConnectorDto
    Description

autessa.acumatica.connectors.getSharingDetailsREAD

autessa.acumatica.connectors.getSharingDetails({ connectorId })

Read the current sharing configuration of a Acumatica connector.

Returns how the Acumatica connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    companyPermissionLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    sharedWith
    Type
    UserShareWrapper[]
    Description
  • Name
    userAccessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

autessa.acumatica.connectors.shareMUTATE

autessa.acumatica.connectors.share({ connectorId, level, accessLevel, usersToAdd, usersToRemove })

Change who in your company can use a Acumatica connector.

Sets the sharing scope of the Acumatica connector. level=PRIVATE keeps it to the owner; level=COMPANY grants everyone in the company the given accessLevel; level=SPECIFIC_MEMBER shares with named users — add them in usersToAdd and revoke via usersToRemove (each as a UserShareWrapper). accessLevel applies to COMPANY sharing. Sharing lets other members' tools and scripts use the connector; the credential itself is never exposed. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersToAdd
    Type
    UserShareWrapper[]
    Description
  • Name
    usersToRemove
    Type
    UserShareWrapper[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    AcumaticaConnectorDto
    Description

autessa.acumatica.connectors.updateMUTATE

autessa.acumatica.connectors.update({ connectorId, connectorName, isActive })

Rename a Acumatica connector or toggle whether it is active.

Applies a sparse patch to the Acumatica connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    connectorName
    Type
    string
    Description
  • Name
    isActive
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    AcumaticaConnectorDto
    Description