API changelog

1.9.2 (2024-12-03)

  • Request logging improvement

1.9.1 (2024-11-11)

  • Worker mapping cache update

1.9.0

This API release requires the target environment to be updated to release 2411 and will only be available after the upgrade.

1.8.1 (2024-08-28)

  • Support for cancelling requests across all document operations. Requests will no longer create or update a document if the client terminates the request.

  • Swagger schema change to clarify use of DocClass parameter

1.8.0

This API release requires the target environment to be updated to release 2407 and will only be available after the upgrade.

1.7.1 (2024-04-25)

  • Support for amending documents in dispute.

  • Bug fixes

    • Corrected behaviour of PATCH /api/Document/{idOrDocNo}/amend to merge (preserve) existing custom field (ext) values

1.7.0

This API release requires the target environment to be updated to release 2404 and will only be available after the upgrade.

1.6.0

This API release requires the target environment to be updated to release 2402 and will only be available after the upgrade.

1.5.0 (2023-12-06)

  • Deferred profile added for Deferred income and prepayment document lines

  • New endpoints available to support Contact Account fields:

    • Resource
      • Create
      • Search
      • Retrieve
      • Update
      • Lock/Unlock

  • Validation added to Create Document for Stock document type to require:

    • ProductSkuId
    • ToStockLocationId
    • FromStockLocationId

  • Fixed bug on Update Document where ExtJson is overwritten rather than edited/appended.

  • Fixed bug on Document Unauthorise, where HTTP 500 (Internal Exception) was being returned instead of 400 (Bad Request) when specified document class does not match the target document.

1.4.0 (2023-11-01)

  • New endpoints available to support Bank transactions
    • Create
    • Retrieve
    • Update
    • Lock/Unlock
    • Delete
  • Support for additional Contact Account fields:
    • ContactClassificationId
    • Customer
      • ApplyDomesticReverseCharge
      • CostCentreId
      • CostCentreFixed
      • DepartmentId
      • DepartmentFixed
    • Supplier
      • ApplyDomesticReverseCharge
      • CostCentreId
      • CostCentreFixed
      • DepartmentId
      • DepartmentFixed
      • ProductId
      • AccountId
  • Support for providing explicit amounts when creating documents
  • Support for additional Document fields
    • FromStockLocationId
    • ToStockLocationId
    • StockDate
    • Details
      • FromStockLocationId
      • ToStockLocationId
      • StockDate
  • Support for searching documents by TheirDocNo GET /api/Document
  • New filter parameters on GET /api/ContactAccount
    • Code
    • IntRef
  • Fixed UoM and UoM Group code support on Product creation
  • Fixed bug where HTTP 401 (Unauthorized) was being returned instead of 403 (Forbidden) when user had valid credentials but insufficient permissions for an operation
  • Added checks to prevent unintended actions in case of an identifier clash

1.3.0 (2023-09-26)

New endpoints available to support Attachments

1.2.13 (2023-08-16)

  • Contact Account IntRef support
    • Contact Account endpoints can now be invoked by IntRef as well as Id and Code
  • Project IntRef support:
    • IntRef can now be specified on Project creation
    • Project endpoints can now be invoked by IntRef as well as Id and Code
  • Authorisation Workflows
    • Workflows now apply to Contact Accounts and Bank Accounts created and modified via the API
  • Improved validation of Contact names on Contact Account creation
  • Bug fixes
    • GET /api/ContactAccount/{contactAccountRef}/contacts/{contactRef} now returns the specified contact rather than primary contact
    • PATCH /api/ContactAccount/{contactAccountRef} no longer creates a Contact Account if contactAccountRef is unknown

1.2.12 (2023-06-21)

  • Document matching:

    • GET /api/document/$ref/match/details matches collection added new field MatchName.
    • GET /api/document/$ref/match/reverse new endpoint to query matches in reverse.

  • Contact bank details support for the AccountName field.

1.2.11 (2023-05-17)

  • Support for abandoning draft documents
    • POST document/$ref/abandon
  • Support for unauthorising non-GL documents (e.g. Sale Orders)
    • POST document/$ref/unauthorise

1.2.10 (2023-04-14)

  • Support for getting posting fields on documents via Post properties.

