ReceivedItemService

Manage and track received items.

Symitar eDocs References: Coming soon.

Operations

getReceivedItemSelectFields

post

Gets a received item with select fields.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/persistent/receiveditem/getReceivedItemSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 269,
  "SelectableFields": {
    "IncludeAllReceivedItemFields": true
  }
}

200

Successful operation.

{
  "ReceivedItem": {
    "AssocAccountNumber": "0000013824",
    "AssocId": "0020",
    "AssocIdType": 0,
    "Branch": 0,
    "ConsoleNumber": 9999,
    "GlobalSequence": 269,
    "GlobalSequenceDate": "2010-05-08",
    "ItemAcctNumber": "0000013824",
    "ItemAmount": "0.01",
    "ItemCheckNumber": "990001",
    "RecordChangeDate": "2010-05-08",
    "Status": 0,
    "Type": 0,
    "UserNumber": 800,
    "Version_1": null,
    "_value_1": null
  },
  "Version_1": null,
  "_value_1": null,
  "MessageId": "getReceivedItemSelectFields"
}

updateReceivedItemByID

post

Updates a received item by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/persistent/receiveditem/updateReceivedItemByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 271,
  "ReceivedItemFields": {
    "ItemId": "NXW3"
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateReceivedItemByID"
}

createReceivedItem

post

Creates a received item.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/createReceivedItem

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemFields": {
    "Type": 0,
    "Status": 0,
    "ItemAmount": "0.01",
    "ItemAcctNumber": "0000013824",
    "ItemCheckNumber": "990001",
    "AssocAccountNumber": "0000013824",
    "AssocId": "0020",
    "AssocIdType": 0,
    "Branch": 0
  }
}

200

Successful operation.

{
  "ReceivedItemCompositeKey": {
    "ReceivedItemGlobalSequenceDate": "2010-05-08",
    "ReceivedItemGlobalSequence": 269
  },
  "MessageId": "createReceivedItem"
}

deleteReceivedItem

post

Deletes a received item.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteReceivedItem

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 269
}

200

Successful operation.

{
  "MessageId": "deleteReceivedItem"
}