{"basePath":"/v1","consumes":["application/json"],"definitions":{"Address":{"properties":{"City":{"description":"City","type":"string"},"Country":{"description":"Country full name","type":"string"},"CountryCode":{"description":"Country Code","type":"string"},"PostalCode":{"description":"Postal Code","type":"string"},"State":{"description":"State full name","type":"string"},"StateCode":{"description":"State Code","type":"string"},"Street":{"description":"Street number and name","type":"string"}},"type":"object"},"Database":{"description":"A Database provisioned and owned by a Tenant","properties":{"Active":{"description":"Is this database active?","type":"boolean"},"ID":{"description":"Record Id","type":"string"},"Microservices":{"description":"List of Taxnexus Microservices implemented by this Database","type":"string"},"Status":{"description":"The current status of this Tenant","type":"string"},"Type":{"description":"The type of Database (mysql, etc)","type":"string"}},"type":"object"},"Error":{"properties":{"code":{"format":"int64","type":"integer"},"fields":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Lead":{"properties":{"Address":{"$ref":"#/definitions/Address"},"Company":{"description":"Company","type":"string"},"Description":{"description":"Description","type":"string"},"Email":{"description":"Email","type":"string"},"FirstName":{"description":"First Name","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"LastName":{"description":"Last Name","type":"string"},"MobilePhone":{"description":"Mobile","type":"string"},"Name":{"description":"Name","type":"string"},"OwnerId":{"description":"LeadBasic Owner","type":"string"},"PartnerAccountId":{"description":"Partner Account","type":"string"},"Phone":{"description":"Phone","type":"string"},"ProductID":{"description":"Product","type":"string"},"RefererURL":{"description":"referer_url","type":"string"},"Status":{"description":"LeadBasic Status","type":"string"},"Title":{"description":"Title","type":"string"},"Type":{"description":"Type","type":"string"},"UTMCampaign":{"description":"utm_campaign","type":"string"},"UTMContent":{"description":"utm_content","type":"string"},"UTMMedium":{"description":"utm_medium","type":"string"},"UTMSource":{"description":"utm_source","type":"string"},"UTMTerm":{"description":"utm_term","type":"string"},"Website":{"description":"Website","type":"string"}},"type":"object"},"LeadResponse":{"properties":{"Data":{"items":{"$ref":"#/definitions/Lead"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Pagination":{"properties":{"Limit":{"format":"int64","type":"number"},"POffset":{"format":"int64","type":"number"},"PageSize":{"format":"int64","type":"number"},"SetSize":{"format":"int64","type":"number"}},"type":"object"},"RequestMeta":{"properties":{"TaxnexusAccount":{"description":"Taxnexus Account Number of the Reseller or OEM","type":"string"}},"required":["TaxnexusAccount"],"type":"object"},"ResponseMeta":{"properties":{"Contact":{"description":"Microservice Contact Info","type":"string"},"Copyright":{"description":"Copyright Info","type":"string"},"License":{"description":"License Information and Restrictions","type":"string"},"OperationID":{"description":"Operation ID","type":"string"},"Pagination":{"$ref":"#/definitions/Pagination"},"RequestIP":{"description":"Request IP Address","type":"string"},"RequestType":{"description":"Request Type","type":"string"},"RequestURL":{"description":"Request URL","type":"string"},"ServerInfo":{"description":"Data Server Info","type":"string"},"ServerResponseTime":{"description":"Data Server Response Time (ms)","type":"string"},"ServerTimestamp":{"description":"Backend Server Timestamp","type":"string"},"TaxnexusAccount":{"description":"Taxnexus Account Number used for recording transactions","type":"string"}},"type":"object"},"Role":{"description":"A functional role within a Tenant","properties":{"Auth0RoleID":{"description":"The corresponding Auth0 Role","type":"string"},"CreatedByID":{"description":"Created By","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Role Description","type":"string"},"ID":{"description":"Record Id","type":"string"},"LastModifiedByID":{"description":"Last Modified By","type":"string"},"LastModifiedDate":{"description":"Last Modifed Date","type":"string"},"RoleName":{"description":"The name of this role","type":"string"},"TenantID":{"description":"The ID of the Tenant that owns this Role","type":"string"}},"type":"object"},"Tenant":{"description":"Taxnexus Account Tenant","properties":{"AccountID":{"description":"The Account that owns this Tenant","type":"string"},"Active":{"description":"Is this Tenant currently active?","type":"boolean"},"CreatedByID":{"description":"Created By","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"ID":{"description":"Record Id","type":"string"},"LastModifiedByID":{"description":"Last Modified By","type":"string"},"LastModifiedDate":{"description":"Last Modifed Date","type":"string"},"Status":{"description":"The current status of this Tenant","type":"string"},"TenantName":{"description":"Name of the Tenant Resource","type":"string"},"Type":{"description":"The type of Tenant","type":"string"},"Version":{"description":"The version number of the Tenant Onboarding system used to create this tenant","type":"string"}},"type":"object"},"TenantRequest":{"description":"An array of Tenant objects","properties":{"Data":{"items":{"$ref":"#/definitions/Tenant"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"type":"object"},"TenantResponse":{"description":"An array of Tenant objects","properties":{"Data":{"items":{"$ref":"#/definitions/Tenant"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"TenantUser":{"description":"Relationship object that connects users to a tenant","properties":{"AccessLevel":{"description":"The makeTenantUser access level for this User","type":"string"},"AccountID":{"description":"Account ID","type":"string"},"Auth0UserID":{"description":"Auth0 User ID","type":"string"},"CompanyName":{"description":"Account Name","type":"string"},"ContactID":{"description":"Contact ID","type":"string"},"TaxnexusAccount":{"description":"Taxnexus Account","type":"string"},"TenantActive":{"description":"Tenant active?","type":"boolean"},"TenantID":{"description":"The Tenant ID","type":"string"},"TenantName":{"description":"Tenant Name","type":"string"},"TenantStatus":{"description":"Tenant Status","type":"string"},"TenantType":{"description":"Tenant type","type":"string"},"TenantVersion":{"description":"Tenant Version","type":"string"},"UserEmail":{"description":"User Email Address","type":"string"},"UserFullName":{"description":"User Full Name","type":"string"},"UserID":{"description":"The User ID","type":"string"},"Username":{"description":"Username","type":"string"}}},"User":{"properties":{"APIKey":{"description":"API Key","type":"string"},"AboutMe":{"description":"About Me","type":"string"},"AccountID":{"description":"Account ID","type":"string"},"Address":{"$ref":"#/definitions/Address"},"Alias":{"description":"Alias","type":"string"},"Auth0UserID":{"description":"Auth0 User Id","type":"string"},"CommunityNickname":{"description":"Nickname","type":"string"},"CompanyName":{"description":"Company Name","type":"string"},"ContactID":{"description":"Contact","type":"string"},"CreatedByID":{"description":"Created User ID","type":"string"},"CreatedDate":{"description":"Date Created","type":"string"},"DelegatedApproverID":{"description":"Delegated Approver","type":"string"},"Department":{"description":"Department","type":"string"},"Division":{"description":"Division","type":"string"},"Email":{"description":"Email address","type":"string"},"EmployeeNumber":{"description":"Employee Number","type":"string"},"EndOfDay":{"description":"Time day ends","type":"string"},"Environment":{"description":"Environment","type":"string"},"Extension":{"description":"Extension","type":"string"},"FabricAPIKey":{"description":"Fabric API Key","type":"string"},"Fax":{"description":"Fax","type":"string"},"FirstName":{"description":"The first name","type":"string"},"ForecastEnabled":{"description":"Allow Forecasting","type":"boolean"},"FullPhotoURL":{"description":"Full Photo URL","type":"string"},"ID":{"description":"Taxnexus ID","type":"string"},"IsActive":{"description":"Active","type":"boolean"},"IsPortalEnabled":{"description":"Is the user enabled for Communities?","type":"boolean"},"IsProphilePhotoActive":{"description":"Has Profile Photo","type":"boolean"},"IsSystemControlled":{"type":"boolean"},"LastIP":{"description":"IP address of last login","type":"string"},"LastLogin":{"description":"Last login time","type":"string"},"LastModifiedByID":{"description":"Last Modified User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LastName":{"description":"The Last Name","type":"string"},"LoginCount":{"description":"Number of times user has logged in","format":"int64","type":"number"},"ManagerID":{"description":"Manager","type":"string"},"MobilePhone":{"description":"Mobile","type":"string"},"Name":{"description":"Name","type":"string"},"OutOfOfficeMessage":{"description":"Out of office message","type":"string"},"Phone":{"description":"Phone","type":"string"},"PortalRole":{"description":"Portal Role Level","type":"string"},"ProfileID":{"description":"Profile","type":"string"},"ReceivesAdminEmails":{"description":"Info Emails","type":"boolean"},"ReceivesAdminInfoEmails":{"description":"Admin Info Emails","type":"boolean"},"SenderEmail":{"description":"Email Sender Address","type":"string"},"SenderName":{"description":"Email Sender Name","type":"string"},"Signature":{"description":"Email Signature","type":"string"},"SmallPhotoURL":{"description":"Small Photo URL","type":"string"},"StartOfDay":{"description":"The time day starts","type":"string"},"TaxnexusAccount":{"description":"Taxnexus Account","type":"string"},"TenantUsers":{"items":{"$ref":"#/definitions/TenantUser"},"type":"array"},"TimeZone":{"description":"Time Zone","type":"string"},"Title":{"description":"Title","type":"string"},"UserRoleID":{"description":"Role","type":"string"},"UserRoles":{"items":{"$ref":"#/definitions/UserRole"},"type":"array"},"UserType":{"description":"User Type","type":"string"},"Username":{"description":"Username","type":"string"}},"type":"object"},"UserAuth":{"properties":{"APIKey":{"description":"API Key","type":"string"},"AccountID":{"description":"Account ID","type":"string"},"ContactID":{"description":"Contact","type":"string"},"Email":{"description":"Email address","type":"string"},"Roles":{"description":"Valid Roles for all tenants","items":{"type":"string"},"type":"array"},"Tenants":{"description":"Valid Tenants","items":{"type":"string"},"type":"array"},"UserID":{"description":"Taxneuxs User ID","type":"string"}}},"UserResponse":{"description":"An array of Print-Ready ingest Objects","properties":{"Data":{"items":{"$ref":"#/definitions/User"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"UserRole":{"description":"Relationship object to connect a user to a role","properties":{"AccountID":{"description":"Account Id","type":"string"},"Auth0RoleID":{"description":"Linked role ID","type":"string"},"Auth0UserID":{"description":"Auth0 User ID","type":"string"},"CompanyName":{"description":"Company Name","type":"string"},"ContactID":{"description":"Contact ID","type":"string"},"RoleDescription":{"description":"Role description","type":"string"},"RoleID":{"description":"The Role ID","type":"string"},"RoleName":{"description":"Role Name","type":"string"},"TaxnexusAccount":{"description":"Taxnexus Account Number","type":"string"},"UserEmail":{"description":"User Email Address","type":"string"},"UserFullName":{"description":"User Full Name","type":"string"},"UserID":{"description":"The User ID","type":"string"},"Username":{"description":"Username","type":"string"}},"type":"object"}},"host":"board.fabric.tnxs.net:8080","info":{"contact":{"email":"noc@taxnexus.net"},"description":"Taxnexus Onboarding Service","license":{"name":"Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc."},"termsOfService":"http://taxnexus.net/terms/","title":"board","version":"1.2.6"},"parameters":{"emailQueryRequired":{"description":"Email address","in":"query","name":"email","required":true,"type":"string"},"leadRequest":{"description":"An array of new Lead records","in":"body","name":"leadRequest","required":true,"schema":{"$ref":"#/definitions/Lead"}},"tenantRequest":{"description":"An array of new Tenants","in":"body","name":"tenantRequest","required":true,"schema":{"$ref":"#/definitions/TenantRequest"}}},"paths":{"/developers":{"options":{"description":"CORS support","operationId":"developerOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Register new developers with POST","operationId":"postDevelopers","parameters":[{"$ref":"#/parameters/leadRequest"}],"responses":{"200":{"$ref":"#/responses/DeveloperResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"tags":["Developers"]}},"/leads":{"options":{"description":"CORS support","operationId":"leadOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Lead records to be added","operationId":"postLeads","parameters":[{"$ref":"#/parameters/leadRequest"}],"responses":{"200":{"$ref":"#/responses/LeadResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Add new Leads","tags":["Leads"]}},"/tenants":{"options":{"description":"CORS support","operationId":"tenantOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Create new tenants with POST","operationId":"postTenants","parameters":[{"$ref":"#/parameters/tenantRequest"}],"responses":{"200":{"$ref":"#/responses/DeveloperResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"tags":["Tenants"]}},"/users":{"get":{"description":"Get a clean user record","operationId":"getUsers","parameters":[{"$ref":"#/parameters/emailQueryRequired"}],"responses":{"200":{"$ref":"#/responses/UserResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"tags":["Users"]},"options":{"description":"CORS support","operationId":"userOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]}},"/users/auth":{"get":{"description":"Get a Taxnexus Authentication profile","operationId":"getUsersAuth","parameters":[{"$ref":"#/parameters/emailQueryRequired"}],"responses":{"200":{"$ref":"#/responses/UserAuthResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"tags":["Users"]},"options":{"description":"CORS support","operationId":"userAuthOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]}}},"produces":["application/json"],"responses":{"AccessForbidden":{"description":"Access forbidden, account lacks access","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"CORSResponse":{"description":"CORS OPTIONS response","headers":{"Access-Control-Allow-Credentials":{"type":"string"},"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"},"Access-Control-Expose-Headers":{"type":"string"},"Access-Control-Max-Age":{"type":"string"},"Cache-Control":{"type":"string"}}},"Conflict":{"description":"Conflict","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"DeveloperResponse":{"description":"Taxnexus Response with an array of User objects","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/UserResponse"}},"InvalidDataError":{"description":"Invalid data was sent","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"LeadResponse":{"description":"Taxnexus Response with an array of Lead objects","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/LeadResponse"}},"NotFound":{"description":"Resource was not found","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"ServerError":{"description":"Server Internal Error","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"Unauthorized":{"description":"Access unauthorized, invalid API-KEY was used","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"UnprocessableEntity":{"description":"Unprocessable Entity, likely a bad parameter","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"UserAuthResponse":{"description":"Taxneuxs User Authentication Response","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/UserAuth"}},"UserResponse":{"description":"User Response","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/User"}}},"schemes":["http"],"securityDefinitions":{"ApiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey"}},"swagger":"2.0"}