1.2.9 / 764 (2022-11-16)

  • Support for document summary / detail totals validation and/or rounding differences. See Document rounding guide for more details.

  • Document detail: new field: ProductType.

  • Purchase invoice: TheirDocNo is now correctly validates duplications when supplier flag Allow invoice duplication is not set.

  • X-Validate-Unknown-Properties: When this header is present any unknown properties will be reported as errors. Currently this is supported when creating documents.

1.2.8 (2022-10-10)

  • Catalogs endpoint added new methods to manage the catalog items.
  • Projects endpoint supports creating/updating the IsParent flag.

1.2.7 (2022-07-26)

  • Further endpoints changed at 1.2.1 responded with a 201 status code. This release fixes the specification only, to correctly mark these endpoints as returning 201.
  • The exact API version (including revision number) is now advertised in the OpenAPI specification as well as on the login request.

1.2.6 (2022-07-07)

  • Custom fields (Ext) updates will now merge (preserve) existing values.

1.2.5 (2022-05-25)

  • CostCentre, Department, LegalEntity GET endpoints.

1.2.4 (2022-04-20)

  • Data access control support for the enquiry endpoint.

1.2.3 (2022-03-28)

  • Support for project on document headers.

1.2.2 (2022-03-25)

  • Optional contact accounts on document headers (suitable for journals).

1.2.1 (2022-03-08)

  • Create methods now correctly return 201 status code, as per the provided open spec.

1.2.0 (2022-03-07)

This release includes additional API enhancements for the Projects endpoint:

  • Additional project filtering fields:

    • ProjectGroupCode, ProjectGroupId, ParentProjectCode, ParentProjectId, LegalEntityCode, LegalEntityId, ContactAccountCode, ContactAccountId
    • LastModifiedFrom, LastModifiedTo
    • IncludeClosed, IsActive, IsParent

  • Include additional details when fetching projects via ?include=:

    • ext: custom fields
    • address: address
    • availability: resource availability
    • milestones: milestones
    • subProjects: sub projects For example: GET https://api.iplicit.com/api/project/P100?include=ext,address

  • Support to create and update a project with specified resource availability, milestones, address: See POST /api/Project and PATCH /api/Project

  • Various endpoints around resource availability and milestone management:

    • GET, POST, PUT, DELETE on project/$id/availability
    • GET, PUT, DELETE on project/$id/milestone

  • Support to lock/unlock projects:

    • POST project/$id/lock
    • POST project/$id/unlock

1.1.1 (2022-01-31)

  • Document filters: draft, outstanding, posted, approved, reversed, abandoned.

1.1.0 (2021-12-01)

Support to update any document fields, including adding, updating, replacing details.

  • documents or document details can now be referred by Id or IntRef.
  • update document: PATCH /document/{docRef}
  • add document detail: POST /document/{docRef}/detail
  • update document detail: PATCH /document/{docRef}/detail/{detailRef}
Deprecated:
  • PATCH /document/detail/{docDetailId} has been deprecated, please use instead the PATCH /document/{ref}/detail/{detailRef}.

1.0.10 (2021-08-02)

  • Contacts endpoint:
    • create: POST /contact
    • retrieve: GET /contact/{ref}
    • update: PATCH /contact/{ref}
    • delete: DELETE /contact/{ref}
    • lock (soft delete): POST /contact/{ref}/lock
    • unlock (undelete): POST /contact/{ref}/unlock
  • Assign contact to contact account:
    • add link: POST /contactAccount/{refContactAccount}/contactLinks/{refContact}
    • remove link: DELETE /contactAccount/{refContactAccount}/contactLinks/{refContact}
  • Contact account endpoint now supports code references on all actions; related contacts can also be referred by intRef.
  • maxLength annotations are now specified and validated.

1.0.9 (2021-07-23)

  • Contact accounts:
    • Enhanced support to manage related contacts:
      • support for merging existing contact details when an id or intRef is provided instead of completely replacing the whole list of contacts.
      • append related contacts (without replacing): POST /contactAccount/{id}/contacts
      • update a contact by id: PATCH /contactAccount/{id}/contacts/{id}
      • remove a contact by id: DELETE /contactAccount/{id}/contacts/{id}
    • Support for IntRef(interface reference) field on contact accounts and related contacts.

See the updated Contact accounts guide for examples.

1.0.8 (2021-07-21)

  • Products:
    • Support to update by code
    • Support to update product groups.
    • Default accounting from product group.

