List Payments

Overview
Retrieve payment List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/payment/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user

Filter or Search Criteria

description	By payment description
status	By status of payment
externalId	By external ID of payment
category	By cateogry of payment
createdDateFrom	By created date of payment
createdDateTo	By created date of payment
dueDateFrom	By due date of payment
dueDateTo	By due date of payment

Return
Returns a list of payment Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 payments will be returned. Returns an error if not a valid request

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="createdDateFrom"/>
        <xs:element ref="createdDateTo"/>
        <xs:element ref="invoiceId"/>
        <xs:element ref="status"/>
        <xs:element ref="userId"/>
        <xs:element ref="userName"/>
        <xs:element ref="workOrderId"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="createdDateFrom" type="xs:string" minOccurs="0"/>
  <xs:element name="createdDateTo" type="xs:string" minOccurs="0"/>
  <xs:element name="invoiceId" type="xs:integer" minOccurs="0"/>
  <xs:element name="status" type="xs:NCName" minOccurs="0"/>
  <xs:element name="userId" type="xs:integer" minOccurs="0"/>
  <xs:element name="userName" type="xs:string" minOccurs="0"/>
  <xs:element name="workOrderId" type="xs:integer" minOccurs="0"/>
  <xs:element name="integrationStatus" type="xs:NCName" minOccurs="0"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="paymentList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="paymentList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="payment"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="payment">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="status"/>
        <xs:element ref="amount"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="externalId"/>
        <xs:element ref="invoiceId"/>
        <xs:element ref="paymentDate"/>
        <xs:element ref="paymentId"/>
        <xs:element ref="paymentReference"/>
        <xs:element ref="paymentType"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="status">
    <xs:complexType/>
  </xs:element>
  <xs:element name="amount" type="xs:decimal"/>
  <xs:element name="createdBy" type="xs:integer"/>
  <xs:element name="createdByName" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="externalId">
    <xs:complexType/>
  </xs:element>
  <xs:element name="invoiceId" type="xs:integer"/>
  <xs:element name="paymentDate" type="xs:string"/>
  <xs:element name="paymentId" type="xs:integer"/>
  <xs:element name="paymentReference">
    <xs:complexType/>
  </xs:element>
  <xs:element name="paymentType" type="xs:NCName"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/5.0.141/payment/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data'<request> <createdFromDate></createdFromDate> <createdToDate></createdToDate> <invoiceId></invoiceId> <status></status> <userId></userId> <userName></userName> <workOrderId></workOrderId> </request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.141" statusCode="1"> <paymentList> <payment> <status>CREATED</status> <amount>100</amount> <createdBy>1</createdBy> <createdByName>User</createdByName> <createdDate>2019/06/26</createdDate> <externalId>123</externalId> <invoiceId>1</invoiceId> <paymentDate>2019/06/26</paymentDate> <paymentId>1</paymentId> <paymentReference>ref</paymentReference> <paymentType>PAYMENT</paymentType> </payment> </paymentList> </response>