Skip to content

Latest commit

 

History

History
275 lines (264 loc) · 31.9 KB

File metadata and controls

275 lines (264 loc) · 31.9 KB

CompuMaster.Scopevisio.OpenApi - Interactive documentation

PLEASE NOTE: This documentation has been generated by OpenApi Generator and might be (partially) inaccurate or out of date.

Documentation for API Endpoints

All URIs are relative to https://appload.scopevisio.com/rest

Class Method HTTP request Description
AccountingApi AddDimensionEntry POST /dimensions/{dimensionNameOrNumber}/dimensionentry/new Add a dimensionEntry to a dimension
AccountingApi AddFile POST /journal/{documentNumber}/file/new Add a file to a Scopevisio journal entry
AccountingApi CancelPostingDocument POST /journal/{documentNumber}/cancel Cancels the posting with the given documentNumber.
AccountingApi CreateDebitor POST /createdebitor Create debitor for a given contact, if the contact is not already a debitor.
AccountingApi CreateDebitorBankConnection POST /debitoraccounts/{accountNumber}/bankConnection/new Create a new bank connection for debitor.
AccountingApi CreateImpersonalAcocunts POST /createimpersonalaccounts import impersonalaccounts
AccountingApi CreateKebitorBankConnection POST /kreditoraccounts/{accountNumber}/bankConnection/new Create a new bank connection for kreditor.
AccountingApi CreateKreditor POST /createkreditor Create vendor for a given contact, if the contact is not already a vendor
AccountingApi CreatePaymentTerm POST /paymentterm/new Create a new payment term.
AccountingApi CreatePostings POST /postings/new import postings
AccountingApi ExportDatev POST /datevexport export postings in DATEV EXTF format
AccountingApi GetAccountingInfos GET /accountinginfo Returns accounting info details.
AccountingApi GetAllDimensionEntries POST /dimensions dimensions
AccountingApi GetBankConnectionsForDebitor GET /debitoraccounts/{accountNumber}/bankConnections Bank connections for a Scopevisio debitor account.
AccountingApi GetBankConnectionsForKreditor GET /kreditoraccounts/{accountNumber}/bankConnections Bank connections for a Scopevisio kreditor account.
AccountingApi GetDebitorAccounts POST /debitoraccounts debitor accounts
AccountingApi GetDimensionReportEntries GET /dimensions/{dimensionNameOrNumber}/dimensionentries dimension entries
AccountingApi GetGeneralJournalEntryFile GET /journal/{documentNumber}/file Returns file for a journal entry if existing
AccountingApi GetImpersonalAccounts POST /impersonalaccounts impersonal accounts
AccountingApi GetJournalEntries POST /journal general journal entries
AccountingApi GetJournalEntryByDocumentNumber GET /journal/{documentNumber} Posting by documentNumber
AccountingApi GetKreditorAccounts POST /kreditoraccounts kreditor accounts
AccountingApi GetPaymentTerm GET /paymentterm/{id} Gets payment term for id.
AccountingApi GetPaymentTerms GET /paymentterms Get payment terms..
AccountingApi GetPersonalJournalEntries POST /personaljournal personal journal entries
AccountingApi GetTextTemplates GET /texttemplates Get text templates (Textbausteine)
AccountingApi GetVatMatrixEntries GET /vatmatrixentries vat matrix
AccountingApi GetZones POST /zones zones
AccountingApi ImportDatevData POST /datevpostings/new import postings in DATEV-Format
AccountingApi UpdateDebitor POST /debitoraccounts/{accountNumber} Update a debitor by accountNumber (Kontonummer).
AccountingApi UpdateDimensionEntry POST /dimensions/{dimensionNameOrNumber}/dimensionentry Updates the name of a dimension entry.
AccountingApi UpdateKreditor POST /kreditoraccounts/{accountNumber} Update a kreditor by accountNumber (Kontonummer).
AccountingApi UpdatePaymentTerm POST /paymentterm/{id} Update payment term.
ActivitiesApi GetEvents POST /events events
AdditionalApi DeleteTeamworkToken DELETE /teamworktoken Invalidates the stored teamwork token
AdditionalApi GetApplicationContext GET /myaccount customer account information
AdditionalApi GetLicences GET /licences Scopevisio licences
AdditionalApi GetTeamworkToken GET /teamworktoken Teamwork token
AdditionalApi GetVersion GET /version retrieve deployment version infos
AdditionalApi HelloJson GET /hello simple hello world call.
AdditionalApi OrganisationJson GET /organisations organisations
AuthorizationApi ChangeOrganisationById PUT /token/organisation/{organisationId} Changes the organisation by ID
AuthorizationApi ChangeOrganisationByName PUT /token/organisation Changes the organisation by name
AuthorizationApi RevokeToken DELETE /token Revokes the given token
AuthorizationApi Token POST /token Access token
CashbookApi CreateCashbookEntry POST /cashbookentry/new creates a new cashbook entry
CashbookApi GetCashbookSheets POST /cashbooksheets cashbook sheets
CashbookApi GetCashbooks POST /cashbooks cashbooks
ContactApi AddContactFile POST /contact/{contactIdOrLegacyNumber}/file/new Add a file to a Scopevisio contact
ContactApi AssignMailContact POST /contact/{contactIdOrLegacyNumber}/assignMail Assign mail to a contact.
ContactApi CreateContact POST /contact/new create a new contact
ContactApi CreateContactComment POST /contact/{contactId}/comment/new Create a new comment.
ContactApi CreateProperty POST /contact/{contactIdOrLegacyNumber}/contactProperty/new Create a contact property (allgemeine Information)
ContactApi DeleteContactById DELETE /contact/{contactIdOrLegacyNumber} Delete a contact by contactId or legacyNumber
ContactApi GetBlogEntriesByContactId GET /contact/{contactIdOrLegacyNumber}/comments Comments by contactIdOrLegacyNumber.
ContactApi GetContactById GET /contact/{id} Get contact by id
ContactApi GetContactByKeyIdentifierId GET /contact/{keyIdentifier}/{id} Get contact by id matching the field stated as key identifier
ContactApi GetContactEmployees GET /contact/{id}/employees employees of an organisation contact
ContactApi GetContactEmployers GET /contact/{id}/employers employers of a personal contact
ContactApi GetContactProperties GET /contact/{id}/properties contact propeties for the given contact
ContactApi GetContacts POST /contacts contacts
ContactApi GetImage GET /contact/{id}/thumb thumbnail image of contact
ContactApi GetProperty GET /contact/contactProperty/{propertyId} Get contact property (allgemeine Information) by id
ContactApi UpdateContactById POST /contact/{id} update contact by id
ContactApi UpdateProperty POST /contact/contactProperty/{propertyId} Update contact property (allgemeine Information) by id
CreditApi GetCredit GET /credit/{number} credit for number (interne Nummer)
CreditApi GetCreditParent GET /credit/{number}/parent the parent of a credit with the given document number
CreditApi GetCreditPositions GET /credit/{number}/positions get outgoing invoice positions for the given number(interne Nummer)
CreditApi GetCredits POST /credits credits
CreditApi PostCredit POST /credit/{number}/post Post a credit.
DispatchApi GetDispatch GET /dispatch/{number} get dispatch with number (interne Nummer)
DispatchApi GetDispatchParent GET /dispatch/{number}/parent the parent of the dispatch with the given document number
DispatchApi GetDispatchPositions GET /dispatch/{number}/positions get the positions for the dispatch with the given number (interne Nummer)
DispatchApi GetDispatches POST /dispatches Dispatches
HumanResourcesApi GetHumanResources POST /humanresources Get human resources
HumanResourcesApi GetHumanResourcesYear POST /humanresourcesAvailability Get availability of human resources.
IncomingInvoiceApi CreateIncomingInvoice POST /incominginvoice/new Import an incoming invoice.
IncomingInvoiceApi GetIncomingInvoiceTeamworkFileLink GET /incominginvoice/{idOrNumber}/teamworkFileLink Link to the main file for the incoming invoice in the teamwork web application
IncomingInvoiceApi GetIncomingInvoices POST /incominginvoices incoming invoices
IncomingInvoiceApi GetInvoice GET /incominginvoice/{idOrNumber} incoming invoice for the given idOrNumber (id or interne Nummer)
IncomingInvoiceApi GetInvoiceFile GET /incominginvoice/{idOrNumber}/file The file of incoming invoice with the given idOrNumber (id or Interne Nummer)
OfferApi ConvertOfferToDispatch POST /offer/{number}/convertToDispatch Convert offer to dispatch
OfferApi ConvertOfferToOpportunity POST /offer/{number}/convertToOpportunity Convert offer to opportunity
OfferApi ConvertOfferToOrder POST /offer/{number}/convertToOrder Convert offer to order
OfferApi ConvertOfferToOutgoingInvoice POST /offer/{number}/convertToOutgoingInvoice Convert offer to outgoing invoice
OfferApi ConvertOfferToRecurringInvoice POST /offer/{number}/convertToRecurringInvoice Convert offer to recurring invoice
OfferApi GetOffer GET /offer/{number} get offer with number (interne Nummer)
OfferApi GetOfferParent GET /offer/{number}/parent the parent of an offer with the given document number
OfferApi GetOfferPositions GET /offer/{number}/positions get the positions for the offer with the given number (interne Nummer)
OfferApi GetOffers POST /offers Offers
OpportunityApi ConvertOpportunityToDispatch POST /opportunity/{number}/convertToDispatch Convert opportunity to dispatch
OpportunityApi ConvertOpportunityToOffer POST /opportunity/{number}/convertToOffer Convert opportunity to offer
OpportunityApi ConvertOpportunityToOrder POST /opportunity/{number}/convertToOrder Convert opportunity to order
OpportunityApi ConvertOpportunityToOutgoingInvoice POST /opportunity/{number}/convertToOutgoingInvoice Convert opportunity to outgoing invoice
OpportunityApi ConvertOpportunityToRecurringInvoice POST /opportunity/{number}/convertToRecurringInvoice Convert opportunity to recurring invoice
OpportunityApi GetOpportunities POST /opportunities Opportunities
OpportunityApi GetOpportunity GET /opportunity/{number} get opportunity with number (interne Nummer)
OpportunityApi GetOpportunityPositions GET /opportunity/{number}/positions get opportunity positions for the given number (interne Nummer)
OrderApi ConvertOrderToDispatch POST /order/{number}/convertToDispatch Convert order to Dispatch
OrderApi ConvertOrderToOffer POST /order/{number}/convertToOffer Convert order to offer
OrderApi ConvertOrderToOpportunity POST /order/{number}/convertToOpportunity Convert order to opportunity
OrderApi ConvertOrderToOutgoingInvoice POST /order/{number}/convertToOutgoingInvoice Convert order to outgoing invoice
OrderApi ConvertOrderToRecurringInvoice POST /order/{number}/convertToRecurringInvoice Convert order to recurring invoice
OrderApi GetOrder GET /order/{number} get order with number (interne Nummer)
OrderApi GetOrderParent GET /order/{number}/parent the parent of an order with the given document number
OrderApi GetOrderPositions GET /order/{number}/positions get the positions for the order with the given number (interne Nummer)
OrderApi GetOrders POST /orders Orders
OrganisationApi CreateOrganisation POST /organisation/new Creates a Scopevisio organisation.
OutgoingInvoiceApi AddFileToOutgoingInvoice POST /outgoinginvoice/{number}/file/new Add a file to a Scopevisio outgoing invoice
OutgoingInvoiceApi ConvertInvoiceToDispatch POST /outgoinginvoice/{number}/convertToDispatch Convert outgoing invoice to dispatch
OutgoingInvoiceApi ConvertInvoiceToOffer POST /outgoinginvoice/{number}/convertToOffer Convert outgoing invoice to offer
OutgoingInvoiceApi ConvertInvoiceToOpportunity POST /outgoinginvoice/{number}/convertToOpportunity Convert outgoing invoice to opportunity
OutgoingInvoiceApi ConvertInvoiceToOrder POST /outgoinginvoice/{number}/convertToOrder Convert outgoing invoice to order
OutgoingInvoiceApi ConvertInvoiceToRecurringInvoice POST /outgoinginvoice/{number}/convertToRecurringInvoice Convert outgoing invoice to recurring invoice
OutgoingInvoiceApi GetOutgoingInvoice GET /outgoinginvoice/{number} outgoing invoice for number (interne Nummer)
OutgoingInvoiceApi GetOutgoingInvoiceExportTemplates GET /outgoinginvoice/exporttemplates Export templates for offer, opportunity, order, outgoing invoice, credit, packing slip
OutgoingInvoiceApi GetOutgoingInvoiceFile GET /outgoinginvoice/{number}/file The file for the outgoing invoice
OutgoingInvoiceApi GetOutgoingInvoiceParent GET /outgoinginvoice/{number}/parent the parent of an outgoing invoice with the given document number
OutgoingInvoiceApi GetOutgoingInvoicePositions GET /outgoinginvoice/{number}/positions get outgoing invoice positions for the given number (interne Nummer)
OutgoingInvoiceApi GetOutgoingInvoiceTeamworkFileLink GET /outgoinginvoice/{number}/teamworkFileLink Link to the last file for the outgoing invoice in the teamwork web application
OutgoingInvoiceApi GetOutgoingInvoices POST /outgoinginvoices outgoing invoices
OutgoingInvoiceApi ImportOutgoingInvoices POST /outgoinginvoices/import Imports outgoing invoices
OutgoingInvoiceApi PostOutgoingInvoice POST /outgoinginvoice/{number}/post Post an outgoing invoice.
ProductApi CreateProduct POST /product/new creates a new product
ProductApi CreateProductGroup POST /productGroup/new creates a new productGroup
ProductApi GetProduct GET /product/{id} get product by id
ProductApi GetProductGroup GET /productGroups get all productGroups
ProductApi GetProducts POST /products products
ProductApi UpdateProduct POST /product/{id} update product by id
ProjectApi AddProjectFile POST /project/{projectId}/file/new Add a file to a Scopevisio project
ProjectApi AssignMailProject POST /project/{projectId}/assignMail Assign mail to a project.
ProjectApi CreateIncomingMail POST /incomingmail/new Import an incoming email.
ProjectApi CreateProject POST /project/new create a new project
ProjectApi CreateProjectComment POST /project/{projectId}/comment/new Create a new comment.
ProjectApi CreateProjectEmployee POST /project/{projectId}/projectemployee/new Create a project employee (Projektteam-Eintrag)
ProjectApi CreateSalesProject POST /salesproject/new Create a new sales project (Vertriebsprojekt)
ProjectApi CreateTimeEntry POST /timeentry/new Create a new timeentry
ProjectApi GetAllTimEntries POST /timeentries Get all timeentries available
ProjectApi GetBlogEntriesByProjectId GET /project/{projectId}/comments Comments by projectId.
ProjectApi GetProject GET /project/{id} project by id
ProjectApi GetProjectEmployee GET /project/{projectId}/projectemployee/{employeeId} Get project employee (Projektteam-Eintrag) by id
ProjectApi GetProjectEmployees POST /project/{projectId}/projectemployees project employees (Projektteam) of a given project
ProjectApi GetProjectResources POST /projectresources Get project resources.
ProjectApi GetProjectRevenue POST /projectrevenue Get project revenue
ProjectApi GetProjects POST /projects projects
ProjectApi GetTimeEntry GET /timeentry/{id} timeEntry for id
ProjectApi UpdateProject POST /project/{id} update project by id
ProjectApi UpdateProjectEmployee POST /project/{projectId}/projectemployee/{employeeId} update project employee (Projektteam-Eintrag) by employeeId (not contactId).
ProjectApi UpdateSalesProject POST /salesproject/{id} update sales project (Vertriebsprojekt) by id
ProjectApi UpdateTimeEntry POST /timeentry/{id} Update timeEntry
RecurringInvoiceApi ConvertRecurringInvoiceToDispatch POST /recurringinvoice/{number}/convertToDispatch Convert recurring invoice to dispatch
RecurringInvoiceApi ConvertRecurringInvoiceToOffer POST /recurringinvoice/{number}/convertToOffer Convert recurring invoice to offer
RecurringInvoiceApi ConvertRecurringInvoiceToOpportunity POST /recurringinvoice/{number}/convertToOpportunity Convert recurring invoice to opportunity
RecurringInvoiceApi ConvertRecurringInvoiceToOrder POST /recurringinvoice/{number}/convertToOrder Convert recurring invoice to order
RecurringInvoiceApi ConvertRecurringInvoiceToOutgoingInvoice POST /recurringinvoice/{number}/convertToOutgoingInvoice Convert recurring invoice to recurring invoice
RecurringInvoiceApi GetRecurringInvoice GET /recurringinvoice/{number} recurring invoice for number (interne Nummer)
RecurringInvoiceApi GetRecurringInvoicePositions GET /recurringinvoice/{number}/positions get recurring invoice positions for the given number (interne Nummer)
RecurringInvoiceApi GetRecurringInvoices POST /recurringinvoices recurring invoices
RecurringInvoiceApi UpdateRecurringInvoice POST /recurringinvoice/{number} Update the recurrence data of an invoice.
ReportApi GetReport GET /reports/{type} Exports accounting reports
TaskApi AddTaskFile POST /task/{taskId}/file/new Add a file to a Scopevisio task
TaskApi AssignMailTask POST /task/{taskId}/assignMail Assign mail to a task.
TaskApi CreateSubtask POST /subtask/new Create a new subtask (Tätigkeit)
TaskApi CreateTask POST /task/new create a new task
TaskApi CreateTaskComment POST /task/{taskId}/comment/new Create a new comment.
TaskApi GetSubtasks GET /task/{taskId}/subtasks Subtasks (Tätigkeiten) for task id
TaskApi GetTask GET /task/{id} task for id
TaskApi GetTaskComments GET /task/{taskId}/comments Comments by taskId.
TaskApi GetTasks POST /tasks tasks
TaskApi UpdateTask POST /task/{id} Update task
TeamworkApi DeleteHandler1 DELETE /teamworkbridge/{arg1}
TeamworkApi DeleteHandler2 DELETE /teamworkbridge/{arg1}/{arg2}
TeamworkApi DeleteHandler3 DELETE /teamworkbridge/{arg1}/{arg2}/{arg3}
TeamworkApi DeleteHandler4 DELETE /teamworkbridge/{arg1}/{arg2}/{arg3}/{arg4}
TeamworkApi GetHandler1 GET /teamworkbridge/{arg1}
TeamworkApi GetHandler2 GET /teamworkbridge/{arg1}/{arg2}
TeamworkApi GetHandler3 GET /teamworkbridge/{arg1}/{arg2}/{arg3}
TeamworkApi PostHandler1 POST /teamworkbridge/{arg1}
TeamworkApi PostHandler2 POST /teamworkbridge/{arg1}/{arg2}
TeamworkApi PostHandler3 POST /teamworkbridge/{arg1}/{arg2}/{arg3}
TeamworkApi PutHandler1 PUT /teamworkbridge/{arg1}
TeamworkApi PutHandler2 PUT /teamworkbridge/{arg1}/{arg2}
TeamworkApi PutHandler3 PUT /teamworkbridge/{arg1}/{arg2}/{arg3}
TeamworkApi PutHandler4 PUT /teamworkbridge/{arg1}/{arg2}/{arg3}/{arg4}
UserApi CreateUsers POST /users Creates the given users
UserApi DeleteUser DELETE /users/{uidOrEmail} Deletes the user by UID or email. Please note, the users are only marked as deleted.
UserApi GetUser GET /users/{uidOrEmail} Returns the user by UID or email
UserApi GetUsers GET /users Returns all users
UserApi UpdateUsers PUT /users Updates the given users

Documentation for Models

Documentation for Authorization

oauth

  • Type: OAuth
  • Flow: accessCode