Hey Geeks, here's the API!

API Forum

The Less Accounting API has a google group. Please use this group to ask questions and receive notifications about the API. Please search for your question before asking to see if your question has already been answered. New members are moderated so your question might not show up for a few hours. http://groups.google.com/group/less-accounting-api

Authentication

The Less Accounting API requires authentication for every request. HTTP Basic Authentication is the only supported authentication scheme.

API Keys

All uses of the Less Accounting API are required to have a valid API Key, which must be supplied as a parameter to each method in the API.

Abuse of the API will result in the api key being revoked. API calls made with a revoked API Key will receive the follow xml as the response with a status code 403: 

  <?xml version="1.0" encoding="UTF-8"?>
  <errors>
    <error>API Key is not valid</error>
  </errors>

You must have a valid user account to create an API key.

Create/view your API Keys

HTTP Verbs

  • The API makes use of the HTTP verbs GET, POST, PUT and DELETE.
  • Many of the methods are made to the same url and the HTTP verb is used to distinguish what type of operation to perform (Create, Read, Update, Delete).
  • Since web browsers only support GET and POST, the PUT and DELETE verbs must be supplied via a form variable called '_method' with the value either 'put' or 'delete.'

HTTP Status Codes

Here is a complete list of HTTP status codes. Here is an example of a few:
  • 200 OK: everything went ok.
  • 304 Not Modified: there was no new data to return.
  • 400 Bad Request: your request is invalid, and we'll return an error message that tells you why.
  • 401 Not Authorized: either you need to provide authentication credentials, or the credentials provided aren't valid.
  • 403 Forbidden: we understand your request, but are refusing to fulfill it.  An accompanying error message should explain why.
  • 404 Not Found: either you're requesting an invalid URI or the resource in question doesn't exist (ex: no such user). 
  • 500 Internal Server Error: we did something wrong.  Please post to the group about it and the we will investigate.
  • 502 Bad Gateway: returned if More Honey is down or being upgraded.
  • 503 Service Unavailable: the More Honey servers are up, but are overloaded with requests.  Try again later.

Errors

Errors are sent with the proper HTTP status codes and the xml in the following format: 
  <?xml version="1.0" encoding="UTF-8"?>
  <errors>
    <error>Name has already been taken</error>
  </errors>

Method Parameters

Method parameters that pertain to a specific object should be supplied in the format: object_type[parameter]. E.G., bank_account[name] or expense[amount]. Please see the example for each method to see the usage.

Business Methods

get_businesses
HTTP Verb/URL: GET https://lessaccounting.com/businesses/get_businesses.xml
Business sub-domain required in url: false
Id parameter required in url: false
API Key (api_key) parameter required: true
No other parameters.

Example:

Request: https://{your_business}.lessaccounting.com/businesses/get_businesses.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<businesses type="array">
  <business>
    <address nil="true"></address>
    <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
    <currency-id type="integer">1</currency-id>
    <description-string>Description</description-string>
    <id type="integer">1</id>
    <invoice-date-string>Date:</invoice-date-string>
    <invoice-due-string>Due:</invoice-due-string>
    <invoice-total-string>i total</invoice-total-string>
    <level type="integer">2</level>
    <line-total-string>Line Total</line-total-string>
    <name>bus1</name>
    <next-reference-number type="integer">1</next-reference-number>
    <payment-received-email-subject-string>Payment Received - Thank you</payment-received-email-subject-string>
    <payment-string>Payment:</payment-string>
    <paypal-email-address nil="true"></paypal-email-address>
    <proposal-total-string>p total</proposal-total-string>
    <quantity-string>Quantity</quantity-string>
    <receive-email-brief type="boolean" nil="true"></receive-email-brief>
    <reference-number-string>Reference #:</reference-number-string>
    <remaining-balance-string>Remaining Balance:</remaining-balance-string>
    <sales-tax-fields-default-on type="boolean">true</sales-tax-fields-default-on>
    <show-paypal type="boolean" nil="true"></show-paypal>
    <subdomain>bus1</subdomain>
    <title-string>Title</title-string>
    <total-paid-string>Total Paid:</total-paid-string>
    <unit-price-string>Unit Price</unit-price-string>
    <updated-at type="datetime">2010-03-02T23:11:34Z</updated-at>
    <vat nil="true"></vat>
    <vat-string>VAT Number:</vat-string>
  </business>
  <business>
    <address nil="true"></address>
    <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
    <currency-id type="integer">1</currency-id>
    <description-string>Description</description-string>
    <id type="integer">17</id>
    <invoice-date-string>Date:</invoice-date-string>
    <invoice-due-string>Due:</invoice-due-string>
    <invoice-total-string>i total</invoice-total-string>
    <level type="integer">2</level>
    <line-total-string>Line Total</line-total-string>
    <name>bus17</name>
    <next-reference-number type="integer">1</next-reference-number>
    <payment-received-email-subject-string>Payment Received - Thank you</payment-received-email-subject-string>
    <payment-string>Payment:</payment-string>
    <paypal-email-address nil="true"></paypal-email-address>
    <proposal-total-string>p total</proposal-total-string>
    <quantity-string>Quantity</quantity-string>
    <receive-email-brief type="boolean" nil="true"></receive-email-brief>
    <reference-number-string>Reference #:</reference-number-string>
    <remaining-balance-string>Remaining Balance:</remaining-balance-string>
    <sales-tax-fields-default-on type="boolean">true</sales-tax-fields-default-on>
    <show-paypal type="boolean" nil="true"></show-paypal>
    <subdomain>bus17</subdomain>
    <title-string>Title</title-string>
    <total-paid-string>Total Paid:</total-paid-string>
    <unit-price-string>Unit Price</unit-price-string>
    <updated-at type="datetime">2010-03-02T23:11:34Z</updated-at>
    <vat nil="true"></vat>
    <vat-string>VAT Number:</vat-string>
  </business>
</businesses>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/businesses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the business.
name String required Both The name of the business.
subdomain String required Both The subdomain at lessaccounting.com used to access this business.
email String required Both The used to send invoices.
created_at Datetime N/A Output
updated_at Datetime N/A Output
sales_tax_fields_default_on Boolean optional Both Do line items show sales tax by default.
next_reference_number Integer optional Both the next number to use to create an invoice or proposal.
address Text optional Both
vat String optional Both The string displayed for VAT.
paypal_email_address String optional Both The paypal account email address to use when showing the paypal button in invoices.
currency_id Integer optional Both The id for the currency type that this business uses. See the Currency object for details. This parameter will be moving to another object in the future.
receive_email_brief Boolean optional Both
show_paypal Boolean optional Both
level Integer optional Both
proposal_total_string String optional Both
invoice_total_string String optional Both
vat_string String optional Both
invoice_date_string String optional Both
invoice_due_string String optional Both
reference_number_string String optional Both
payment_string String optional Both
total_paid_string String optional Both
remaining_balance_string String optional Both
payment_received_email_subject_string String optional Both
title_string String optional Both
description_string String optional Both
unit_price_string String optional Both
quantity_string String optional Both
line_total_string String optional Both

Example:

Request: https://{your_business}.lessaccounting.com/businesses/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<business>
  <address nil="true"></address>
  <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
  <currency-id type="integer">1</currency-id>
  <description-string>Description</description-string>
  <id type="integer">1</id>
  <invoice-date-string>Date:</invoice-date-string>
  <invoice-due-string>Due:</invoice-due-string>
  <invoice-total-string>i total</invoice-total-string>
  <level type="integer">2</level>
  <line-total-string>Line Total</line-total-string>
  <name>bus1</name>
  <next-reference-number type="integer">1</next-reference-number>
  <payment-received-email-subject-string>Payment Received - Thank you</payment-received-email-subject-string>
  <payment-string>Payment:</payment-string>
  <paypal-email-address nil="true"></paypal-email-address>
  <proposal-total-string>p total</proposal-total-string>
  <quantity-string>Quantity</quantity-string>
  <receive-email-brief type="boolean" nil="true"></receive-email-brief>
  <reference-number-string>Reference #:</reference-number-string>
  <remaining-balance-string>Remaining Balance:</remaining-balance-string>
  <sales-tax-fields-default-on type="boolean">true</sales-tax-fields-default-on>
  <show-paypal type="boolean" nil="true"></show-paypal>
  <subdomain>bus1</subdomain>
  <title-string>Title</title-string>
  <total-paid-string>Total Paid:</total-paid-string>
  <unit-price-string>Unit Price</unit-price-string>
  <updated-at type="datetime">2010-03-02T23:11:34Z</updated-at>
  <vat nil="true"></vat>
  <vat-string>VAT Number:</vat-string>
</business>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/businesses.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the business.
name String required Both The name of the business.
subdomain String required Both The subdomain at lessaccounting.com used to access this business.
email String required Both The used to send invoices.
created_at Datetime N/A Output
updated_at Datetime N/A Output
sales_tax_fields_default_on Boolean optional Both Do line items show sales tax by default.
next_reference_number Integer optional Both the next number to use to create an invoice or proposal.
address Text optional Both
vat String optional Both The string displayed for VAT.
paypal_email_address String optional Both The paypal account email address to use when showing the paypal button in invoices.
currency_id Integer optional Both The id for the currency type that this business uses. See the Currency object for details. This parameter will be moving to another object in the future.
receive_email_brief Boolean optional Both
show_paypal Boolean optional Both
level Integer optional Both
proposal_total_string String optional Both
invoice_total_string String optional Both
vat_string String optional Both
invoice_date_string String optional Both
invoice_due_string String optional Both
reference_number_string String optional Both
payment_string String optional Both
total_paid_string String optional Both
remaining_balance_string String optional Both
payment_received_email_subject_string String optional Both
title_string String optional Both
description_string String optional Both
unit_price_string String optional Both
quantity_string String optional Both
line_total_string String optional Both

Example:

Request: https://{your_business}.lessaccounting.com/businesses.xml?business[name]=my new business&business[subdomain]=my_new_business&business[email]=myemail@mydomain.com&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<business>
  <address nil="true"></address>
  <created-at type="datetime">2010-03-02T23:11:38Z</created-at>
  <currency-id type="integer">1</currency-id>
  <description-string>Description</description-string>
  <id type="integer">160</id>
  <invoice-date-string>Date:</invoice-date-string>
  <invoice-due-string>Due:</invoice-due-string>
  <invoice-total-string>Invoice Total:</invoice-total-string>
  <level type="integer">2</level>
  <line-total-string>Line Total</line-total-string>
  <name>my new business</name>
  <next-reference-number type="integer">1</next-reference-number>
  <payment-received-email-subject-string>Payment Received - Thank you</payment-received-email-subject-string>
  <payment-string>Payment:</payment-string>
  <paypal-email-address nil="true"></paypal-email-address>
  <proposal-total-string>Proposal Total:</proposal-total-string>
  <quantity-string>Quantity</quantity-string>
  <receive-email-brief type="boolean" nil="true"></receive-email-brief>
  <reference-number-string>Reference #:</reference-number-string>
  <remaining-balance-string>Remaining Balance:</remaining-balance-string>
  <sales-tax-fields-default-on type="boolean" nil="true"></sales-tax-fields-default-on>
  <show-paypal type="boolean" nil="true"></show-paypal>
  <subdomain>my_new_business</subdomain>
  <title-string>Title</title-string>
  <total-paid-string>Total Paid:</total-paid-string>
  <unit-price-string>Unit Price</unit-price-string>
  <updated-at type="datetime">2010-03-02T23:11:38Z</updated-at>
  <vat nil="true"></vat>
  <vat-string>VAT Number:</vat-string>
