API Reference

Get Services for Client V2

post https://uat.api.globalpay.convera.com/geo-api/clientServicesV2

Client services search - only returns records that are changed within the timeframe specified by inputs startDate and endDate in YYYY-MM-DD format.

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:tns="http://api.globalpay.convera.com" targetNamespace="http://api.globalpay.convera.com" elementFormDefault="qualified" attributeFormDefault="unqualified" vc:minVersion="1.1">
    <xs:include schemaLocation="common.xsd"/>
    <xs:element name="clientServicesRequest" type="tns:ClientServicesRequestTypeV2"/>
    <xs:complexType name="ClientServicesRequestTypeV2">
        <xs:complexContent>
            <xs:extension base="tns:AbstractInputType">
                <xs:sequence>
                    <xs:element name="clientId" type="xs:long" minOccurs="0" maxOccurs="1"/>
                    <xs:element name="startDate" type="xs:date" minOccurs="0"/>
                    <xs:element name="endDate" type="xs:date" minOccurs="0"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:element name="clientServicesResponse" type="tns:ClientServicesResponseTypeV2"/>
    <xs:complexType name="ClientServicesResponseTypeV2">
        <xs:complexContent>
            <xs:extension base="tns:AbstractOutputType">
                <xs:sequence>
                    <xs:element name="debtorGroups" type="tns:DebtorGroupsV2"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:complexType name="DebtorGroupsV2">
        <xs:sequence>
            <xs:element name="debtorGroup" type="tns:DebtorGroupV2" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="DebtorGroupV2">
        <xs:sequence>
            <xs:element name="serviceItem" type="tns:ServiceItemV2" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="name" type="tns:String30Type"/>
    </xs:complexType>
    <xs:complexType name="ServiceItemV2">
        <xs:sequence>
            <xs:element name="id" type="tns:String255Type"/>
            <xs:element name="name" type="tns:String255Type"/>
            <xs:element name="description" type="tns:String255Type"/>
            <xs:element name="mandatory" type="xs:boolean"/>
            <xs:element name="amountOwing" type="xs:decimal"/>
            <xs:element name="minAmount" type="xs:decimal" nillable="true"/>
            <xs:element name="maxAmount" type="xs:decimal" nillable="true"/>
            <xs:element name="editable" type="xs:boolean" minOccurs="0"/>
            <xs:element name="action" type="tns:actionType" minOccurs="0"  />
        </xs:sequence>
    </xs:complexType>
</xs:schema>


<clientServicesRequest xmlns="http://api.globalpay.convera.com">
    <clientId>123456789</clientId>
    <startDate>2023-01-01</startDate>
    <endDate>2023-03-31</endDate>
</clientServicesRequest>

<clientServicesResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://api.globalpay.convera.com" xmlns="http://api.globalpay.convera.com">
    <status success="true"/>
    <debtorGroups>
        <debtorGroup>
            <serviceItem>
                <id>100000012345</id>
                <name>Tuition</name>
                <description>Tuition Fee</description>
                <mandatory>false</mandatory>
                <amountOwing>100</amountOwing>
                <minAmount xsi:nil="true"/>
                <maxAmount xsi:nil="true"/>
                <editable>true</editable>
                <action>create</action>
            </serviceItem>
        </debtorGroup>
    </debtorGroups>
</clientServicesResponse>
Language
URL