API

Интерфейс прикладного программирования

Нескольсколько методов для использования API. Весь список можно посмотреть тут

Создание Компании

Создается новая Компания

  • METHOD:

    createCompany

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

Создание Клиента

Создается новый Клиент

  • METHOD:

    createClient

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

Создание Услуги

Создается новая Услуга

  • METHOD:

    createService

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

Создание Договора/Контракта

Создается новый Договор/Контракт

  • METHOD:

    createContract

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

Создание Счета/Инвойса

Создается новый Счет/Инвойс

  • METHOD:

    createInvoice

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

Список Компаний

Выводится список ваших Компаний

  • METHOD:

    listCompanies

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

Список Клиентов

Выводится список ваших Клиентов

  • METHOD:

    listClients

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

Список Услуг

Выводится список ваших Услуг

  • METHOD:

    listServices

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

Список Контрактов/Договоров

Выводится список ваших Контрактов/Договоров

  • METHOD:

    listContracts

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

Список Счетов/Инвойсов

Выводится список ваших Счетов/Инвойсов

  • METHOD:

    listInvoices

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

Создание Wizard

Создается полный комплект: 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

Создается полный комплект: Company, Services, Contract, Invoice со списком Client-ов

  • METHOD:

    createBatch

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

Создание и Отправка Счета

Создается и Отправляется полный комплект: 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" } }

Создание Счета

Создается и получается PDF полного комплекта: 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" } }

Отправляется Ранее созданный Инвойс

Отправляется ранее созданный инвойс

  • 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" } }