</business>

Example:

Request: https://{your_business}.lessaccounting.com/businesses.xml?business[name]=&business[subdomain]=&business[email]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
  <error>Name should contain at least one alpha character (a-z).</error>
  <error>Subdomain is too short (minimum is 1 characters)</error>
  <error>Email can't be blank</error>
</errors>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/businesses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the business.
name String required Both The name of the business.
subdomain String required Both The subdomain at lessaccounting.com used to access this business.
email String required Both The used to send invoices.
created_at Datetime N/A Output
updated_at Datetime N/A Output
sales_tax_fields_default_on Boolean optional Both Do line items show sales tax by default.
next_reference_number Integer optional Both the next number to use to create an invoice or proposal.
address Text optional Both
vat String optional Both The string displayed for VAT.
paypal_email_address String optional Both The paypal account email address to use when showing the paypal button in invoices.
currency_id Integer optional Both The id for the currency type that this business uses. See the Currency object for details. This parameter will be moving to another object in the future.
receive_email_brief Boolean optional Both
show_paypal Boolean optional Both
level Integer optional Both
proposal_total_string String optional Both
invoice_total_string String optional Both
vat_string String optional Both
invoice_date_string String optional Both
invoice_due_string String optional Both
reference_number_string String optional Both
payment_string String optional Both
total_paid_string String optional Both
remaining_balance_string String optional Both
payment_received_email_subject_string String optional Both
title_string String optional Both
description_string String optional Both
unit_price_string String optional Both
quantity_string String optional Both
line_total_string String optional Both

Example:

Request: https://{your_business}.lessaccounting.com/businesses/1.xml?business[name]=&business[subdomain]=&business[email]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
  <error>Name should contain at least one alpha character (a-z).</error>
  <error>Subdomain is too short (minimum is 1 characters)</error>
  <error>Email can't be blank</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/businesses/1.xml?business[name]=my new business&business[subdomain]=my_new_business&business[email]=myemail@mydomain.com&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<business>
  <address nil="true"></address>
  <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
  <currency-id type="integer">1</currency-id>
  <description-string>Description</description-string>
  <id type="integer">1</id>
  <invoice-date-string>Date:</invoice-date-string>
  <invoice-due-string>Due:</invoice-due-string>
  <invoice-total-string>i total</invoice-total-string>
  <level type="integer">2</level>
  <line-total-string>Line Total</line-total-string>
  <name>my new business</name>
  <next-reference-number type="integer">1</next-reference-number>
  <payment-received-email-subject-string>Payment Received - Thank you</payment-received-email-subject-string>
  <payment-string>Payment:</payment-string>
  <paypal-email-address nil="true"></paypal-email-address>
  <proposal-total-string>p total</proposal-total-string>
  <quantity-string>Quantity</quantity-string>
  <receive-email-brief type="boolean" nil="true"></receive-email-brief>
  <reference-number-string>Reference #:</reference-number-string>
  <remaining-balance-string>Remaining Balance:</remaining-balance-string>
  <sales-tax-fields-default-on type="boolean">true</sales-tax-fields-default-on>
  <show-paypal type="boolean" nil="true"></show-paypal>
  <subdomain>my_new_business</subdomain>
  <title-string>Title</title-string>
  <total-paid-string>Total Paid:</total-paid-string>
  <unit-price-string>Unit Price</unit-price-string>
  <updated-at type="datetime">2010-03-02T23:11:40Z</updated-at>
  <vat nil="true"></vat>
  <vat-string>VAT Number:</vat-string>
</business>

destroy
Notes: Can only be called by the business owner.
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/businesses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the business.
name String N/A Output The name of the business.
subdomain String N/A Output The subdomain at lessaccounting.com used to access this business.
email String N/A Output The used to send invoices.
created_at Datetime N/A Output
updated_at Datetime N/A Output
sales_tax_fields_default_on Boolean N/A Output Do line items show sales tax by default.
next_reference_number Integer N/A Output the next number to use to create an invoice or proposal.
address Text N/A Output
vat String N/A Output The string displayed for VAT.
paypal_email_address String N/A Output The paypal account email address to use when showing the paypal button in invoices.
currency_id Integer N/A Output The id for the currency type that this business uses. See the Currency object for details. This parameter will be moving to another object in the future.
receive_email_brief Boolean N/A Output
show_paypal Boolean N/A Output
level Integer N/A Output
proposal_total_string String N/A Output
invoice_total_string String N/A Output
vat_string String N/A Output
invoice_date_string String N/A Output
invoice_due_string String N/A Output
reference_number_string String N/A Output
payment_string String N/A Output
total_paid_string String N/A Output
remaining_balance_string String N/A Output
payment_received_email_subject_string String N/A Output
title_string String N/A Output
description_string String N/A Output
unit_price_string String N/A Output
quantity_string String N/A Output
line_total_string String N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/businesses/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Bank Account Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/bank_accounts.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the bank account.
name String N/A Output The name of the business.
business_id Integer N/A Output
created_at Datetime N/A Output
starting_balance Decimal N/A Output
balance Decimal N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<bank-accounts type="array">
  <bank-account>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
    <id type="integer">1</id>
    <name>checking</name>
    <starting-balance type="decimal">0.0</starting-balance>
    <balance type="decimal">-991.06</balance>
  </bank-account>
  <bank-account>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
    <id type="integer">101</id>
    <name>other</name>
    <starting-balance type="decimal">0.0</starting-balance>
    <balance type="decimal">1000.0</balance>
  </bank-account>
</bank-accounts>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/bank_accounts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the bank account.
name String required Both The name of the business.
business_id Integer N/A Output
created_at Datetime N/A Output
starting_balance Decimal optional Both
balance Decimal N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<bank-account>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
  <id type="integer">1</id>
  <name>checking</name>
  <starting-balance type="decimal">0.0</starting-balance>
  <balance type="decimal">-991.06</balance>
</bank-account>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/bank_accounts.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the bank account.
name String required Both The name of the business.
business_id Integer N/A Output
created_at Datetime N/A Output
starting_balance Decimal optional Both
balance Decimal N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts.xml?bank_account[name]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts.xml?bank_account[name]=Checking&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<bank-account>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <id type="integer">114</id>
  <name>Checking</name>
  <starting-balance type="decimal">0.0</starting-balance>
  <balance type="decimal">0.0</balance>
</bank-account>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/bank_accounts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the bank account.
name String required Both The name of the business.
business_id Integer N/A Output
created_at Datetime N/A Output
starting_balance Decimal optional Both
balance Decimal N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts/1.xml?bank_account[name]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts/1.xml?bank_account[name]=Checking&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<bank-account>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
  <id type="integer">1</id>
  <name>Checking</name>
  <starting-balance type="decimal">0.0</starting-balance>
  <balance type="decimal">-991.06</balance>
</bank-account>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/bank_accounts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the bank account.
name String N/A Output The name of the business.
business_id Integer N/A Output
created_at Datetime N/A Output
starting_balance Decimal N/A Output
balance Decimal N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/bank_accounts/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<bank-account>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
  <id type="integer">1</id>
  <name>checking</name>
  <starting-balance type="decimal">0.0</starting-balance>
  <balance type="decimal">0.0</balance>
</bank-account>

Expense Category Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/expense_categories.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense category.
name String N/A Output The name of the expense category.
business_id String N/A Output The id of the business that this expense category belongs to.
expenses_count String N/A Output The number of expenses that belongs to this expense category.

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense-categories type="array">
  <expense-category>
    <business-id type="integer">1</business-id>
    <expenses-count type="integer">0</expenses-count>
    <id type="integer">1</id>
    <name>first expense</name>
  </expense-category>
</expense-categories>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/expense_categories/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense category.
name String required Both The name of the expense category.
business_id String N/A Output The id of the business that this expense category belongs to.
expenses_count String N/A Output The number of expenses that belongs to this expense category.

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense-category>
  <business-id type="integer">1</business-id>
  <expenses-count type="integer">0</expenses-count>
  <id type="integer">1</id>
  <name>first expense</name>
</expense-category>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/expense_categories.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense category.
name String required Both The name of the expense category.
business_id String N/A Output The id of the business that this expense category belongs to.
expenses_count String N/A Output The number of expenses that belongs to this expense category.

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories.xml?expense_category[name]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories.xml?expense_category[name]=Wages&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense-category>
  <business-id type="integer">1</business-id>
  <expenses-count type="integer">0</expenses-count>
  <id type="integer">3937</id>
  <name>Wages</name>
</expense-category>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/expense_categories/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense category.
name String required Both The name of the expense category.
business_id String N/A Output The id of the business that this expense category belongs to.
expenses_count String N/A Output The number of expenses that belongs to this expense category.

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories/1.xml?expense_category[name]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name can't be blank</error>
  <error>Name is too short (minimum is 1 characters)</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories/1.xml?expense_category[name]=Wages&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense-category>
  <business-id type="integer">1</business-id>
  <expenses-count type="integer">0</expenses-count>
  <id type="integer">1</id>
  <name>Wages</name>
</expense-category>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/expense_categories/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense category.
name String N/A Output The name of the expense category.
business_id String N/A Output The id of the business that this expense category belongs to.
expenses_count String N/A Output The number of expenses that belongs to this expense category.

Example:

Request: https://{your_business}.lessaccounting.com/expense_categories/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense-category>
  <business-id type="integer">1</business-id>
  <expenses-count type="integer">0</expenses-count>
  <id type="integer">1</id>
  <name>first expense</name>
</expense-category>

