FinrepService

Manage Current Transaction Report (CTR) records.

Symitar eDocs References: Coming soon.

Operations

getCtrSelectFields

post

Retrieves CTRs with selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1884

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "SelectableFields": {
    "IncludeAllCtrFields": true,
    "CtrFields": {
      "AckByUser": true,
      "AckDate": true,
      "AckErrorByUser": true,
      "AckErrorDate": true,
      "ApproveAmendByUser": true,
      "ApproveAmendDate": true,
      "ApproveByUser": true,
      "ApproveDate": true,
      "Approver": true,
      "ApproverTitle": true,
      "BackFileFlag": true,
      "BatchSequence": true,
      "BranchRouting": true,
      "CashinBillsInsert": true,
      "CashinCurrWager": true,
      "CashinCurrXchng": true,
      "CashinDeposit": true,
      "CashinFundsXfer": true,
      "CashinGamingIns": true,
      "CashinNegIns": true,
      "CashinOther": true,
      "CashinOtherDesc": true,
      "CashinPayment": true,
      "CashinPrepaid": true,
      "CashinTotal": true,
      "CashoutAdvOnCred": true,
      "CashoutCurrXchng": true,
      "CashoutFundsXfer": true,
      "CashoutGamingIns": true,
      "CashoutNegIns": true,
      "CashoutOther": true,
      "CashoutOtherDesc": true,
      "CashoutPayOnWagers": true,
      "CashoutPrepaid": true,
      "CashoutPromo": true,
      "CashoutTotal": true,
      "CashoutTravel": true,
      "CashoutWithdraw": true,
      "ContactOffice": true,
      "ContactPhone": true,
      "ContactPhoneExt": true,
      "CreateByUser": true,
      "CreateDate": true,
      "DcNumber": true,
      "ExemptByUser": true,
      "ExemptDate": true,
      "FederalRegulator": true,
      "FiIdNumber": true,
      "FiIdNumberType": true,
      "FiOtherType": true,
      "FiType": true,
      "FilingDate": true,
      "FilingType": true,
      "FmPurgeDate": true,
      "IncompleteByUser": true,
      "IncompleteDate": true,
      "LastFmDate": true,
      "LastSubmitDate": true,
      "NonReportByUser": true,
      "NonReportDate": true,
      "Number": true,
      "Preparer": true,
      "ReSubAmendByUser": true,
      "ReSubAmendDate": true,
      "RecordChangeDate": true,
      "RsnAggregateFlag": true,
      "RsnArmCarFlag": true,
      "RsnAtmFlag": true,
      "RsnMailShipFlag": true,
      "RsnNgtDepFlag": true,
      "RsnShBRFlag": true,
      "Status": true,
      "StatusDate": true,
      "SubmitByUser": true,
      "SubmitDate": true,
      "Tcc": true,
      "TranDate": true,
      "TranSeq": true,
      "VerifyAmendByUser": true,
      "VerifyAmendDate": true,
      "VerifyByUser": true,
      "VerifyDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Ctr": {
    "AckByUser": "text",
    "AckDate": "2025-05-21",
    "AckErrorByUser": "text",
    "AckErrorDate": "2025-05-21",
    "ApproveAmendByUser": "text",
    "ApproveAmendDate": "2025-05-21",
    "ApproveByUser": "text",
    "ApproveDate": "2025-05-21",
    "Approver": "text",
    "ApproverTitle": "text",
    "BackFileFlag": 1,
    "BatchSequence": 1,
    "BranchRouting": "text",
    "CashinBillsInsert": 1,
    "CashinCurrWager": 1,
    "CashinCurrXchng": 1,
    "CashinDeposit": 1,
    "CashinFundsXfer": 1,
    "CashinGamingIns": 1,
    "CashinNegIns": 1,
    "CashinOther": 1,
    "CashinOtherDesc": "text",
    "CashinPayment": 1,
    "CashinPrepaid": 1,
    "CashinTotal": 1,
    "CashoutAdvOnCred": 1,
    "CashoutCurrXchng": 1,
    "CashoutFundsXfer": 1,
    "CashoutGamingIns": 1,
    "CashoutNegIns": 1,
    "CashoutOther": 1,
    "CashoutOtherDesc": "text",
    "CashoutPayOnWagers": 1,
    "CashoutPrepaid": 1,
    "CashoutPromo": 1,
    "CashoutTotal": 1,
    "CashoutTravel": 1,
    "CashoutWithdraw": 1,
    "ContactOffice": "text",
    "ContactPhone": "text",
    "ContactPhoneExt": "text",
    "CreateByUser": "text",
    "CreateDate": "2025-05-21",
    "CtrAccountList": {
      "hasReachedMaximumListSize": true,
      "CtrAccount": [
        {
          "AccountNumber": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "RecordChangeDate": "2025-05-21",
          "SlId": "text",
          "SlIdType": 1,
          "Source": 1
        }
      ]
    },
    "CtrBranchList": {
      "hasReachedMaximumListSize": true,
      "CtrBranch": [
        {
          "Address": "text",
          "CashinLocation": 1,
          "CashoutLocation": 1,
          "City": "text",
          "CountryCode": "text",
          "Ein": "text",
          "Id": 1,
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "Name": "text",
          "RecordChangeDate": "2025-05-21",
          "State": "text",
          "Type": 1,
          "ZipCode": "text"
        }
      ]
    },
    "CtrFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "CtrFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-05-21",
          "NewCharacter": "text",
          "NewDate": "2025-05-21",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-05-21",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-05-21",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "CtrForeignList": {
      "hasReachedMaximumListSize": true,
      "CtrForeign": [
        {
          "Cashin": 1,
          "Cashout": 1,
          "CountryCode": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "RecordChangeDate": "2025-05-21"
        }
      ]
    },
    "CtrNoteList": {
      "hasReachedMaximumListSize": true,
      "CtrNote": [
        {
          "Code": 1,
          "EnterDate": "2025-05-21",
          "EnterTime": 1,
          "ExpirationDate": "2025-05-21",
          "Id": "text",
          "IdType": 1,
          "Locator": 1,
          "RecordChangeDate": "2025-05-21",
          "Text": [
            {
              "EntryId": 1,
              "Text": "text"
            }
          ],
          "TextLineCount": 1,
          "UserId": 1,
          "VoidFlag": 1,
          "VoidedBy": 1
        }
      ]
    },
    "CtrPersonList": {
      "hasReachedMaximumListSize": true,
      "CtrPerson": [
        {
          "Address": "text",
          "BirthDate": "2025-05-21",
          "Cashin": 1,
          "Cashout": 1,
          "City": "text",
          "CountryCode": "text",
          "CtrPersonCtrTranInfoList": {
            "hasReachedMaximumListSize": true,
            "CtrPersonCtrTranInfo": [
              {
                "AccountNumber": "text",
                "Amount": 1,
                "LastFmDate": "2025-05-21",
                "Locator": 1,
                "RecordChangeDate": "2025-05-21",
                "SlId": "text",
                "SlIdType": 1,
                "Source": 1
              }
            ]
          },
          "DbaFirst": "text",
          "DbaLast": "text",
          "DbaLongName": "text",
          "DbaMiddle": "text",
          "DbaShortName": "text",
          "DbaSuffix": "text",
          "Email": "text",
          "EntityFlag": 1,
          "First": "text",
          "Gender": "text",
          "Headquarters": 1,
          "IdIssueByCountry": "text",
          "IdIssueByState": "text",
          "IdNumber": "text",
          "IdTypeOtherDesc": "text",
          "IdVerifyMethod": 1,
          "Last": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "LongName": "text",
          "Middle": "text",
          "MultiTransFlag": 1,
          "NaicsCode": "text",
          "Occupation": "text",
          "Phone": "text",
          "PhoneExt": "text",
          "RecordChangeDate": "2025-05-21",
          "ShortName": "text",
          "Ssn": "text",
          "SsnTintype": 1,
          "State": "text",
          "Suffix": "text",
          "Type": 1,
          "ZipCode": "text"
        }
      ]
    },
    "DcNumber": "text",
    "ExemptByUser": "text",
    "ExemptDate": "2025-05-21",
    "FederalRegulator": 1,
    "FiIdNumber": "text",
    "FiIdNumberType": "text",
    "FiOtherType": "text",
    "FiType": "text",
    "FilingDate": "2025-05-21",
    "FilingType": "text",
    "FmPurgeDate": "2025-05-21",
    "IncompleteByUser": "text",
    "IncompleteDate": "2025-05-21",
    "LastFmDate": "2025-05-21",
    "LastSubmitDate": "2025-05-21",
    "NonReportByUser": "text",
    "NonReportDate": "2025-05-21",
    "Number": "text",
    "Preparer": "text",
    "ReSubAmendByUser": "text",
    "ReSubAmendDate": "2025-05-21",
    "RecordChangeDate": "2025-05-21",
    "RsnAggregateFlag": 1,
    "RsnArmCarFlag": 1,
    "RsnAtmFlag": 1,
    "RsnMailShipFlag": 1,
    "RsnNgtDepFlag": 1,
    "RsnShBRFlag": 1,
    "Status": 1,
    "StatusDate": "2025-05-21",
    "SubmitByUser": "text",
    "SubmitDate": "2025-05-21",
    "Tcc": "text",
    "TranDate": "2025-05-21",
    "TranSeq": "text",
    "VerifyAmendByUser": "text",
    "VerifyAmendDate": "2025-05-21",
    "VerifyByUser": "text",
    "VerifyDate": "2025-05-21"
  }
}

getCtrSelectFieldsFilterChildren

post

Retrieves CTRs with selected fields and filtered children.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 4897

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "SelectableFields": {
    "IncludeAllCtrFields": true,
    "CtrFields": {
      "AckByUser": true,
      "AckDate": true,
      "AckErrorByUser": true,
      "AckErrorDate": true,
      "ApproveAmendByUser": true,
      "ApproveAmendDate": true,
      "ApproveByUser": true,
      "ApproveDate": true,
      "Approver": true,
      "ApproverTitle": true,
      "BackFileFlag": true,
      "BatchSequence": true,
      "BranchRouting": true,
      "CashinBillsInsert": true,
      "CashinCurrWager": true,
      "CashinCurrXchng": true,
      "CashinDeposit": true,
      "CashinFundsXfer": true,
      "CashinGamingIns": true,
      "CashinNegIns": true,
      "CashinOther": true,
      "CashinOtherDesc": true,
      "CashinPayment": true,
      "CashinPrepaid": true,
      "CashinTotal": true,
      "CashoutAdvOnCred": true,
      "CashoutCurrXchng": true,
      "CashoutFundsXfer": true,
      "CashoutGamingIns": true,
      "CashoutNegIns": true,
      "CashoutOther": true,
      "CashoutOtherDesc": true,
      "CashoutPayOnWagers": true,
      "CashoutPrepaid": true,
      "CashoutPromo": true,
      "CashoutTotal": true,
      "CashoutTravel": true,
      "CashoutWithdraw": true,
      "ContactOffice": true,
      "ContactPhone": true,
      "ContactPhoneExt": true,
      "CreateByUser": true,
      "CreateDate": true,
      "DcNumber": true,
      "ExemptByUser": true,
      "ExemptDate": true,
      "FederalRegulator": true,
      "FiIdNumber": true,
      "FiIdNumberType": true,
      "FiOtherType": true,
      "FiType": true,
      "FilingDate": true,
      "FilingType": true,
      "FmPurgeDate": true,
      "IncompleteByUser": true,
      "IncompleteDate": true,
      "LastFmDate": true,
      "LastSubmitDate": true,
      "NonReportByUser": true,
      "NonReportDate": true,
      "Number": true,
      "Preparer": true,
      "ReSubAmendByUser": true,
      "ReSubAmendDate": true,
      "RecordChangeDate": true,
      "RsnAggregateFlag": true,
      "RsnArmCarFlag": true,
      "RsnAtmFlag": true,
      "RsnMailShipFlag": true,
      "RsnNgtDepFlag": true,
      "RsnShBRFlag": true,
      "Status": true,
      "StatusDate": true,
      "SubmitByUser": true,
      "SubmitDate": true,
      "Tcc": true,
      "TranDate": true,
      "TranSeq": true,
      "VerifyAmendByUser": true,
      "VerifyAmendDate": true,
      "VerifyByUser": true,
      "VerifyDate": true
    },
    "CtrAccountSelectableFields": {
      "IncludeAllCtrAccountFields": true,
      "CtrAccountFields": {
        "AccountNumber": true,
        "LastFmDate": true,
        "Locator": true,
        "RecordChangeDate": true,
        "SlId": true,
        "SlIdType": true,
        "Source": true
      }
    },
    "CtrBranchSelectableFields": {
      "IncludeAllCtrBranchFields": true,
      "CtrBranchFields": {
        "Address": true,
        "CashinLocation": true,
        "CashoutLocation": true,
        "City": true,
        "CountryCode": true,
        "Ein": true,
        "Id": true,
        "LastFmDate": true,
        "Locator": true,
        "Name": true,
        "RecordChangeDate": true,
        "State": true,
        "Type": true,
        "ZipCode": true
      }
    },
    "CtrFmHistorySelectableFields": {
      "IncludeAllCtrFmHistoryFields": true,
      "CtrFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true,
        "OldNumber": true,
        "OldRate": true,
        "PostDate": true,
        "PostTime": true,
        "ProcessorUser": true,
        "RecordName": true,
        "RecordType": true,
        "SecurityLevels": true,
        "SequenceNumber": true,
        "SubFieldNumber": true,
        "UserNumber": true,
        "UserOverride": true
      }
    },
    "CtrForeignSelectableFields": {
      "IncludeAllCtrForeignFields": true,
      "CtrForeignFields": {
        "Cashin": true,
        "Cashout": true,
        "CountryCode": true,
        "LastFmDate": true,
        "Locator": true,
        "RecordChangeDate": true
      }
    },
    "CtrNoteSelectableFields": {
      "IncludeAllCtrNoteFields": true,
      "CtrNoteFields": {
        "Code": true,
        "EnterDate": true,
        "EnterTime": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Text": [
          1
        ],
        "TextLineCount": true,
        "UserId": true,
        "VoidFlag": true,
        "VoidedBy": true
      }
    },
    "CtrPersonSelectableFields": {
      "IncludeAllCtrPersonFields": true,
      "CtrPersonFields": {
        "Address": true,
        "BirthDate": true,
        "Cashin": true,
        "Cashout": true,
        "City": true,
        "CountryCode": true,
        "DbaFirst": true,
        "DbaLast": true,
        "DbaLongName": true,
        "DbaMiddle": true,
        "DbaShortName": true,
        "DbaSuffix": true,
        "Email": true,
        "EntityFlag": true,
        "First": true,
        "Gender": true,
        "Headquarters": true,
        "IdIssueByCountry": true,
        "IdIssueByState": true,
        "IdNumber": true,
        "IdTypeOtherDesc": true,
        "IdVerifyMethod": true,
        "Last": true,
        "LastFmDate": true,
        "Locator": true,
        "LongName": true,
        "Middle": true,
        "MultiTransFlag": true,
        "NaicsCode": true,
        "Occupation": true,
        "Phone": true,
        "PhoneExt": true,
        "RecordChangeDate": true,
        "ShortName": true,
        "Ssn": true,
        "SsnTintype": true,
        "State": true,
        "Suffix": true,
        "Type": true,
        "ZipCode": true
      },
      "CtrPersonCtrTranInfoSelectableFields": {
        "IncludeAllCtrPersonCtrTranInfoFields": true,
        "CtrPersonCtrTranInfoFields": {
          "AccountNumber": true,
          "Amount": true,
          "LastFmDate": true,
          "Locator": true,
          "RecordChangeDate": true,
          "SlId": true,
          "SlIdType": true,
          "Source": true
        }
      }
    }
  },
  "ChildrenSearchFilter": {
    "CtrAccountFilter": {
      "Query": "text"
    },
    "CtrBranchFilter": {
      "Query": "text"
    },
    "CtrFmHistoryFilter": {
      "StartPostDate": "2025-05-21",
      "EndPostDate": "2025-05-21",
      "Query": "text"
    },
    "CtrForeignFilter": {
      "Query": "text"
    },
    "CtrNoteFilter": {
      "Query": "text"
    },
    "CtrPersonFilter": {
      "Query": "text",
      "CtrPersonChildrenFilter": {
        "CtrPersonCtrTranInfoFilter": {
          "Query": "text"
        }
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Ctr": {
    "AckByUser": "text",
    "AckDate": "2025-05-21",
    "AckErrorByUser": "text",
    "AckErrorDate": "2025-05-21",
    "ApproveAmendByUser": "text",
    "ApproveAmendDate": "2025-05-21",
    "ApproveByUser": "text",
    "ApproveDate": "2025-05-21",
    "Approver": "text",
    "ApproverTitle": "text",
    "BackFileFlag": 1,
    "BatchSequence": 1,
    "BranchRouting": "text",
    "CashinBillsInsert": 1,
    "CashinCurrWager": 1,
    "CashinCurrXchng": 1,
    "CashinDeposit": 1,
    "CashinFundsXfer": 1,
    "CashinGamingIns": 1,
    "CashinNegIns": 1,
    "CashinOther": 1,
    "CashinOtherDesc": "text",
    "CashinPayment": 1,
    "CashinPrepaid": 1,
    "CashinTotal": 1,
    "CashoutAdvOnCred": 1,
    "CashoutCurrXchng": 1,
    "CashoutFundsXfer": 1,
    "CashoutGamingIns": 1,
    "CashoutNegIns": 1,
    "CashoutOther": 1,
    "CashoutOtherDesc": "text",
    "CashoutPayOnWagers": 1,
    "CashoutPrepaid": 1,
    "CashoutPromo": 1,
    "CashoutTotal": 1,
    "CashoutTravel": 1,
    "CashoutWithdraw": 1,
    "ContactOffice": "text",
    "ContactPhone": "text",
    "ContactPhoneExt": "text",
    "CreateByUser": "text",
    "CreateDate": "2025-05-21",
    "CtrAccountList": {
      "hasReachedMaximumListSize": true,
      "CtrAccount": [
        {
          "AccountNumber": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "RecordChangeDate": "2025-05-21",
          "SlId": "text",
          "SlIdType": 1,
          "Source": 1
        }
      ]
    },
    "CtrBranchList": {
      "hasReachedMaximumListSize": true,
      "CtrBranch": [
        {
          "Address": "text",
          "CashinLocation": 1,
          "CashoutLocation": 1,
          "City": "text",
          "CountryCode": "text",
          "Ein": "text",
          "Id": 1,
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "Name": "text",
          "RecordChangeDate": "2025-05-21",
          "State": "text",
          "Type": 1,
          "ZipCode": "text"
        }
      ]
    },
    "CtrFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "CtrFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-05-21",
          "NewCharacter": "text",
          "NewDate": "2025-05-21",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-05-21",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-05-21",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "CtrForeignList": {
      "hasReachedMaximumListSize": true,
      "CtrForeign": [
        {
          "Cashin": 1,
          "Cashout": 1,
          "CountryCode": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "RecordChangeDate": "2025-05-21"
        }
      ]
    },
    "CtrNoteList": {
      "hasReachedMaximumListSize": true,
      "CtrNote": [
        {
          "Code": 1,
          "EnterDate": "2025-05-21",
          "EnterTime": 1,
          "ExpirationDate": "2025-05-21",
          "Id": "text",
          "IdType": 1,
          "Locator": 1,
          "RecordChangeDate": "2025-05-21",
          "Text": [
            {
              "EntryId": 1,
              "Text": "text"
            }
          ],
          "TextLineCount": 1,
          "UserId": 1,
          "VoidFlag": 1,
          "VoidedBy": 1
        }
      ]
    },
    "CtrPersonList": {
      "hasReachedMaximumListSize": true,
      "CtrPerson": [
        {
          "Address": "text",
          "BirthDate": "2025-05-21",
          "Cashin": 1,
          "Cashout": 1,
          "City": "text",
          "CountryCode": "text",
          "CtrPersonCtrTranInfoList": {
            "hasReachedMaximumListSize": true,
            "CtrPersonCtrTranInfo": [
              {
                "AccountNumber": "text",
                "Amount": 1,
                "LastFmDate": "2025-05-21",
                "Locator": 1,
                "RecordChangeDate": "2025-05-21",
                "SlId": "text",
                "SlIdType": 1,
                "Source": 1
              }
            ]
          },
          "DbaFirst": "text",
          "DbaLast": "text",
          "DbaLongName": "text",
          "DbaMiddle": "text",
          "DbaShortName": "text",
          "DbaSuffix": "text",
          "Email": "text",
          "EntityFlag": 1,
          "First": "text",
          "Gender": "text",
          "Headquarters": 1,
          "IdIssueByCountry": "text",
          "IdIssueByState": "text",
          "IdNumber": "text",
          "IdTypeOtherDesc": "text",
          "IdVerifyMethod": 1,
          "Last": "text",
          "LastFmDate": "2025-05-21",
          "Locator": 1,
          "LongName": "text",
          "Middle": "text",
          "MultiTransFlag": 1,
          "NaicsCode": "text",
          "Occupation": "text",
          "Phone": "text",
          "PhoneExt": "text",
          "RecordChangeDate": "2025-05-21",
          "ShortName": "text",
          "Ssn": "text",
          "SsnTintype": 1,
          "State": "text",
          "Suffix": "text",
          "Type": 1,
          "ZipCode": "text"
        }
      ]
    },
    "DcNumber": "text",
    "ExemptByUser": "text",
    "ExemptDate": "2025-05-21",
    "FederalRegulator": 1,
    "FiIdNumber": "text",
    "FiIdNumberType": "text",
    "FiOtherType": "text",
    "FiType": "text",
    "FilingDate": "2025-05-21",
    "FilingType": "text",
    "FmPurgeDate": "2025-05-21",
    "IncompleteByUser": "text",
    "IncompleteDate": "2025-05-21",
    "LastFmDate": "2025-05-21",
    "LastSubmitDate": "2025-05-21",
    "NonReportByUser": "text",
    "NonReportDate": "2025-05-21",
    "Number": "text",
    "Preparer": "text",
    "ReSubAmendByUser": "text",
    "ReSubAmendDate": "2025-05-21",
    "RecordChangeDate": "2025-05-21",
    "RsnAggregateFlag": 1,
    "RsnArmCarFlag": 1,
    "RsnAtmFlag": 1,
    "RsnMailShipFlag": 1,
    "RsnNgtDepFlag": 1,
    "RsnShBRFlag": 1,
    "Status": 1,
    "StatusDate": "2025-05-21",
    "SubmitByUser": "text",
    "SubmitDate": "2025-05-21",
    "Tcc": "text",
    "TranDate": "2025-05-21",
    "TranSeq": "text",
    "VerifyAmendByUser": "text",
    "VerifyAmendDate": "2025-05-21",
    "VerifyByUser": "text",
    "VerifyDate": "2025-05-21"
  }
}

getCtrAccountSelectFields

post

Retrieves CTR accounts with selected fields.

Authorizations

Body

CtrNumberstringOptional

CtrAccountLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrAccountSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "CtrAccountLocator": 1,
  "SelectableFields": {
    "IncludeAllCtrAccountFields": true,
    "CtrAccountFields": {
      "AccountNumber": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrAccount": {
    "AccountNumber": "text",
    "LastFmDate": "2025-05-21",
    "Locator": 1,
    "RecordChangeDate": "2025-05-21",
    "SlId": "text",
    "SlIdType": 1,
    "Source": 1
  }
}

getCtrAccountPagedListSelectFields

post

Retrieves a paged list of CTR accounts with selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrAccountPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 433

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrAccountFields": true,
    "CtrAccountFields": {
      "AccountNumber": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrAccount": [
    {
      "AccountNumber": "text",
      "LastFmDate": "2025-05-21",
      "Locator": 1,
      "RecordChangeDate": "2025-05-21",
      "SlId": "text",
      "SlIdType": 1,
      "Source": 1
    }
  ],
  "Token": "text"
}

