release14.12/applications/accounting/servicedef/services_payment.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="http://ofbiz.apache.org/dtds/services.xsd">
    <description>Accounting Services</description>
    <vendor>OFBiz</vendor>
    <version>1.0</version>

    <!-- Payment services -->
    <service name="createPayment" engine="simple" default-entity-name="Payment"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPayment" auth="true">
        <description>Create a Payment.  If a paymentMethodId is supplied, paymentMethodTypeId is gotten from paymentMethod.  Otherwise, it must be supplied.  If no
        paymentMethodTypeId and no paymentMethodId is supplied, then an error will be returned. </description>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes include="pk" mode="INOUT" optional="true"/>
        <override name="paymentTypeId" optional="false"/>
        <override name="partyIdFrom" optional="false"/>
        <override name="partyIdTo" optional="false"/>
        <override name="amount" optional="false"/>
    </service>

    <service name="updatePayment" engine="simple" default-entity-name="Payment"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="updatePayment" auth="true">
        <description>Update a Payment</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>

    <service name="setPaymentStatus" engine="simple" default-entity-name="Payment"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="setPaymentStatus" auth="true">
        <description>Change the status of a Payment</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <attribute name="statusId" type="String" mode="IN" optional="false"/>
        <attribute name="oldStatusId" type="String" mode="OUT" optional="true"/>
    </service>

    <service name="checkPaymentInvoices" engine="java"
        location="org.ofbiz.accounting.invoice.InvoiceServices" invoke="checkPaymentInvoices">
        <description>Checks to see if each invoice to which a payment is applied has been fully paid up.  If so, sets the invoice status to PAID.</description>
        <attribute name="paymentId" type="String" mode="IN" optional="false"/>
    </service>

    <service name="quickSendPayment" engine="simple" default-entity-name="Payment"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="quickSendPayment">
        <description>Updates a Payment and then marks it as PMNT_SENT</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>

    <service name="createPaymentApplication" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentApplication" auth="true">
        <description>Create a payment application</description>
        <attribute name="paymentId" type="String" mode="IN" optional="false"/>
        <attribute name="toPaymentId" type="String" mode="IN" optional="true"/>
        <attribute name="invoiceId" type="String" mode="IN" optional="true"/>
        <attribute name="billingAccountId" type="String" mode="IN" optional="true"/>
        <attribute name="taxAuthGeoId" type="String" mode="IN" optional="true"/>
        <attribute name="amountApplied" type="BigDecimal" mode="INOUT" optional="true"/>
        <attribute name="paymentApplicationId" type="String" mode="OUT" optional="false"/>
        <attribute name="paymentTypeId" type="String" mode="OUT" optional="false"/>
    </service>
    <service name="updatePaymentApplication" default-entity-name="PaymentApplication" engine="java"
        location="org.ofbiz.accounting.invoice.InvoiceServices" invoke="updatePaymentApplication">
        <description>
            Apply a payment to a Invoice or other payment or Billing account or  Taxauthority,
            create/update paymentApplication records.
        </description>
        <auto-attributes mode="IN" include="pk" optional="true"/>
        <auto-attributes mode="IN" include="nonpk" optional="true"/>
        <attribute name="invoiceProcessing" type="String" mode="IN" optional="true"/>
        <override name="paymentId" optional="false"/>
    </service>
    <service name="updatePaymentApplicationDef" default-entity-name="PaymentApplication" engine="java"
        location="org.ofbiz.accounting.invoice.InvoiceServices" invoke="updatePaymentApplicationDef">
        <description>
            Apply a payment to a Invoice or other payment or Billing account or Taxauthority,
            If no ammountApplied is supplied the system will calculate and use the maximum possible value.
        </description>
        <auto-attributes mode="IN" include="pk" optional="true"/>
        <auto-attributes mode="IN" include="nonpk" optional="true"/>
        <attribute name="invoiceProcessing" type="String" mode="IN" optional="true"/>
        <override name="paymentId" optional="false"/>
    </service>
    <service name="removePaymentApplication" default-entity-name="PaymentApplication" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/invoice/InvoiceServices.xml" invoke="removePaymentApplication">
        <description>Delete a paymentApplication record.</description>
        <permission-service service-name="acctgInvoicePermissionCheck" main-action="UPDATE"/>
        <auto-attributes mode="IN" include="pk" optional="false"/>
        <auto-attributes mode="OUT" include="nonpk" optional="true"/>
    </service>

    <service name="createPaymentAndApplication" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentAndApplication" auth="true">
        <description>Create a payment and a payment application for the full amount</description>
        <auto-attributes entity-name="Payment" include="nonpk" mode="IN" optional="true"/>
        <auto-attributes entity-name="Payment" include="pk" mode="INOUT" optional="true"/>
        <attribute name="invoiceId" type="String" mode="IN" optional="true"/>
        <attribute name="invoiceItemSeqId" type="String" mode="IN" optional="true"/>
        <attribute name="billingAccountId" type="String" mode="IN" optional="true"/>
        <attribute name="overrideGlAccountId" type="String" mode="IN" optional="true"/>
        <attribute name="taxAuthGeoId" type="String" mode="IN" optional="true"/>
        <attribute name="paymentApplicationId" type="String" mode="OUT" optional="false"/>
        <override name="paymentTypeId" optional="false"/>
        <override name="partyIdFrom" optional="false"/>
        <override name="partyIdTo" optional="false"/>
        <override name="statusId" optional="false"/>
        <override name="amount" optional="false"/>
    </service>

    <service name="getInvoicePaymentInfoList" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="getInvoicePaymentInfoList" auth="true">
        <description>Create a list with information on payment due dates and amounts for the invoice; one of invoiceId or invoice must be provided.</description>
        <attribute name="invoiceId" type="String" mode="IN" optional="true"/>
        <attribute name="invoice" type="org.ofbiz.entity.GenericValue" mode="IN" optional="true"/>
        <attribute name="invoicePaymentInfoList" type="List" mode="OUT" optional="false"/>
    </service>
    <service name="getInvoicePaymentInfoListByDueDateOffset" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="getInvoicePaymentInfoListByDueDateOffset" auth="true">
        <description>Create a list with information on payment due dates and amounts.</description>
        <attribute name="invoiceTypeId" type="String" mode="IN" optional="false"/>
        <attribute name="daysOffset" type="Long" mode="IN" optional="false"/>
        <attribute name="partyId" type="String" mode="IN" optional="true"/>
        <attribute name="partyIdFrom" type="String" mode="IN" optional="true"/>
        <attribute name="invoicePaymentInfoList" type="List" mode="OUT" optional="true"/>
    </service>
    <service name="voidPayment" engine="simple" 
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="voidPayment" auth="true">
        <description>Sets payment status to PMNT_VOID, removes all PaymentApplications, changes related invoice statuses to 
            INVOICE_READY if status is INVOICE_PAID, and reverses related AcctgTrans by calling copyAcctgTransAndEntries service</description>
        <attribute name="paymentId" mode="IN" optional="false" type="String"/>
        <attribute name="finAccountTransId" type="String" mode="OUT" optional="true"/>
        <attribute name="statusId" type="String" mode="OUT" optional="true"/>
    </service>
    <service name="getPaymentRunningTotal" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="getPaymentRunningTotal" auth="true">
        <description>calculate running total for payments</description>
        <attribute name="paymentIds" type="List" mode="IN" optional="false"/>
        <attribute name="organizationPartyId" type="String" mode="IN" optional="true"/>
        <attribute name="paymentRunningTotal" type="String" mode="OUT" optional="false"/>
    </service>
    <service name="cancelPaymentBatch" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="cancelPaymentBatch" auth="true">
        <description>cancel payment batch</description>
        <attribute name="paymentGroupId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="createPaymentAndPaymentGroupForInvoices" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentAndPaymentGroupForInvoices" auth="true">
        <description>Creates Payments, Payment Application and Payment Group for the same</description>
        <attribute name="organizationPartyId" type="String" mode="IN" optional="false"/>
        <attribute name="checkStartNumber" type="Long" mode="IN" optional="true"/>
        <attribute name="invoiceIds" type="List" mode="IN" optional="false"/>
        <attribute name="paymentMethodTypeId" type="String" mode="IN" optional="true"/>
        <attribute name="paymentMethodId" type="String" mode="IN" optional="false"/>
        <attribute name="paymentGroupId" type="String" mode="OUT" optional="true"/>
        <attribute name="errorMessage" type="String" optional="true" mode="OUT"/>
    </service>
    <service name="createPaymentAndApplicationForParty" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentAndApplicationForParty" auth="true">
        <description>create Payment and PaymentApplications for multiple invoices for one party</description>
        <attribute name="organizationPartyId" type="String" mode="INOUT" optional="true"/>
        <attribute name="partyId" type="String" mode="IN" optional="false"/>
        <attribute name="invoices" type="List" mode="IN" optional="false"/>
        <attribute name="paymentMethodTypeId" type="String" mode="IN" optional="true"/>
        <attribute name="paymentMethodId" type="String" mode="IN" optional="false"/>
        <attribute name="finAccountId" type="String" mode="INOUT" optional="true"/>
        <attribute name="checkStartNumber" type="Long" mode="IN" optional="true"/>
        <attribute name="paymentId" type="String" mode="OUT" optional="true"/>
        <attribute name="invoiceIds" type="List" mode="OUT" optional="true"/>
        <attribute name="amount" type="BigDecimal" mode="OUT" optional="true"/>
    </service>
    <service name="createPaymentGroupAndMember" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentGroupAndMember" auth="true">
        <attribute name="paymentIds" type="List" mode="IN" optional="false"/>
        <attribute name="paymentGroupTypeId" type="String" mode="IN" optional="false"/>
        <attribute name="fromDate" type="Timestamp" mode="IN" optional="true"/>
        <attribute name="paymentGroupName" type="String" mode="IN" optional="true"/>
        <attribute name="paymentGroupId" type="String" mode="OUT" optional="false"/>
    </service>
    <service name="cancelCheckRunPayments" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="cancelCheckRunPayments" auth="true">
        <description>Cancel all payments for payment group</description>
        <attribute name="paymentGroupId" type="String" mode="IN" optional="false"/>
    </service>
    <service name="createFinAccoutnTransFromPayment" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createFinAccoutnTransFromPayment" auth="true">
        <auto-attributes entity-name="FinAccountTrans" include="nonpk" mode="IN" optional="true"/>
        <auto-attributes entity-name="FinAccountTrans" include="pk" mode="INOUT" optional="true"/>
        <attribute name="invoiceIds" type="List" mode="IN" optional="true"/>
    </service>
    <service name="getPayments" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="getPayments" auth="true">
        <description>Get list of payment</description>
        <attribute name="paymentGroupId" type="String" mode="IN" optional="true"/>
        <attribute name="finAccountTransId" type="String" mode="IN" optional="true"/>
        <attribute name="payments" type="List" mode="OUT" optional="true"/>
    </service>
    <service name="getPaymentGroupReconciliationId" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="getPaymentGroupReconciliationId" auth="true">
        <description>Get ReconciliationId associated to paymentGroup</description>
        <attribute name="paymentGroupId" type="String" mode="IN" optional="false"/>
        <attribute name="glReconciliationId" type="String" mode="OUT" optional="true"/>
    </service>
    
    <service name="checkAndCreateBatchForValidPayments" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="checkAndCreateBatchForValidPayments" auth="true">
        <description>Check the valid(unbatched) payment and create batch for same</description>
        <implements service="createPaymentGroupAndMember"/>
    </service>
    
    <service name="massChangePaymentStatus" engine="simple"
            location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="massChangePaymentStatus" auth="true">
        <description>Set status of Payments in bulk.</description>
        <attribute name="paymentIds" type="List" mode="IN" optional="false"/>
        <attribute name="statusId" type="String" mode="IN" optional="false"/>
        <attribute name="errorMessage" type="String" optional="true" mode="OUT"/>
    </service>

    <service name="createPaymentFromOrder" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentFromOrder" auth="true">
        <description>Create Payment from Order when payment does exist yet and not disabled by accountingconfig</description>
        <attribute name="orderId" type="String" mode="IN" optional="false"/>
        <attribute name="paymentId" type="String" mode="OUT" optional="true"/>
        <attribute name="paymentMethodId" type="String" mode="IN" optional="true"/>
        <attribute name="paymentRefNum" type="String" mode="IN" optional="true"/>
        <attribute name="comments" type="String" mode="IN" optional="true"/>
    </service>

    <service name="createMatchingPaymentApplication" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createMatchingPaymentApplication" auth="true">
        <description>Create a payment application if either the invoice of payment could be found</description>
        <attribute name="paymentId" type="String" mode="IN" optional="true"/>
        <attribute name="invoiceId" type="String" mode="IN" optional="true"/>
    </service>

    <!-- Payment content services -->
    <service name="createPaymentContent" default-entity-name="PaymentContent" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="createPaymentContent" auth="true">
        <description>Add Content To Payment</description>
        <auto-attributes include="pk" mode="INOUT" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes entity-name="Content" include="nonpk" mode="IN" optional="true"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="updatePaymentContent" default-entity-name="PaymentContent" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="updatePaymentContent" auth="true">
        <description>Update Content To Payment</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <auto-attributes entity-name="Content" include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="removePaymentContent" default-entity-name="PaymentContent" engine="simple"
        location="component://accounting/script/org/ofbiz/accounting/payment/PaymentServices.xml" invoke="removePaymentContent" auth="true">
        <description>Remove Content From Payment</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
</services>