services_tax.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://ofbiz.apache.org/dtds/services.xsd">
    <description>Accounting Services: TaxAuthority and related </description>
    <vendor>OFBiz</vendor>
    <version>1.0</version>

    <!-- Tax Calc Interfaces -->
    <service name="calcTaxInterface" engine="interface" location="" invoke="">
        <description>Tax Calc Service Interface</description>
        <attribute name="productStoreId" type="String" mode="IN" optional="true"><!-- this will be used to find the payToPartyId, if the payToPartyId parameter is not explicitly passed, and as one of the columns to constrain by on the lookup --></attribute>
        <attribute name="facilityId" type="String" mode="IN" optional="true"><!-- if no shippingAddress is passed in this will be used to lookup an address for a face-to-face sale --></attribute>
        <attribute name="payToPartyId" type="String" mode="IN" optional="true"/>
        <attribute name="billToPartyId" type="String" mode="IN" optional="true"><!-- would like to have this not-optional, but in some circumstances may need a tax estimate without knowing who the customer is --></attribute>
        <attribute name="itemProductList" type="java.util.List" mode="IN" optional="false"><!-- List of GenericValues --></attribute>
        <attribute name="itemAmountList" type="java.util.List" mode="IN" optional="false"><!-- List of BigDecimals --></attribute>
        <attribute name="itemPriceList" type="java.util.List" mode="IN" optional="false"><!-- List of BigDecimals --></attribute>
        <attribute name="itemQuantityList" type="java.util.List" mode="IN" optional="true"><!-- List of BigDecimals --></attribute>
        <attribute name="itemShippingList" type="java.util.List" mode="IN" optional="true"><!-- List of BigDecimals --></attribute>
        <attribute name="orderShippingAmount" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="orderPromotionsAmount" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="shippingAddress" type="org.apache.ofbiz.entity.GenericValue" mode="IN" optional="true"/>
        <attribute name="orderAdjustments" type="java.util.List" mode="OUT" optional="false"><!-- List of GenericValues (OrderAdjustment) --></attribute>
        <attribute name="itemAdjustments" type="java.util.List" mode="OUT" optional="false"><!-- List of Lists of GenericValues (OrderAdjustment), one List of Adjustments per item --></attribute>
    </service>
    <service name="calcTaxTotalForDisplayInterface" engine="interface" location="" invoke="">
        <description>Tax Calc Total For Display Service Interface</description>
        <attribute name="productStoreId" type="String" mode="IN" optional="false"><!-- this will be used to get the taxAuthPartyId and taxAuthGeoId to use for the rate lookup, and for the payToPartyId, and as one of the columns to constrain by on the lookup --></attribute>
        <attribute name="billToPartyId" type="String" mode="IN" optional="true"><!-- would like to have this not-optional, but in some circumstances may need a tax estimate without knowing who the customer is --></attribute>
        <attribute name="productId" type="String" mode="IN" optional="false"/>
        <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="basePrice" type="BigDecimal" mode="IN" optional="false"/>
        <attribute name="shippingPrice" type="BigDecimal" mode="IN" optional="true"/>
        <attribute name="taxTotal" type="BigDecimal" mode="OUT" optional="false"/>
        <attribute name="taxPercentage" type="BigDecimal" mode="OUT" optional="false"/>
        <attribute name="priceWithTax" type="BigDecimal" mode="OUT" optional="false"/>
    </service>

    <!-- Tax Authority Calc Services -->
    <service name="calcTax" engine="java"
        location="org.apache.ofbiz.accounting.tax.TaxAuthorityServices" invoke="rateProductTaxCalc">
        <description>Tax Authority Rate Product Calc Service</description>
        <implements service="calcTaxInterface"/>
    </service>
    <service name="calcTaxForDisplay" engine="java"
        location="org.apache.ofbiz.accounting.tax.TaxAuthorityServices" invoke="rateProductTaxCalcForDisplay">
        <description>Tax Authority Rate Product Calc Service</description>
        <implements service="calcTaxTotalForDisplayInterface"/>
    </service>

    <!-- TaxAuthority -->
    <service name="createTaxAuthority" default-entity-name="TaxAuthority" engine="entity-auto" invoke="create" auth="true">
        <description>Create TaxAuthority</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateTaxAuthority" default-entity-name="TaxAuthority" engine="entity-auto" invoke="update" auth="true">
        <description>Update TaxAuthority</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthority" default-entity-name="TaxAuthority" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete TaxAuthority</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- TaxAuthorityAssoc -->
    <service name="createTaxAuthorityAssoc" default-entity-name="TaxAuthorityAssoc" engine="entity-auto" invoke="create" auth="true">
        <description>Create TaxAuthorityAssoc</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="updateTaxAuthorityAssoc" default-entity-name="TaxAuthorityAssoc" engine="entity-auto" invoke="update" auth="true">
        <description>Update TaxAuthorityAssoc</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityAssoc" default-entity-name="TaxAuthorityAssoc" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete TaxAuthorityAssoc</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- TaxAuthorityCategory -->
    <service name="createTaxAuthorityCategory" default-entity-name="TaxAuthorityCategory" engine="entity-auto" invoke="create" auth="true">
        <description>Create TaxAuthorityCategory</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateTaxAuthorityCategory" default-entity-name="TaxAuthorityCategory" engine="entity-auto" invoke="update" auth="true">
        <description>Update TaxAuthorityCategory</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityCategory" default-entity-name="TaxAuthorityCategory" engine="simple" auth="true"
        location="component://accounting/minilang/tax/TaxAuthorityServices.xml" invoke="deleteTaxAuthorityCategory">
        <description>Delete TaxAuthorityCategory</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- TaxAuthorityGlAccount -->
    <service name="createTaxAuthorityGlAccount" default-entity-name="TaxAuthorityGlAccount" engine="entity-auto" invoke="create" auth="true">
        <description>Create TaxAuthorityGlAccount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateTaxAuthorityGlAccount" default-entity-name="TaxAuthorityGlAccount" engine="entity-auto" invoke="update" auth="true">
        <description>Update TaxAuthorityGlAccount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityGlAccount" default-entity-name="TaxAuthorityGlAccount" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete TaxAuthorityGlAccount</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- TaxAuthorityRateProduct -->
    <service name="createTaxAuthorityRateProduct" default-entity-name="TaxAuthorityRateProduct" engine="entity-auto" invoke="create" auth="true">
        <description>Create TaxAuthorityRateProduct</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="OUT" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateTaxAuthorityRateProduct" default-entity-name="TaxAuthorityRateProduct" engine="entity-auto" invoke="update" auth="true">
        <description>Update TaxAuthorityRateProduct</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityRateProduct" default-entity-name="TaxAuthorityRateProduct" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete TaxAuthorityRateProduct</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- PartyTaxAuthInfo -->
    <service name="createPartyTaxAuthInfo" default-entity-name="PartyTaxAuthInfo" engine="simple" auth="true"
        location="component://accounting/minilang/tax/TaxAuthorityServices.xml" invoke="createPartyTaxAuthInfo">
        <description>Create PartyTaxAuthInfo</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="updatePartyTaxAuthInfo" default-entity-name="PartyTaxAuthInfo" engine="simple" auth="true"
        location="component://accounting/minilang/tax/TaxAuthorityServices.xml" invoke="updatePartyTaxAuthInfo">
        <description>Update PartyTaxAuthInfo</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deletePartyTaxAuthInfo" default-entity-name="PartyTaxAuthInfo" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete PartyTaxAuthInfo</description>
        <permission-service service-name="acctgBasePermissionCheck" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <service name="createCustomerTaxAuthInfo" default-entity-name="PartyTaxAuthInfo" engine="simple" auth="true"
        location="component://accounting/minilang/tax/TaxAuthorityServices.xml" invoke="createCustomerTaxAuthInfo">
        <description>Create Customer PartyTaxAuthInfo</description>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <attribute name="partyId" type="String" mode="IN" optional="false"/>
        <attribute name="taxAuthPartyGeoIds" type="String" mode="IN" optional="false"/>
        <attribute name="fromDate" type="String" mode="IN" optional="true"/>
    </service>

    <!-- ZipSales Tax Services -->
    <service name="importZipSalesTaxData" engine="java" transaction-timeout="7200"
        location="org.apache.ofbiz.order.thirdparty.zipsales.ZipSalesServices" invoke="importFlatTable">
        <description>Import ZipSales Flat File</description>
        <attribute name="taxFileLocation" type="String" mode="IN" optional="false"/>
        <attribute name="ruleFileLocation" type="String" mode="IN" optional="false"/>
    </service>

    <service name="flatZipSalesTaxCalc" engine="java"
        location="org.apache.ofbiz.order.thirdparty.zipsales.ZipSalesServices" invoke="flatTaxCalc">
        <description>Zip Sales Calc Tax Service - change this to calcTax to run</description>
        <implements service="calcTaxInterface"/>
    </service>

    <!-- TaxAuthorityAssocType services -->
    <service name="createTaxAuthorityAssocType" default-entity-name="TaxAuthorityAssocType" engine="entity-auto" invoke="create" auth="true">
        <description>Create a TaxAuthorityAssocType</description>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes include="pk" mode="INOUT" optional="true"/>
   </service>
    <service name="updateTaxAuthorityAssocType" default-entity-name="TaxAuthorityAssocType" engine="entity-auto" invoke="update" auth="true">
        <description>Update a TaxAuthorityAssocType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityAssocType" default-entity-name="TaxAuthorityAssocType" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete a TaxAuthorityAssocType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- TaxAuthorityRateType services -->
    <service name="createTaxAuthorityRateType" default-entity-name="TaxAuthorityRateType" engine="entity-auto" invoke="create" auth="true">
        <description>Create a TaxAuthorityRateType</description>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes include="pk" mode="INOUT" optional="true"/>
   </service>
    <service name="updateTaxAuthorityRateType" default-entity-name="TaxAuthorityRateType" engine="entity-auto" invoke="update" auth="true">
        <description>Update a TaxAuthorityRateType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="deleteTaxAuthorityRateType" default-entity-name="TaxAuthorityRateType" engine="entity-auto" invoke="delete" auth="true">
        <description>Delete a TaxAuthorityRateType</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>
</services>