Expense Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/expenses.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense.
amount Decimal N/A Output
bank_account_id Integer N/A Output
title String N/A Output
check_number String N/A Output
created_at Datetime N/A Output
creator_id Integer N/A Output
updated_at Datetime N/A Output
updater_id Integer N/A Output
notes Text N/A Output
business_id Integer N/A Output
date Date N/A Output Returns the paid date if this expense is paid or the due date if it is not paid.
expense_category_id Integer N/A Output
contractor_id Integer N/A Output
employee_id Integer N/A Output
paid_date Date N/A Output Either due date or paid date is required.
is_paid Boolean N/A Output
transfer_fund_id Integer N/A Output The Transfer Fund that this expense is associated with.
payee_id Integer N/A Output
due_date Date N/A Output Either due date or paid date is required.
client_id Integer N/A Output
receipt_url Integer N/A Output
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/expenses.xml?q=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expenses type="array">
  <expense>
    <amount type="decimal">1.06</amount>
    <bank-account-id type="integer">1</bank-account-id>
    <business-id type="integer">1</business-id>
    <check-number nil="true"></check-number>
    <client-id type="integer">1</client-id>
    <contractor-id type="integer" nil="true"></contractor-id>
    <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
    <creator-id type="integer">1</creator-id>
    <date type="date">2006-01-01</date>
    <due-date type="date">2006-01-01</due-date>
    <employee-id type="integer" nil="true"></employee-id>
    <expense-category-id type="integer">1</expense-category-id>
    <id type="integer">1</id>
    <is-paid type="boolean">true</is-paid>
    <notes nil="true"></notes>
    <paid-date type="date">2006-01-01</paid-date>
    <payee-id type="integer" nil="true"></payee-id>
    <title>Check 111</title>
    <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
    <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
    <updater-id type="integer">1</updater-id>
    <receipt-url></receipt-url>
  </expense>
  <expense>
    <amount type="decimal">1.06</amount>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <check-number nil="true"></check-number>
    <client-id type="integer" nil="true"></client-id>
    <contractor-id type="integer" nil="true"></contractor-id>
    <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
    <creator-id type="integer">1</creator-id>
    <date type="date">2006-01-01</date>
    <due-date type="date">2006-01-01</due-date>
    <employee-id type="integer" nil="true"></employee-id>
    <expense-category-id type="integer">1</expense-category-id>
    <id type="integer">100</id>
    <is-paid type="boolean" nil="true"></is-paid>
    <notes nil="true"></notes>
    <paid-date type="date" nil="true"></paid-date>
    <payee-id type="integer" nil="true"></payee-id>
    <title>first expense</title>
    <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
    <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
    <updater-id type="integer">1</updater-id>
    <receipt-url></receipt-url>
  </expense>
  <expense>
    <amount type="decimal">1.06</amount>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <check-number nil="true"></check-number>
    <client-id type="integer">1</client-id>
    <contractor-id type="integer" nil="true"></contractor-id>
    <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
    <creator-id type="integer">1</creator-id>
    <date type="date">2006-01-01</date>
    <due-date type="date">2006-01-01</due-date>
    <employee-id type="integer" nil="true"></employee-id>
    <expense-category-id type="integer">1</expense-category-id>
    <id type="integer">2002</id>
    <is-paid type="boolean">true</is-paid>
    <notes nil="true"></notes>
    <paid-date type="date">2006-01-01</paid-date>
    <payee-id type="integer" nil="true"></payee-id>
    <title>Check 111</title>
    <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
    <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
    <updater-id type="integer">1</updater-id>
    <receipt-url></receipt-url>
  </expense>
  <expense>
    <amount type="decimal">1.06</amount>
    <bank-account-id type="integer">1</bank-account-id>
    <business-id type="integer">1</business-id>
    <check-number nil="true"></check-number>
    <client-id type="integer">1</client-id>
    <contractor-id type="integer" nil="true"></contractor-id>
    <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
    <creator-id type="integer">1</creator-id>
    <date type="date">2006-01-01</date>
    <due-date type="date" nil="true"></due-date>
    <employee-id type="integer" nil="true"></employee-id>
    <expense-category-id type="integer">1</expense-category-id>
    <id type="integer">999</id>
    <is-paid type="boolean" nil="true"></is-paid>
    <notes nil="true"></notes>
    <paid-date type="date" nil="true"></paid-date>
    <payee-id type="integer" nil="true"></payee-id>
    <title>Check 111</title>
    <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
    <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
    <updater-id type="integer">1</updater-id>
    <receipt-url></receipt-url>
  </expense>
  <expense>
    <amount type="decimal">1.06</amount>
    <bank-account-id type="integer">1</bank-account-id>
    <business-id type="integer">1</business-id>
    <check-number nil="true"></check-number>
    <client-id type="integer">1</client-id>
    <contractor-id type="integer" nil="true"></contractor-id>
    <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
    <creator-id type="integer">1</creator-id>
    <date type="date" nil="true"></date>
    <due-date type="date" nil="true"></due-date>
    <employee-id type="integer" nil="true"></employee-id>
    <expense-category-id type="integer">1</expense-category-id>
    <id type="integer">2001</id>
    <is-paid type="boolean" nil="true"></is-paid>
    <notes nil="true"></notes>
    <paid-date type="date" nil="true"></paid-date>
    <payee-id type="integer" nil="true"></payee-id>
    <title>Check 111</title>
    <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
    <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
    <updater-id type="integer">1</updater-id>
    <receipt-url></receipt-url>
  </expense>
</expenses>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/expenses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense.
amount Decimal optional Both
bank_account_id Integer optional Both
title String optional Both
check_number String optional Both
created_at Datetime N/A Output
creator_id Integer N/A Output
updated_at Datetime N/A Output
updater_id Integer N/A Output
notes Text optional Both
business_id Integer N/A Output
date Date N/A Output Returns the paid date if this expense is paid or the due date if it is not paid.
expense_category_id Integer optional Both
contractor_id Integer optional Both
employee_id Integer optional Both
paid_date Date required Both Either due date or paid date is required.
is_paid Boolean optional Both
transfer_fund_id Integer optional Both The Transfer Fund that this expense is associated with.
payee_id Integer optional Both
due_date Date required Both Either due date or paid date is required.
client_id Integer optional Both
receipt_url Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/expenses/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense>
  <amount type="decimal">1.06</amount>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <check-number nil="true"></check-number>
  <client-id type="integer">1</client-id>
  <contractor-id type="integer" nil="true"></contractor-id>
  <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
  <creator-id type="integer">1</creator-id>
  <date type="date">2006-01-01</date>
  <due-date type="date">2006-01-01</due-date>
  <employee-id type="integer" nil="true"></employee-id>
  <expense-category-id type="integer">1</expense-category-id>
  <id type="integer">1</id>
  <is-paid type="boolean">true</is-paid>
  <notes nil="true"></notes>
  <paid-date type="date">2006-01-01</paid-date>
  <payee-id type="integer" nil="true"></payee-id>
  <title>Check 111</title>
  <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
  <updated-at type="datetime">2006-01-01T00:00:00Z</updated-at>
  <updater-id type="integer">1</updater-id>
  <receipt-url></receipt-url>
</expense>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/expenses.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense.
amount Decimal optional Both
bank_account_id Integer optional Both
title String optional Both
check_number String optional Both
created_at Datetime N/A Output
creator_id Integer N/A Output
updated_at Datetime N/A Output
updater_id Integer N/A Output
notes Text optional Both
business_id Integer N/A Output
date Date N/A Output Returns the paid date if this expense is paid or the due date if it is not paid.
expense_category_id Integer optional Both
contractor_id Integer optional Both
employee_id Integer optional Both
paid_date Date required Both Either due date or paid date is required.
is_paid Boolean optional Both
transfer_fund_id Integer optional Both The Transfer Fund that this expense is associated with.
payee_id Integer optional Both
due_date Date required Both Either due date or paid date is required.
client_id Integer optional Both
receipt_url Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/expenses.xml?expense[title]=&expense[amount]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Amount is not a number</error>
  <error>Date either due date or paid date must be a valid date format.</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/expenses.xml?expense[title]=Pizza&expense[amount]=15.87&expense[due_date]=2008-01-01&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense>
  <amount type="decimal">15.87</amount>
  <bank-account-id type="integer" nil="true"></bank-account-id>
  <business-id type="integer">1</business-id>
  <check-number nil="true"></check-number>
  <client-id type="integer" nil="true"></client-id>
  <contractor-id type="integer" nil="true"></contractor-id>
  <created-at type="datetime">2010-03-02T23:11:43Z</created-at>
  <creator-id type="integer">1</creator-id>
  <date type="date">2008-01-01</date>
  <due-date type="date">2008-01-01</due-date>
  <employee-id type="integer" nil="true"></employee-id>
  <expense-category-id type="integer" nil="true"></expense-category-id>
  <id type="integer">2299</id>
  <is-paid type="boolean" nil="true"></is-paid>
  <notes nil="true"></notes>
  <paid-date type="date" nil="true"></paid-date>
  <payee-id type="integer" nil="true"></payee-id>
  <title>Pizza</title>
  <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
  <updated-at type="datetime">2010-03-02T23:11:43Z</updated-at>
  <updater-id type="integer">1</updater-id>
  <receipt-url></receipt-url>
</expense>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/expenses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense.
amount Decimal optional Both
bank_account_id Integer optional Both
title String optional Both
check_number String optional Both
created_at Datetime N/A Output
creator_id Integer N/A Output
updated_at Datetime N/A Output
updater_id Integer N/A Output
notes Text optional Both
business_id Integer N/A Output
date Date N/A Output Returns the paid date if this expense is paid or the due date if it is not paid.
expense_category_id Integer optional Both
contractor_id Integer optional Both
employee_id Integer optional Both
paid_date Date required Both Either due date or paid date is required.
is_paid Boolean optional Both
transfer_fund_id Integer optional Both The Transfer Fund that this expense is associated with.
payee_id Integer optional Both
due_date Date required Both Either due date or paid date is required.
client_id Integer optional Both
receipt_url Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/expenses/1.xml?expense[title]=Pizza&expense[amount]=15.87&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<expense>
  <amount type="decimal">15.87</amount>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <check-number nil="true"></check-number>
  <client-id type="integer">1</client-id>
  <contractor-id type="integer" nil="true"></contractor-id>
  <created-at type="datetime">2006-01-01T00:00:00Z</created-at>
  <creator-id type="integer">1</creator-id>
  <date type="date">2006-01-01</date>
  <due-date type="date">2006-01-01</due-date>
  <employee-id type="integer" nil="true"></employee-id>
  <expense-category-id type="integer">1</expense-category-id>
  <id type="integer">1</id>
  <is-paid type="boolean">true</is-paid>
  <notes nil="true"></notes>
  <paid-date type="date">2006-01-01</paid-date>
  <payee-id type="integer" nil="true"></payee-id>
  <title>Pizza</title>
  <transfer-fund-id type="integer" nil="true"></transfer-fund-id>
  <updated-at type="datetime">2010-03-02T23:11:44Z</updated-at>
  <updater-id type="integer">1</updater-id>
  <receipt-url></receipt-url>
</expense>

Example:

