Features - Connectors Framework - Inbound REST API - Payments
Payment
Overview
All the API methods available for payment.
Parameters
Allows the API to create and view your payments. You can retrieve individual payments as well as a list of all your payments.
description
optional
String
A description of the payment
status
optional
String
Custom status of the payment if any are defined in payment settings
customer
optional
Long
The customer ID this payment is for
locationId
optional
Long
The Id of the location this payment is for
category
optional
Long
Category ID of the payment's categories if any are defined in payment settings
assignedTo
optional
String
A payment can be assigned to user existing in MobiWork
externalId
required
String
The third-party client's internal ID
dueDate
required
String
The date which the payment is due
address
optional
Address Object
The address object associated with this payment
contact
optional
Contact Object
The contact object associated with this payment
Example
<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>