Create Address for a Firm
POST {{base_url}}/firm/:ClientID/address
Use this endpoint to create a new address to associate with the firm in the Firms hub.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
Request Body
[{"name"=>"ClientID", "value"=>"String", "datatype"=>"string"}, {"name"=>"PrimaryInd", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"Billing", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"Accounting", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"Address", "value"=>"String", "datatype"=>"string"}, {"name"=>"Addressee", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address1", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address2", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address3", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address4", "value"=>"String", "datatype"=>"string"}, {"name"=>"City", "value"=>"String", "datatype"=>"string"}, {"name"=>"State", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Zip", "value"=>"String", "datatype"=>"string"}, {"name"=>"Country", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Phone", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"FAX", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"Email", "value"=>"String", "datatype"=>"string"}, {"name"=>"TaxRegistrationNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"TaxCountryCode", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"FaxFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"CreateUser", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"CreateDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"ModUser", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"ModDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"Payment", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"StateDescription", "value"=>"String", "datatype"=>"string"}, {"name"=>"QBOID", "value"=>"String", "datatype"=>"string"}, {"name"=>"QBOAddressID", "value"=>"String", "datatype"=>"string"}, {"name"=>"QBOIsShippingAddr", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"QBOLastUpdated", "value"=>"Datetime", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
[{"ClientID":"CLIENTID1234567889","CLAddressID":"42e0a190-6f8d-4720-851f-ced9f2fe5906","PrimaryInd":"Y","Billing":"Y","Accounting":"Y","Address":"API Reference","Addressee":"Addressee care of","Address1":"3 Hanover Square","Address2":"Line 2","Address3":"Line 3","Address4":"Line 4","City":"Toronto","State":"ON","Zip":"12345","Country":"CA","Phone":"44 (0) 20 7518-5010","FAX":"44 (0) 20 7518-5222","Email":"email@company.com","TaxRegistrationNumber":"","TaxCountryCode":"CA","PhoneFormat":"## (#) ## ####-####","FaxFormat":"## (#) ## ####-####","CreateUser":"ADMIN","CreateDate":"2017-12-19T18:39:22.457","ModUser":"ADMIN","ModDate":"2017-12-19T18:39:22.457","Payment":"Y","StateDescription":"Ontario","QBOID":"","QBOAddressID":"","QBOIsBillingAddr":"Y","QBOIsShippingAddr":"Y","QBOLastUpdated":""}]