ReceivedItemService

Manage and track received items.

Symitar eDocs References: Coming soon.

Operations

getReceivedItem

post

Gets a received item.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post/getReceivedItem

HTTPcURLJavaScriptPython

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: 175

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 274
}

200

Successful operation.

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

getReceivedItemSelectFields

post

Gets a received item with select fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post/getReceivedItemSelectFields

HTTPcURLJavaScriptPython

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: 232

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 270,
  "SelectableFields": {
    "IncludeAllReceivedItemFields": true
  }
}

200

Successful operation.

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

updateReceivedItemByID

post

Updates a received item by ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ReceivedItemGlobalSequenceDatestring · dateOptional

The received item global sequence date.

ReceivedItemGlobalSequenceintegerOptional

The received item global sequence number.

Responses

200

Successful operation.

application/json

post/updateReceivedItemByID

HTTPcURLJavaScriptPython

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: 223

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 273,
  "ReceivedItemUpdatableFields": {
    "ItemId": "NXW3"
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateReceivedItemByID"
}

createReceivedItem

post

Creates a received item.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/createReceivedItem

HTTPcURLJavaScriptPython

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: 303

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "ReceivedItemCreatableFields": {
    "Type": 0,
    "Status": 0,
    "ItemAmount": "0.01",
    "ItemAcctNumber": "0000013824",
    "ItemCheckNumber": "990002",
    "AssocAccountNumber": "0000013824",
    "AssocId": "0020",
    "AssocIdType": 0,
    "Branch": 0
  }
}

200

Successful operation.

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

deleteReceivedItem

post

Deletes a received item.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

HTTPcURLJavaScriptPython

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: 175

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "ReceivedItemGlobalSequenceDate": "2010-05-08",
  "ReceivedItemGlobalSequence": 270
}

200

Successful operation.

{
  "MessageId": "deleteReceivedItem"
}