ReceivedItemService

Manage and track received items.

Symitar eDocs References: Coming soon.

Operations

getReceivedItem

post

Gets a received item.

Authorizations

Body

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post

/getReceivedItem

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2025-11-07",
  "ReceivedItemGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ReceivedItem": {
    "AssocAccountNumber": "text",
    "AssocId": "text",
    "AssocIdType": 1,
    "BondDenomination": 1,
    "BondInterest": 1,
    "BondPrincipal": 1,
    "BondRecpCity": "text",
    "BondRecpName": "text",
    "BondRecpSsn": "text",
    "BondRecpState": "text",
    "BondRecpStreet": "text",
    "BondRecpZipCode": "text",
    "Branch": 1,
    "ChargeOffDate": "2025-11-07",
    "CollectedDate": "2025-11-07",
    "CollectionDate": "2025-11-07",
    "ConsoleNumber": 1,
    "Disposition": [
      {
        "EntryId": 1,
        "Disposition": 1
      }
    ],
    "FraudCode": [
      {
        "EntryId": 1,
        "FraudCode": 1
      }
    ],
    "FraudDescription": [
      {
        "EntryId": 1,
        "FraudDescription": "text"
      }
    ],
    "FraudSeverity": [
      {
        "EntryId": 1,
        "FraudSeverity": 1
      }
    ],
    "FraudVendor": [
      {
        "EntryId": 1,
        "FraudVendor": "text"
      }
    ],
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-11-07",
    "InputSource": 1,
    "ItcForeignItem": 1,
    "ItcReported": 1,
    "ItcStatusCode": 1,
    "ItemAcctNumber": "text",
    "ItemAmount": 1,
    "ItemCheckNumber": "text",
    "ItemId": "text",
    "Micr1": "text",
    "Micr2": "text",
    "MicrAmount": "text",
    "MicrAuxOnUs": "text",
    "MicrEpc": "text",
    "MicrOnUs": "text",
    "MicrTransit": "text",
    "OnUs": 1,
    "OnUsAcctNumber": "text",
    "OnUsId": "text",
    "OnUsIdType": 1,
    "PostDate": "2025-11-07",
    "PostTime": 1,
    "RecordChangeDate": "2025-11-07",
    "RejectDate": "2025-11-07",
    "ReportDate": "2025-11-07",
    "ResubmitDate": [
      {
        "EntryId": 1,
        "ResubmitDate": "2025-11-07"
      }
    ],
    "ReturnDate": [
      {
        "EntryId": 1,
        "ReturnDate": "2025-11-07"
      }
    ],
    "ReturnReason": [
      {
        "EntryId": 1,
        "ReturnReason": 1
      }
    ],
    "SbFlag": 1,
    "SbTranSequenceNumber": 1,
    "SequenceNumber": 1,
    "Status": 1,
    "TranSeqNumberAll": [
      {
        "EntryId": 1,
        "TranSeqNumberAll": 1
      }
    ],
    "TranSetId": "text",
    "Type": 1,
    "UserNumber": 1,
    "VoidDate": "2025-11-07"
  }
}

getReceivedItemSelectFields

post

Gets a received item with select fields.

Authorizations

Body

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post

/getReceivedItemSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2025-11-07",
  "ReceivedItemGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllReceivedItemFields": true,
    "ReceivedItemFields": {
      "AssocAccountNumber": true,
      "AssocId": true,
      "AssocIdType": true,
      "BondDenomination": true,
      "BondInterest": true,
      "BondPrincipal": true,
      "BondRecpCity": true,
      "BondRecpName": true,
      "BondRecpSsn": true,
      "BondRecpState": true,
      "BondRecpStreet": true,
      "BondRecpZipCode": true,
      "Branch": true,
      "ChargeOffDate": true,
      "CollectedDate": true,
      "CollectionDate": true,
      "ConsoleNumber": true,
      "Disposition": [
        1
      ],
      "FraudCode": [
        1
      ],
      "FraudDescription": [
        1
      ],
      "FraudSeverity": [
        1
      ],
      "FraudVendor": [
        1
      ],
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "InputSource": true,
      "ItcForeignItem": true,
      "ItcReported": true,
      "ItcStatusCode": true,
      "ItemAcctNumber": true,
      "ItemAmount": true,
      "ItemCheckNumber": true,
      "ItemId": true,
      "Micr1": true,
      "Micr2": true,
      "MicrAmount": true,
      "MicrAuxOnUs": true,
      "MicrEpc": true,
      "MicrOnUs": true,
      "MicrTransit": true,
      "OnUs": true,
      "OnUsAcctNumber": true,
      "OnUsId": true,
      "OnUsIdType": true,
      "PostDate": true,
      "PostTime": true,
      "RecordChangeDate": true,
      "RejectDate": true,
      "ReportDate": true,
      "ResubmitDate": [
        1
      ],
      "ReturnDate": [
        1
      ],
      "ReturnReason": [
        1
      ],
      "SbFlag": true,
      "SbTranSequenceNumber": true,
      "SequenceNumber": true,
      "Status": true,
      "TranSeqNumberAll": [
        1
      ],
      "TranSetId": true,
      "Type": true,
      "UserNumber": true,
      "VoidDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ReceivedItem": {
    "AssocAccountNumber": "text",
    "AssocId": "text",
    "AssocIdType": 1,
    "BondDenomination": 1,
    "BondInterest": 1,
    "BondPrincipal": 1,
    "BondRecpCity": "text",
    "BondRecpName": "text",
    "BondRecpSsn": "text",
    "BondRecpState": "text",
    "BondRecpStreet": "text",
    "BondRecpZipCode": "text",
    "Branch": 1,
    "ChargeOffDate": "2025-11-07",
    "CollectedDate": "2025-11-07",
    "CollectionDate": "2025-11-07",
    "ConsoleNumber": 1,
    "Disposition": [
      {
        "EntryId": 1,
        "Disposition": 1
      }
    ],
    "FraudCode": [
      {
        "EntryId": 1,
        "FraudCode": 1
      }
    ],
    "FraudDescription": [
      {
        "EntryId": 1,
        "FraudDescription": "text"
      }
    ],
    "FraudSeverity": [
      {
        "EntryId": 1,
        "FraudSeverity": 1
      }
    ],
    "FraudVendor": [
      {
        "EntryId": 1,
        "FraudVendor": "text"
      }
    ],
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-11-07",
    "InputSource": 1,
    "ItcForeignItem": 1,
    "ItcReported": 1,
    "ItcStatusCode": 1,
    "ItemAcctNumber": "text",
    "ItemAmount": 1,
    "ItemCheckNumber": "text",
    "ItemId": "text",
    "Micr1": "text",
    "Micr2": "text",
    "MicrAmount": "text",
    "MicrAuxOnUs": "text",
    "MicrEpc": "text",
    "MicrOnUs": "text",
    "MicrTransit": "text",
    "OnUs": 1,
    "OnUsAcctNumber": "text",
    "OnUsId": "text",
    "OnUsIdType": 1,
    "PostDate": "2025-11-07",
    "PostTime": 1,
    "RecordChangeDate": "2025-11-07",
    "RejectDate": "2025-11-07",
    "ReportDate": "2025-11-07",
    "ResubmitDate": [
      {
        "EntryId": 1,
        "ResubmitDate": "2025-11-07"
      }
    ],
    "ReturnDate": [
      {
        "EntryId": 1,
        "ReturnDate": "2025-11-07"
      }
    ],
    "ReturnReason": [
      {
        "EntryId": 1,
        "ReturnReason": 1
      }
    ],
    "SbFlag": 1,
    "SbTranSequenceNumber": 1,
    "SequenceNumber": 1,
    "Status": 1,
    "TranSeqNumberAll": [
      {
        "EntryId": 1,
        "TranSeqNumberAll": 1
      }
    ],
    "TranSetId": "text",
    "Type": 1,
    "UserNumber": 1,
    "VoidDate": "2025-11-07"
  }
}

updateReceivedItemByID

post

Updates a received item by ID.

Authorizations

Body

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post

/updateReceivedItemByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2025-11-07",
  "ReceivedItemGlobalSequence": 1,
  "ReceivedItemUpdatableFields": {
    "AssocAccountNumber": "text",
    "AssocId": "text",
    "AssocIdType": 1,
    "BondDenomination": 1,
    "BondInterest": 1,
    "BondPrincipal": 1,
    "BondRecpCity": "text",
    "BondRecpName": "text",
    "BondRecpSsn": "text",
    "BondRecpState": "text",
    "BondRecpStreet": "text",
    "BondRecpZipCode": "text",
    "Branch": 1,
    "ChargeOffDate": "2025-11-07",
    "CollectedDate": "2025-11-07",
    "CollectionDate": "2025-11-07",
    "ConsoleNumber": 1,
    "Disposition": [
      {
        "EntryId": 1,
        "Disposition": 1
      }
    ],
    "FraudCode": [
      {
        "EntryId": 1,
        "FraudCode": 1
      }
    ],
    "FraudDescription": [
      {
        "EntryId": 1,
        "FraudDescription": "text"
      }
    ],
    "FraudSeverity": [
      {
        "EntryId": 1,
        "FraudSeverity": 1
      }
    ],
    "FraudVendor": [
      {
        "EntryId": 1,
        "FraudVendor": "text"
      }
    ],
    "InputSource": 1,
    "ItcForeignItem": 1,
    "ItcReported": 1,
    "ItemAcctNumber": "text",
    "ItemAmount": 1,
    "ItemCheckNumber": "text",
    "ItemId": "text",
    "Micr1": "text",
    "Micr2": "text",
    "MicrAmount": "text",
    "MicrAuxOnUs": "text",
    "MicrEpc": "text",
    "MicrOnUs": "text",
    "MicrTransit": "text",
    "OnUs": 1,
    "OnUsAcctNumber": "text",
    "OnUsId": "text",
    "OnUsIdType": 1,
    "PostDate": "2025-11-07",
    "PostTime": 1,
    "RejectDate": "2025-11-07",
    "ReportDate": "2025-11-07",
    "ResubmitDate": [
      {
        "EntryId": 1,
        "ResubmitDate": "2025-11-07"
      }
    ],
    "ReturnDate": [
      {
        "EntryId": 1,
        "ReturnDate": "2025-11-07"
      }
    ],
    "ReturnReason": [
      {
        "EntryId": 1,
        "ReturnReason": 1
      }
    ],
    "SbFlag": 1,
    "SbTranSequenceNumber": 1,
    "SequenceNumber": 1,
    "Status": 1,
    "TranSeqNumberAll": [
      {
        "EntryId": 1,
        "TranSeqNumberAll": 1
      }
    ],
    "TranSetId": "text",
    "Type": 1,
    "UserNumber": 1,
    "VoidDate": "2025-11-07"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

createReceivedItem

post

Creates a received item.

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/createReceivedItem

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemCreatableFields": {
    "AssocAccountNumber": "text",
    "AssocId": "text",
    "AssocIdType": 1,
    "BondDenomination": 1,
    "BondInterest": 1,
    "BondPrincipal": 1,
    "BondRecpCity": "text",
    "BondRecpName": "text",
    "BondRecpSsn": "text",
    "BondRecpState": "text",
    "BondRecpStreet": "text",
    "BondRecpZipCode": "text",
    "Branch": 1,
    "ChargeOffDate": "2025-11-07",
    "CollectedDate": "2025-11-07",
    "CollectionDate": "2025-11-07",
    "ConsoleNumber": 1,
    "Disposition": [
      {
        "EntryId": 1,
        "Disposition": 1
      }
    ],
    "FraudCode": [
      {
        "EntryId": 1,
        "FraudCode": 1
      }
    ],
    "FraudDescription": [
      {
        "EntryId": 1,
        "FraudDescription": "text"
      }
    ],
    "FraudSeverity": [
      {
        "EntryId": 1,
        "FraudSeverity": 1
      }
    ],
    "FraudVendor": [
      {
        "EntryId": 1,
        "FraudVendor": "text"
      }
    ],
    "InputSource": 1,
    "ItcForeignItem": 1,
    "ItcReported": 1,
    "ItemAcctNumber": "text",
    "ItemAmount": 1,
    "ItemCheckNumber": "text",
    "ItemId": "text",
    "Micr1": "text",
    "Micr2": "text",
    "MicrAmount": "text",
    "MicrAuxOnUs": "text",
    "MicrEpc": "text",
    "MicrOnUs": "text",
    "MicrTransit": "text",
    "OnUs": 1,
    "OnUsAcctNumber": "text",
    "OnUsId": "text",
    "OnUsIdType": 1,
    "PostDate": "2025-11-07",
    "PostTime": 1,
    "RejectDate": "2025-11-07",
    "ReportDate": "2025-11-07",
    "ResubmitDate": [
      {
        "EntryId": 1,
        "ResubmitDate": "2025-11-07"
      }
    ],
    "ReturnDate": [
      {
        "EntryId": 1,
        "ReturnDate": "2025-11-07"
      }
    ],
    "ReturnReason": [
      {
        "EntryId": 1,
        "ReturnReason": 1
      }
    ],
    "SbFlag": 1,
    "SbTranSequenceNumber": 1,
    "SequenceNumber": 1,
    "Status": 1,
    "TranSeqNumberAll": [
      {
        "EntryId": 1,
        "TranSeqNumberAll": 1
      }
    ],
    "TranSetId": "text",
    "Type": 1,
    "UserNumber": 1,
    "VoidDate": "2025-11-07"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ReceivedItemCompositeKey": {
    "ReceivedItemGlobalSequenceDate": "2025-11-07",
    "ReceivedItemGlobalSequence": 1
  }
}

deleteReceivedItem

post

Deletes a received item.

Authorizations

Body

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post

/deleteReceivedItem

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2025-11-07",
  "ReceivedItemGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}

PreviousProjectionService NextRemittanceService

Last updated 1 year ago

Was this helpful?