Create Group

Create Group

This endpoint can be used to create groups in your TaxBandits account. Groups are typically used to organize your payers and team members based on location, form type, or any other aspects.

Your request JSON should include the group’s name, reference ID, description, and the associated team members and payers.

POST TeamMember/CreateGroup 

Request Body

Field	Type	Description
TeamMemberDetails	object[]	Object to identify the team member and group details
GroupNm	string	Name of the Group Size Range: 3..75
GroupRef	string	Unique reference for the group Size Range: ..100
GroupDesc	string	Description for the group Size Range: ..100
AsgnPayers	object[]	Object to identify the assigned payer details for the group
BusinessId	Guid	A unique identifier of the Business
PayerRef	string	A Unique reference of the payer
AsgnMembers	object[]	Object to identify the assigned team member details for the group
MemberId	Guid	A unique identifier of the team member
MemberRef	string	A Unique reference of the team member

Response Body

Field	Type	Description
SuccessRecords	object[]	Returns detailed information about the success records
GroupId	Guid	Returns unique identifier of the group
GroupNm	string	Returns the name of the group
GroupRef	string	Returns unique reference for the group
GroupDesc	string	Returns the description for the group
AsgnPayers	object[]	Object to identify the assigned payer details for the group
BusinessId	Guid	Returns unique identifier of the Business
PayerRef	string	Returns Unique reference of the payer
AsgnMembers	object[]	Object to identify the assigned team member details for the group
MemberId	Guid	Returns unique identifier of the team member
MemberRef	string	Returns unique reference of the team member
ErrorRecords	object[]	Returns detailed information about the error records
GroupNm	string	Returns the name of the group
GroupRef	string	Returns unique reference for the group
GroupDesc	string	Returns the description for the group
AsgnPayers	object[]	Object to identify the assigned payer details for the group
BusinessId	Guid	A unique identifier of the Business
PayerRef	string	A Unique reference of the payer
AsgnMembers	object[]	Object to identify the assigned payer details for the group
MemberId	Guid	A unique identifier of the team member
MemberRef	string	A Unique reference of the team member
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error ID
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error ID
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON

{
    "TeamMemberDetails": [
        {
            "GroupNm": "94x Team",
            "GroupRef": "94x",
            "GroupDesc": "The team handling 94x clients",
            "AsgnPayers": [
                {
                    "BusinessId": "bf35ce5a-81ec-467c-85a9-17beae6a3038"
                }
            ],
            "AsgnMembers": [
                {
                    "MemberId": "420a0afb-d26d-4cc6-b3e1-84741436394b"
                }
            ]
        }
    ]
}

Response JSON

Success Response - This is a sample response for successful API requests.

{
    "SuccessRecords": [
        {
            "GroupId": 12899,
            "GroupNm": "94x Team",
            "GroupRef": "94x",
            "GroupDesc": "The team handling 94x clients",
            "AsgnPayers": [
                {
                    "BusinessId": "bf35ce5a-81ec-467c-85a9-17beae6a3038",
                    "PayerRef": null
                }
            ],
            "AsgnMembers": [
                {
                    "MemberId": "420a0afb-d26d-4cc6-b3e1-84741436394b",
                    "MemberRef": null
                }
            ],
            "Status": "SUCCESS"
        }
    ],
    "ErrorRecords": null,
    "Errors": null
}