Request: https://{your_business}.lessaccounting.com/expenses/1.xml?expense[title]=&expense[amount]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Amount is not a number</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/expenses/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the expense.
amount Decimal N/A Output
bank_account_id Integer N/A Output
title String N/A Output
check_number String N/A Output
created_at Datetime N/A Output
creator_id Integer N/A Output
updated_at Datetime N/A Output
updater_id Integer N/A Output
notes Text N/A Output
business_id Integer N/A Output
date Date N/A Output Returns the paid date if this expense is paid or the due date if it is not paid.
expense_category_id Integer N/A Output
contractor_id Integer N/A Output
employee_id Integer N/A Output
paid_date Date N/A Output Either due date or paid date is required.
is_paid Boolean N/A Output
transfer_fund_id Integer N/A Output The Transfer Fund that this expense is associated with.
payee_id Integer N/A Output
due_date Date N/A Output Either due date or paid date is required.
client_id Integer N/A Output
receipt_url Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/expenses/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Currency Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/currencies.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the currency.
name Integer N/A Output
code Integer N/A Output
html_symbol Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/currencies.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<currencies type="array">
  <currency>
    <code>USD</code>
    <html-symbol>$</html-symbol>
    <id type="integer">1</id>
    <name nil="true"></name>
  </currency>
  <currency>
    <code>CAD</code>
    <html-symbol>$</html-symbol>
    <id type="integer">2</id>
    <name nil="true"></name>
  </currency>
  <currency>
    <code>EUR</code>
    <html-symbol>4</html-symbol>
    <id type="integer">3</id>
    <name nil="true"></name>
  </currency>
  <currency>
    <code>GBP</code>
    <html-symbol>5</html-symbol>
    <id type="integer">4</id>
    <name nil="true"></name>
  </currency>
  <currency>
    <code>OTH</code>
    <html-symbol>$</html-symbol>
    <id type="integer">5</id>
    <name nil="true"></name>
  </currency>
</currencies>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/currencies/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the currency.
name Integer N/A Output
code Integer N/A Output
html_symbol Integer N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/currencies/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<currency>
  <code>USD</code>
  <html-symbol>$</html-symbol>
  <id type="integer">1</id>
  <name nil="true"></name>
</currency>

Contact Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/contacts.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the contact.
name String N/A Output The name of the contact.
company_name String N/A Output
created_at Datetime N/A Output
updated_at Datetime N/A Output
is_contractor Boolean N/A Output
is_employee Boolean N/A Output
active Boolean N/A Output
note String N/A Output
address String N/A Output
email String N/A Output
phone_number_1 String N/A Output
phone_number_2 String N/A Output
basecamp_id Integer N/A Output The unique identifier for Basecamp.
highrise_id Integer N/A Output The unique identifier for Highrise.
google_id String N/A Output The unique identifier for Google.
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/contacts.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<contacts type="array">
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">85</id>
    <is-contractor type="boolean" nil="true"></is-contractor>
    <is-employee type="boolean">true</is-employee>
    <name>a</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">false</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">86</id>
    <is-contractor type="boolean" nil="true"></is-contractor>
    <is-employee type="boolean">true</is-employee>
    <name>b</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">87</id>
    <is-contractor type="boolean" nil="true"></is-contractor>
    <is-employee type="boolean">true</is-employee>
    <name>c</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">88</id>
    <is-contractor type="boolean" nil="true"></is-contractor>
    <is-employee type="boolean">true</is-employee>
    <name>d</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">89</id>
    <is-contractor type="boolean">true</is-contractor>
    <is-employee type="boolean" nil="true"></is-employee>
    <name>e</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">90</id>
    <is-contractor type="boolean">true</is-contractor>
    <is-employee type="boolean" nil="true"></is-employee>
    <name>f</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name>company name</company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">1</id>
    <is-contractor type="boolean">false</is-contractor>
    <is-employee type="boolean">false</is-employee>
    <name>first contact</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email>sjdf@lsdjf.com</email>
    <phone-number-1>555-555-1212</phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name>The Ferret Freakatorium</company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">93</id>
    <is-contractor type="boolean">false</is-contractor>
    <is-employee type="boolean">false</is-employee>
    <name>Freaky Ferret</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">91</id>
    <is-contractor type="boolean">true</is-contractor>
    <is-employee type="boolean" nil="true"></is-employee>
    <name>g</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
  <contact>
    <active type="boolean">true</active>
    <address nil="true"></address>
    <basecamp-id type="integer" nil="true"></basecamp-id>
    <company-name nil="true"></company-name>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <google-id nil="true"></google-id>
    <highrise-id type="integer" nil="true"></highrise-id>
    <id type="integer">92</id>
    <is-contractor type="boolean">true</is-contractor>
    <is-employee type="boolean" nil="true"></is-employee>
    <name>h</name>
    <note nil="true"></note>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <email></email>
    <phone-number-1 nil="true"></phone-number-1>
    <phone-number-2 nil="true"></phone-number-2>
  </contact>
</contacts>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/contacts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the contact.
name String required Both The name of the contact.
company_name String N/A Output
created_at Datetime N/A Output
updated_at Datetime N/A Output
is_contractor Boolean optional Both
is_employee Boolean optional Both
active Boolean optional Both
note String optional Both
address String optional Both
email String optional Both
phone_number_1 String optional Both
phone_number_2 String optional Both
basecamp_id Integer N/A Output The unique identifier for Basecamp.
highrise_id Integer N/A Output The unique identifier for Highrise.
google_id String N/A Output The unique identifier for Google.

Example:

Request: https://{your_business}.lessaccounting.com/contacts/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<contact>
  <active type="boolean">true</active>
  <address nil="true"></address>
  <basecamp-id type="integer" nil="true"></basecamp-id>
  <company-name>company name</company-name>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <google-id nil="true"></google-id>
  <highrise-id type="integer" nil="true"></highrise-id>
  <id type="integer">1</id>
  <is-contractor type="boolean">false</is-contractor>
  <is-employee type="boolean">false</is-employee>
  <name>first contact</name>
  <note nil="true"></note>
  <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  <email>sjdf@lsdjf.com</email>
  <phone-number-1>555-555-1212</phone-number-1>
  <phone-number-2 nil="true"></phone-number-2>
</contact>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/contacts.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the contact.
name String required Both The name of the contact.
company_name String N/A Output
created_at Datetime N/A Output
updated_at Datetime N/A Output
is_contractor Boolean optional Both
is_employee Boolean optional Both
active Boolean optional Both
note String optional Both
address String optional Both
email String optional Both
phone_number_1 String optional Both
phone_number_2 String optional Both
basecamp_id Integer N/A Output The unique identifier for Basecamp.
highrise_id Integer N/A Output The unique identifier for Highrise.
google_id String N/A Output The unique identifier for Google.

Example:

Request: https://{your_business}.lessaccounting.com/contacts.xml?contact[name]=&contact[email]=alsjdf@&contact[phone_number_1]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name or company name is required</error>
  <error>Emails is invalid</error>
  <error>Emails is invalid</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/contacts.xml?contact[name]=John Alibastar&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<contact>
  <active type="boolean">true</active>
  <address nil="true"></address>
  <basecamp-id type="integer" nil="true"></basecamp-id>
  <company-name nil="true"></company-name>
  <created-at type="datetime">2010-03-02T23:11:40Z</created-at>
  <google-id nil="true"></google-id>
  <highrise-id type="integer" nil="true"></highrise-id>
  <id type="integer">111</id>
  <is-contractor type="boolean" nil="true"></is-contractor>
  <is-employee type="boolean" nil="true"></is-employee>
  <name>John Alibastar</name>
  <note nil="true"></note>
  <updated-at type="datetime">2010-03-02T23:11:40Z</updated-at>
  <email></email>
  <phone-number-1 nil="true"></phone-number-1>
  <phone-number-2 nil="true"></phone-number-2>
</contact>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/contacts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the contact.
name String required Both The name of the contact.
company_name String N/A Output
created_at Datetime N/A Output
updated_at Datetime N/A Output
is_contractor Boolean optional Both
is_employee Boolean optional Both
active Boolean optional Both
note String optional Both
address String optional Both
email String optional Both
phone_number_1 String optional Both
phone_number_2 String optional Both
basecamp_id Integer N/A Output The unique identifier for Basecamp.
highrise_id Integer N/A Output The unique identifier for Highrise.
google_id String N/A Output The unique identifier for Google.

Example:

Request: https://{your_business}.lessaccounting.com/contacts/1.xml?contact[name]=John Alibastar&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<contact>
  <active type="boolean">true</active>
  <address nil="true"></address>
  <basecamp-id type="integer" nil="true"></basecamp-id>
  <company-name>company name</company-name>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <google-id nil="true"></google-id>
  <highrise-id type="integer" nil="true"></highrise-id>
  <id type="integer">1</id>
  <is-contractor type="boolean">false</is-contractor>
  <is-employee type="boolean">false</is-employee>
  <name>John Alibastar</name>
  <note nil="true"></note>
  <updated-at type="datetime">2010-03-02T23:11:41Z</updated-at>
  <email>sjdf@lsdjf.com</email>
  <phone-number-1>555-555-1212</phone-number-1>
  <phone-number-2 nil="true"></phone-number-2>
</contact>

Example:

Request: https://{your_business}.lessaccounting.com/contacts/1.xml?contact[name]=&contact[company_name]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Name or company name is required</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/contacts/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the contact.
name String N/A Output The name of the contact.
company_name String N/A Output
created_at Datetime N/A Output
updated_at Datetime N/A Output
is_contractor Boolean N/A Output
is_employee Boolean N/A Output
active Boolean N/A Output
note String N/A Output
address String N/A Output
email String N/A Output
phone_number_1 String N/A Output
phone_number_2 String N/A Output
basecamp_id Integer N/A Output The unique identifier for Basecamp.
highrise_id Integer N/A Output The unique identifier for Highrise.
google_id String N/A Output The unique identifier for Google.

Example:

