Household

Perform various operations on house records.

Symitar eDocs References: Coming soon.

Operations

getHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getHousehold

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Household": {
    "AccountNumber": "text",
    "Locator": 1,
    "RecordChangeDate": "2026-03-26",
    "Type": 1
  }
}

getHouseholdSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getHouseholdSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Household": {
    "AccountNumber": "text",
    "Locator": 1,
    "RecordChangeDate": "2026-03-26",
    "Type": 1
  }
}

getHouseholdPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/getHouseholdPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Household": [
    {
      "AccountNumber": "text",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Type": 1
    }
  ],
  "Token": "text"
}

getHouseholdListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getHouseholdListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "HouseholdList": {
    "hasReachedMaximumListSize": true,
    "Household": [
      {
        "AccountNumber": "text",
        "Locator": 1,
        "RecordChangeDate": "2026-03-26",
        "Type": 1
      }
    ]
  }
}

searchHouseholdSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/searchHouseholdSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "HouseholdList": {
    "hasReachedMaximumListSize": true,
    "Household": [
      {
        "AccountNumber": "text",
        "Locator": 1,
        "RecordChangeDate": "2026-03-26",
        "Type": 1
      }
    ]
  }
}

getHouseholdPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/getHouseholdPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Household": [
    {
      "AccountNumber": "text",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchHouseholdPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post

/searchHouseholdPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Household": [
    {
      "AccountNumber": "text",
      "Locator": 1,
      "RecordChangeDate": "2026-03-26",
      "Type": 1
    }
  ],
  "Token": "text"
}

updateHouseholdByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

HouseholdLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/updateHouseholdByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "HouseholdLocator": 1,
  "HouseholdUpdatableFields": {
    "AccountNumber": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

createHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

HouseholdLocatorintegerOptional

post

/createHousehold

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "HouseholdCreatableFields": {
    "AccountNumber": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "HouseholdLocator": 1
}

deleteHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post

/deleteHousehold

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}