1.0.7 (2021-06-17)

  • Support for custom fields on document headers via the Ext property.
  • Support for text fields on document:
    • document header: TextHeader, TextFooter
    • document lines: TextPre, TextPost

1.0.6 (2021-06-03)

  • Project additional fields: AllowTasks, AllowTimesheets
  • Contact account customer, supplier additional fields: ProjectId

1.0.5 (2021-05-19)

  • Project: additional fields: LegalEntityId

1.0.4 (2021-05-10)

  • Documents: support to update documents by code.
  • Contact accounts: support for custom fields via the Ext property.

1.0.3 (2021-04-27)

  • Projects: support for custom fields via the Ext property.

1.0.2 (2021-03-15)

  • Document allocations:
    • new include parameter when getting documents to include allocations (e.g. payments to invoice allocations):
    • allocate existing documents (support to create documents with allocations has already been supported) POST https://api.iplicit.com/api/documents/PAY1/allocation
    • improved allocation validations
  • Additional amendable and searchable document reference fields:
    • IntRef - new internal reference
    • TheirRef - front end reference
  • Document searching: search by multiple docCLasses: GET /api/document?docClass=PurchaseOrder,PurchaseInvoice

1.0.1 (2021-03-04)

  • Hold / stop flags on customers.
  • Additional filters on documents: ContactAccount, ContactAccountId, DocTypeId, LegalEntityId.

1.0 (2021-02-05)

Contact account:

  • Support to update existing customers, suppliers, bank details, contacts, related persons via PATCH

  • Ability to load additional nodes: customer, supplier, bank details, main contact, related contacts.

  • Bank details are now available to retrieve, create and update.

  • Ability to lock (soft delete) customers, suppliers.

  • New fields: reminderGroupId, creditScore, creditReportDate

Bulk payments

A new Bulk payments endpoint is now available: /api/BatchPayments

0.5 (2020-07-17)

  • Endpoints for payments and receipts document classes.

  • Support for document allocation:

    • Automatic allocation for simple cases where a receipt / payment fully pays an outstanding invoice

    • Manual document allocation.

  • Projects: searching, creation.

  • Documents: outstanding fields; outstandingAmount, outstandingCurrencyAmount.

0.4 (2020-07-06)

This version introduces 2 endpoints to query document matching:

  • matching outstanding summary

  • matching details

0.3 (2020-06-24)

  • Catalogs:

    A catalog API is now available to retrieve codes and ids for static data. All the catalogs available in Iplicit are exposed by this API.

    Examples of catalogs that you may require include: LegalEntity, ContactAccount, ContactClassification, ContactGroupCustomer, ContactGroupSupplier, DocType, Account, Product, ProductSale, ProductPurchase, TaxAuthority, TaxBand, TaxCode, Project, PaymentMethod, PayTerm, Currency.

  • Document creation:

    Read the documents section for more information.

  • Contact accounts

    Ability to create: customers, suppliers, contacts (phones, emails, addresses)

    Similar to document creation, most fields are optional, and they will be defaulted from the Contact Group setup if not specified.

    A simple example (does not include all the possible fields):

    POST /api/contactAccount
{
    "Description": "API Customer 1",
    "Customer": {
        "ContactGroupCustomerId": "CU",
        "Currency": "EUR"
    },
    "CompanyNo": "12345678",
    "Contact": {
        "CompanyName": "API Ltd",
        "Phones": [ {"Phone": "020 0123 456"} ],
        "Emails": [ {"Email": "accounts@example.com"} ],
        "Addresses": [
            { "PostCode": "EC1 AAA", "Address": "1 High Street", "City": "London", "CountryCode": "GB" }
        ]
    }
}

  • Codes vs ids

    As part of this release updates we are supporting specifying codes instead of unique identifiers (GUIDs) whenever an Id field is required. For example, you can specify docTypeId as either it's unique id: 46dc8981-5bff-45c1-a167-3532f76b1eed or APPO.

    The retrieved data on reads will continue to return the unique identifiers.

0.2.0 (2020-05-14)

  • Documents:

    Ability to filter by LastModifiedFrom / LastModifiedTo

  • Update a document. Only the following fields are updateable:

    • Description
    • TheirDocNo (Invoice number)
    • DocDate
    • DueDate

  • Submit for authorisation & posting.

    Note this is a queued request.