Request: https://{your_business}.lessaccounting.com/contacts/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Invoice Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/invoices.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the invoice.
reference_name_number String N/A Output This value will be auto-generated if it is omitted.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_template_id Integer N/A Output
header Text N/A Output
first_sent Datetime N/A Output The first datetime that this invoice was sent (or marked as sent).
sent_at Datetime N/A Output The most recent datetime that this invoice was sent.
sent_to Text N/A Output A comma separated list of email addresses that this invoice was sent to. This list is who a receipt will be sent to.
email_heading Text N/A Output
email_subject String N/A Output
proposal_id Integer N/A Output The unique identifier of the Proposal that this invoice was converted from. If this invoice was not converted from a proposal, this value will be nil.
bank_account_id Integer N/A Output The Bank Account that this invoice's Payments should be deposited into by default. Note that the true Bank Account is determined by the Payment items associated with this invoice. This Id is meant to be used as a cached default value.
sales_tax_amount Decimal N/A Output The total sales tax amount applied from the Line Items of this invoice.
sales_tax_percentage Decimal N/A Output The percentage of sales tax applied to this invoice. When an invoice is created, this value is pulled from the Business object, and it is cached here.
total Decimal N/A Output The total of the Line Items.
payment_total Decimal N/A Output The total amount of Payments that have been made so far.
business_id Integer N/A Output The Id of the Business that this invoice is associated with.
contact_id Integer N/A Output The Id of the Contact that this invoice is associated with.
due_on Date N/A Output The due date of the invoice. This defaults to today plus the "default due date" integer value of the Business object.
show_paypal Boolean N/A Output Whether or no to display the paypal button in the emailed invoice. The Business must have a paypal account setup (via the Business object) for this filed to be recognized.
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/invoices.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<invoices type="array">
  <invoice>
    <bank-account-id type="integer">1</bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date">2007-01-01</due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - invoice 1</email-subject>
    <first-sent type="datetime">2007-01-01T00:00:00Z</first-sent>
    <header nil="true"></header>
    <id type="integer">11</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">1</proposal-template-id>
    <reference-name-number>invoice 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime">2007-01-01T00:00:00Z</sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">122</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">102</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">123</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">103</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">124</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">104</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">125</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">105</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">126</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">106</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - proposal 1</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">127</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">107</proposal-template-id>
    <reference-name-number>proposal 1</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
  <invoice>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">92</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <due-on type="date" nil="true"></due-on>
    <email-heading nil="true"></email-heading>
    <email-subject>bus1 - Mangy Mongoose</email-subject>
    <first-sent type="datetime" nil="true"></first-sent>
    <header nil="true"></header>
    <id type="integer">129</id>
    <payment-total type="decimal">0.0</payment-total>
    <proposal-id type="integer" nil="true"></proposal-id>
    <proposal-template-id type="integer">1</proposal-template-id>
    <reference-name-number>Mangy Mongoose</reference-name-number>
    <sales-tax-amount type="decimal">0.0</sales-tax-amount>
    <sent-at type="datetime" nil="true"></sent-at>
    <sent-to nil="true"></sent-to>
    <show-paypal type="boolean">true</show-paypal>
    <total type="decimal">85.2</total>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </invoice>
</invoices>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/invoices/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the invoice.
reference_name_number String required Both This value will be auto-generated if it is omitted.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_template_id Integer N/A Output
header Text optional Both
first_sent Datetime N/A Output The first datetime that this invoice was sent (or marked as sent).
sent_at Datetime N/A Output The most recent datetime that this invoice was sent.
sent_to Text N/A Output A comma separated list of email addresses that this invoice was sent to. This list is who a receipt will be sent to.
email_heading Text optional Both
email_subject String optional Both
proposal_id Integer N/A Output The unique identifier of the Proposal that this invoice was converted from. If this invoice was not converted from a proposal, this value will be nil.
bank_account_id Integer N/A Output The Bank Account that this invoice's Payments should be deposited into by default. Note that the true Bank Account is determined by the Payment items associated with this invoice. This Id is meant to be used as a cached default value.
sales_tax_amount Decimal N/A Output The total sales tax amount applied from the Line Items of this invoice.
sales_tax_percentage Decimal N/A Output The percentage of sales tax applied to this invoice. When an invoice is created, this value is pulled from the Business object, and it is cached here.
total Decimal N/A Output The total of the Line Items.
payment_total Decimal N/A Output The total amount of Payments that have been made so far.
business_id Integer N/A Output The Id of the Business that this invoice is associated with.
contact_id Integer optional Both The Id of the Contact that this invoice is associated with.
due_on Date N/A Output The due date of the invoice. This defaults to today plus the "default due date" integer value of the Business object.
show_paypal Boolean N/A Output Whether or no to display the paypal button in the emailed invoice. The Business must have a paypal account setup (via the Business object) for this filed to be recognized.

Example:

Request: https://{your_business}.lessaccounting.com/invoices/11.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<invoice>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <contact-id type="integer">1</contact-id>
  <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
  <due-on type="date">2007-01-01</due-on>
  <email-heading nil="true"></email-heading>
  <email-subject>bus1 - invoice 1</email-subject>
  <first-sent type="datetime">2007-01-01T00:00:00Z</first-sent>
  <header nil="true"></header>
  <id type="integer">11</id>
  <payment-total type="decimal">0.0</payment-total>
  <proposal-id type="integer" nil="true"></proposal-id>
  <proposal-template-id type="integer">1</proposal-template-id>
  <reference-name-number>invoice 1</reference-name-number>
  <sales-tax-amount type="decimal">0.0</sales-tax-amount>
  <sent-at type="datetime">2007-01-01T00:00:00Z</sent-at>
  <sent-to nil="true"></sent-to>
  <show-paypal type="boolean">true</show-paypal>
  <total type="decimal">85.2</total>
  <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
</invoice>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/invoices.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the invoice.
reference_name_number String required Both This value will be auto-generated if it is omitted.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_template_id Integer N/A Output
header Text optional Both
first_sent Datetime N/A Output The first datetime that this invoice was sent (or marked as sent).
sent_at Datetime N/A Output The most recent datetime that this invoice was sent.
sent_to Text N/A Output A comma separated list of email addresses that this invoice was sent to. This list is who a receipt will be sent to.
email_heading Text optional Both
email_subject String optional Both
proposal_id Integer N/A Output The unique identifier of the Proposal that this invoice was converted from. If this invoice was not converted from a proposal, this value will be nil.
bank_account_id Integer N/A Output The Bank Account that this invoice's Payments should be deposited into by default. Note that the true Bank Account is determined by the Payment items associated with this invoice. This Id is meant to be used as a cached default value.
sales_tax_amount Decimal N/A Output The total sales tax amount applied from the Line Items of this invoice.
sales_tax_percentage Decimal N/A Output The percentage of sales tax applied to this invoice. When an invoice is created, this value is pulled from the Business object, and it is cached here.
total Decimal N/A Output The total of the Line Items.
payment_total Decimal N/A Output The total amount of Payments that have been made so far.
business_id Integer N/A Output The Id of the Business that this invoice is associated with.
contact_id Integer optional Both The Id of the Contact that this invoice is associated with.
due_on Date N/A Output The due date of the invoice. This defaults to today plus the "default due date" integer value of the Business object.
show_paypal Boolean N/A Output Whether or no to display the paypal button in the emailed invoice. The Business must have a paypal account setup (via the Business object) for this filed to be recognized.

Example:

Request: https://{your_business}.lessaccounting.com/invoices.xml?invoice[reference_name_number]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Reference name number is too short (minimum is 1 characters)</error>
  <error>Currency can't be blank</error>
  <error>Currency can only be different from your default business currency if your business is set to use the More Accounting level.</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/invoices.xml?invoice[currency_id]=1&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<invoice>
  <bank-account-id type="integer" nil="true"></bank-account-id>
  <business-id type="integer">1</business-id>
  <contact-id type="integer" nil="true"></contact-id>
  <created-at type="datetime">2010-03-02T23:11:44Z</created-at>
  <due-on type="date">2010-03-02</due-on>
  <email-heading nil="true"></email-heading>
  <email-subject>bus1 - 2010-0001</email-subject>
  <first-sent type="datetime" nil="true"></first-sent>
  <header nil="true"></header>
  <id type="integer">1313</id>
  <payment-total type="decimal">0.0</payment-total>
  <proposal-id type="integer" nil="true"></proposal-id>
  <proposal-template-id type="integer" nil="true"></proposal-template-id>
  <reference-name-number>2010-0001</reference-name-number>
  <sales-tax-amount type="decimal">0.0</sales-tax-amount>
  <sent-at type="datetime" nil="true"></sent-at>
  <sent-to nil="true"></sent-to>
  <show-paypal type="boolean">true</show-paypal>
  <total type="decimal">0.0</total>
  <updated-at type="datetime">2010-03-02T23:11:44Z</updated-at>
</invoice>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/invoices/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the invoice.
reference_name_number String required Both This value will be auto-generated if it is omitted.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_template_id Integer N/A Output
header Text optional Both
first_sent Datetime N/A Output The first datetime that this invoice was sent (or marked as sent).
sent_at Datetime N/A Output The most recent datetime that this invoice was sent.
sent_to Text N/A Output A comma separated list of email addresses that this invoice was sent to. This list is who a receipt will be sent to.
email_heading Text optional Both
email_subject String optional Both
proposal_id Integer N/A Output The unique identifier of the Proposal that this invoice was converted from. If this invoice was not converted from a proposal, this value will be nil.
bank_account_id Integer N/A Output The Bank Account that this invoice's Payments should be deposited into by default. Note that the true Bank Account is determined by the Payment items associated with this invoice. This Id is meant to be used as a cached default value.
sales_tax_amount Decimal N/A Output The total sales tax amount applied from the Line Items of this invoice.
sales_tax_percentage Decimal N/A Output The percentage of sales tax applied to this invoice. When an invoice is created, this value is pulled from the Business object, and it is cached here.
total Decimal N/A Output The total of the Line Items.
payment_total Decimal N/A Output The total amount of Payments that have been made so far.
business_id Integer N/A Output The Id of the Business that this invoice is associated with.
contact_id Integer optional Both The Id of the Contact that this invoice is associated with.
due_on Date N/A Output The due date of the invoice. This defaults to today plus the "default due date" integer value of the Business object.
show_paypal Boolean N/A Output Whether or no to display the paypal button in the emailed invoice. The Business must have a paypal account setup (via the Business object) for this filed to be recognized.

Example:

Request: https://{your_business}.lessaccounting.com/invoices/11.xml?invoice[contact_id]=1&invoice[first_sent]=2008-01-01&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<invoice>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <contact-id type="integer">1</contact-id>
  <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
  <due-on type="date">2007-01-01</due-on>
  <email-heading nil="true"></email-heading>
  <email-subject>bus1 - invoice 1</email-subject>
  <first-sent type="datetime">2008-01-01T00:00:00Z</first-sent>
  <header nil="true"></header>
  <id type="integer">11</id>
  <payment-total type="decimal">10.0</payment-total>
  <proposal-id type="integer" nil="true"></proposal-id>
  <proposal-template-id type="integer">1</proposal-template-id>
  <reference-name-number>invoice 1</reference-name-number>
  <sales-tax-amount type="decimal">0.0</sales-tax-amount>
  <sent-at type="datetime">2007-01-01T00:00:00Z</sent-at>
  <sent-to nil="true"></sent-to>
  <show-paypal type="boolean">true</show-paypal>
  <total type="decimal">392.32</total>
  <updated-at type="datetime">2010-03-02T23:11:46Z</updated-at>
</invoice>

Example:

Request: https://{your_business}.lessaccounting.com/invoices/11.xml?invoice[reference_name_number]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Reference name number is too short (minimum is 1 characters)</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/invoices/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the invoice.
reference_name_number String N/A Output This value will be auto-generated if it is omitted.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_template_id Integer N/A Output
header Text N/A Output
first_sent Datetime N/A Output The first datetime that this invoice was sent (or marked as sent).
sent_at Datetime N/A Output The most recent datetime that this invoice was sent.
sent_to Text N/A Output A comma separated list of email addresses that this invoice was sent to. This list is who a receipt will be sent to.
email_heading Text N/A Output
email_subject String N/A Output
proposal_id Integer N/A Output The unique identifier of the Proposal that this invoice was converted from. If this invoice was not converted from a proposal, this value will be nil.
bank_account_id Integer N/A Output The Bank Account that this invoice's Payments should be deposited into by default. Note that the true Bank Account is determined by the Payment items associated with this invoice. This Id is meant to be used as a cached default value.
sales_tax_amount Decimal N/A Output The total sales tax amount applied from the Line Items of this invoice.
sales_tax_percentage Decimal N/A Output The percentage of sales tax applied to this invoice. When an invoice is created, this value is pulled from the Business object, and it is cached here.
total Decimal N/A Output The total of the Line Items.
payment_total Decimal N/A Output The total amount of Payments that have been made so far.
business_id Integer N/A Output The Id of the Business that this invoice is associated with.
contact_id Integer N/A Output The Id of the Contact that this invoice is associated with.
due_on Date N/A Output The due date of the invoice. This defaults to today plus the "default due date" integer value of the Business object.
show_paypal Boolean N/A Output Whether or no to display the paypal button in the emailed invoice. The Business must have a paypal account setup (via the Business object) for this filed to be recognized.

Example:

Request: https://{your_business}.lessaccounting.com/invoices/11.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

sending
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/invoices/1/sending.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
method_of_sending String optional Input How the invoice is sent. Allowed values are: email, email_attachment, pdf_download, none
email_self Boolean optional Input Send a copy of the invoice to the user?
send_to_contact Boolean optional Input Send a copy of the invoice to the contact?

Example:

Request: https://{your_business}.lessaccounting.com/invoices/11/sending.xml?method_of_sending=email&email_self=true&send_to_contact=true&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<hash>
  <message>Invoice sent and recorded as a note.</message>
</hash>

Line Item Methods

All the methods for the Line Item object must be called with the nested resource "proposals." This is true regardless of whether or not the Line Item is associated with a Proposal or an Invoice, the nested resource is to "proposals." Please see the examples.

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/proposals/1/line_items.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the line item.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_id Integer N/A Output The Id of the Proposal or Invoice that this line item is associated with.
unit_price Decimal N/A Output The price of one of this line item.
line Text N/A Output The name of the thing this line item is referring to.
additional_description Text N/A Output Any additional descriptive text to go along with this line item. Some HTML markup is allowed. Textile is supported, see http://hobix.com/textile/ for details.
quantity Decimal N/A Output
position Integer N/A Output The ordinal position of this line item. This is in relation to the other line items.
business_id Integer N/A Output The Id of the business that this line item/invoice/proposal is associated with.
total Decimal N/A Output The total of this line item. It is calculated as the unit_price * quantity.
subtotal Decimal N/A Output The subtotal of this line item.
taxes_total Decimal N/A Output The total taxes of this line item.
sales_tax_ids Array Of Integers N/A Output The sales tax ids that should be applied to this line item.
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<line-items type="array">
  <line-item>
    <additional-description nil="true"></additional-description>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <id type="integer">11</id>
    <line>sdf</line>
    <position type="integer">0</position>
    <proposal-id type="integer">11</proposal-id>
    <quantity type="decimal">1.0</quantity>
    <subtotal type="decimal">392.32</subtotal>
    <taxes-total type="decimal">0.0</taxes-total>
    <total type="decimal">392.32</total>
    <unit-price type="decimal">392.32</unit-price>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
    <sales-tax-ids nil="true"></sales-tax-ids>
  </line-item>
</line-items>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/proposals/1/line_items.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the line item.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_id Integer optional Both The Id of the Proposal or Invoice that this line item is associated with.
unit_price Decimal optional Both The price of one of this line item.
line Text optional Both The name of the thing this line item is referring to.
additional_description Text optional Both Any additional descriptive text to go along with this line item. Some HTML markup is allowed. Textile is supported, see http://hobix.com/textile/ for details.
quantity Decimal optional Both
position Integer optional Both The ordinal position of this line item. This is in relation to the other line items.
business_id Integer N/A Output The Id of the business that this line item/invoice/proposal is associated with.
total Decimal N/A Output The total of this line item. It is calculated as the unit_price * quantity.
subtotal Decimal N/A Output The subtotal of this line item.
taxes_total Decimal N/A Output The total taxes of this line item.
sales_tax_ids Array Of Integers optional Both The sales tax ids that should be applied to this line item.

Example:

Request: https://{your_business}.lessaccounting.com/proposals/1200/line_items/1103.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<line-item>
  <additional-description nil="true"></additional-description>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <id type="integer">1103</id>
  <line>fdsa</line>
  <position type="integer">1</position>
  <proposal-id type="integer">1200</proposal-id>
  <quantity type="decimal">1.0</quantity>
  <subtotal type="decimal">0.0</subtotal>
  <taxes-total type="decimal">0.0</taxes-total>
  <total type="decimal">8.34</total>
  <unit-price type="decimal">8.34</unit-price>
  <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  <sales-tax-ids nil="true"></sales-tax-ids>
  <applied-sales-taxes type="array">
    <applied-sales-tax>
      <amount type="decimal">0.83</amount>
      <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
      <id type="integer">1103</id>
      <line-item-id type="integer">1103</line-item-id>
      <override type="decimal">0.0</override>
      <percentage type="decimal">10.0</percentage>
      <reconciled-on type="date" nil="true"></reconciled-on>
      <sales-tax-id type="integer">1</sales-tax-id>
      <updated-at type="datetime">2010-03-02T23:11:34Z</updated-at>
    </applied-sales-tax>
    <applied-sales-tax>
      <amount type="decimal">0.04</amount>
      <created-at type="datetime">2010-03-02T23:11:34Z</created-at>
      <id type="integer">1104</id>
      <line-item-id type="integer">1103</line-item-id>
      <override type="decimal">0.0</override>
      <percentage type="decimal">5.0</percentage>
      <reconciled-on type="date" nil="true"></reconciled-on>
      <sales-tax-id type="integer">2</sales-tax-id>
      <updated-at type="datetime">2010-03-02T23:11:34Z</updated-at>
    </applied-sales-tax>
  </applied-sales-taxes>
</line-item>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/proposals/1/line_items.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the line item.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_id Integer optional Both The Id of the Proposal or Invoice that this line item is associated with.
unit_price Decimal optional Both The price of one of this line item.
line Text optional Both The name of the thing this line item is referring to.
additional_description Text optional Both Any additional descriptive text to go along with this line item. Some HTML markup is allowed. Textile is supported, see http://hobix.com/textile/ for details.
quantity Decimal optional Both
position Integer optional Both The ordinal position of this line item. This is in relation to the other line items.
business_id Integer N/A Output The Id of the business that this line item/invoice/proposal is associated with.
total Decimal N/A Output The total of this line item. It is calculated as the unit_price * quantity.
subtotal Decimal N/A Output The subtotal of this line item.
taxes_total Decimal N/A Output The total taxes of this line item.
sales_tax_ids Array Of Integers optional Both The sales tax ids that should be applied to this line item.

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items.xml?line_item[unit_price]=non-number&line_item[line]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Line can't be blank</error>
  <error>Unit price is not a number</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items.xml?line_item[unit_price]=7.32&line_item[line]=yo, dis is da ting&line_item[sales_tax_ids]=1,2&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<line-item>
  <additional-description nil="true"></additional-description>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:46Z</created-at>
  <id type="integer">1188</id>
  <line>yo, dis is da ting</line>
  <position type="integer">999</position>
  <proposal-id type="integer">11</proposal-id>
  <quantity type="decimal">1.0</quantity>
  <subtotal type="decimal">7.32</subtotal>
  <taxes-total type="decimal">0.732</taxes-total>
  <total type="decimal">8.052</total>
  <unit-price type="decimal">7.32</unit-price>
  <updated-at type="datetime">2010-03-02T23:11:46Z</updated-at>
  <sales-tax-ids>1,2</sales-tax-ids>
</line-item>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/proposals/1/line_items.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the line item.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_id Integer optional Both The Id of the Proposal or Invoice that this line item is associated with.
unit_price Decimal optional Both The price of one of this line item.
line Text optional Both The name of the thing this line item is referring to.
additional_description Text optional Both Any additional descriptive text to go along with this line item. Some HTML markup is allowed. Textile is supported, see http://hobix.com/textile/ for details.
quantity Decimal optional Both
position Integer optional Both The ordinal position of this line item. This is in relation to the other line items.
business_id Integer N/A Output The Id of the business that this line item/invoice/proposal is associated with.
total Decimal N/A Output The total of this line item. It is calculated as the unit_price * quantity.
subtotal Decimal N/A Output The subtotal of this line item.
taxes_total Decimal N/A Output The total taxes of this line item.
sales_tax_ids Array Of Integers optional Both The sales tax ids that should be applied to this line item.

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items/11.xml?line_item[unit_price]=321.12&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<line-item>
  <additional-description nil="true"></additional-description>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <id type="integer">11</id>
  <line>sdf</line>
  <position type="integer">0</position>
  <proposal-id type="integer">11</proposal-id>
  <quantity type="decimal">1.0</quantity>
  <subtotal type="decimal">321.12</subtotal>
  <taxes-total type="decimal">0.0</taxes-total>
  <total type="decimal">321.12</total>
  <unit-price type="decimal">321.12</unit-price>
  <updated-at type="datetime">2010-03-02T23:11:48Z</updated-at>
  <sales-tax-ids nil="true"></sales-tax-ids>
</line-item>

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items/11.xml?line_item[unit_price]=non-number&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Unit price is not a number</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/proposals/1/line_items.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the line item.
created_at Datetime N/A Output
updated_at Datetime N/A Output
proposal_id Integer N/A Output The Id of the Proposal or Invoice that this line item is associated with.
unit_price Decimal N/A Output The price of one of this line item.
line Text N/A Output The name of the thing this line item is referring to.
additional_description Text N/A Output Any additional descriptive text to go along with this line item. Some HTML markup is allowed. Textile is supported, see http://hobix.com/textile/ for details.
quantity Decimal N/A Output
position Integer N/A Output The ordinal position of this line item. This is in relation to the other line items.
business_id Integer N/A Output The Id of the business that this line item/invoice/proposal is associated with.
total Decimal N/A Output The total of this line item. It is calculated as the unit_price * quantity.
subtotal Decimal N/A Output The subtotal of this line item.
taxes_total Decimal N/A Output The total taxes of this line item.
sales_tax_ids Array Of Integers N/A Output The sales tax ids that should be applied to this line item.

