Web Service: AccountingService

Target Namespace:
https://secure.clearbooks.co.uk/api/accounting/soap/

Port AccountingPort Port typeSource code

Location:
https://secure.clearbooks.co.uk/api/accounting/soap/
Protocol:
SOAP
Default style:
rpc
Transport protocol:
SOAP over HTTP
Operations:
  1. addBankStatementLinesDetailSource code
  2. allocatePaymentDetailSource code
  3. createAccountCodeDetailSource code
  4. createBankAccountDetailSource code
  5. createEntityDetailSource code
  6. createInvoiceDetailSource code
  7. createInvoicesDetailSource code
  8. createJournalDetailSource code
  9. createPaymentDetailSource code
  10. createPaymentsDetailSource code
  11. createProjectDetailSource code
  12. deleteEntityDetailSource code
  13. deleteJournalDetailSource code
  14. getEntityIdFromExternalIdDetailSource code
  15. getEntityOutstandingBalanceDetailSource code
  16. getExchangeRateDetailSource code
  17. getInvoiceIdFromInvoiceNumberDetailSource code
  18. getPaymentIdFromExternalIdDetailSource code
  19. listAccountCodeHeadingsDetailSource code
  20. listAccountCodesDetailSource code
  21. listBankAccountsDetailSource code
  22. listCurrenciesDetailSource code
  23. listEntitiesDetailSource code
  24. listInvoicesDetailSource code
  25. listOutstandingBalancesDetailSource code
  26. listPaymentMethodsDetailSource code
  27. listProjectsDetailSource code
  28. listThemesDetailSource code
  29. updateAccountCodeDetailSource code
  30. updateEntityDetailSource code
  31. updateProjectDetailSource code
  32. voidInvoiceDetailSource code
  33. voidPaymentDetailSource code
  34. writeOffDetailSource code
  35. writeOffPartialDetailSource code

