PayeeService

Display, create, revise, and delete payee information.

Symitar eDocs References: Coming soon.

Operations

getPayee

post

Retrieves detailed information about a payee.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayeeNumberstringRequired

Responses

200

Successful operation.

application/json

post/getPayee

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayeeNumber": "0000999995"
}

200

Successful operation.

{
  "Payee": {
    "BillPaymentTypeCode": 0,
    "CheckCode": 0,
    "City": "POWAY",
    "CreationDate": "2010-05-08",
    "LastFmDate": "2010-05-08",
    "Name": "NEXUM WAVE3 TEST",
    "Number": "0000999995",
    "PaymentsLastYear": "0.00",
    "PaymentsYtd": "0.00",
    "RecordChangeDate": "2010-05-08",
    "State": "CA",
    "Street": "1 TEST ST",
    "ZipCode": "92064",
    "_value_1": null
  },
  "MessageId": "getPayee"
}

getPayeeSelectFields

post

Retrieves selected fields of information for a payee.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayeeNumberstringOptional

Responses

200

Successful operation.

application/json

post/getPayeeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayeeNumber": "0000999998",
  "SelectableFields": {
    "IncludeAllPayeeFields": true
  }
}

200

Successful operation.

{
  "Payee": {
    "BillPaymentTypeCode": 0,
    "CheckCode": 0,
    "City": "POWAY",
    "CreationDate": "2010-05-08",
    "LastFmDate": "2010-05-08",
    "Name": "NEXUM WAVE3 TEST",
    "Number": "0000999998",
    "PaymentsLastYear": "0.00",
    "PaymentsYtd": "0.00",
    "RecordChangeDate": "2010-05-08",
    "State": "CA",
    "Street": "1 TEST ST",
    "ZipCode": "92064",
    "_value_1": null
  },
  "MessageId": "getPayeeSelectFields"
}

updatePayeeByID

post

Updates information about a payee based on its ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayeeNumberstringOptional

Responses

200

Successful operation.

application/json

post/updatePayeeByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayeeNumber": "0000999996",
  "PayeeUpdatableFields": {
    "ContactName": "NXW3"
  }
}

200

Successful operation.

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

createPayee

post

Adds a new payee.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

PayeeNumberstringOptional

post/createPayee

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/payee/createPayee 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
      }
    }
  },
  "PayeeCreatableFields": {
    "Number": "999998",
    "Name": "NEXUM WAVE3 TEST",
    "Street": "1 TEST ST",
    "City": "POWAY",
    "State": "CA",
    "ZipCode": "92064"
  }
}

200

Successful operation.

{
  "PayeeNumber": "0000999998",
  "MessageId": "createPayee"
}

deletePayee

post

Removes an existing payee.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayeeNumberstringRequired

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deletePayee

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayeeNumber": "0000999998"
}

200

Successful operation.

{
  "MessageId": "deletePayee"
}