API

Application Programming Interface

Several methods for using the API. The entire list can be viewed here

Creation of the Company

A new company is created

  • METHOD:

    createCompany

  • REQUEST:
    { "method": "createCompany", "data": { "company_name": "New Company Name Ltd.", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createCompany", "data": { "Fields": "ALL COMPANY DATA" } }

Creating a Client

A new client is created

  • METHOD:

    createClient

  • REQUEST:
    { "method": "createClient", "data": { "client_name": "New Client Name", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createClient", "data": { "Fields": "ALL CLIENT DATA" } }

Creating a Service

A new Service is being created

  • METHOD:

    createService

  • REQUEST:
    { "method": "createService", "data": { "service_name": "New Service Name", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createService", "data": { "Fields": "ALL SERVICE DATA" } }

Creation of the Agreement/Contract

A new Agreement/Contract is being created

  • METHOD:

    createContract

  • REQUEST:
    { "method": "createContract", "data": { "contract_name": "New Contract Name", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createContract", "data": { "Fields": "ALL CONTRACT DATA" } }

Creating an Invoice/Invoice

A new Account/Invoice is created

  • METHOD:

    createInvoice

  • REQUEST:
    { "method": "createInvoice", "data": { "invoice_name": "New Invoice Name.", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createInvoice", "data": { "Fields": "ALL INVOICE DATA" } }

List of companies

A list of your Companies is displayed

  • METHOD:

    listCompanies

  • REQUEST:
    { "method": "listCompanies" }
  • ANSWER:
    { "result": "ok", "method": "listCompanies", "data": [ { "id": "1", "other fields": "..." }, { "id": "1", "other fields": "..." } ] }

List of clients

Displays a list of your Clients

  • METHOD:

    listClients

  • REQUEST:
    { "method": "listClients" }
  • ANSWER:
    { "result": "ok", "method": "listClients", "data": [ { "id": "1", "other fields": "..." }, { "id": "1", "other fields": "..." } ] }

List of Services

A list of your Services is displayed

  • METHOD:

    listServices

  • REQUEST:
    { "method": "listServices" }
  • ANSWER:
    { "result": "ok", "method": "listServices", "data": [ { "id": "1", "other fields": "..." }, { "id": "1", "other fields": "..." } ] }

List of Contracts/Agreements

A list of your Contracts/Agreements is displayed

  • METHOD:

    listContracts

  • REQUEST:
    { "method": "listContracts" }
  • ANSWER:
    { "result": "ok", "method": "listContracts", "data": [ { "id": "1", "other fields": "..." }, { "id": "1", "other fields": "..." } ] }

List of Accounts/Invoices

A list of your Accounts/Invoices is displayed

  • METHOD:

    listInvoices

  • REQUEST:
    { "method": "listInvoices" }
  • ANSWER:
    { "result": "ok", "method": "listInvoices", "data": [ { "id": "1", "other fields": "..." }, { "id": "1", "other fields": "..." } ] }

Creating Wizard

A complete set is created: Company, Client, Services, Contract, Invoice

  • METHOD:

    createWizard

  • REQUEST:
    { "method": "createWizard", "data": { "company_name": "New Copany Name Ltd.", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createWizard", "data": { "Fields": "ALL COMPANY DATA" } }

Batch Creation

A complete set is created: Company, Services, Contract, Invoice with a list of Clients

  • METHOD:

    createBatch

  • REQUEST:
    { "method": "createBatch", "data": { "company_name": "New Copany Name Ltd.", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createBatch", "data": { "Fields": "ALL COMPANY DATA" } }

Creating and Submitting an Invoice

A complete set is created and sent: Company, Client, Services, Contract, Invoice

  • METHOD:

    createSend

  • REQUEST:
    { "method": "createSend", "data": { "company_name": "New Copany Name Ltd.", "...": ".." } }
  • ANSWER:
    { "result": "ok", "method": "createSend", "data": { "Fields": "ALL COMPANY DATA" } }

Creating an Account

A full set PDF is created and received: Company, Client, Services, Contract, Invoice

  • METHOD:

    getInvoice

  • REQUEST:
    { "method": "getInvoice", "data": { "invoice_id": "1" } }
  • ANSWER:
    { "result": "ok", "method": "getInvoice", "data": { "pdf_link": "FULL URL TO PDF FILE for download" } }

A previously created Invoice is sent

A previously created invoice is sent

  • METHOD:

    sendInvoice

  • REQUEST:
    { "method": "sendInvoice", "data": { "invoice_id": "1", "email_data": ". smtp settings and email settings." } }
  • ANSWER:
    { "result": "ok", "method": "sendInvoice", "data": { "status": "OK or ERRORS" } }