UpdateDBA

UpdateDBA

This endpoint modifies the name or address of an existing DBA associated with a recipient. Identify the DBA using its DBAId or DBARef.

PUT recipient/updatedba

Run in Postman

Request Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Optional Your unique identifier for the recipient.
DBADetails	Object []	Information about the DBA.
DBAId	GUID	TaxBandits-generated unique identifier for the DBA.
SequenceId	String	Optional A unique reference ID for the submission that can be used to identify a particular DBA. The Sequence ID will be returned in the Response for your reference. Max 50 characters
DBANm	String	Name of the DBA. Max 75 characters
DBARef	String	Your unique identifier for the DBA. 1-50 characters
Address	Object	Address information of DBA.
Address1	String	Street address or PO Box. Max 46 characters
Address2	String	Optional Suite or apartment number. Max 46 characters
City	String	DBA's city. Max 40 characters
ProvinceOrState	String	DBA's province or state name. Max 40 characters
ZipCd	String	DBA's zip code. 8-10 characters
Country	String	Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

Response Body

Field	Type	Description
StatusCode	number	HTTP status code of the response.
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
SuccessRecords	Object []	DBA records that were updated successfully.
SequenceId	String	A unique reference ID for the submission that can be used to identify a particular DBA.
DBAId	GUID	TaxBandits-generated unique identifier for the DBA.
DBARef	String	Your unique identifier for the DBA.
DBANm	String	Name of the DBA.
ErrorRecords	Object []	A unique reference ID for the submission that can be used to identify a particular DBA.
DBAId	GUID	TaxBandits-generated unique identifier for the DBA.
DBARef	String	Your unique identifier for the DBA.
DBANm	String	Name of the DBA.
Errors	Object []	Validation error details.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of the error.
Errors	Object []	Top-level request errors if the entire request cannot be processed.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of what went wrong.

Request JSON

{
    "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
    "PayeeRef": "PAYEE001",
    "DBADetails": [
        {
            "SequenceId": "002",
            "DBAId": "9425a051-a2b9-4cf9-b853-e56246464b3f",
            "DBANm": "Sunrise Tech Solutions Inc.",
            "DBARef": "STS001",
            "Address": {
                "Address1": "123 Biscayne Blvd",
                "Address2": "Suite 120",
                "City": "Miami",
                "ProvinceOrState": "FL",
                "ZipCd": "33132",
                "Country": "US"
            }
        }
    ]
}

Response

{
    "StatusCode": 200,
    "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
    "PayeeRef": "PAYEE001",
    "DBADetails": {
        "SuccessRecords": [
            {
                "SequenceId": "002",
                "DBAId": "9425a051-a2b9-4cf9-b853-e56246464b3f",
                "DBARef": "STS001",
                "DBANm": "Sunrise Tech Solutions Inc."
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}