updateIrs

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

Symitar eDocs References: Coming soon.

Operations

updateIrsByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

IrsLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/updateIrsByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/updateIrsByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 758

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "IrsFields": {
    "ActualMaxContribution": 1,
    "ContrLastYear": [
      {
        "EntryId": 1,
        "ContrLastYear": 1
      }
    ],
    "ContrThisYear": [
      {
        "EntryId": 1,
        "ContrThisYear": 1
      }
    ],
    "ContributionYear": 1,
    "DistrLastYear": [
      {
        "EntryId": 1,
        "DistrLastYear": 1
      }
    ],
    "DistrThisYear": [
      {
        "EntryId": 1,
        "DistrThisYear": 1
      }
    ],
    "FairMarketValueDeath": 1,
    "FairMarketValueLastYear": 1,
    "IraRmd": 1,
    "IrsCode": 1,
    "IrsHolderBirthDate": "2025-12-25",
    "IrsHolderSpouseBirthDate": "2025-12-25",
    "IrsPlan": 1,
    "LastDistribType": 1,
    "Locator": 1,
    "MaxContribution": 1,
    "MsaHolderCode": 1,
    "OpenDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "RmdTableOption": 1,
    "Ssn": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

updateIrsDistributionByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

IrsLocatorintegerOptional

IrsDistributionLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/updateIrsDistributionByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/updateIrsDistributionByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 773

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "IrsDistributionLocator": 1,
  "IrsDistributionFields": {
    "Amount": 1,
    "DestinationAccount": "text",
    "DestinationId": "text",
    "DistributionCode": 1,
    "DistributionDay1": 1,
    "DistributionDay2": 1,
    "DistributionFreq": 1,
    "DistributionMethod": 1,
    "EffectiveDate": "2025-12-25",
    "ExpirationDate": "2025-12-25",
    "FedWholdAmount": 1,
    "FedWholdCode": 1,
    "FedWholdPercent": 1,
    "LastDistributnAmt": 1,
    "LastDistributnDate": "2025-12-25",
    "Locator": 1,
    "NextDistributnDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "RegE": 1,
    "SourceId": [
      {
        "EntryId": 1,
        "SourceId": "text"
      }
    ],
    "StateWholdAmount": 1,
    "StateWholdCode": 1,
    "StateWholdPercent": 1,
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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