RemittanceService

Manage remittance records.

Symitar eDocs References: Coming soon.

Operations

getRemittanceSelectFields

post
Authorizations
Body
RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/remittance/getRemittanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 713

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "2025-07-17",
  "RemittanceGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllRemittanceFields": true,
    "RemittanceFields": {
      "Amount": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "Description": true,
      "FundType": true,
      "GlCode": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "MemberAccount": true,
      "Payer": true,
      "PostDate": true,
      "PrevDueDate": true,
      "ProcessorAcct": true,
      "ProcessorCode": true,
      "ReconDate": true,
      "RecordChangeDate": true,
      "RemitDate": true,
      "Sequence": true,
      "Status": true,
      "TranCode": true,
      "TranType": true,
      "User": true,
      "VoidDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Remittance": {
    "Amount": 1,
    "ConfirmationNumber": "text",
    "ConfirmationSeq": 1,
    "ConsoleNumber": 1,
    "Description": "text",
    "FundType": 1,
    "GlCode": 1,
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-07-17",
    "MemberAccount": "text",
    "Payer": 1,
    "PostDate": "2025-07-17",
    "PrevDueDate": "2025-07-17",
    "ProcessorAcct": "text",
    "ProcessorCode": 1,
    "ReconDate": "2025-07-17",
    "RecordChangeDate": "2025-07-17",
    "RemitDate": "2025-07-17",
    "Sequence": 1,
    "Status": 1,
    "TranCode": "text",
    "TranType": 1,
    "User": 1,
    "VoidDate": "2025-07-17"
  }
}

updateRemittanceByID

post
Authorizations
Body
RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/remittance/updateRemittanceByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 688

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "2025-07-17",
  "RemittanceGlobalSequence": 1,
  "RemittanceFields": {
    "Amount": 1,
    "ConfirmationNumber": "text",
    "ConfirmationSeq": 1,
    "ConsoleNumber": 1,
    "Description": "text",
    "FundType": 1,
    "GlCode": 1,
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-07-17",
    "MemberAccount": "text",
    "Payer": 1,
    "PostDate": "2025-07-17",
    "PrevDueDate": "2025-07-17",
    "ProcessorAcct": "text",
    "ProcessorCode": 1,
    "ReconDate": "2025-07-17",
    "RecordChangeDate": "2025-07-17",
    "RemitDate": "2025-07-17",
    "Sequence": 1,
    "Status": 1,
    "TranCode": "text",
    "TranType": 1,
    "User": 1,
    "VoidDate": "2025-07-17"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createRemittance

post
Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/remittance/createRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 615

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceFields": {
    "Amount": 1,
    "ConfirmationNumber": "text",
    "ConfirmationSeq": 1,
    "ConsoleNumber": 1,
    "Description": "text",
    "FundType": 1,
    "GlCode": 1,
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-07-17",
    "MemberAccount": "text",
    "Payer": 1,
    "PostDate": "2025-07-17",
    "PrevDueDate": "2025-07-17",
    "ProcessorAcct": "text",
    "ProcessorCode": 1,
    "ReconDate": "2025-07-17",
    "RecordChangeDate": "2025-07-17",
    "RemitDate": "2025-07-17",
    "Sequence": 1,
    "Status": 1,
    "TranCode": "text",
    "TranType": 1,
    "User": 1,
    "VoidDate": "2025-07-17"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "RemittanceCompositeKey": {
    "RemittanceGlobalSequenceDate": "2025-07-17",
    "RemittanceGlobalSequence": 1
  }
}

deleteRemittance

post
Authorizations
Body
RemittanceGlobalSequenceDatestring · dateOptional

The remittance global sequence date.

RemittanceGlobalSequenceintegerOptional

The remittance global sequence number.

Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/remittance/deleteRemittance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "2025-07-17",
  "RemittanceGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}
PreviousReceivedItemServiceNextTransactionsService

Last updated

Was this helpful?