Example:

Request: https://{your_business}.lessaccounting.com/proposals/11/line_items/11.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Note Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/notes.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the note.
created_at Datetime N/A Output
updated_at Datetime N/A Output
business_id Integer N/A Output The Business this note is associated with.
contact_id Integer N/A Output The contact this note is associated with.
body Text N/A Output
is_system Boolean N/A Output Was this note created by the system
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/notes.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<notes type="array">
  <note>
    <body>Proposal sent to allan@speedymediagroup.com, stevenbristol@gmail.com, at 2007-03-04 23:41:02

Proposal:




	<div class="send_header">
<div id="email_heading_preview">
				<p>Hi Allan,</p>

<p>Here is the proposal we talked about. Let me know if you have any questions. Please send <strong>the check</strong> asap, so we can start work. </p>

<p>Thanks!</p>
			</div>
	</div></body>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <id type="integer">7</id>
    <is-system type="boolean">true</is-system>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </note>
  <note>
    <body>Ferrets are freaky.  Mongeese are mean.</body>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">92</contact-id>
    <created-at type="datetime">2007-01-01T00:00:00Z</created-at>
    <id type="integer">8</id>
    <is-system type="boolean">true</is-system>
    <updated-at type="datetime">2007-01-01T00:00:00Z</updated-at>
  </note>
  <note>
    <body>Proposal sent to allan@speedymediagroup.com, stevenbristol@gmail.com, at 2007-03-04 23:41:02

Proposal:




	<div class="send_header">
<div id="email_heading_preview">
				<p>Hi Allan,</p>

<p>Here is the proposal we talked about. Let me know if you have any questions. Please send <strong>the check</strong> asap, so we can start work. </p>

<p>Thanks!</p>
			</div>
	</div></body>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2001-11-01T00:00:00Z</created-at>
    <id type="integer">1</id>
    <is-system type="boolean" nil="true"></is-system>
    <updated-at type="datetime">2001-11-01T00:00:00Z</updated-at>
  </note>
  <note>
    <body>Proposal sent to allan@speedymediagroup.com, stevenbristol@gmail.com, at 2007-03-04 23:41:02

Proposal:




	<div class="send_header">
<div id="email_heading_preview">
				<p>Hi Allan,</p>

<p>Here is the proposal we talked about. Let me know if you have any questions. Please send <strong>the check</strong> asap, so we can start work. </p>

<p>Thanks!</p>
			</div>
	</div></body>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2001-11-01T00:00:00Z</created-at>
    <id type="integer">5</id>
    <is-system type="boolean" nil="true"></is-system>
    <updated-at type="datetime">2001-11-01T00:00:00Z</updated-at>
  </note>
  <note>
    <body>Proposal sent to allan@speedymediagroup.com, stevenbristol@gmail.com, at 2007-03-04 23:41:02

Proposal:




	<div class="send_header">
<div id="email_heading_preview">
				<p>Hi Allan,</p>

<p>Here is the proposal we talked about. Let me know if you have any questions. Please send <strong>the check</strong> asap, so we can start work. </p>

<p>Thanks!</p>
			</div>
	</div></body>
    <business-id type="integer">1</business-id>
    <contact-id type="integer">1</contact-id>
    <created-at type="datetime">2001-11-01T00:00:00Z</created-at>
    <id type="integer">6</id>
    <is-system type="boolean" nil="true"></is-system>
    <updated-at type="datetime">2001-11-01T00:00:00Z</updated-at>
  </note>
</notes>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/notes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the note.
created_at Datetime N/A Output
updated_at Datetime N/A Output
business_id Integer N/A Output The Business this note is associated with.
contact_id Integer optional Both The contact this note is associated with.
body Text optional Both
is_system Boolean N/A Output Was this note created by the system

Example:

Request: https://{your_business}.lessaccounting.com/notes/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<note>
  <body>Proposal sent to allan@speedymediagroup.com, stevenbristol@gmail.com, at 2007-03-04 23:41:02

Proposal:




	<div class="send_header">
<div id="email_heading_preview">
				<p>Hi Allan,</p>

<p>Here is the proposal we talked about. Let me know if you have any questions. Please send <strong>the check</strong> asap, so we can start work. </p>

<p>Thanks!</p>
			</div>
	</div></body>
  <business-id type="integer">1</business-id>
  <contact-id type="integer">1</contact-id>
  <created-at type="datetime">2001-11-01T00:00:00Z</created-at>
  <id type="integer">1</id>
  <is-system type="boolean" nil="true"></is-system>
  <updated-at type="datetime">2001-11-01T00:00:00Z</updated-at>
</note>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/notes.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the note.
created_at Datetime N/A Output
updated_at Datetime N/A Output
business_id Integer N/A Output The Business this note is associated with.
contact_id Integer optional Both The contact this note is associated with.
body Text optional Both
is_system Boolean N/A Output Was this note created by the system

Example:

Request: https://{your_business}.lessaccounting.com/notes.xml?note[body]=note¬e[contact_id]=1&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<note>
  <body>note</body>
  <business-id type="integer">1</business-id>
  <contact-id type="integer">1</contact-id>
  <created-at type="datetime">2010-03-02T23:11:48Z</created-at>
  <id type="integer">52</id>
  <is-system type="boolean" nil="true"></is-system>
  <updated-at type="datetime">2010-03-02T23:11:48Z</updated-at>
</note>

Example:

Request: https://{your_business}.lessaccounting.com/notes.xml?note[body]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Body can't be blank</error>
</errors>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/notes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the note.
created_at Datetime N/A Output
updated_at Datetime N/A Output
business_id Integer N/A Output The Business this note is associated with.
contact_id Integer optional Both The contact this note is associated with.
body Text optional Both
is_system Boolean N/A Output Was this note created by the system

Example:

Request: https://{your_business}.lessaccounting.com/notes/1.xml?note[body]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Body can't be blank</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/notes/1.xml?note[body]=note&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<note>
  <body>note</body>
  <business-id type="integer">1</business-id>
  <contact-id type="integer">1</contact-id>
  <created-at type="datetime">2001-11-01T00:00:00Z</created-at>
  <id type="integer">1</id>
  <is-system type="boolean" nil="true"></is-system>
  <updated-at type="datetime">2010-03-02T23:11:49Z</updated-at>
</note>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/notes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the note.
created_at Datetime N/A Output
updated_at Datetime N/A Output
business_id Integer N/A Output The Business this note is associated with.
contact_id Integer N/A Output The contact this note is associated with.
body Text N/A Output
is_system Boolean N/A Output Was this note created by the system

Example:

Request: https://{your_business}.lessaccounting.com/notes/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Payment Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/payments.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the payment.
created_at Datetime N/A Output
updated_at Datetime N/A Output
amount Decimal N/A Output
invoice_id Integer N/A Output The Invoice this payment is associated with.
bank_account_id Integer N/A Output The Bank Account that this payment is associated with.
date Date N/A Output The date this payment was deposited.
business_id Integer N/A Output The Business this payment is associated with.
notes Text N/A Output
is_paid Boolean N/A Output
expense_category_id Integer N/A Output The Expense Category this payment is associated with.
is_other_income Boolean N/A Output Is this payment from Other Income? This is not set directly.
is_interest_income Boolean N/A Output Is this payment from Interest Income? This is not set directly.
is_regular_income Boolean N/A Output Is this payment from Regular Income, like and invoice? This is not set directly.
is_expense Boolean N/A Output Is this payment a refund from an Expense? This is not set directly.
is_transfer Boolean N/A Output The Transfer Fund that this payment is associated with.
payment_type String N/A Output The string describing the type of payment this payment is. Allowed values are "expense refund," "regular income," "interest income" or "other income." The proper boolean flag is set automatically based on this string value.
q String optional Input The query to use in search.
page Integer optional Input The page of the search results to return. Default is 1. The number of items per page is 25.

Example:

Request: https://{your_business}.lessaccounting.com/payments.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<payments type="array">
  <payment>
    <amount type="decimal">10.0</amount>
    <bank-account-id type="integer">1</bank-account-id>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <date type="date">2007-01-01</date>
    <expense-category-id type="integer" nil="true"></expense-category-id>
    <id type="integer">1</id>
    <invoice-id type="integer">11</invoice-id>
    <is-expense type="boolean" nil="true"></is-expense>
    <is-interest-income type="boolean" nil="true"></is-interest-income>
    <is-other-income type="boolean" nil="true"></is-other-income>
    <is-paid type="boolean" nil="true"></is-paid>
    <is-regular-income type="boolean">true</is-regular-income>
    <is-transfer type="boolean" nil="true"></is-transfer>
    <notes nil="true"></notes>
    <payment-type>Regular Income</payment-type>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  </payment>
  <payment>
    <amount type="decimal">85.24</amount>
    <bank-account-id type="integer" nil="true"></bank-account-id>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <date type="date">2007-01-01</date>
    <expense-category-id type="integer" nil="true"></expense-category-id>
    <id type="integer">100</id>
    <invoice-id type="integer" nil="true"></invoice-id>
    <is-expense type="boolean" nil="true"></is-expense>
    <is-interest-income type="boolean" nil="true"></is-interest-income>
    <is-other-income type="boolean">true</is-other-income>
    <is-paid type="boolean" nil="true"></is-paid>
    <is-regular-income type="boolean" nil="true"></is-regular-income>
    <is-transfer type="boolean" nil="true"></is-transfer>
    <notes nil="true"></notes>
    <payment-type>Other Income</payment-type>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  </payment>
  <payment>
    <amount type="decimal">1000.0</amount>
    <bank-account-id type="integer">101</bank-account-id>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <date type="date">2007-01-01</date>
    <expense-category-id type="integer" nil="true"></expense-category-id>
    <id type="integer">101</id>
    <invoice-id type="integer" nil="true"></invoice-id>
    <is-expense type="boolean" nil="true"></is-expense>
    <is-interest-income type="boolean" nil="true"></is-interest-income>
    <is-other-income type="boolean" nil="true"></is-other-income>
    <is-paid type="boolean" nil="true"></is-paid>
    <is-regular-income type="boolean" nil="true"></is-regular-income>
    <is-transfer type="boolean">true</is-transfer>
    <notes nil="true"></notes>
    <payment-type>Transfer Funds</payment-type>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  </payment>
