Features
Pricing
Support
Accountants
MTD Software
Contact
More
Log in
 

Soap API documentation

Method: allocatePayment

Allocate a payment against an invoice or set of invoices.

Request

Field Type Description  
payment paymentId integer The ID of the payment in Clear Books. required
payment entityId integer The ID of the entity linked to the payment. required
payment type string String identifying the type of the payment; either "sales" or "purchases". required
payment invoices[ ] array See createPayment for details. required

Response

Field Type Description  
payment success boolean True if successful, false if failed. optional
payment msg string Brief explanation of why success is true or false. optional

Examples

Documentation of this method currently does not have any examples.