FinrepService⁠

Manage Current Transaction Report (CTR) records.

Operations⁠

getCtr⁠

POST

Retrieves CTRs.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringrequired

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/getCtr

POST /nexum/627/2022.01/finrep/getCtr HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrSelectFields⁠

POST

Retrieves CTRs with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/getCtrSelectFields

POST /nexum/627/2022.01/finrep/getCtrSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "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
    },
    "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
      }
    },
    "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": [
          0
        ],
        "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
      },
      "CtrPersonCtrTranInfoSelectableFields": {
        "IncludeAllCtrPersonCtrTranInfoFields": true,
        "CtrPersonCtrTranInfoFields": {
          "AccountNumber": true,
          "Amount": true,
          "LastFmDate": true,
          "Locator": true,
          "RecordChangeDate": true,
          "SlId": true,
          "SlIdType": true,
          "Source": true
        }
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrSelectFieldsFilterChildren⁠

POST

Retrieves CTRs with selected fields and filtered children.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/getCtrSelectFieldsFilterChildren

POST /nexum/627/2022.01/finrep/getCtrSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "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
    },
    "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
      }
    },
    "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": [
          0
        ],
        "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
      },
      "CtrPersonCtrTranInfoSelectableFields": {
        "IncludeAllCtrPersonCtrTranInfoFields": true,
        "CtrPersonCtrTranInfoFields": {
          "AccountNumber": true,
          "Amount": true,
          "LastFmDate": true,
          "Locator": true,
          "RecordChangeDate": true,
          "SlId": true,
          "SlIdType": true,
          "Source": true
        }
      }
    }
  },
  "ChildrenSearchFilter": {
    "CtrAccountFilter": {
      "Query": "string"
    },
    "CtrBranchFilter": {
      "Query": "string"
    },
    "CtrFmHistoryFilter": {
      "Query": "string"
    },
    "CtrForeignFilter": {
      "Query": "string"
    },
    "CtrNoteFilter": {
      "Query": "string"
    },
    "CtrPersonFilter": {
      "Query": "string",
      "CtrPersonChildrenFilter": {
        "CtrPersonCtrTranInfoFilter": {
          "Query": "string"
        }
      }
    }
  },
  "nxAttributes": null
}

getCtrAccount⁠

POST

Retrieves CTR accounts.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrAccountLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/getCtrAccount

POST /nexum/627/2022.01/finrep/getCtrAccount HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "CtrAccountLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getCtrAccountSelectFields⁠

POST

Retrieves CTR accounts with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

CtrAccountLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/finrep/getCtrAccountSelectFields

POST /nexum/627/2022.01/finrep/getCtrAccountSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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

getCtrAccountPagedList⁠

POST

Retrieves a paged list of CTR accounts.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CtrNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/finrep/getCtrAccountPagedList

POST /nexum/627/2022.01/finrep/getCtrAccountPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CtrNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}