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

IrsLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/updateIrsByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "IrsLocator": 1,
  "IrsUpdatableFields": {
    "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,
    "MaxContribution": 1,
    "MsaHolderCode": 1,
    "OpenDate": "2025-12-25",
    "RmdTableOption": 1,
    "Ssn": "text"
  },
  "IrsDistributionUpdateRequest": [
    {
      "IrsDistributionLocator": 1,
      "IrsDistributionUpdatableFields": {
        "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",
        "NextDistributnDate": "2025-12-25",
        "RegE": 1,
        "SourceId": [
          {
            "EntryId": 1,
            "SourceId": "text"
          }
        ],
        "StateWholdAmount": 1,
        "StateWholdCode": 1,
        "StateWholdPercent": 1,
        "Type": 1
      }
    }
  ],
  "IrsNameUpdateRequest": [
    {
      "IrsNameLocator": 1,
      "IrsNameUpdatableFields": {
        "ActiveDuty": 1,
        "ActiveDutySeparationDate": "2025-12-25",
        "ActiveDutyStartDate": "2025-12-25",
        "ActiveDutyVerificationDate": "2025-12-25",
        "AddrExpDate": "2025-12-25",
        "AddressType": 1,
        "AltEmail": "text",
        "BeneficialOwner": 1,
        "BeneficialPercent": 1,
        "BeneficiaryPercent": 1,
        "BirthDate": "2025-12-25",
        "CarrierRoute": "text",
        "Chapter4StatusCode": "text",
        "City": "text",
        "Confidential": 1,
        "Country": "text",
        "CountryCode": "text",
        "CreditReportAddrIndicator": "text",
        "CreditReportAddrIndicatorDate": "2025-12-25",
        "CreditReportConsumerInfo": "text",
        "CreditReportConsumerInfoDate": "2025-12-25",
        "CtrExempt": 1,
        "CurrGrossMonthPay": 1,
        "CurrNetMonthPay": 1,
        "DbaExtendedName": "text",
        "DbaFirst": "text",
        "DbaLast": "text",
        "DbaMiddle": "text",
        "DbaNameFormat": 1,
        "DbaSuffix": "text",
        "DbaTitle": "text",
        "DeathDate": "2025-12-25",
        "EffectiveDate": "2025-12-25",
        "Email": "text",
        "EmployerName": "text",
        "ExpirationDate": "2025-12-25",
        "ExtendedName": "text",
        "ExtraAddress": "text",
        "ExtraInfo": "text",
        "First": "text",
        "ForeignTin": "text",
        "FormW8OnFile": 1,
        "GIin": "text",
        "Headquarters": 1,
        "HomePhone": "text",
        "IdentDocFlag": [
          {
            "EntryId": 1,
            "IdentDocFlag": 1
          }
        ],
        "IdentIdDescription": [
          {
            "EntryId": 1,
            "IdentIdDescription": "text"
          }
        ],
        "IdentIdExpireDate": [
          {
            "EntryId": 1,
            "IdentIdExpireDate": "2025-12-25"
          }
        ],
        "IdentIdIssueDate": [
          {
            "EntryId": 1,
            "IdentIdIssueDate": "2025-12-25"
          }
        ],
        "IdentIdNumber": [
          {
            "EntryId": 1,
            "IdentIdNumber": "text"
          }
        ],
        "IdentIdType": [
          {
            "EntryId": 1,
            "IdentIdType": 1
          }
        ],
        "IdentIdVerifyDate": [
          {
            "EntryId": 1,
            "IdentIdVerifyDate": "2025-12-25"
          }
        ],
        "Irs1042SAmendNum": 1,
        "IrsCountryCode": "text",
        "Last": "text",
        "LastAddrVerifDate": "2025-12-25",
        "Lei": "text",
        "Lob": "text",
        "MarketingAddress": 1,
        "MbrAddrNumLink": "text",
        "MbrExpDate": "2025-12-25",
        "MbrStatus": 1,
        "MemberNumLink": "text",
        "Middle": "text",
        "MobilePhone": "text",
        "MothersMaidenName": "text",
        "NameFormat": 1,
        "NonAcctNameNum": "text",
        "NraExemptionCode": "text",
        "NraTaxRate": 1,
        "Occupation": "text",
        "PagerNumber": "text",
        "PhoneType": 1,
        "PreferredContactMethod": 1,
        "Restrict": 1,
        "Sex": "text",
        "Ssn": "text",
        "SsnCertification": 1,
        "SsnType": 1,
        "State": "text",
        "Street": "text",
        "SubType": 1,
        "SubstantialOwner": 1,
        "Suffix": "text",
        "Title": "text",
        "Type": 1,
        "UsPersonFlag": 1,
        "UserAmount1": 1,
        "UserAmount2": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserChar4": "text",
        "UserDate1": "2025-12-25",
        "UserDate2": "2025-12-25",
        "W8ExpirationDate": "2025-12-25",
        "WorkPhone": "text",
        "WorkPhoneExtension": "text",
        "ZipCode": "text"
      }
    }
  ],
  "AccountNumber": "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

IrsDistributionLocatorintegerOptional

AccountNumberstringOptional

IrsLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/updateIrsDistributionByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "IrsDistributionLocator": 1,
  "IrsDistributionUpdatableFields": {
    "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",
    "NextDistributnDate": "2025-12-25",
    "RegE": 1,
    "SourceId": [
      {
        "EntryId": 1,
        "SourceId": "text"
      }
    ],
    "StateWholdAmount": 1,
    "StateWholdCode": 1,
    "StateWholdPercent": 1,
    "Type": 1
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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