</payments>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/payments/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the payment.
created_at Datetime N/A Output
updated_at Datetime N/A Output
amount Decimal required Both
invoice_id Integer optional Both The Invoice this payment is associated with.
bank_account_id Integer optional Both The Bank Account that this payment is associated with.
date Date optional Both The date this payment was deposited.
business_id Integer N/A Output The Business this payment is associated with.
notes Text optional Both
is_paid Boolean optional Both
expense_category_id Integer optional Both The Expense Category this payment is associated with.
is_other_income Boolean N/A Output Is this payment from Other Income? This is not set directly.
is_interest_income Boolean N/A Output Is this payment from Interest Income? This is not set directly.
is_regular_income Boolean N/A Output Is this payment from Regular Income, like and invoice? This is not set directly.
is_expense Boolean N/A Output Is this payment a refund from an Expense? This is not set directly.
is_transfer Boolean optional Both The Transfer Fund that this payment is associated with.
payment_type String required Both The string describing the type of payment this payment is. Allowed values are "expense refund," "regular income," "interest income" or "other income." The proper boolean flag is set automatically based on this string value.

Example:

Request: https://{your_business}.lessaccounting.com/payments/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<payment>
  <amount type="decimal">10.0</amount>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <date type="date">2007-01-01</date>
  <expense-category-id type="integer" nil="true"></expense-category-id>
  <id type="integer">1</id>
  <invoice-id type="integer">11</invoice-id>
  <is-expense type="boolean" nil="true"></is-expense>
  <is-interest-income type="boolean" nil="true"></is-interest-income>
  <is-other-income type="boolean" nil="true"></is-other-income>
  <is-paid type="boolean" nil="true"></is-paid>
  <is-regular-income type="boolean">true</is-regular-income>
  <is-transfer type="boolean" nil="true"></is-transfer>
  <notes nil="true"></notes>
  <payment-type>Regular Income</payment-type>
  <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
</payment>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/payments.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the payment.
created_at Datetime N/A Output
updated_at Datetime N/A Output
amount Decimal required Both
invoice_id Integer optional Both The Invoice this payment is associated with.
bank_account_id Integer optional Both The Bank Account that this payment is associated with.
date Date optional Both The date this payment was deposited.
business_id Integer N/A Output The Business this payment is associated with.
notes Text optional Both
is_paid Boolean optional Both
expense_category_id Integer optional Both The Expense Category this payment is associated with.
is_other_income Boolean N/A Output Is this payment from Other Income? This is not set directly.
is_interest_income Boolean N/A Output Is this payment from Interest Income? This is not set directly.
is_regular_income Boolean N/A Output Is this payment from Regular Income, like and invoice? This is not set directly.
is_expense Boolean N/A Output Is this payment a refund from an Expense? This is not set directly.
is_transfer Boolean optional Both The Transfer Fund that this payment is associated with.
payment_type String required Both The string describing the type of payment this payment is. Allowed values are "expense refund," "regular income," "interest income" or "other income." The proper boolean flag is set automatically based on this string value.

Example:

Request: https://{your_business}.lessaccounting.com/payments.xml?payment[amount]=&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Amount is not a number</error>
  <error>Date may not be blank</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/payments.xml?payment[amount]=10.12&payment[date]=2008-01-01&payment[payment_type]=regular%20income&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<payment>
  <amount type="decimal">10.12</amount>
  <bank-account-id type="integer" nil="true"></bank-account-id>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:49Z</created-at>
  <date type="date">2008-01-01</date>
  <expense-category-id type="integer" nil="true"></expense-category-id>
  <id type="integer">212</id>
  <invoice-id type="integer" nil="true"></invoice-id>
  <is-expense type="boolean">false</is-expense>
  <is-interest-income type="boolean">false</is-interest-income>
  <is-other-income type="boolean">false</is-other-income>
  <is-paid type="boolean" nil="true"></is-paid>
  <is-regular-income type="boolean">true</is-regular-income>
  <is-transfer type="boolean">false</is-transfer>
  <notes nil="true"></notes>
  <payment-type>Regular Income</payment-type>
  <updated-at type="datetime">2010-03-02T23:11:49Z</updated-at>
</payment>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/payments/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the payment.
created_at Datetime N/A Output
updated_at Datetime N/A Output
amount Decimal required Both
invoice_id Integer optional Both The Invoice this payment is associated with.
bank_account_id Integer optional Both The Bank Account that this payment is associated with.
date Date optional Both The date this payment was deposited.
business_id Integer N/A Output The Business this payment is associated with.
notes Text optional Both
is_paid Boolean optional Both
expense_category_id Integer optional Both The Expense Category this payment is associated with.
is_other_income Boolean N/A Output Is this payment from Other Income? This is not set directly.
is_interest_income Boolean N/A Output Is this payment from Interest Income? This is not set directly.
is_regular_income Boolean N/A Output Is this payment from Regular Income, like and invoice? This is not set directly.
is_expense Boolean N/A Output Is this payment a refund from an Expense? This is not set directly.
is_transfer Boolean optional Both The Transfer Fund that this payment is associated with.
payment_type String required Both The string describing the type of payment this payment is. Allowed values are "expense refund," "regular income," "interest income" or "other income." The proper boolean flag is set automatically based on this string value.

Example:

Request: https://{your_business}.lessaccounting.com/payments/1.xml?payment[amount]=15.83&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<payment>
  <amount type="decimal">15.83</amount>
  <bank-account-id type="integer">1</bank-account-id>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <date type="date">2007-01-01</date>
  <expense-category-id type="integer" nil="true"></expense-category-id>
  <id type="integer">1</id>
  <invoice-id type="integer" nil="true"></invoice-id>
  <is-expense type="boolean">false</is-expense>
  <is-interest-income type="boolean">false</is-interest-income>
  <is-other-income type="boolean">false</is-other-income>
  <is-paid type="boolean" nil="true"></is-paid>
  <is-regular-income type="boolean">true</is-regular-income>
  <is-transfer type="boolean">false</is-transfer>
  <notes nil="true"></notes>
  <payment-type>Regular Income</payment-type>
  <updated-at type="datetime">2010-03-02T23:11:50Z</updated-at>
</payment>

Example:

Request: https://{your_business}.lessaccounting.com/payments/1.xml?payment[amount]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Amount is not a number</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/payments/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the payment.
created_at Datetime N/A Output
updated_at Datetime N/A Output
amount Decimal N/A Output
invoice_id Integer N/A Output The Invoice this payment is associated with.
bank_account_id Integer N/A Output The Bank Account that this payment is associated with.
date Date N/A Output The date this payment was deposited.
business_id Integer N/A Output The Business this payment is associated with.
notes Text N/A Output
is_paid Boolean N/A Output
expense_category_id Integer N/A Output The Expense Category this payment is associated with.
is_other_income Boolean N/A Output Is this payment from Other Income? This is not set directly.
is_interest_income Boolean N/A Output Is this payment from Interest Income? This is not set directly.
is_regular_income Boolean N/A Output Is this payment from Regular Income, like and invoice? This is not set directly.
is_expense Boolean N/A Output Is this payment a refund from an Expense? This is not set directly.
is_transfer Boolean N/A Output The Transfer Fund that this payment is associated with.
payment_type String N/A Output The string describing the type of payment this payment is. Allowed values are "expense refund," "regular income," "interest income" or "other income." The proper boolean flag is set automatically based on this string value.

Example:

Request: https://{your_business}.lessaccounting.com/payments/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:

Sales Tax Methods

index
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/sales_taxes.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the sales tax.
created_at Datetime N/A Output
updated_at Datetime N/A Output
percentage Decimal N/A Output
business_id Integer N/A Output The Business this sales tax is associated with.
name Text N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<sales-taxes type="array">
  <sales-tax>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <id type="integer">1</id>
    <name>s tax 10</name>
    <percentage type="decimal">10.0</percentage>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  </sales-tax>
  <sales-tax>
    <business-id type="integer">1</business-id>
    <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
    <id type="integer">2</id>
    <name>s tax 5</name>
    <percentage type="decimal">5.0</percentage>
    <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
  </sales-tax>
</sales-taxes>

show
HTTP Verb/URL: GET https://<business_name>.lessaccounting.com/sales_taxes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the sales tax.
created_at Datetime N/A Output
updated_at Datetime N/A Output
percentage Decimal required Both
business_id Integer N/A Output The Business this sales tax is associated with.
name Text optional Both

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes/1.xml?api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<sales-tax>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <id type="integer">1</id>
  <name>s tax 10</name>
  <percentage type="decimal">10.0</percentage>
  <updated-at type="datetime">2010-03-02T23:11:35Z</updated-at>
</sales-tax>

create
HTTP Verb/URL: POST https://<business_name>.lessaccounting.com/sales_taxes.xml
Business sub-domain required in url: true
Id parameter required in url: false
API Key (api_key) parameter required: true
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the sales tax.
created_at Datetime N/A Output
updated_at Datetime N/A Output
percentage Decimal required Both
business_id Integer N/A Output The Business this sales tax is associated with.
name Text optional Both

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes.xml?sales_tax[percentage]=asdf&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Percentage is not a number</error>
</errors>

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes.xml?sales_tax[percentage]=10.12&sales_tax[name]=sales%20tax&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<sales-tax>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:51Z</created-at>
  <id type="integer">281</id>
  <name>sales tax</name>
  <percentage type="decimal">10.12</percentage>
  <updated-at type="datetime">2010-03-02T23:11:51Z</updated-at>
</sales-tax>

update
HTTP Verb/URL: PUT https://<business_name>.lessaccounting.com/sales_taxes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'put'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the sales tax.
created_at Datetime N/A Output
updated_at Datetime N/A Output
percentage Decimal required Both
business_id Integer N/A Output The Business this sales tax is associated with.
name Text optional Both

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes/1.xml?sales_tax[percentage]=15.83&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<sales-tax>
  <business-id type="integer">1</business-id>
  <created-at type="datetime">2010-03-02T23:11:35Z</created-at>
  <id type="integer">1</id>
  <name>s tax 10</name>
  <percentage type="decimal">15.83</percentage>
  <updated-at type="datetime">2010-03-02T23:11:52Z</updated-at>
</sales-tax>

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes/1.xml?sales_tax[percentage]=&_method=put&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response: 
  <?xml version="1.0" encoding="UTF-8"?>
<errors>
  <error>Percentage is not a number</error>
</errors>

destroy
HTTP Verb/URL: DELETE https://<business_name>.lessaccounting.com/sales_taxes/1.xml
Business sub-domain required in url: true
Id parameter required in url: true
API Key (api_key) parameter required: true
_method Must be supplied as: 'delete'
Parameter Data Type Required Input/Output param Description
id Integer N/A Output The unique identifier of the sales tax.
created_at Datetime N/A Output
updated_at Datetime N/A Output
percentage Decimal N/A Output
business_id Integer N/A Output The Business this sales tax is associated with.
name Text N/A Output

Example:

Request: https://{your_business}.lessaccounting.com/sales_taxes/1.xml?_method=delete&api_key=89341988-6b36-4128-b3d5-deab427132a7
Response:
LessAccounting © 2010, accounting software developed by Less Everything
About Us Sign-up Login Privacy Policy Terms of Service Developers Site Map Company Blog
Powered by Olark
Powered by Olark