PUT /settlements/create
Creates a new settlement record for the given data.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| settlement |
the data to use when creating the new settlement |
body of type: application/xml application/json
|
|
RowSettlement
|
Result
RowSettlement
of type:
application/xml
application/json
returns the created settlement record
Additional attributes:
__payMethodDescr This value represents the description of the pay method, found in the settlement.pay_method field.
__payeeTypeDescr This value represents the description of the payee type.
__commodityIdDescr This value represents the description of the commodity, found in the settlement.commodity_id field.
__revenueIdDescr This value represents the description of the revenue code, found in the settlement.revenue_id field.
Child Elements:
RowMovement This element represent the movement associated with the settlement.
The element contains a __name attribute with the value movement.
RowOrders This element represent the order associated with the settlement.
The element contains a __name attribute with the value order.
RowPayee This element represent the payee associated with the settlement.
The element contains a __name attribute with the value payee.
RowDrsPayee This element represent the drs_payee associated with the settlement.
The element contains a __name attribute with the value drs_payee.
RowDrsPendingDeduct This element represent the pending deduction associated with the settlement.
The element contains a __name attribute with the value drs_pending_deduct.
Try It Out
Request