searchCtrAccountPagedSelectFields

post

Searches CTR accounts with pagination and selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/searchCtrAccountPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 465

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrAccountFields": true,
    "CtrAccountFields": {
      "AccountNumber": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SlId": true,
      "SlIdType": true,
      "Source": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrAccount": [
    {
      "AccountNumber": "text",
      "LastFmDate": "2025-05-21",
      "Locator": 1,
      "RecordChangeDate": "2025-05-21",
      "SlId": "text",
      "SlIdType": 1,
      "Source": 1
    }
  ],
  "Token": "text"
}

getCtrBranchSelectFields

post

Retrieves CTR branches with selected fields.

Authorizations

Body

CtrNumberstringOptional

CtrBranchLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrBranchSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 459

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "CtrBranchLocator": 1,
  "SelectableFields": {
    "IncludeAllCtrBranchFields": true,
    "CtrBranchFields": {
      "Address": true,
      "CashinLocation": true,
      "CashoutLocation": true,
      "City": true,
      "CountryCode": true,
      "Ein": true,
      "Id": true,
      "LastFmDate": true,
      "Locator": true,
      "Name": true,
      "RecordChangeDate": true,
      "State": true,
      "Type": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrBranch": {
    "Address": "text",
    "CashinLocation": 1,
    "CashoutLocation": 1,
    "City": "text",
    "CountryCode": "text",
    "Ein": "text",
    "Id": 1,
    "LastFmDate": "2025-05-21",
    "Locator": 1,
    "Name": "text",
    "RecordChangeDate": "2025-05-21",
    "State": "text",
    "Type": 1,
    "ZipCode": "text"
  }
}

