Documentazione Versioning V2 WebApi

With the release of WebAPI version V2, we have initiated a substantial redesign aimed at streamlining and optimizing the integration interface. Compared to the previous V1 iteration, the new version introduces a more lightweight and developer-friendly endpoint architecture, featuring a fully restructured field naming convention in English. This change is specifically designed to enhance semantic clarity, improve parsing efficiency, and facilitate faster onboarding for development teams. The primary objective of this evolution is to deliver a more consistent and predictable API experience, aligned with modern software integration standards. V2 marks a significant step toward increased standardization, comprehensive documentation, and enhanced interoperability across heterogeneous systems and platforms.

Backward Compatibility: To ensure a smooth and non-disruptive transition for existing integrations, WebAPI version V1 remains fully supported and operational. However, it is strongly recommended to plan the migration to V2, as all new features and enhancements will be exclusively available in this version. The coexistence of both versions allows developers to progressively adapt their systems, minimizing the risk of regressions and ensuring continuity in production environments

To support the various managed usage scenarios, some use cases are provided as examples.

Note

Although the use of services allows for implementations different from those specified, it is reminded that the supported functionalities are those described in the indicated Use Cases.

Common Data Entities

Search for an Accounting Reason Code

To search for an accounting reason code, you must use a POST request. Here is an example:

{{webapi_base_url}}/{{api}}/v2/{{scope}}/CO/AccountingReasonCodeCO/search?company={{azienda}}&getTotalCount=true

{
    "filters": {
    "items": [
      {
        "operator": 0,
        "propertyName": "alias",
        "comparer": 0,
        "value": "FTV1"
      }
    ]
  },
  "pageSize": 0,
  "pageNumber": 0
}

This is the response:

{
    "totalCount": 1,
    "pageSize": 1,
    "pageNumber": 0,
    "data": [
        {
            "accountStatementManagedType": 1.0,
            "alias": "FTV1",
            "billsType": 0,
            "classificationId": null,
            "code": "1",
            "debitCreditType": 0,
            "description": "Fattura di vendita",
            "hyperMediaId": null,
            "isAdvancePayment": 0.0,
            "isCheckReferencesRequest": 0.0,
            "isFixedReasonCode": 1.0,
            "isMovementProtocol": 0.0,
            "isOutstanding": 0.0,
            "isPortfolioManagement": 1.0,
            "isPreviousFiscalYearAccrual": 0.0,
            "isPublishingVat": 0.0,
            "isSelfInvoice": 0.0,
            "isSingleEntryDocumentNumber": 0.0,
            "isStatusAccountManagement": 1.0,
            "isSubcontracting": 0.0,
            "isTravelAgencies": 0.0,
            "isVatCompetenceDateRequired": 0.0,
            "journalType": 2,
            "linkedReasonCode": null,
            "marginSchemeType": 0.0,
            "operationType": 3,
            "proformaInvoiceDueDateType": 0,
            "proformaInvoiceManagementType": 0,
            "proteo360IntegrationType": 0.0,
            "referenceReasonCode": null,
            "rsmSinglePhaseTransactionType": 0.0,
            "extensionData": [],
            "additionalData": {},
            "pluginData": {}
        }
    ],
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

Agent Master Data Entry

To insert a new agent, you must use a POST request. Here is an example:

{{webapi_base_url}}/{{api}}/v2/{{scope}}/co/AgentCO?company={{azienda}}

{
    "code": "008",
    "companyCode": 2.0,
    "generalMasterDataCode": 2593,
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

This is the response:

{
    "isCommissionAdjustment": 0.0,
    "discountCalculationType": 0.0,
    "discountCommissionBaseType": 0.0,
    "surchargeCommissionBaseType": 0.0,
    "enasarcoListPrint": 0.0,
    "companyType": 0.0,
    "generalMasterData": {
        "address": "",
        "city": "Misano",
        "fiscalCode": null,
        "legalName": "Anagrafica test WebApi ",
        "nationCode": 86.0,
        "province": null,
        "vatNumber": null,
        "extensionData": [],
        "additionalData": {},
        "pluginData": {}
    },
    "agentType": 0.0,
    "code": "008",
    "commissionPercentage": 0.0,
    "commissionRegimeType": 0.0,
    "companyCode": 1000.0,
    "customerCommissionRegime": 0.0,
    "generalMasterDataCode": 980,
    "guid": "5df6ff45-1c82-4651-b9a7-f0aebd211267",
    "hyperMediaId": null,
    "id": 100,
    "itemCommissionRegime": 0.0,
    "mandateEndDate": null,
    "mandateStartDate": null,
    "mandateType": 0.0,
    "minimumInvoiceAmount": 0.0,
    "preferredPrintDocumentType": 0.0,
    "regimePriorityType": 0.0,
    "relationStartDate": null,
    "relationType": 1.0,
    "settlementType": 0.0,
    "idExtendedAttributeEntity": 4,
    "idExtendedAttributeSubEntity": 5,
    "dmsPublishedEntityFW": null,
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

Create a Country

To insert a new country, you must use a POST request. Here is an example:

{{webapi_base_url}}/{{api}}/v2/{{scope}}/co/NationCO?company={{azienda}}

{
   
    "code": 811.0,
    "currencyCode": "EURO",
    "description": "Nazione Italia Webapi",
    "euEntryDate": "1995-01-01T00:00:00",
    "hyperMediaId": null,
    "ibanLength": 27,
    "isIbanUsed": 1,
    "iso3166Alpha2": "IT",
    "iso3166Alpha3": "ITA",
    "iso3166Description": "ITALY",
    "iso3166Number": "380",
    "isoCode": "IT",
    "isSepaStandardUsed": 1,
    "nationType": 1.0,
    "sianCode": null,
    "vatNumberLength": "11",
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

This is the response:

{
    "blacklistEndDate": null,
    "blacklistStartDate": null,
    "code": 8122.0,
    "currencyCode": "EURO",
    "description": "Nazione Italia Webapi",
    "euEntryDate": "1995-01-01T00:00:00",
    "hyperMediaId": null,
    "ibanLength": 27,
    "isIbanUsed": 1,
    "iso3166Alpha2": "IT",
    "iso3166Alpha3": "ITA",
    "iso3166Description": "ITALY",
    "iso3166Number": "380",
    "isoCode": "IT",
    "isSepaStandardUsed": 1,
    "nationType": 1.0,
    "sianCode": null,
    "vatNumberLength": "11",
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

General Master Data

Insert a minimal General Master Data Record

To insert a minimal general master record, you must use a POST request. Here is an example:

{{webapi_base_url}}/{{api}}/V2/{{scope}}/co/generalmasterdataco?company={{azienda}}

{
    "city": "Misano",
    "genderType": 0.0,
    "isEInvoicingEnabled": 0,
    "isExcludedFromBlacklist": 0.0,
    "isMasterDataForHomonymMerge": 0.0,
    "isNaturalPerson": 0.0,
    "isValidGeneralMasterData": 1.0,
    "legalName": "Anagrafica test WebApi ",
    "nationCode": 86.0,
    "taxCity": "Misano",
    "taxLegalName": "Anagrafica prova WebApi",
    "taxNationCode": 86.0,
    "idExtendedAttributeEntity": 1,
    "idExtendedAttributeSubEntity": 2,
    "extensionData": [],
    "additionalData": {},
    "pluginData": {}
}

Customer/Supplier Master Data

Insert a Minimal Customer/Supplier Record

To insert a minimal customer/supplier master record, you must use a POST request. Here is an example:

{{webapi_base_url}}/{{api}}/v2/{{scope}}/co/CustomerSupplierCO?company={{azienda}}

{
    "customerSupplierType": 0,
    "generalMasterDataCode": 980, 
    "paymentTermCode": "201", 
    "blackListGeneralMasterDataCode": 4,
    "csAccountingIndexCode": "CATF",
    "currencyCode": "EURO",
    "AgenteCode" : "Agente",
    "OfficeCode": 1,
    "VatCode": 22,
    "additionalInformation": {
        "macroAreaCode": "UE",
        "areaCode": "ITA",
        "zoneCode": null,
      
        "macrocategoryCode": "MCQ",
        "categoryCode": "CA1",
        "subCategory": "SC1"
    }

}