Hook up your own application with The Machine's functionality.

invoice.payment

This method let you add a payment for the invoice with the given id.

You call this method with the following URL:

Parameters

Parameters are the data you will pass with the call.

api_token

Your secret identifier. You find your API Token under Account Overview in the Account section.

Rules: Required

id

The ID of the invoice.

Rules: Required.

amount (optional)

The amount of the payment.

Rules: Can only include numeric characters.

get (optional)

If this parameter is set the result sent back will be the edited invoice in XML data rather than the success message.

Rules: If parameter is used it must be set to "true". Otherwise it will be ignored.

Return Values

This is the result that will be passed back to you when you have sent a call.

Success

Success: Payment added.

The payment was successfully added.

If you have set the get parameter to "true" you will rather get the edited invoice in XML sent back to you. Like this:

<?xml version="1.0" encoding="utf-8"?>
<request method="invoice.get">
    <invoice>
        <id>205092</id>
        <status>Paid</status>
        <date>15 Jan 2009</date>
        <due_date>16 Feb 2009</due_date>
        <invoice_id>0000004</invoice_id>
        <po></po>
        <due>30</due>
        <tax_rate>0.00</tax_rate>
        <discount_rate>0.00</discount_rate>
        <shipping_amount>0.00</shipping_amount>
        <currency_symbol>$</currency_symbol>
        <currency_code></currency_code>
        <notes>Thank you!</notes>
        <permalink>http://machine_id.invoicemachine.com/invoice/view/24192915345543</permalink>
        <download_link>http://machine_id.invoicemachine.com/invoice/download/24192915345543</download_link >
        <payment_link>http://machine_id.invoicemachine.com/invoice/payment/24192915345543</payment_link >
        <client_id>204607</client_id>
        <client_name>Sample Contact</client_name>
        <client_email>sample@invoicemachine.com</client_email>
        <client_company>Sample Company, Inc.</client_company>
        <client_address_line_01>35181 Invoice Street</client_address_line_01>
        <client_address_line_02></client_address_line_02>
        <client_city>Invoice City</client_city>
        <client_zip_code>92329</client_zip_code>
        <client_state>CA</client_state>
        <client_country>United States</client_country>
        <client_tax_id></client_tax_id>
        <your_name>Your Name</your_name>
        <your_email>your@email.com</your_email>
        <your_company>Your Company</your_company>
        <your_address_line_01>Your Address</your_address_line_01>
        <your_address_line_02></your_address_line_02>
        <your_city>Your City</your_city>
        <your_zip_code>33018</your_zip_code>
        <your_state></your_state>
        <your_country>United States</your_country>
        <your_tax_id></your_tax_id>
        <lines>
            <line>
                <qty>2</qty>
                <kind>hours</kind>
                <description>Web design</description>
                <price>120.00</price>
                <total>240.00</total>
            </line>
            <line>
                <qty>8</qty>
                <kind>hours</kind>
                <description>Web development</description>
                <price>120.00</price>
                <total>960.00</total>
            </line>
        </lines>
        <subtotal>1200.00</subtotal>
        <tax>0.00</tax>
        <discount>0.00</discount>
           <shipping>0.00</shipping>
        <total>1200.00</total>
        <paid>200.00</paid>
        <balance_due>1000.00</balance_due>	
    </invoice>
</request>
Error

Error: No data passed.

No data was passed to the method.

Error: API Token is invalid.

The API Token parameter is missing or is incorrectly entered.

Error: ID is invalid.

The ID parameter is missing or is incorrectly entered.

Error: Amount is invalid.

The Amount parameter is incorrectly entered.

Example

The example below is strictly a demonstration of the method and it's parameters. Methods should never be posted from a HTML form. They should be posted directly from your server script.

<form action="http://machine_id.invoicemachine.com/api/invoice.payment" method="post">
    <input type="hidden" name="api_token" value="c86cea54c71sbb05a5f8297bed641944">
    <input type="hidden" name="id" value="205092">
    <input type="hidden" name="amount" value="200">
</form>