Operations

    Port type AccountingPortSource code

    1. addBankStatementLines
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://secure.clearbooks.co.uk/api/accounting/soap/#addBankStatementLines
      Input:
      addBankStatementLinesIn (soap:body, use = literal, part = authenticationHeader)Source code
      bankAccount type string
      statementName type string
      statementLines type ArrayOfBankStatementLine - array of type undefined
    2. allocatePayment
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://secure.clearbooks.co.uk/api/accounting/soap/#allocatePayment
      Input:
      allocatePaymentIn (soap:body, use = literal, part = authenticationHeader)Source code
      query type AllocateQuery
      • invoices - optional; type ArrayOfPaymentInvoice - array of type undefined
      • type type string
      • paymentId type int
      • entityId type int
      Output:
      allocatePaymentOut (soap:body, use = literal)Source code
      return type ResponseStatus
        • success type boolean
      • msg - optional; type string
    3. createAccountCode
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://secure.clearbooks.co.uk/api/accounting/soap/#createAccountCode
      Input:
      createAccountCodeIn (soap:body, use = literal, part = authenticationHeader)Source code
      code type AccountCodeRequest
        • heading_id type int
        • name type string
      • default_vat_rate - optional; type string
      • show_sales - optional; type int
      • show_purchases - optional; type int
      • show_budget - optional; type int
      Output:
      createAccountCodeOut (soap:body, use = literal)Source code
      return type AccountCodeResult
      • id type int
    4. createBankAccount
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://secure.clearbooks.co.uk/api/accounting/soap/#createBankAccount
      Input:
      createBankAccountIn (soap:body, use = literal, part = authenticationHeader)Source code
      bankAccount type Bank_BankAccount
      • name type string
      • accountNumber type string
      • sortCode type string
      Output:
      createBankAccountOut (soap:body, use = literal)Source code
      return type int
    5. createEntity
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      https://secure.clearbooks.co.uk/api/accounting/soap/#createEntity
      Input:
      createEntityIn (soap:body, use = literal, part = authenticationHeader)Source code
      entity type Entity
        • supplier - optional; type EntityExtra
            • default_account_code - optional; type int
            • default_vat_rate - optional; type string
            • default_credit_terms - optional; type int
          • customer - optional; type EntityExtra
              • default_account_code - optional; type int
              • default_vat_rate - optional; type string
              • default_credit_terms - optional; type int
            • bankAccount - optional; type BankAccount
              • bankName type string
              • name type string
              • sortcode type string
              • accountNumber type string
            • company_name type string
            • contact_name type string
            • address1 type string
            • town type string
            • county type string
            • postcode type string
            • email type string
            • phone1 type string
          • id - optional; type int
          • country - optional; type string
          • building - optional; type string
          • address2 - optional; type string
          • phone2 - optional; type string
          • fax - optional; type string
          • website - optional; type string
          • date_modified - optional; type dateTime
          • external_id - optional; type string
          • vat_number - optional; type string
          • company_number - optional; type string
          • statement_url - optional; type string
          Output:
          createEntityOut (soap:body, use = literal)Source code
          return type int
        • createInvoice
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createInvoice
          Input:
          createInvoiceIn (soap:body, use = literal, part = authenticationHeader)Source code
          invoice type Invoice
            • items - optional; type ArrayOfItem - array of type undefined
            • description type string
            • entityId type int
            • dateCreated type dateTime
            • type type string
          • invoice_id - optional; type int
          • invoice_prefix - optional; type string
          • invoiceNumber - optional; type int
          • reference - optional; type string
          • dateDue - optional; type dateTime
          • dateModified - optional; type dateTime
          • dateAccrual - optional; type dateTime
          • creditTerms - optional; type int
          • bankPaymentId - optional; type int
          • project - optional; type int
          • external_id - optional; type string
          • status - optional; type string
          • statementPage - optional; type string
          • pdfUrl - optional; type string
          • themeId - optional; type int
          • vatTreatment - optional; type string
          • multicurrency - optional; type int
          • fxrate - optional; type float
          • gross - optional; type float
          • net - optional; type float
          • vat - optional; type float
          • paid - optional; type float
          • balance - optional; type float
          • foreignCurrencyBalance - optional; type float
          Output:
          createInvoiceOut (soap:body, use = literal)Source code
          return type InvoiceReturn
          • due type float
          • invoice_id type int
          • invoice_prefix type string
          • invoice_number type string
        • createInvoices
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createInvoices
          Input:
          createInvoicesIn (soap:body, use = literal, part = authenticationHeader)Source code
          invoices type ArrayOfInvoice - array of type undefined
          Output:
          createInvoicesOut (soap:body, use = literal)Source code
          return type ArrayOfInvoiceReturn - array of type undefined
        • createJournal
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createJournal
          Input:
          createJournalIn (soap:body, use = literal, part = authenticationHeader)Source code
          project type Journal
            • ledger - optional; type ArrayOfJournalLedgerItem - array of type undefined
            • description type string
            • accountingDate type string
          • project - optional; type int
          • entity - optional; type int
          Output:
          createJournalOut (soap:body, use = literal)Source code
          return type JournalReturn
          • journal_id type int
        • createPayment
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createPayment
          Input:
          createPaymentIn (soap:body, use = literal, part = authenticationHeader)Source code
          payment type Payment
            • description type string
            • invoices - optional; type ArrayOfPaymentInvoice - array of type undefined
            • type type string
            • project type int
            • accountingDate type dateTime
            • amount type float
            • entityId type int
            • paymentMethod type int
            • bankAccount type string
          • bsAccount - optional; type int
          • fxRate - optional; type float
          Output:
          createPaymentOut (soap:body, use = literal)Source code
          return type PaymentReturn
          • payment_id type int
        • createPayments
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createPayments
          Input:
          createPaymentsIn (soap:body, use = literal, part = authenticationHeader)Source code
          payments type ArrayOfPayment - array of type undefined
          Output:
          createPaymentsOut (soap:body, use = literal)Source code
          return type PaymentReturn
          • payment_id type int
        • createProject
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#createProject
          Input:
          createProjectIn (soap:body, use = literal, part = authenticationHeader)Source code
          project type Project
            • projectName type string
            • status type string
          • description - optional; type string
          • id - optional; type int
          Output:
          createProjectOut (soap:body, use = literal)Source code
          return type ProjectReturn
          • project_id type int
        • deleteEntity
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#deleteEntity
          Input:
          deleteEntityIn (soap:body, use = literal, part = authenticationHeader)Source code
          entityId type int
          Output:
          deleteEntityOut (soap:body, use = literal)Source code
          return type boolean
        • deleteJournal
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#deleteJournal
          Input:
          deleteJournalIn (soap:body, use = literal, part = authenticationHeader)Source code
          journalId type int
          Output:
          deleteJournalOut (soap:body, use = literal)Source code
          return type boolean
        • getEntityIdFromExternalId
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#getEntityIdFromExternalId
          Input:
          getEntityIdFromExternalIdIn (soap:body, use = literal, part = authenticationHeader)Source code
          externalId type string
          Output:
          getEntityIdFromExternalIdOut (soap:body, use = literal)Source code
          return type int
        • getEntityOutstandingBalance
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#getEntityOutstandingBalance
          Input:
          getEntityOutstandingBalanceIn (soap:body, use = literal, part = authenticationHeader)Source code
          entityId type int
          type type string
          Output:
          getEntityOutstandingBalanceOut (soap:body, use = literal)Source code
          return type EntityOutstandingBalance
          • outstanding type float
          • overdue type float
        • getExchangeRate
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#getExchangeRate
          Input:
          getExchangeRateIn (soap:body, use = literal, part = authenticationHeader)Source code
          exchangeRateRequest type ExchangeRateRequest
            • targetCurrency type string
          • baseCurrency - optional; type string
          • date - optional; type dateTime
          Output:
          getExchangeRateOut (soap:body, use = literal)Source code
          return type float
        • getInvoiceIdFromInvoiceNumber
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#getInvoiceIdFromInvoiceNumber
          Input:
          getInvoiceIdFromInvoiceNumberIn (soap:body, use = literal, part = authenticationHeader)Source code
          type type string
          invoicePrefix type string
          invoiceNumber type string
          Output:
          getInvoiceIdFromInvoiceNumberOut (soap:body, use = literal)Source code
          return type int
        • getPaymentIdFromExternalId
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#getPaymentIdFromExternalId
          Input:
          getPaymentIdFromExternalIdIn (soap:body, use = literal, part = authenticationHeader)Source code
          externalId type string
          Output:
          getPaymentIdFromExternalIdOut (soap:body, use = literal)Source code
          return type int
        • listAccountCodeHeadings
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listAccountCodeHeadings
          Input:
          listAccountCodeHeadingsIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listAccountCodeHeadingsOut (soap:body, use = literal)Source code
          return type ArrayOfAccountCodeHeading - array of type undefined
        • listAccountCodes
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listAccountCodes
          Input:
          listAccountCodesIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listAccountCodesOut (soap:body, use = literal)Source code
          return type ArrayOfAccountCode - array of type undefined
        • listBankAccounts
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listBankAccounts
          Input:
          listBankAccountsIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listBankAccountsOut (soap:body, use = literal)Source code
          return type ListBankAccountsReturn
          • bankAccounts - optional; type ArrayOfBankAccountListItem - array of type undefined
          • total type float
        • listCurrencies
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listCurrencies
          Input:
          listCurrenciesIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listCurrenciesOut (soap:body, use = literal)Source code
          return type ArrayOfCurrency - array of type undefined
        • listEntities
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listEntities
          Input:
          listEntitiesIn (soap:body, use = literal, part = authenticationHeader)Source code
          query type EntityQuery
            • id - optional; type ArrayOfInt - array of type undefined
          • companyName - optional; type string
          • type - optional; type string
          • offset - optional; type int
          • modifiedSince - optional; type dateTime
          Output:
          listEntitiesOut (soap:body, use = literal)Source code
          return type ArrayOfEntity - array of type undefined
        • listInvoices
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listInvoices
          Input:
          listInvoicesIn (soap:body, use = literal, part = authenticationHeader)Source code
          query type InvoiceQuery
            • id - optional; type ArrayOfInt - array of type undefined
            • entityId - optional; type ArrayOfInt - array of type undefined
            • ledger type string
          • status - optional; type string
          • offset - optional; type int
          • modifiedSince - optional; type string
          Output:
          listInvoicesOut (soap:body, use = literal)Source code
          return type ArrayOfInvoice - array of type undefined
        • listOutstandingBalances
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listOutstandingBalances
          Input:
          listOutstandingBalancesIn (soap:body, use = literal, part = authenticationHeader)Source code
          type type string
          limit type int
          Output:
          listOutstandingBalancesOut (soap:body, use = literal)Source code
          return type ArrayOfListOutstandingBalancesReturn - array of type undefined
        • listPaymentMethods
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listPaymentMethods
          Input:
          listPaymentMethodsIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listPaymentMethodsOut (soap:body, use = literal)Source code
          return type ArrayOfPaymentMethod - array of type undefined
        • listProjects
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listProjects
          Input:
          listProjectsIn (soap:body, use = literal, part = authenticationHeader)Source code
          offset type int
          Output:
          listProjectsOut (soap:body, use = literal)Source code
          return type ArrayOfProject - array of type undefined
        • listThemes
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#listThemes
          Input:
          listThemesIn (soap:body, use = literal, part = authenticationHeader)Source code
          Output:
          listThemesOut (soap:body, use = literal)Source code
          return type ArrayOfTheme - array of type undefined
        • updateAccountCode
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#updateAccountCode
          Input:
          updateAccountCodeIn (soap:body, use = literal, part = authenticationHeader)Source code
          codeId type int
          code type AccountCodeRequest
            • heading_id type int
            • name type string
          • default_vat_rate - optional; type string
          • show_sales - optional; type int
          • show_purchases - optional; type int
          • show_budget - optional; type int
          Output:
          updateAccountCodeOut (soap:body, use = literal)Source code
          return type AccountCodeResult
          • id type int
        • updateEntity
          Operation type:
          Request-response. The endpoint receives a message, and sends a correlated message.
          SOAP action:
          https://secure.clearbooks.co.uk/api/accounting/soap/#updateEntity
          Input:
          updateEntityIn (soap:body, use = literal, part = authenticationHeader)Source code
          entityId type int
          entity type Entity
            • supplier - optional; type EntityExtra
                • default_account_code - optional; type int
                • default_vat_rate - optional; type string
                • default_credit_terms - optional; type int
              • customer - optional; type EntityExtra
                  • default_account_code - optional; type int
                  • default_vat_rate - optional; type string
                  • default_credit_terms - optional; type int
                • bankAccount - optional; type BankAccount
                  • bankName type string
                  • name type string
                  • sortcode type string
                  • accountNumber type string
                • company_name type string
                • contact_name type string
                • address1 type string
                • town type string
                • county type string
                • postcode type string
                • email type string
                • phone1 type string
              • id - optional; type int
              • country - optional; type string
              • building - optional; type string
              • address2 - optional; type string
              • phone2 - optional; type string
              • fax - optional; type string
              • website - optional; type string
              • date_modified - optional; type dateTime
              • external_id - optional; type string
              • vat_number - optional; type string
              • company_number - optional; type string
              • statement_url - optional; type string
              Output:
              updateEntityOut (soap:body, use = literal)Source code
              return type int
            • updateProject
              Operation type:
              Request-response. The endpoint receives a message, and sends a correlated message.
              SOAP action:
              https://secure.clearbooks.co.uk/api/accounting/soap/#updateProject
              Input:
              updateProjectIn (soap:body, use = literal, part = authenticationHeader)Source code
              projectId type int
              project type Project
                • projectName type string
                • status type string
              • description - optional; type string
              • id - optional; type int
              Output:
              updateProjectOut (soap:body, use = literal)Source code
              return type ProjectReturn
              • project_id type int
            • voidInvoice
              Operation type:
              Request-response. The endpoint receives a message, and sends a correlated message.
              SOAP action:
              https://secure.clearbooks.co.uk/api/accounting/soap/#voidInvoice
              Input:
              voidInvoiceIn (soap:body, use = literal, part = authenticationHeader)Source code
              invoice type InvoiceRef
              • type type string
              • id type int
              Output:
              voidInvoiceOut (soap:body, use = literal)Source code
              return type ResponseStatus
                • success type boolean
              • msg - optional; type string
            • voidPayment
              Operation type:
              Request-response. The endpoint receives a message, and sends a correlated message.
              SOAP action:
              https://secure.clearbooks.co.uk/api/accounting/soap/#voidPayment
              Input:
              voidPaymentIn (soap:body, use = literal, part = authenticationHeader)Source code
              payment type RemovePayment
              • id type int
              • type type string
              Output:
              voidPaymentOut (soap:body, use = literal)Source code
              return type ResponseStatus
                • success type boolean
              • msg - optional; type string
            • writeOff
              Operation type:
              Request-response. The endpoint receives a message, and sends a correlated message.
              SOAP action:
              https://secure.clearbooks.co.uk/api/accounting/soap/#writeOff
              Input:
              writeOffIn (soap:body, use = literal, part = authenticationHeader)Source code
              query type CreditQuery
              • dateCreated type dateTime
              • description type string
              • ledger type string
              • accountCode type string
              • id type int
              Output:
              writeOffOut (soap:body, use = literal)Source code
              return type CreditResponseStatus
                • id - optional; type int
                • msg - optional; type string
              • writeOffPartial
                Operation type:
                Request-response. The endpoint receives a message, and sends a correlated message.
                SOAP action:
                https://secure.clearbooks.co.uk/api/accounting/soap/#writeOffPartial
                Input:
                writeOffPartialIn (soap:body, use = literal, part = authenticationHeader)Source code
                query type CreditPartialQuery
                • invoiceId type int
                • creditId type int
                • amountToAllocate type float
                • ledger type string
                Output:
                writeOffPartialOut (soap:body, use = literal)Source code
                return type CreditResponseStatus
                  • id - optional; type int
                  • msg - optional; type string

              WSDL source code

              <?xml version="1.0"?>
              <definitions name="Accounting" targetNamespace="https://secure.clearbooks.co.uk/api/accounting/soap/"
              xmlns="http://schemas.xmlsoap.org/wsdl/"
              xmlns:tns="https://secure.clearbooks.co.uk/api/accounting/soap/"
              xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
              xmlns:xsd="http://www.w3.org/2001/XMLSchema"
              xmlns:soap-enc="http://schemas.xmlsoap.org/soap/encoding/"
              xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
              >
              <types>
              <xsd:schema targetNamespace="https://secure.clearbooks.co.uk/api/accounting/soap/">
              <xsd:complexType name="Invoice"></xsd:complexType>
              </xsd:schema>
              </types>
              <portType name="AccountingPort"></portType>
              <binding name="AccountingBinding" type="tns:AccountingPort"></binding>
              </definitions>

              About wsdl-viewer.xsl

              This document was generated by Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.
              This page has been generated by wsdl-viewer.xsl, version 3.1.01

              Author: tomi vanek

              Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.



              The transformation was inspired by the article

              Uche Ogbuji: WSDL processing with XSLT