updateIrs

Perform various update operations on Internal Revenue Service (IRS) records.

Symitar eDocs References: Coming soon.

Operations

updateIrsByID

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/account/updateIrsByID

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

IrsLocatorinteger

IrsUpdatableFieldsobject

IrsDistributionUpdateRequestarray of object

IrsNameUpdateRequestarray of object

AccountNumberstring

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

UpdateStatusobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/account/updateIrsByID', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "UserNumberCredentials": {
          "UserNumber": 1995,
          "Password": "2dfKQYR!TeXJwe"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": false,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

updateIrsDistributionByID

POSThttps://naas.ymcu.libum.io/nexum/627/2022.01/account/updateIrsDistributionByID

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

IrsDistributionLocatorinteger

IrsDistributionUpdatableFieldsobject

AccountNumberstring

IrsLocatorinteger

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

UpdateStatusobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/2022.01/account/updateIrsDistributionByID', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "UserNumberCredentials": {
          "UserNumber": 1995,
          "Password": "2dfKQYR!TeXJwe"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": false,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}