getCtrBranchPagedListSelectFields

post

Retrieves a paged list of CTR branches with selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrBranchPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrBranchFields": true,
    "CtrBranchFields": {
      "Address": true,
      "CashinLocation": true,
      "CashoutLocation": true,
      "City": true,
      "CountryCode": true,
      "Ein": true,
      "Id": true,
      "LastFmDate": true,
      "Locator": true,
      "Name": true,
      "RecordChangeDate": true,
      "State": true,
      "Type": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrBranch": [
    {
      "Address": "text",
      "CashinLocation": 1,
      "CashoutLocation": 1,
      "City": "text",
      "CountryCode": "text",
      "Ein": "text",
      "Id": 1,
      "LastFmDate": "2025-05-21",
      "Locator": 1,
      "Name": "text",
      "RecordChangeDate": "2025-05-21",
      "State": "text",
      "Type": 1,
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

searchCtrBranchPagedSelectFields

post

Searches CTR branches with pagination and selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/searchCtrBranchPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 564

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrBranchFields": true,
    "CtrBranchFields": {
      "Address": true,
      "CashinLocation": true,
      "CashoutLocation": true,
      "City": true,
      "CountryCode": true,
      "Ein": true,
      "Id": true,
      "LastFmDate": true,
      "Locator": true,
      "Name": true,
      "RecordChangeDate": true,
      "State": true,
      "Type": true,
      "ZipCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrBranch": [
    {
      "Address": "text",
      "CashinLocation": 1,
      "CashoutLocation": 1,
      "City": "text",
      "CountryCode": "text",
      "Ein": "text",
      "Id": 1,
      "LastFmDate": "2025-05-21",
      "Locator": 1,
      "Name": "text",
      "RecordChangeDate": "2025-05-21",
      "State": "text",
      "Type": 1,
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

getCtrFmHistoryPagedListSelectFields

post

Retrieves a paged list of CTRs from history with selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 884

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrFmHistoryFields": true,
    "CtrFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-05-21",
      "NewCharacter": "text",
      "NewDate": "2025-05-21",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-05-21",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-05-21",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

searchCtrFmHistoryPagedSelectFields

post

Searches CTRs from history with pagination and selected fields.

Authorizations

Body

CtrNumberstringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/searchCtrFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 972

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCtrFmHistoryFields": true,
    "CtrFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "SearchFilter": {
    "StartPostDate": "2025-05-21",
    "EndPostDate": "2025-05-21",
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-05-21",
      "NewCharacter": "text",
      "NewDate": "2025-05-21",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-05-21",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-05-21",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

getCtrForeignSelectFields

post

Retrieves foreign CTRs with selected fields.

Authorizations

Body

CtrNumberstringOptional

CtrForeignLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/finrep/getCtrForeignSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "text",
  "CtrForeignLocator": 1,
  "SelectableFields": {
    "IncludeAllCtrForeignFields": true,
    "CtrForeignFields": {
      "Cashin": true,
      "Cashout": true,
      "CountryCode": true,
      "LastFmDate": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CtrForeign": {
    "Cashin": 1,
    "Cashout": 1,
    "CountryCode": "text",
    "LastFmDate": "2025-05-21",
    "Locator": 1,
    "RecordChangeDate": "2025-05-21"
  }
}