{"basePath":"/v1","consumes":["application/json"],"definitions":{"AppLog":{"description":"Application Log for human consumption","properties":{"AccountID":{"type":"string"},"CompanyID":{"type":"string"},"CreatedByID":{"type":"string"},"CreatedDate":{"type":"string"},"ID":{"type":"string"},"Message":{"type":"string"},"ObjectID":{"type":"string"},"ObjectType":{"type":"string"},"Severity":{"type":"string"},"Source":{"type":"string"},"SourceTimestamp":{"type":"string"}},"type":"object"},"AppLogRequest":{"description":"An array Taxnexus Application Log objects","properties":{"data":{"items":{"$ref":"#/definitions/AppLog"},"type":"array"},"meta":{"$ref":"#/definitions/RequestMeta"}},"type":"object"},"AppLogResponse":{"description":"An array Taxnexus Application Log objects","properties":{"data":{"items":{"$ref":"#/definitions/AppLog"},"type":"array"},"meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Document":{"description":"Taxnexus Document","properties":{"ArchivedByID":{"type":"string"},"ArchivedDate":{"type":"string"},"AuthorID":{"type":"string"},"Body":{"format":"byte","type":"string"},"BodyLength":{"format":"int64","type":"number"},"CommentCount":{"format":"int64","type":"number"},"ConnectionID":{"type":"string"},"ContentAssetID":{"type":"string"},"ContentModificationDate":{"type":"string"},"ContentSize":{"format":"int64","type":"number"},"ContentType":{"type":"string"},"ContentVersionDocumentID":{"type":"string"},"ContnetDocumentID":{"type":"string"},"CreatedByID":{"type":"string"},"CreatedDate":{"type":"string"},"DDate":{"type":"string"},"Description":{"type":"string"},"DeveloperName":{"type":"string"},"Discount":{"type":"number"},"Document":{"format":"byte","type":"string"},"DocumentID":{"type":"string"},"DocumentSequence":{"format":"int64","type":"number"},"Field":{"type":"string"},"FileExtension":{"type":"string"},"FileType":{"type":"string"},"FolderID":{"type":"string"},"GrandTotal":{"type":"string"},"ID":{"type":"string"},"InsertedByID":{"type":"string"},"IsArchived":{"type":"boolean"},"IsBodySearchable":{"type":"boolean"},"IsCommentSub":{"type":"boolean"},"IsDocumentSub":{"type":"boolean"},"IsInternalUseOnly":{"type":"boolean"},"IsPublic":{"type":"boolean"},"IsRichText":{"type":"boolean"},"Keywords":{"type":"string"},"LastModifiedByID":{"type":"string"},"LastModifiedDate":{"type":"string"},"LastViewedDate":{"type":"string"},"LatstPublishedVersionID":{"type":"string"},"LikeCount":{"format":"int64","type":"number"},"LinkURL":{"type":"string"},"LinkedEntityID":{"type":"string"},"Name":{"type":"string"},"NamespacePrefix":{"type":"string"},"NetworkScope":{"type":"string"},"OwnerID":{"type":"string"},"ParentID":{"type":"string"},"Publishstatus":{"type":"string"},"QuoteID":{"type":"string"},"RelatedRecordID":{"type":"string"},"ShareType":{"type":"string"},"SharingOption":{"type":"string"},"SharingPrivacy":{"type":"string"},"Title":{"type":"string"},"Type":{"type":"string"},"URL":{"type":"string"},"UserID":{"type":"string"},"Visibility":{"type":"string"}},"type":"object"},"EmailMessage":{"properties":{"ActivityID":{"type":"string"},"BCCAddress":{"type":"string"},"CCAddress":{"type":"string"},"CreatedByID":{"type":"string"},"CreatedDate":{"type":"string"},"EmailMessageID":{"type":"string"},"FromAddress":{"type":"string"},"FromName":{"type":"string"},"HTML":{"format":"byte","type":"string"},"HasAttachment":{"type":"boolean"},"Headers":{"$ref":"#/definitions/Headers"},"ID":{"type":"string"},"Incoming":{"type":"boolean"},"IsClientManaged":{"type":"boolean"},"IsExternallyManaged":{"type":"boolean"},"LastModifiedByID":{"type":"string"},"LastModifiedDate":{"type":"string"},"MessageDate":{"type":"string"},"MessageIdentifier":{"type":"string"},"ParentID":{"type":"string"},"RelatedToID":{"type":"string"},"RelationAddress":{"type":"string"},"RelationID":{"type":"string"},"RelationObjectType":{"type":"string"},"RelationType":{"type":"string"},"ReplyToEmailMessageID":{"type":"string"},"Status":{"type":"string"},"Subject":{"type":"string"},"Text":{"format":"byte","type":"string"},"ThreadIdentifier":{"type":"string"},"ToAddress":{"type":"string"},"ValidatedFromAddress":{"type":"string"}},"type":"object"},"EmailMessageRequest":{"description":"An array Taxnexus Send Email Message objects","properties":{"data":{"items":{"$ref":"#/definitions/EmailMessage"},"type":"array"},"meta":{"$ref":"#/definitions/RequestMeta"}},"type":"object"},"EmailMessagesResponse":{"description":"An array Taxnexus user objects","properties":{"data":{"items":{"$ref":"#/definitions/EmailMessage"},"type":"array"},"meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Error":{"properties":{"Code":{"format":"int32","type":"integer"},"Fields":{"type":"string"},"Message":{"type":"string"}},"type":"object"},"Headers":{"properties":{"Key":{"type":"string"},"Values":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"}},"type":"object"},"OutgoingEmailMessage":{"description":"A new email message to be sent","properties":{"BCCAddress":{"type":"string"},"CCAddress":{"type":"string"},"EmailMessageID":{"type":"string"},"EmailTemplateID":{"type":"string"},"ExternalID":{"type":"string"},"FromContactID":{"type":"string"},"FromName":{"type":"string"},"HTML":{"type":"string"},"Headers":{"$ref":"#/definitions/Headers"},"ID":{"type":"string"},"Subject":{"type":"string"},"Text":{"type":"string"},"ToAddress":{"type":"string"},"ToName":{"type":"string"},"ValidatedFromAddress":{"type":"string"},"WhoID":{"type":"string"}},"type":"object"},"OutgoingEmailMessageRequest":{"description":"An array Taxnexus New Email Message objects","properties":{"data":{"items":{"$ref":"#/definitions/OutgoingEmailMessage"},"type":"array"},"meta":{"$ref":"#/definitions/RequestMeta"}},"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"},"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"}},"host":"workflow.fabric.tnxs.net:8080","info":{"contact":{"email":"noc@taxnexus.net"},"description":"Workflow Microservice","license":{"name":"Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc."},"termsOfService":"http://taxnexus.net/terms/","title":"workflow","version":"1.2.6"},"parameters":{"AppLogRequest":{"description":"An array of new AppLog records","in":"body","name":"AppLogRequest","required":true,"schema":{"$ref":"#/definitions/AppLogRequest"}},"OutgoingEmailMessageRequest":{"description":"An array of new Outgoing Email Message records","in":"body","name":"OutgoingEmailMessageRequest","required":true,"schema":{"$ref":"#/definitions/OutgoingEmailMessageRequest"}},"emailMessageIdQuery":{"description":"Email Message ID","in":"query","name":"emailMessageId","type":"string"}},"paths":{"/applogs":{"options":{"description":"CORS support","operationId":"appLogOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Insert app log messages into workflow storage","operationId":"postAppLogs","parameters":[{"$ref":"#/parameters/AppLogRequest"}],"responses":{"200":{"$ref":"#/responses/AppLogResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Post app log messages","tags":["AppLog"]}},"/emailmessages":{"get":{"description":"Retrieves email messages from workflow storage","operationId":"getEmailMessages","parameters":[{"$ref":"#/parameters/emailMessageIdQuery"}],"responses":{"200":{"$ref":"#/responses/EmailMessagesResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get email messages from data store","tags":["EmailMessage"]},"options":{"description":"CORS support","operationId":"emailMessageOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]}},"/outgoingemailmessages":{"options":{"description":"CORS support","operationId":"outgoingEmailMessageOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Insert new email messages into workflow storage","operationId":"postOutgoingEmailMessages","parameters":[{"$ref":"#/parameters/OutgoingEmailMessageRequest"}],"responses":{"200":{"$ref":"#/responses/EmailMessagesResponse"},"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 email messages to the outgoing queue","tags":["OutgoingEmailMessage"]}}},"produces":["application/json"],"responses":{"AccessForbidden":{"description":"Access forbidden, account lacks access","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"AppLogResponse":{"description":"Array of AppLogs","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/AppLogResponse"}},"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"}}},"EmailMessagesResponse":{"description":"Array of Email Messages","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/EmailMessagesResponse"}},"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"}}},"schemes":["http"],"securityDefinitions":{"ApiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey"}},"swagger":"2.0"}