XML API v1.1

Build against the documented method surface.

All 78 XML v1.1 methods, each with its request fields, required flags, accepted values, a full request and response example and the error messages it returns.

Browse API calls API overview

Request contractXML v1.1

Method: POST
Endpoint: https://api.invoicera.com/xml/1.1/
Authentication: HTTP Basic authentication; API token as username
Payload field: xml_request
First call: getAccountInfo

Use a server-side integration. Never expose an account token in browser code or a public repository.

Reference status

The Invoicera XML API v1.1 reference documents 78 methods in 11 groups, 622 request fields and 221 error messages. Each method lists its request fields, required flags, accepted values, a full request and response example and its errors. OAuth scopes, JSON payloads and REST calls are not part of this interface.

Reviewed 29 September 2026

Getting started

Complete one read path before writing billing data.

The interface accepts one XML request per HTTPS POST. Start with getAccountInfo, retain the Invoicera identifiers that later calls return, then test one create-and-read workflow in a non-production data set.

01
Find the token
The account owner finds the API token in Invoicera under My Account, on the Invoicera API tab. Keep it in a server-side secret store.
02
Post the XML envelope
Send the token as the HTTP Basic username and the XML document in the xml_request form field.
03
Read the XML status
Parse the status attribute on the root response element before reading identifiers, records or paging attributes.
04
Reconcile every write
Read the created or updated record back, record its Invoicera identifier and prevent retries from creating duplicate commercial records.

First request

<?xml version="1.0" encoding="utf-8"?>
<request method="getAccountInfo">
</request>

First response

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <account>
    <company>[COMPANY_NAME]</company>
    <name>[ACCOUNT_OWNER_NAME]</name>
    <country_code>USA</country_code>
    <currency_code>USD</currency_code>
  </account>
</response>

cURL

curl --request POST \
  --user "$INVOICERA_API_TOKEN:X" \
  --data-urlencode 'xml_request=<?xml version="1.0" encoding="utf-8"?><request method="getAccountInfo"></request>' \
  https://api.invoicera.com/xml/1.1/

Sample PHP request

<?php
$token = getenv('INVOICERA_API_TOKEN');
$xml = '<?xml version="1.0" encoding="utf-8"?>'
     . '<request method="listClient"><filter><page>1</page><per_page_record>10</per_page_record></filter></request>';

$ch = curl_init('https://api.invoicera.com/xml/1.1/');
curl_setopt_array($ch, [
    CURLOPT_USERPWD        => $token . ':X',
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => http_build_query(['xml_request' => $xml]),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 60,
]);
$body = curl_exec($ch);
curl_close($ch);

$response = simplexml_load_string($body);
if ((string) $response['status'] !== '200') {
    // handle the error message in (string) $response
}

Certificate checks stay on, the body is URL-encoded and the token is read from the environment.

Conventions

Rules that apply to every method.

Dates, numbers, codes, paging, empty elements and identifiers work the same way across the interface. Read these once before using the method tables below.

Endpoint and version

The API has one entry point: https://api.invoicera.com/xml/1.1/.

The version, 1.1, is part of the path. This reference covers version 1.1 only.

Send every request over HTTPS. Never send your token over plain HTTP.

Authentication

Each request carries your API token in the HTTP Authorization header, using Basic authentication.

Use the token as the username. Only the token is checked: send any short value as the password, such as X.

The account owner finds the token in Invoicera under My Account, on the Invoicera API tab.

Changing the account password resets the token. Update the token in your integration after a password change.

Keep the token on your server. Do not put it in browser code, mobile apps, URLs, logs or source control.

Request format

Send an HTTP POST with a form-encoded body. Put the XML document in a field named xml_request.

Send one method per request. The method name goes in the method attribute of the root <request> element and is case-sensitive.

Start the document with <?xml version="1.0" encoding="utf-8"?>.

Escape &, < and > inside values (&, <, >). A document that does not parse is rejected with status 400.

Responses and status

Every response is an XML document with a root <response> element.

Read the status attribute on <response>, not the HTTP status line. A status of 200 means the call worked.

Other status values carry a short message as the element text, for example <response status="400">Date is invalid.</response>.

Some calls that handle several records return status 200 with a <failure> list, or status 400 with <invalid> and <success> lists. Check the whole body.

Paging through lists

List methods take page and per_page_record inside <filter>.

page starts at 1. per_page_record accepts 1 to 100 and defaults to 100. A larger value returns 100 records.

The list element carries page, per_page_record and total_pages attributes, and the number of matching records in total_records (total on listClient, listStaff and listExpenseCategory). Keep requesting pages until page equals total_pages.

Dates

Send dates as YYYY-MM-DD, for example 2026-01-15.

Responses return dates as YYYY-MM-DD or as date and time, YYYY-MM-DD HH:MM:SS.

Amounts and quantities

Send amounts, rates, quantities and percentages as plain numbers with up to two decimal places, for example 1250.50.

Do not include currency symbols or thousands separators.

Currency, country and language codes

currency and currency_code take a three-letter currency code, such as USD or GBP.

country takes the country code Invoicera stores, as in the old example USA.

language takes one of en, po, fr, de, ru, dt, it, sp, swd, por, ind or cro.

When createClient leaves out country or currency, your account's country and base currency are used.

Empty and missing elements

An empty element, such as <discount></discount>, is treated as not supplied and takes the default.

On line items, send every element shown in the method's example, even if empty. Several methods reject a line that leaves out <type>, <discount> or <discount_type>.

Identifiers

Use the identifiers Invoicera returns, such as client_id and invoice_id. Do not use display numbers in their place.

Delete and send methods accept the identifier element more than once, to act on several records in one request.

Limits

This reference does not publish a fixed request limit. Some plans limit how many invoices and clients can be created, or invoices sent, each day or in total. Ask Invoicera for the allowance on your account before planning bulk imports.

First call

Start with getAccountInfo. It needs no fields and returns your company name, country and currency, so it proves the token works without touching billing records.

Status codes

Branch on the XML status, then retain the message safely.

The result of a call is carried in the status attribute of the XML response. Do not treat an HTTP 200 response as proof that the requested billing operation succeeded. Each method below lists the messages it can return.

XML API response status codes
Status	Meaning
`200`	The call worked.
`400`	The request was not valid: no token, XML that does not parse, or a field that failed a check. The message says which.
`401`	The account linked to the token is not active.
`403`	The token is not recognised, the plan does not include API access, or the record belongs to another account. Also returned as Authentication failed when HTTP authentication fails.
`404`	No record matched. List calls return this when nothing matches the filter.
`426`	Your plan limit for this kind of record has been reached.
`500`	Invoicera could not complete the request.
`501`	The method name is not recognised.

Do not display raw server errors to end users or log account tokens, complete XML documents, client addresses, invoice notes or other commercial data.

Method index

Choose the resource, then the smallest required operation.

Begin with one end-to-end record path. Test the response, duplicate protection, retry behaviour and reconciliation before adding another resource. The methods act on the same records your team manages in Invoicera invoicing.

Call reference

Every method, field and response.

Open a method to see its fields and examples. Required means the element must be sent; where a description says an element may be empty, send it empty to take the default. Values in [SQUARE_BRACKETS] are placeholders for your own data.

Invoices

9 methods

createInvoice

Create an invoice with its line items. Returns the new invoice_id.

TransportPOST, xml_request

Request fields37

Required3

Creating an invoice does not email it. Use sendInvoiceMail to send it.
status accepts draft, sent, viewed or paid. Any other value, or no value, saves the invoice as a draft.
Line items, extra charges and custom fields are optional. Repeat <item> for each line.

Request fields

createInvoice request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`invoice_title`	string	No	Title shown on the invoice.
`number`	string	No	Document number shown on the invoice. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Document date. Defaults to today when left out.
`due_date`	date (YYYY-MM-DD)	No	Date payment is due.
`late_fee`	integer (Invoicera identifier)	No	Identifier of an active late-fee rule. Get it from listLateFee. Leave empty for no late fee.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Document status. See allowed values.	`draft` `sent` `viewed` `paid`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	No	How discount is applied: Percent or Fixed. An empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_type`	string	No	Type of the first tax. Only Normal is accepted. Defaults to Normal.	`Normal`
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.
`items/item/tax2_type`	string	No	Type of the second tax: Normal or Compound. Compound applies the second tax on top of the first. Defaults to Normal.	`Normal` `Compound`
`additional_charges`	element	No	Container for one or more extra charges, such as shipping.
`additional_charges/additional_charge`	element · repeatable	No	One extra charge.
`additional_charges/additional_charge/name`	string	No	Name of the charge, for example Shipping.
`additional_charges/additional_charge/type`	string	No	How amount is applied: Percent or Fixed. Defaults to Percent.	`Percent` `Fixed`
`additional_charges/additional_charge/amount`	decimal (up to 2 decimal places)	No	Charge value, read as a percentage or a fixed amount depending on type.
`custom_fields`	element	No	Container for up to four custom fields.
`custom_fields/custom_field`	element · repeatable	No	One custom field.
`custom_fields/custom_field/label`	string	No	Custom field label.
`custom_fields/custom_field/value`	string	No	Custom field value.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createInvoice">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <invoice_title>[INVOICE_TITLE]</invoice_title>
  <number></number>
  <date>2026-01-15</date>
  <due_date>2026-02-14</due_date>
  <late_fee></late_fee>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_type>Normal</tax1_type>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
      <tax2_type></tax2_type>
    </item>
  </items>
  <additional_charges>
    <additional_charge>
      <name>Shipping</name>
      <type>Fixed</type>
      <amount>10.00</amount>
    </additional_charge>
  </additional_charges>
  <custom_fields>
    <custom_field>
      <label>[CUSTOM_FIELD_LABEL]</label>
      <value>[CUSTOM_FIELD_VALUE]</value>
    </custom_field>
  </custom_fields>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

createInvoice response fields
Path	Description
`invoice_id`	Identifier of the new invoice.

Errors

createInvoice error messages
Status	Message	When
`400`	`Client id is not exists.`	client_id does not belong to your account.
`400`	`Date is invalid.`	A date is not a real date in YYYY-MM-DD form.
`400`	`Due Date is invalid.`	due_date is not a valid date.
`400`	`Late Fee is invalid or inactive.`	late_fee is not an active late-fee identifier.
`400`	`Schedule Date is invalid.`	schedule_date is not a valid date.
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Tax1 type is invalid.`	tax1_type is not Normal.
`400`	`Tax2 type is invalid.`	tax2_type is not Normal or Compound.

updateInvoice

Replace the details of an existing invoice. Returns the invoice_id.

TransportPOST, xml_request

Request fields34

Required5

This call replaces the whole invoice. The existing lines, extra charges and custom field values are removed, and the lines and charges you send are saved in their place. Send the complete invoice every time.
To change one line without resending the invoice, use updateInvoiceItem.

Request fields

updateInvoice request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier)	Yes	Invoice identifier returned by createInvoice or listInvoice.
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`invoice_title`	string	No	Title shown on the invoice.
`number`	string	No	Document number shown on the invoice. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Invoice date.
`due_date`	date (YYYY-MM-DD)	No	Date payment is due.
`late_fee`	integer (Invoicera identifier)	No	Identifier of an active late-fee rule. Get it from listLateFee. Leave empty for no late fee.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Invoice status. When the request includes lines, any other value saves the invoice as a draft.	`draft` `sent` `paid`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax1_type`	string	No	Type of the first tax. Only Normal is accepted. Defaults to Normal.	`Normal`
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.
`items/item/tax2_type`	string	No	Type of the second tax: Normal or Compound. Compound applies the second tax on top of the first. Defaults to Normal.	`Normal` `Compound`
`additional_charges`	element	No	Container for one or more extra charges, such as shipping.
`additional_charges/additional_charge`	element · repeatable	No	One extra charge.
`additional_charges/additional_charge/name`	string	No	Name of the charge, for example Shipping.
`additional_charges/additional_charge/type`	string	No	How amount is applied: Percent or Fixed. Defaults to Percent.	`Percent` `Fixed`
`additional_charges/additional_charge/amount`	decimal (up to 2 decimal places)	No	Charge value, read as a percentage or a fixed amount depending on type.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateInvoice">
  <invoice_id>[INVOICE_ID]</invoice_id>
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <invoice_title>[INVOICE_TITLE]</invoice_title>
  <number></number>
  <date>2026-01-15</date>
  <due_date>2026-02-14</due_date>
  <late_fee></late_fee>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>sent</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax1_percent>10</tax1_percent>
      <tax1_type>Normal</tax1_type>
      <tax2_name></tax2_name>
      <tax2_percent></tax2_percent>
      <tax2_type></tax2_type>
    </item>
  </items>
  <additional_charges>
    <additional_charge>
      <name>Shipping</name>
      <type>Fixed</type>
      <amount>10.00</amount>
    </additional_charge>
  </additional_charges>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

updateInvoice response fields
Path	Description
`invoice_id`	Identifier of the updated invoice.

Errors

updateInvoice error messages
Status	Message	When
`403`	`Client id is invalid.`	client_id does not belong to your account.
`400`	`Date is invalid.`	A date is not a real date in YYYY-MM-DD form.
`400`	`Due Date is invalid.`	due_date is not a valid date.
`400`	`Late Fee is invalid or inactive.`	late_fee is not an active late-fee identifier.
`400`	`Schedule Date is invalid.`	schedule_date is not a valid date.
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Tax1 type is invalid.`	tax1_type is not Normal.
`400`	`Tax2 type is invalid.`	tax2_type is not Normal or Compound.
`400`	`Invoice id is invalid.`	invoice_id is not an invoice in your account.

deleteInvoice

Delete one or more invoices.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><invoice id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteInvoice request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier) · repeatable	Yes	Invoice to delete. Repeat the element to delete more than one invoice.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteInvoice">
  <invoice_id>[INVOICE_ID]</invoice_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteInvoice response fields
Path	Description
`failure`	Present only when some invoices could not be deleted. Lists their identifiers.

getInvoice

Return one invoice with its lines, extra charges and payments.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getInvoice request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier)	Yes	Invoice to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getInvoice">
  <invoice_id>[INVOICE_ID]</invoice_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice>
    <client>
      <client_id>[CLIENT_ID]</client_id>
      <address>[CLIENT_ADDRESS]</address>
    </client>
    <invoice_title>[INVOICE_TITLE]</invoice_title>
    <number>[INVOICE_NUMBER]</number>
    <date>2026-01-15</date>
    <po_number>[PO_NUMBER]</po_number>
    <total_discount>0.00</total_discount>
    <total_tax>10.00</total_tax>
    <net_balance>110.00</net_balance>
    <late_fee>0.00</late_fee>
    <late_fee_id>0</late_fee_id>
    <total_paid>0.00</total_paid>
    <outstanding>110.00</outstanding>
    <invoice_status>Draft</invoice_status>
    <status>Active</status>
    <invoice_due_date>2026-02-14</invoice_due_date>
    <invoice_schedule_date></invoice_schedule_date>
    <notes>[NOTES]</notes>
    <terms>[TERMS]</terms>
    <currency>USD</currency>
    <items>
      <item>
        <item_id>[INVOICE_ITEM_ID]</item_id>
        <type>Services</type>
        <name>[ITEM_NAME]</name>
        <description>[ITEM_DESCRIPTION]</description>
        <unit_cost>50.00</unit_cost>
        <quantity>2.00</quantity>
        <discount></discount>
        <discount_type>Percent</discount_type>
        <tax1_name>[TAX_NAME]</tax1_name>
        <tax1_percent>10</tax1_percent>
        <tax1_type>Normal</tax1_type>
        <tax2_name></tax2_name>
        <tax2_percent></tax2_percent>
        <tax2_type></tax2_type>
      </item>
    </items>
    <additional_charges>
      <charge>
        <name>[CHARGE_NAME]</name>
        <type>Fixed</type>
        <amount>0.00</amount>
      </charge>
    </additional_charges>
    <transactions>
      <transaction>
        <method>[PAYMENT_METHOD]</method>
        <notes>[PAYMENT_NOTES]</notes>
        <amount>0.00</amount>
        <date>2026-01-20</date>
      </transaction>
    </transactions>
  </invoice>
</response>

Response fields

getInvoice response fields
Path	Description
`invoice/client`	Client identifier and billing address.
`invoice/number`	Invoice number.
`invoice/date`	Invoice date.
`invoice/total_discount`	Total discount.
`invoice/total_tax`	Total tax.
`invoice/net_balance`	Invoice total after discounts and taxes.
`invoice/late_fee`	Late fee charged.
`invoice/late_fee_id`	Late-fee rule applied, or 0.
`invoice/total_paid`	Amount paid so far.
`invoice/outstanding`	Amount still due.
`invoice/invoice_status`	Commercial status, for example Draft, Sent, Viewed, Paid or Partial-Paid.
`invoice/status`	Record status: Active, Archived or Cancel.
`invoice/invoice_due_date`	Due date.
`invoice/currency`	Currency code.
`invoice/items/item`	One entry per line. Line type is returned as Products or Services.
`invoice/additional_charges/charge`	One entry per extra charge.
`invoice/transactions/transaction`	One entry per recorded payment.

Errors

getInvoice error messages
Status	Message	When
`400`	`Invoice id is invalid.`	The invoice does not exist in your account.

listInvoice

Return a page of invoices, newest invoice number first by default.

TransportPOST, xml_request

Request fields11

Required0

All filters are optional. With no filter, active invoices are returned.
The response root carries paging attributes: page, per_page_record, total_pages and total_records.

Request fields

listInvoice request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/date_from`	date (YYYY-MM-DD)	No	Return only records dated on or after this date.
`filter/date_to`	date (YYYY-MM-DD)	No	Return only records dated on or before this date.
`filter/invoice_number`	string	No	Return only the invoice with this exact number.
`filter/invoice_record_status`	string	No	Record status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Cancel`
`filter/invoice_status`	string	No	Invoice status to return. See allowed values.	`Draft` `Sent` `Viewed` `Outstanding` `Paid` `Unpaid` `Disputed` `Auto-Paid` `Retry` `Failed` `Resolved` `Auto-Failed` `Partial-Paid`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.
`filter/sort_column`	string	No	Column to sort by. See allowed values.	`number` `date` `invoice_id` `organization`
`filter/sort_order`	string	No	Sort direction: asc or desc. Defaults to desc.	`asc` `desc`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listInvoice">
  <filter>
    <client_id></client_id>
    <date_from></date_from>
    <date_to></date_to>
    <invoice_number></invoice_number>
    <invoice_record_status></invoice_record_status>
    <invoice_status></invoice_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
    <sort_column>number</sort_column>
    <sort_order>desc</sort_order>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoices page="1" per_page_record="100" total_pages="1" total_records="1">
    <invoice>
      <!-- one invoice record -->
    </invoice>
  </invoices>
</response>

Response fields

listInvoice response fields
Path	Description
`invoices@page`	Page returned.
`invoices@per_page_record`	Records per page.
`invoices@total_pages`	Number of pages.
`invoices@total_records`	Number of matching invoices.
`invoices/invoice`	One entry per invoice.

Errors

listInvoice error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

sendInvoiceMail

Email one or more invoices to the client, with a PDF copy. Each invoice is marked as sent.

TransportPOST, xml_request

Request fields1

Required1

If some invoices cannot be sent, the response is status 400 with an <invalid> list and a <success> list. Check both.

Request fields

sendInvoiceMail request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier) · repeatable	Yes	Invoice to email. Repeat the element to send more than one invoice.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="sendInvoiceMail">
  <invoice_id>[INVOICE_ID]</invoice_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

sendInvoiceMail response fields
Path	Description
`invoice_id`	Each invoice that was sent.

Errors

sendInvoiceMail error messages
Status	Message	When
`400`	Message varies	One or more invoices could not be sent. The response lists them in <invalid> and the sent ones in <success>.
`400`	`Invalid data.`	No invoice identifier was supplied.

addInvoiceItem

Add one or more lines to an existing invoice. Returns the new line identifiers.

TransportPOST, xml_request

Request fields14

Required5

Request fields

addInvoiceItem request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier)	Yes	Invoice identifier returned by createInvoice or listInvoice.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="addInvoiceItem">
  <invoice_id>[INVOICE_ID]</invoice_id>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
  <invoice_items>
    <invoice_item_id>[INVOICE_ITEM_ID]</invoice_item_id>
  </invoice_items>
</response>

Response fields

addInvoiceItem response fields
Path	Description
`invoice_id`	Invoice the lines were added to.
`invoice_items/invoice_item_id`	One identifier per new line. Keep it for later updates.

Errors

addInvoiceItem error messages
Status	Message	When
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

updateInvoiceItem

Change one or more existing lines on an invoice.

TransportPOST, xml_request

Request fields15

Required6

Request fields

updateInvoiceItem request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier)	Yes	Invoice identifier returned by createInvoice or listInvoice.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/invoice_item_id`	integer (Invoicera identifier)	Yes	Identifier of the invoice line to change. Returned by addInvoiceItem and getInvoice.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateInvoiceItem">
  <invoice_id>[INVOICE_ID]</invoice_id>
  <items>
    <item>
      <invoice_item_id>[INVOICE_ITEM_ID]</invoice_item_id>
      <type>Service</type>
      <name>[ITEM_NAME]</name>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateInvoiceItem error messages
Status	Message	When
`400`	`Invoice item is invalid.`	invoice_item_id does not belong to the invoice.
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

deleteInvoiceItem

Delete a line from an invoice.

TransportPOST, xml_request

Request fields2

Required2

Request fields

deleteInvoiceItem request fields
Path	Type	Required	Description	Accepted values
`invoice_id`	integer (Invoicera identifier) · repeatable	Yes	Invoice identifier returned by createInvoice or listInvoice.
`invoice_item_id`	integer (Invoicera identifier) · repeatable	Yes	Identifier of the invoice line to delete.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteInvoiceItem">
  <invoice_id>[INVOICE_ID]</invoice_id>
  <invoice_item_id>[INVOICE_ITEM_ID]</invoice_item_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Estimates

9 methods

createEstimate

Create an estimate with its line items. Returns the new estimate_id.

TransportPOST, xml_request

Request fields24

Required4

Creating an estimate does not email it. Use sendEstimateMail to send it.

Request fields

createEstimate request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`estimate_title`	string	No	Title shown on the estimate.
`number`	string	No	Estimate number. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Document date. Defaults to today when left out.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Estimate status. The value is saved as you send it and is not checked, so send one of the listed values.	`draft` `sent` `viewed`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createEstimate">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <estimate_title>[ESTIMATE_TITLE]</estimate_title>
  <number></number>
  <date>2026-01-15</date>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax1_percent>10</tax1_percent>
      <tax2_name></tax2_name>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
</response>

Response fields

createEstimate response fields
Path	Description
`estimate_id`	Identifier of the new estimate.

Errors

createEstimate error messages
Status	Message	When
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Tax1 type is invalid.`	tax1_type is not Normal.
`400`	`Tax2 type is invalid.`	tax2_type is not Normal or Compound.

updateEstimate

Replace the details of an existing estimate.

TransportPOST, xml_request

Request fields24

Required5

If you send <items>, they replace all the existing lines on the estimate.

Request fields

updateEstimate request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier)	Yes	Estimate identifier returned by createEstimate or listEstimate.
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`number`	string	No	Estimate number. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Estimate date.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Estimate status. The value is saved as you send it and is not checked, so send one of the listed values.	`draft` `sent` `viewed`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateEstimate">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <number></number>
  <date>2026-01-15</date>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax1_percent>10</tax1_percent>
      <tax2_name></tax2_name>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateEstimate error messages
Status	Message	When
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Tax1 type is invalid.`	tax1_type is not Normal.
`400`	`Tax2 type is invalid.`	tax2_type is not Normal or Compound.

deleteEstimate

Delete one or more estimates.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><estimate id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteEstimate request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier) · repeatable	Yes	Estimate to delete. Repeat the element to delete more than one estimate.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteEstimate">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteEstimate response fields
Path	Description
`failure`	Present only when some estimates could not be deleted.

getEstimate

Return one estimate with its lines.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getEstimate request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier)	Yes	Estimate to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getEstimate">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <estimate>
    <client>
      <client_id>[CLIENT_ID]</client_id>
      <organization>[CLIENT_ORGANISATION]</organization>
      <address>[CLIENT_ADDRESS]</address>
    </client>
    <estimate_id>[ESTIMATE_ID]</estimate_id>
    <estimate_status>Draft</estimate_status>
    <estimate_title>[ESTIMATE_TITLE]</estimate_title>
    <number>[ESTIMATE_NUMBER]</number>
    <date>2026-01-15</date>
    <po_number></po_number>
    <total_discount>0.00</total_discount>
    <total_tax>0.00</total_tax>
    <notes></notes>
    <terms></terms>
    <items>
      <item>
        <item_id>[ESTIMATE_ITEM_ID]</item_id>
        <name>[ITEM_NAME]</name>
        <type>Products</type>
        <description>[ITEM_DESCRIPTION]</description>
        <unit_cost>50.00</unit_cost>
        <quantity>1.00</quantity>
        <discount></discount>
        <discount_type>Percent</discount_type>
      </item>
    </items>
  </estimate>
</response>

Response fields

getEstimate response fields
Path	Description
`estimate/client`	Client identifier, organisation and address.
`estimate/estimate_id`	Estimate identifier.
`estimate/estimate_status`	Estimate status.
`estimate/number`	Estimate number.
`estimate/items/item`	One entry per line.

listEstimate

Return a page of estimates. Filter by client, number, status or date.

TransportPOST, xml_request

Request fields10

Required0

All filters are optional.

Request fields

listEstimate request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/date_from`	date (YYYY-MM-DD)	No	Return only records dated on or after this date.
`filter/date_to`	date (YYYY-MM-DD)	No	Return only records dated on or before this date.
`filter/estimate_number`	string	No	Return only the estimate with this number.
`filter/status`	string	No	Estimate status to return, for example Draft or Sent. With no value, active estimates are returned.
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.
`filter/sort_column`	string	No	Column to sort by. See allowed values.	`number` `date` `estimate_id` `organization`
`filter/sort_order`	string	No	Sort direction: asc or desc. Defaults to desc.	`asc` `desc`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listEstimate">
  <filter>
    <client_id></client_id>
    <date_from></date_from>
    <date_to></date_to>
    <estimate_number></estimate_number>
    <status></status>
    <page>1</page>
    <per_page_record>25</per_page_record>
    <sort_column>number</sort_column>
    <sort_order>desc</sort_order>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <estimates page="1" per_page_record="100" total_pages="1" total_records="1">
    <estimate>
      <!-- one estimate record -->
    </estimate>
  </estimates>
</response>

Response fields

listEstimate response fields
Path	Description
`estimates@page`	Page returned.
`estimates@total_records`	Number of matching estimates.
`estimates/estimate`	One entry per estimate.

Errors

listEstimate error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

sendEstimateMail

Email one or more estimates to the client. Each estimate is marked as sent.

TransportPOST, xml_request

Request fields1

Required1

Request fields

sendEstimateMail request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier) · repeatable	Yes	Estimate to email. Repeat the element to send more than one estimate.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="sendEstimateMail">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <success>
    <estimate_id>[ESTIMATE_ID]</estimate_id>
  </success>
</response>

Response fields

sendEstimateMail response fields
Path	Description
`success/estimate_id`	Each estimate that was sent.

addEstimateItem

Add one or more lines to an existing estimate. Returns the new line identifiers.

TransportPOST, xml_request

Request fields14

Required4

Request fields

addEstimateItem request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier)	Yes	Estimate identifier returned by createEstimate or listEstimate.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	No	Line item name.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="addEstimateItem">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
  <estimate_items>
    <estimate_item_id>[ESTIMATE_ITEM_ID]</estimate_item_id>
  </estimate_items>
</response>

Response fields

addEstimateItem response fields
Path	Description
`estimate_items/estimate_item_id`	One identifier per new line.

Errors

addEstimateItem error messages
Status	Message	When
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

updateEstimateItem

Change one or more existing lines on an estimate.

TransportPOST, xml_request

Request fields15

Required5

Request fields

updateEstimateItem request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier)	Yes	Estimate identifier returned by createEstimate or listEstimate.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/estimate_item_id`	integer (Invoicera identifier)	Yes	Identifier of the estimate line to change. Returned by addEstimateItem and getEstimate.
`items/item/name`	string	No	Line item name.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateEstimateItem">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
  <items>
    <item>
      <estimate_item_id>[ESTIMATE_ITEM_ID]</estimate_item_id>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateEstimateItem error messages
Status	Message	When
`400`	`Estimate item is invalid.`	estimate_item_id does not belong to the estimate.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

deleteEstimateItem

Delete a line from an estimate.

TransportPOST, xml_request

Request fields2

Required2

Request fields

deleteEstimateItem request fields
Path	Type	Required	Description	Accepted values
`estimate_id`	integer (Invoicera identifier) · repeatable	Yes	Estimate identifier returned by createEstimate or listEstimate.
`estimate_item_id`	integer (Invoicera identifier) · repeatable	Yes	Identifier of the estimate line to delete.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteEstimateItem">
  <estimate_id>[ESTIMATE_ID]</estimate_id>
  <estimate_item_id>[ESTIMATE_ITEM_ID]</estimate_item_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Recurring invoices

8 methods

createRecurring

Create a recurring invoice profile with its line items. Returns the new recurring_id.

TransportPOST, xml_request

Request fields23

Required2

frequency sets how often an invoice is created. An unrecognised value is saved as 1 Week, so check the value before sending.

Request fields

createRecurring request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`recurring_title`	string	No	Title shown on each invoice the recurring profile creates.
`date`	date (YYYY-MM-DD)	No	Date of the first invoice. Defaults to today.
`po_number`	string	No	Purchase order or reference number shown on the document.
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`frequency`	string	No	How often an invoice is created. See allowed values. An unrecognised value is saved as 1 Week.	`1 Week` `2 Week` `3 Week` `4 Week` `1 Month` `3 Month` `6 Month` `1 Year` `2 Year` `3 Year`
`occurence`	integer	No	Whole number stored as the profile's occurrence count. The element name is spelt occurence.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	No	Line item type: Product or Service. Any other value, or no element, is saved as Product.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	No	How discount is applied: Percent or Fixed. An empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createRecurring">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <recurring_title>[RECURRING_TITLE]</recurring_title>
  <date>2026-01-15</date>
  <po_number>[PO_NUMBER]</po_number>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <frequency>1 Month</frequency>
  <occurence>12</occurence>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <recurring_id>[RECURRING_ID]</recurring_id>
</response>

Response fields

createRecurring response fields
Path	Description
`recurring_id`	Identifier of the new recurring profile.

Errors

createRecurring error messages
Status	Message	When
`400`	`Date is invalid.`	date is not a valid date.
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.

updateRecurring

Change an existing recurring invoice profile. Fields you leave out are unchanged.

TransportPOST, xml_request

Request fields24

Required4

If you send <items>, they replace all the existing lines on the profile.

Request fields

updateRecurring request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier)	Yes	Recurring profile identifier returned by createRecurring or listRecurring.
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`recurring_title`	string	No	Title shown on each invoice the recurring profile creates.
`date`	date (YYYY-MM-DD)	No	Date of the first invoice.
`po_number`	string	No	Purchase order or reference number shown on the document.
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`frequency`	string	No	How often an invoice is created. See allowed values. An unrecognised value is saved as 1 Week.	`1 Week` `2 Week` `3 Week` `4 Week` `1 Month` `3 Month` `6 Month` `1 Year` `2 Year` `3 Year`
`occurence`	integer	No	Whole number stored as the profile's occurrence count. The element name is spelt occurence.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	No	Line item type: Product or Service. Any other value, or no element, is saved as Product.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateRecurring">
  <recurring_id>[RECURRING_ID]</recurring_id>
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <recurring_title>[RECURRING_TITLE]</recurring_title>
  <date>2026-01-15</date>
  <po_number>[PO_NUMBER]</po_number>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <frequency>1 Month</frequency>
  <occurence>12</occurence>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <recurring_id>[RECURRING_ID]</recurring_id>
</response>

Response fields

updateRecurring response fields
Path	Description
`recurring_id`	Identifier of the updated profile.

Errors

updateRecurring error messages
Status	Message	When
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.

deleteRecurring

Delete one or more recurring invoice profiles.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><recurring id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteRecurring request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier) · repeatable	Yes	Recurring profile to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteRecurring">
  <recurring_id>[RECURRING_ID]</recurring_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteRecurring response fields
Path	Description
`failure`	Present only when some profiles could not be deleted.

getRecurring

Return one recurring invoice profile with its lines.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getRecurring request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier)	Yes	Recurring profile to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getRecurring">
  <recurring_id>[RECURRING_ID]</recurring_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <recurring>
    <client>
      <client_id>[CLIENT_ID]</client_id>
      <organization>[CLIENT_ORGANISATION]</organization>
      <address>[CLIENT_ADDRESS]</address>
    </client>
    <recurring_id>[RECURRING_ID]</recurring_id>
    <recurring_status>Active</recurring_status>
    <recurring_title>[RECURRING_TITLE]</recurring_title>
    <number>[PROFILE_NUMBER]</number>
    <date>2026-01-15</date>
    <frequency>1 Month</frequency>
    <occurence>12</occurence>
    <po_number></po_number>
    <total_discount>0.00</total_discount>
    <total_tax>0.00</total_tax>
    <notes></notes>
    <terms></terms>
    <items>
      <item>
        <recurring_item_id>[RECURRING_ITEM_ID]</recurring_item_id>
        <name>[ITEM_NAME]</name>
        <type>Products</type>
        <description>[ITEM_DESCRIPTION]</description>
        <unit_cost>50.00</unit_cost>
        <quantity>1.00</quantity>
        <discount></discount>
        <discount_type>Percent</discount_type>
      </item>
    </items>
  </recurring>
</response>

Response fields

getRecurring response fields
Path	Description
`recurring/recurring_id`	Profile identifier.
`recurring/recurring_status`	Profile status.
`recurring/frequency`	How often invoices are created.
`recurring/occurence`	Occurrence count stored on the profile.
`recurring/items/item`	One entry per line.

listRecurring

Return a page of recurring invoice profiles.

TransportPOST, xml_request

Request fields8

Required0

All filters are optional.

Request fields

listRecurring request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/date_from`	date (YYYY-MM-DD)	No	Return only records dated on or after this date.
`filter/date_to`	date (YYYY-MM-DD)	No	Return only records dated on or before this date.
`filter/recurring_number`	string	No	Return only the recurring profile with this number.
`filter/recurring_record_status`	string	No	Record status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Delete` `Stop`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listRecurring">
  <filter>
    <client_id></client_id>
    <date_from></date_from>
    <date_to></date_to>
    <recurring_number></recurring_number>
    <recurring_record_status></recurring_record_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <recurrings page="1" per_page_record="100" total_pages="1" total_records="1">
    <recurring>
      <!-- one recurring record -->
    </recurring>
  </recurrings>
</response>

Response fields

listRecurring response fields
Path	Description
`recurrings@total_records`	Number of matching profiles.
`recurrings/recurring`	One entry per profile.

Errors

listRecurring error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

addRecurringItem

Add one or more lines to a recurring invoice profile. Returns the new line identifiers.

TransportPOST, xml_request

Request fields10

Required4

Request fields

addRecurringItem request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier)	Yes	Recurring profile identifier returned by createRecurring or listRecurring.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	No	Line item name.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="addRecurringItem">
  <recurring_id>[RECURRING_ID]</recurring_id>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <recurring_id>[RECURRING_ID]</recurring_id>
  <recurring_items>
    <recurring_item_id>[RECURRING_ITEM_ID]</recurring_item_id>
  </recurring_items>
</response>

Response fields

addRecurringItem response fields
Path	Description
`recurring_items/recurring_item_id`	One identifier per new line.

Errors

addRecurringItem error messages
Status	Message	When
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

updateRecurringItem

Change one or more existing lines on a recurring invoice profile.

TransportPOST, xml_request

Request fields15

Required5

Request fields

updateRecurringItem request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier)	Yes	Recurring profile identifier returned by createRecurring or listRecurring.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/recurring_item_id`	integer (Invoicera identifier)	Yes	Identifier of the recurring-profile line to change. Returned by addRecurringItem and getRecurring.
`items/item/name`	string	No	Line item name.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	Yes	Discount on the line, read as a percentage or a fixed amount depending on discount_type. Send the element on every line; an empty element means no discount.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateRecurringItem">
  <recurring_id>[RECURRING_ID]</recurring_id>
  <items>
    <item>
      <recurring_item_id>[RECURRING_ITEM_ID]</recurring_item_id>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </item>
  </items>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateRecurringItem error messages
Status	Message	When
`400`	`Recurring item is invalid.`	recurring_item_id does not belong to the profile.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.
`400`	`Discount is invalid.`	discount is missing or is not a number with up to two decimal places.

deleteRecurringItem

Delete a line from a recurring invoice profile.

TransportPOST, xml_request

Request fields2

Required2

Request fields

deleteRecurringItem request fields
Path	Type	Required	Description	Accepted values
`recurring_id`	integer (Invoicera identifier) · repeatable	Yes	Recurring profile identifier returned by createRecurring or listRecurring.
`recurring_item_id`	integer (Invoicera identifier) · repeatable	Yes	Identifier of the recurring-profile line to delete.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteRecurringItem">
  <recurring_id>[RECURRING_ID]</recurring_id>
  <recurring_item_id>[RECURRING_ITEM_ID]</recurring_item_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Clients

5 methods

createClient

Create a client. Returns the new client_id.

TransportPOST, xml_request

Request fields13

Required2

name and organization are both required.
If country or currency is left out, your account defaults are used.
A login is created for the client portal. If you leave out username, one is generated.

Request fields

createClient request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Contact name for the client. Required.
`organization`	string	Yes	Organisation or company name of the client. Required.
`email`	string	No	Client email address. Checked for a valid format when supplied.
`username`	string	No	Login name for the client portal. At least five characters: letters, numbers and - _ . @ only. Must be unique. Generated for you when left out.
`work_phone`	string	No	Work phone number.
`address`	string	No	Primary postal address.
`country`	string	No	Country code, as in the old example USA. Defaults to your account country when left out. An unknown code is rejected.
`language`	string	No	Language for documents the client receives. See allowed values.	`en` `po` `fr` `de` `ru` `dt` `it` `sp` `swd` `por` `ind` `cro`
`currency`	string	No	Three-letter currency code for the client, for example USD. Defaults to your base currency when left out. An unknown code is rejected.
`custom_fields`	element	No	Container for up to four custom fields.
`custom_fields/custom_field`	element · repeatable	No	One custom field.
`custom_fields/custom_field/label`	string	No	Custom field label.
`custom_fields/custom_field/value`	string	No	Custom field value.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createClient">
  <name>[NAME]</name>
  <organization>[CLIENT_ORGANISATION]</organization>
  <email>[EMAIL]</email>
  <username>[USERNAME]</username>
  <work_phone>[PHONE]</work_phone>
  <address>[ADDRESS]</address>
  <country>USA</country>
  <language>en</language>
  <currency>USD</currency>
  <custom_fields>
    <custom_field>
      <label>[CUSTOM_FIELD_LABEL]</label>
      <value>[CUSTOM_FIELD_VALUE]</value>
    </custom_field>
  </custom_fields>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <client_id>[CLIENT_ID]</client_id>
</response>

Response fields

createClient response fields
Path	Description
`client_id`	Identifier of the new client.

Errors

createClient error messages
Status	Message	When
`400`	`Please provide mandatory data.`	name or organization is missing.
`400`	`Email is invalid.`	email is not a valid address.
`400`	`Username [...] already exists.`	username is taken.
`400`	`Username is invalid.`	username is shorter than five characters or uses other characters.
`400`	`Country code is invalid.`	country is not a known code.
`400`	`Currency code is invalid.`	currency is not a known code.
`400`	`Language is invalid.`	language is not in the allowed list.
`426`	Message varies	Your plan does not allow more clients. The message names the limit.

updateClient

Change an existing client.

TransportPOST, xml_request

Request fields18

Required3

Request fields

updateClient request fields
Path	Type	Required	Description	Accepted values
`client_id`	integer (Invoicera identifier)	Yes	Client identifier returned by createClient or listClient.
`name`	string	Yes	Contact name for the client. Required, even when you are not changing it.
`organization`	string	Yes	Organisation or company name of the client. Required, even when you are not changing it.
`email`	string	No	Email address.
`username`	string	No	Login name for the client portal. At least five characters: letters, numbers and - _ . @ only. Must be unique.
`work_phone`	string	No	Work phone number.
`address`	string	No	Primary postal address.
`country`	string	No	Country code, as in the old example USA. An unknown code is rejected.
`language`	string	No	Language for documents the client receives. See allowed values.	`en` `po` `fr` `de` `ru` `dt` `it` `sp` `swd` `por` `ind` `cro`
`currency`	string	No	Three-letter currency code for the client, for example USD. An unknown code is rejected.
`additional_contacts`	element	No	Container for extra client contacts.
`additional_contacts/contact`	element · repeatable	No	One extra contact.
`additional_contacts/contact/a_name`	string	No	Name of the extra contact.
`additional_contacts/contact/a_email`	string	No	Email address of the extra contact.
`custom_fields`	element	No	Container for up to four custom fields.
`custom_fields/custom_field`	element · repeatable	No	One custom field.
`custom_fields/custom_field/label`	string	No	Custom field label.
`custom_fields/custom_field/value`	string	No	Custom field value.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateClient">
  <client_id>[CLIENT_ID]</client_id>
  <name>[NAME]</name>
  <organization>[CLIENT_ORGANISATION]</organization>
  <email>[EMAIL]</email>
  <username>[USERNAME]</username>
  <work_phone>[PHONE]</work_phone>
  <address>[ADDRESS]</address>
  <country>USA</country>
  <language>en</language>
  <currency>USD</currency>
  <additional_contacts>
    <contact>
      <a_name>[CONTACT_NAME]</a_name>
      <a_email>[CONTACT_EMAIL]</a_email>
    </contact>
  </additional_contacts>
  <custom_fields>
    <custom_field>
      <label>[CUSTOM_FIELD_LABEL]</label>
      <value>[CUSTOM_FIELD_VALUE]</value>
    </custom_field>
  </custom_fields>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  [CLIENT_ID]
</response>

Response fields

updateClient response fields
Path	Description
`(text)`	The client identifier, returned as plain text inside <response>.

Errors

updateClient error messages
Status	Message	When
`400`	`Email is invalid.`
`400`	`Username is invalid.`
`400`	`Country code is invalid.`
`400`	`Currency code is invalid.`
`400`	`Language is invalid.`
`400`	`Client id is invalid.`	client_id is not a whole number.
`400`	`Please provide mandatory data.`	name or organization is missing.
`400`	`Currency can not be changed.`	currency differs from the client's currency and the client already has invoices that are not drafts.

deleteClient

Delete one or more clients.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><client id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteClient request fields
Path	Type	Required	Description	Accepted values
`client_id`	integer (Invoicera identifier) · repeatable	Yes	Client to delete. Repeat the element to delete more than one client.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteClient">
  <client_id>[CLIENT_ID]</client_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteClient response fields
Path	Description
`failure`	Present only when some clients could not be deleted.

getClient

Return one client with contact details and credits.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getClient request fields
Path	Type	Required	Description	Accepted values
`client_id`	integer (Invoicera identifier)	Yes	Client to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getClient">
  <client_id>[CLIENT_ID]</client_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <name>[CLIENT_NAME]</name>
    <organization>[CLIENT_ORGANISATION]</organization>
    <address>[CLIENT_ADDRESS]</address>
    <email>[CLIENT_EMAIL]</email>
    <work_phone>[CLIENT_PHONE]</work_phone>
    <currency>USD</currency>
    <credits>
      <credit>
        <amount>0.00</amount>
        <payment_method>[PAYMENT_METHOD]</payment_method>
        <payment_note></payment_note>
        <credit_date>2026-01-15 00:00:00</credit_date>
      </credit>
    </credits>
  </client>
</response>

Response fields

getClient response fields
Path	Description
`client/client_id`	Client identifier.
`client/name`	Contact name.
`client/organization`	Organisation name.
`client/email`	Email address.
`client/currency`	Client currency code.
`client/credits/credit`	One entry per credit held for the client.

listClient

Return a page of clients, newest first.

TransportPOST, xml_request

Request fields6

Required0

All filters are optional. With no filter, active clients are returned.

Request fields

listClient request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/client_email`	string	No	Return only the client with this business email address.
`filter/client_status`	string	No	Client status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listClient">
  <filter>
    <client_id></client_id>
    <client_email></client_email>
    <client_status></client_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <clients page="1" per_page_record="100" total_pages="1" total="1">
    <client>
      <!-- one client record -->
    </client>
  </clients>
</response>

Response fields

listClient response fields
Path	Description
`clients/client`	One entry per client.

Errors

listClient error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Staff

5 methods

createStaff

Create a staff member. Returns the new staff_id.

TransportPOST, xml_request

Request fields7

Required3

A password is generated for the staff member.
Staff numbers are limited by plan.

Request fields

createStaff request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Staff member name. Required.
`username`	string	Yes	Login name for the staff member. Required and must be unique.
`email`	string	Yes	Staff member email address. Required.
`billing_rate`	decimal (up to 2 decimal places)	No	Hourly billing rate for the staff member.
`user_access_own_record`	string	No	Yes limits the staff member to records they own. No gives access to all records.	`Yes` `No`
`assigned_clients`	element	No	Container for the clients this staff member may work with. Repeat <client_id> for each client.
`assigned_clients/client_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a client to assign.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createStaff">
  <name>[NAME]</name>
  <username>[USERNAME]</username>
  <email>[EMAIL]</email>
  <billing_rate>50.00</billing_rate>
  <user_access_own_record>No</user_access_own_record>
  <assigned_clients>
    <client_id>[CLIENT_ID]</client_id>
  </assigned_clients>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <staff_id>[STAFF_ID]</staff_id>
</response>

Response fields

createStaff response fields
Path	Description
`staff_id`	Identifier of the new staff member.

Errors

createStaff error messages
Status	Message	When
`400`	`Email is invalid.`
`400`	`Billing rate is invalid.`
`400`	`Client is invalid.`	An assigned client_id does not belong to your account.

updateStaff

Change an existing staff member.

TransportPOST, xml_request

Request fields8

Required1

Request fields

updateStaff request fields
Path	Type	Required	Description	Accepted values
`staff_id`	integer (Invoicera identifier)	Yes	Staff identifier returned by createStaff or listStaff.
`name`	string	No	Staff member name.
`username`	string	No	Login name for the staff member.
`email`	string	No	Staff member email address.
`billing_rate`	decimal (up to 2 decimal places)	No	Hourly billing rate for the staff member.
`user_access_own_record`	string	No	Yes limits the staff member to records they own. No gives access to all records.	`Yes` `No`
`assigned_clients`	element	No	Container for the clients this staff member may work with. Repeat <client_id> for each client.
`assigned_clients/client_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a client to assign.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateStaff">
  <staff_id>[STAFF_ID]</staff_id>
  <name>[NAME]</name>
  <username>[USERNAME]</username>
  <email>[EMAIL]</email>
  <billing_rate>50.00</billing_rate>
  <user_access_own_record>No</user_access_own_record>
  <assigned_clients>
    <client_id>[CLIENT_ID]</client_id>
  </assigned_clients>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateStaff error messages
Status	Message	When
`400`	`Email is invalid.`
`400`	`Billing rate is invalid.`
`400`	`Client is invalid.`

deleteStaff

Delete one or more staff members.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><staff id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteStaff request fields
Path	Type	Required	Description	Accepted values
`staff_id`	integer (Invoicera identifier) · repeatable	Yes	Staff member to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteStaff">
  <staff_id>[STAFF_ID]</staff_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteStaff response fields
Path	Description
`failure`	Present only when some staff could not be deleted.

Errors

deleteStaff error messages
Status	Message	When
`400`	`Staff is invalid.`

getStaff

Return one staff member.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getStaff request fields
Path	Type	Required	Description	Accepted values
`staff_id`	integer (Invoicera identifier)	Yes	Staff member to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getStaff">
  <staff_id>[STAFF_ID]</staff_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <staff>
    <staff_id>[STAFF_ID]</staff_id>
    <bill_rate>20.00</bill_rate>
    <name>[STAFF_NAME]</name>
    <username>[STAFF_USERNAME]</username>
    <email>[STAFF_EMAIL]</email>
    <user_level>2</user_level>
    <access_own_record>No</access_own_record>
    <status>Active</status>
    <date_added>2026-01-15 00:00:00</date_added>
    <last_login></last_login>
    <assigned_clients>
      <client_id>[CLIENT_ID]</client_id>
    </assigned_clients>
  </staff>
</response>

Response fields

getStaff response fields
Path	Description
`staff/staff_id`	Staff identifier.
`staff/bill_rate`	Billing rate.
`staff/access_own_record`	Yes or No.
`staff/status`	Active, Archived or Deleted.
`staff/assigned_clients/client_id`	Assigned clients.

listStaff

Return a page of staff members, newest first.

TransportPOST, xml_request

Request fields5

Required0

Request fields

listStaff request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/email`	string	No	Return only the staff member with this email address.
`filter/status`	string	No	Status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listStaff">
  <filter>
    <email></email>
    <status></status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <staff_users page="1" per_page_record="100" total_pages="1" total="1">
    <staff>
      <!-- one staff record -->
    </staff>
  </staff_users>
</response>

Response fields

listStaff response fields
Path	Description
`staff_users/staff`	One entry per staff member.

Errors

listStaff error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Products and services

10 methods

createProduct

Create a product. Returns the new product_id.

TransportPOST, xml_request

Request fields4

Required1

Request fields

createProduct request fields
Path	Type	Required	Description
`name`	string	Yes	Product name. Required. A product with the same name is rejected.
`quantity`	decimal (up to 2 decimal places)	No	Quantity held for the product.
`unitcost`	decimal (up to 2 decimal places)	No	Price per unit. The element name is unitcost, without an underscore.
`description`	string	No	Description.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createProduct">
  <name>[NAME]</name>
  <quantity>2</quantity>
  <unitcost>25.00</unitcost>
  <description>[DESCRIPTION]</description>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <product_id>[PRODUCT_ID]</product_id>
</response>

Response fields

createProduct response fields
Path	Description
`product_id`	Identifier of the new product.

Errors

createProduct error messages
Status	Message	When
`400`	`Quantity is invalid.`
`400`	`Unit cost is invalid.`
`400`	`Product- [name] already exists.`	A product with this name exists.
`400`	`Please provide valid data.`

updateProduct

Change an existing product.

TransportPOST, xml_request

Request fields5

Required1

Request fields

updateProduct request fields
Path	Type	Required	Description
`product_id`	integer (Invoicera identifier)	Yes	Product identifier returned by createProduct or listProduct.
`name`	string	No	Product name.
`quantity`	decimal (up to 2 decimal places)	No	Quantity held for the product.
`unitcost`	decimal (up to 2 decimal places)	No	Price per unit. The element name is unitcost, without an underscore.
`description`	string	No	Description.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateProduct">
  <product_id>[PRODUCT_ID]</product_id>
  <name>[NAME]</name>
  <quantity>2</quantity>
  <unitcost>25.00</unitcost>
  <description>[DESCRIPTION]</description>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateProduct error messages
Status	Message	When
`400`	`Product id is invalid.`
`403`	`Product is not associated with your account.`

deleteProduct

Delete one or more products.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><product id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteProduct request fields
Path	Type	Required	Description	Accepted values
`product_id`	integer (Invoicera identifier) · repeatable	Yes	Product to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteProduct">
  <product_id>[PRODUCT_ID]</product_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteProduct response fields
Path	Description
`failure`	Present only when some products could not be deleted.

getProduct

Return one product.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getProduct request fields
Path	Type	Required	Description	Accepted values
`product_id`	integer (Invoicera identifier)	Yes	Product to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getProduct">
  <product_id>[PRODUCT_ID]</product_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <product>
    <product_id>[PRODUCT_ID]</product_id>
    <product_name>[PRODUCT_NAME]</product_name>
    <unit_cost>10.00</unit_cost>
    <quantity>1</quantity>
    <description>[DESCRIPTION]</description>
    <date>2026-01-15 00:00:00</date>
    <status>Active</status>
  </product>
</response>

Response fields

getProduct response fields
Path	Description
`product/product_id`	Product identifier.
`product/product_name`	Name.
`product/unit_cost`	Price per unit.
`product/quantity`	Quantity held.
`product/date`	Date added.
`product/status`	Active, Archive or Deleted.

Errors

getProduct error messages
Status	Message	When
`400`	`Product id is invalid.`

listProduct

Return a page of products.

TransportPOST, xml_request

Request fields7

Required0

Request fields

listProduct request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/product_id`	integer (Invoicera identifier)	No	Return only this product.
`filter/item_name`	string	No	Return only items with this name.
`filter/item_cost`	decimal (up to 2 decimal places)	No	Return only items with this unit cost.
`filter/item_status`	string	No	Item status to return. See allowed values. Defaults to Active.	`Active` `Archive` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listProduct">
  <filter>
    <product_id></product_id>
    <item_name></item_name>
    <item_cost></item_cost>
    <item_status></item_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <products page="1" per_page_record="100" total_pages="1" total_records="1">
    <product>
      <!-- one product record -->
    </product>
  </products>
</response>

Response fields

listProduct response fields
Path	Description
`products/product`	One entry per product.

Errors

listProduct error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

createService

Create a service. Returns the new service_id.

TransportPOST, xml_request

Request fields4

Required1

Request fields

createService request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Service name. Required. A service with the same name is rejected.
`cost`	decimal (up to 2 decimal places)	No	Price per unit of the service.
`unit`	string	No	Unit the service is charged in. See allowed values.	`Minutes` `Hour` `Day` `Month` `Year` `Basic`
`description`	string	No	Description.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createService">
  <name>[NAME]</name>
  <cost>40.00</cost>
  <unit>Hour</unit>
  <description>[DESCRIPTION]</description>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <service_id>[SERVICE_ID]</service_id>
</response>

Response fields

createService response fields
Path	Description
`service_id`	Identifier of the new service.

Errors

createService error messages
Status	Message	When
`400`	`Cost is invalid.`
`400`	`Unit is invalid.`	unit is not one of the allowed values.
`400`	`Service- [name] already exists.`
`400`	`Please provide valid data.`

updateService

Change an existing service.

TransportPOST, xml_request

Request fields5

Required1

Request fields

updateService request fields
Path	Type	Required	Description	Accepted values
`service_id`	integer (Invoicera identifier)	Yes	Service identifier returned by createService or listService.
`name`	string	No	Service name.
`cost`	decimal (up to 2 decimal places)	No	Price per unit of the service.
`unit`	string	No	Unit the service is charged in. See allowed values.	`Minutes` `Hour` `Day` `Month` `Year` `Basic`
`description`	string	No	Description.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateService">
  <service_id>[SERVICE_ID]</service_id>
  <name>[NAME]</name>
  <cost>40.00</cost>
  <unit>Hour</unit>
  <description>[DESCRIPTION]</description>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateService error messages
Status	Message	When
`400`	`Service id is invalid.`
`400`	`Unit is invalid.`
`403`	`Service is not associated with your account.`

deleteService

Delete one or more services.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><service id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteService request fields
Path	Type	Required	Description	Accepted values
`service_id`	integer (Invoicera identifier) · repeatable	Yes	Service to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteService">
  <service_id>[SERVICE_ID]</service_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteService response fields
Path	Description
`failure`	Present only when some services could not be deleted.

getService

Return one service.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getService request fields
Path	Type	Required	Description	Accepted values
`service_id`	integer (Invoicera identifier)	Yes	Service to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getService">
  <service_id>[SERVICE_ID]</service_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <service>
    <service_id>[SERVICE_ID]</service_id>
    <service_name>[SERVICE_NAME]</service_name>
    <unit_cost>50.00</unit_cost>
    <quantity>Hour</quantity>
    <description>[DESCRIPTION]</description>
    <date>2026-01-15 00:00:00</date>
    <status>Active</status>
  </service>
</response>

Response fields

getService response fields
Path	Description
`service/service_id`	Service identifier.
`service/service_name`	Name.
`service/unit_cost`	Price per unit.
`service/quantity`	The unit the service is charged in (for example Hour). The element is named quantity.
`service/status`	Active, Archive or Deleted.

Errors

getService error messages
Status	Message	When
`400`	`Service id is invalid.`

listService

Return a page of services.

TransportPOST, xml_request

Request fields7

Required0

Request fields

listService request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/service_id`	integer (Invoicera identifier)	No	Return only this service.
`filter/item_name`	string	No	Return only items with this name.
`filter/item_cost`	decimal (up to 2 decimal places)	No	Return only items with this unit cost.
`filter/item_status`	string	No	Item status to return. See allowed values. Defaults to Active.	`Active` `Archive` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listService">
  <filter>
    <service_id></service_id>
    <item_name></item_name>
    <item_cost></item_cost>
    <item_status></item_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <services page="1" per_page_record="100" total_pages="1" total_records="1">
    <service>
      <!-- one service record -->
    </service>
  </services>
</response>

Response fields

listService response fields
Path	Description
`services/service`	One entry per service.

Errors

listService error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Expenses

9 methods

createExpense

Record an expense. Returns the new expense_id.

TransportPOST, xml_request

Request fields11

Required3

Request fields

createExpense request fields
Path	Type	Required	Description
`project_id`	integer (Invoicera identifier)	No	Project to link the expense to, if any.
`client_id`	integer (Invoicera identifier)	No	Client to link the expense to, if any.
`expense_category_id`	integer (Invoicera identifier)	Yes	Expense category identifier. Get it from listExpenseCategory.
`amount`	decimal (up to 2 decimal places)	Yes	Expense amount. Must be greater than zero.
`vendor`	string	No	Supplier or vendor name.
`date`	date (YYYY-MM-DD)	Yes	Expense date. Required.
`tax1`	integer (Invoicera identifier)	No	Identifier of the first tax to apply. Get it from listTax.
`tax2`	integer (Invoicera identifier)	No	Identifier of the second tax to apply. Get it from listTax.
`notes`	string	No	Notes stored with the expense.
`recurring_frequency`	integer	No	Whole number. A value makes the expense recurring. Send the element empty for a one-off expense.
`recurring_end_date`	date (YYYY-MM-DD)	No	Date the recurring expense stops.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createExpense">
  <project_id>[PROJECT_ID]</project_id>
  <client_id>[CLIENT_ID]</client_id>
  <expense_category_id>[CATEGORY_ID]</expense_category_id>
  <amount>10.00</amount>
  <vendor>[VENDOR_NAME]</vendor>
  <date>2026-01-15</date>
  <tax1>[TAX_ID]</tax1>
  <tax2></tax2>
  <notes>[NOTES]</notes>
  <recurring_frequency></recurring_frequency>
  <recurring_end_date></recurring_end_date>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <expense_id>[EXPENSE_ID]</expense_id>
</response>

Response fields

createExpense response fields
Path	Description
`expense_id`	Identifier of the new expense.

Errors

createExpense error messages
Status	Message	When
`400`	`Expense category id is invalid.`
`400`	`Amount is invalid.`	amount is missing, zero or negative.
`400`	`Date is invalid.`
`400`	`Tax-1 id is invalid.`
`400`	`Tax-2 id is invalid.`
`400`	`Recurring frequency is invalid.`
`400`	`Recurring end date is invalid.`
`400`	`Project id is invalid.`
`400`	`Client id is invalid.`

updateExpense

Change an existing expense.

TransportPOST, xml_request

Request fields12

Required1

Request fields

updateExpense request fields
Path	Type	Required	Description
`expense_id`	integer (Invoicera identifier)	Yes	Expense identifier returned by createExpense or listExpense.
`project_id`	integer (Invoicera identifier)	No	Project to link the expense to, if any.
`client_id`	integer (Invoicera identifier)	No	Client to link the expense to, if any.
`expense_category_id`	integer (Invoicera identifier)	No	Expense category identifier. Get it from listExpenseCategory.
`amount`	decimal (up to 2 decimal places)	No	Expense amount. Must be greater than zero.
`vendor`	string	No	Supplier or vendor name.
`date`	date (YYYY-MM-DD)	No	Expense date.
`tax1`	integer (Invoicera identifier)	No	Identifier of the first tax to apply. Get it from listTax.
`tax2`	integer (Invoicera identifier)	No	Identifier of the second tax to apply. Get it from listTax.
`notes`	string	No	Notes stored with the expense.
`recurring_frequency`	integer	No	Whole number. A value makes the expense recurring. Send the element empty for a one-off expense.
`recurring_end_date`	date (YYYY-MM-DD)	No	Date the recurring expense stops.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateExpense">
  <expense_id>[EXPENSE_ID]</expense_id>
  <project_id>[PROJECT_ID]</project_id>
  <client_id>[CLIENT_ID]</client_id>
  <expense_category_id>[CATEGORY_ID]</expense_category_id>
  <amount>10.00</amount>
  <vendor>[VENDOR_NAME]</vendor>
  <date>2026-01-15</date>
  <tax1>[TAX_ID]</tax1>
  <tax2></tax2>
  <notes>[NOTES]</notes>
  <recurring_frequency></recurring_frequency>
  <recurring_end_date></recurring_end_date>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  [EXPENSE_ID]
</response>

Response fields

updateExpense response fields
Path	Description
`(text)`	The expense identifier, returned as plain text.

Errors

updateExpense error messages
Status	Message	When
`400`	`Expense id is invalid.`
`403`	`Expense is not associated with your account.`

deleteExpense

Delete one or more expenses.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><expense id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteExpense request fields
Path	Type	Required	Description	Accepted values
`expense_id`	integer (Invoicera identifier) · repeatable	Yes	Expense to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteExpense">
  <expense_id>[EXPENSE_ID]</expense_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteExpense response fields
Path	Description
`failure`	Present only when some expenses could not be deleted.

getExpense

Return one expense.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getExpense request fields
Path	Type	Required	Description	Accepted values
`expense_id`	integer (Invoicera identifier)	Yes	Expense to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getExpense">
  <expense_id>[EXPENSE_ID]</expense_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <expense>
    <expense_id>[EXPENSE_ID]</expense_id>
    <client_id>[CLIENT_ID]</client_id>
    <project_id>[PROJECT_ID]</project_id>
    <expense_category_id>[CATEGORY_ID]</expense_category_id>
    <vendor>[VENDOR_NAME]</vendor>
    <date>2026-01-15 00:00:00</date>
    <amount>70.00</amount>
    <notes></notes>
    <tax1>[TAX_ID]</tax1>
    <tax2></tax2>
    <is_expense_recurring>0</is_expense_recurring>
    <recurring_frequency></recurring_frequency>
    <recurring_end_date></recurring_end_date>
    <status>Active</status>
  </expense>
</response>

Response fields

getExpense response fields
Path	Description
`expense/expense_id`	Expense identifier.
`expense/amount`	Amount.
`expense/tax1`	First tax identifier.
`expense/is_expense_recurring`	1 if recurring, 0 if not.
`expense/status`	Active, Archived or Deleted.

listExpense

Return a page of expenses.

TransportPOST, xml_request

Request fields8

Required0

Request fields

listExpense request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/expense_category_id`	integer (Invoicera identifier)	No	Return only expenses in this category.
`filter/amount`	decimal (up to 2 decimal places)	No	Return only expenses with this amount.
`filter/status`	string	No	Status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Deleted`
`filter/is_expense_invoiced`	string	No	Yes for expenses already on an invoice, No for the rest.	`Yes` `No`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listExpense">
  <filter>
    <client_id></client_id>
    <expense_category_id></expense_category_id>
    <amount></amount>
    <status></status>
    <is_expense_invoiced></is_expense_invoiced>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <expenses page="1" per_page_record="100" total_pages="1" total_records="1">
    <expense>
      <!-- one expense record -->
    </expense>
  </expenses>
</response>

Response fields

listExpense response fields
Path	Description
`expenses/expense`	One entry per expense.

Errors

listExpense error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

createExpenseCategory

Create an expense category. Returns the new category_id.

TransportPOST, xml_request

Request fields1

Required1

Request fields

createExpenseCategory request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Category name.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createExpenseCategory">
  <name>[NAME]</name>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <category_id>[CATEGORY_ID]</category_id>
</response>

Response fields

createExpenseCategory response fields
Path	Description
`category_id`	Identifier of the new category.

updateExpenseCategory

Rename an expense category.

TransportPOST, xml_request

Request fields2

Required2

Request fields

updateExpenseCategory request fields
Path	Type	Required	Description	Accepted values
`category_id`	integer (Invoicera identifier)	Yes	Expense category identifier returned by createExpenseCategory or listExpenseCategory.
`name`	string	Yes	New category name.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateExpenseCategory">
  <category_id>[CATEGORY_ID]</category_id>
  <name>[NAME]</name>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

deleteExpenseCategory

Delete one or more expense categories.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><category id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteExpenseCategory request fields
Path	Type	Required	Description	Accepted values
`category_id`	integer (Invoicera identifier) · repeatable	Yes	Category to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteExpenseCategory">
  <category_id>[CATEGORY_ID]</category_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteExpenseCategory response fields
Path	Description
`failure`	Present only when some categories could not be deleted.

listExpenseCategory

Return a page of expense categories.

TransportPOST, xml_request

Request fields4

Required0

Request fields

listExpenseCategory request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/status`	string	No	Status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listExpenseCategory">
  <filter>
    <status></status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <categories page="1" per_page_record="100" total_pages="1" total="1">
    <category>
      <category_id>[CATEGORY_ID]</category_id>
      <name>[CATEGORY_NAME]</name>
      <status>Active</status>
      <date_added>2026-01-15 00:00:00</date_added>
    </category>
  </categories>
</response>

Response fields

listExpenseCategory response fields
Path	Description
`categories/category`	One entry per category.

Errors

listExpenseCategory error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Projects

5 methods

createProject

Create a project and optionally link tasks to it. Returns the new project_id.

TransportPOST, xml_request

Request fields8

Required2

budget is needed when billing_method is flat or project.
If some task identifiers are invalid, the project is still created and the response lists them in <invalid>.

Request fields

createProject request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Project name. Required.
`client_id`	integer (Invoicera identifier)	No	Client the project belongs to.
`project_manager_id`	integer (Invoicera identifier)	No	Staff identifier of the project manager.
`description`	string	No	Project description.
`billing_method`	string	Yes	How the project is billed. See allowed values.	`flat` `staff` `task` `project`
`budget`	decimal (up to 2 decimal places)	No	Project budget. Needed when billing_method is flat or project.
`tasks`	element	No	Container for tasks to link to the project. Repeat <task_id> for each task.
`tasks/task_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a task to link.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createProject">
  <name>[NAME]</name>
  <client_id>[CLIENT_ID]</client_id>
  <project_manager_id>[STAFF_ID]</project_manager_id>
  <description>[DESCRIPTION]</description>
  <billing_method>flat</billing_method>
  <budget>500.00</budget>
  <tasks>
    <task_id>[TASK_ID]</task_id>
  </tasks>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <project_id>[PROJECT_ID]</project_id>
</response>

Response fields

createProject response fields
Path	Description
`project_id`	Identifier of the new project.
`invalid/task_id`	Task identifiers that could not be linked, if any.

Errors

createProject error messages
Status	Message	When
`400`	`Billing method is invalid.`
`400`	`Amount is invalid.`	budget is missing or invalid for a flat or project billing method.
`400`	`Client id is invalid.`
`400`	`Project manager id is invalid.`
`400`	`Please provide valid data.`	name is missing.

updateProject

Change an existing project.

TransportPOST, xml_request

Request fields9

Required1

Request fields

updateProject request fields
Path	Type	Required	Description	Accepted values
`project_id`	integer (Invoicera identifier)	Yes	Project identifier returned by createProject or listProject.
`name`	string	No	Project name.
`client_id`	integer (Invoicera identifier)	No	Client the project belongs to.
`project_manager_id`	integer (Invoicera identifier)	No	Staff identifier of the project manager.
`description`	string	No	Description.
`billing_method`	string	No	How the project is billed. See allowed values.	`flat` `staff` `task` `project`
`budget`	decimal (up to 2 decimal places)	No	Project budget. Needed when billing_method is flat or project.
`tasks`	element	No	Container for tasks to link to the project. Repeat <task_id> for each task.
`tasks/task_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a task to link.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateProject">
  <project_id>[PROJECT_ID]</project_id>
  <name>[NAME]</name>
  <client_id>[CLIENT_ID]</client_id>
  <project_manager_id>[STAFF_ID]</project_manager_id>
  <description>[DESCRIPTION]</description>
  <billing_method>flat</billing_method>
  <budget>500.00</budget>
  <tasks>
    <task_id>[TASK_ID]</task_id>
  </tasks>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <project_id>[PROJECT_ID]</project_id>
</response>

Response fields

updateProject response fields
Path	Description
`project_id`	Identifier of the updated project.

Errors

updateProject error messages
Status	Message	When
`400`	`Billing method is invalid.`
`403`	`Project is not associated with your account.`

deleteProject

Delete one or more projects.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><project id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteProject request fields
Path	Type	Required	Description	Accepted values
`project_id`	integer (Invoicera identifier) · repeatable	Yes	Project to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteProject">
  <project_id>[PROJECT_ID]</project_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteProject response fields
Path	Description
`failure`	Present only when some projects could not be deleted.

getProject

Return one project with its staff and tasks.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getProject request fields
Path	Type	Required	Description	Accepted values
`project_id`	integer (Invoicera identifier)	Yes	Project to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getProject">
  <project_id>[PROJECT_ID]</project_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <project>
    <project_id>[PROJECT_ID]</project_id>
    <client_id>[CLIENT_ID]</client_id>
    <project_manager_id>[STAFF_ID]</project_manager_id>
    <project_name>[PROJECT_NAME]</project_name>
    <project_description>[DESCRIPTION]</project_description>
    <project_rate>0</project_rate>
    <billing_method>flat</billing_method>
    <project_billed>No</project_billed>
    <created_date>2026-01-15 00:00:00</created_date>
    <status>Active</status>
    <staff>
      <staff_id>[STAFF_ID]</staff_id>
    </staff>
    <task>
      <task_id>[TASK_ID]</task_id>
    </task>
  </project>
</response>

Response fields

getProject response fields
Path	Description
`project/project_id`	Project identifier.
`project/billing_method`	Billing method.
`project/project_billed`	Yes or No.
`project/staff/staff_id`	Staff on the project.
`project/task/task_id`	Tasks on the project.

Errors

getProject error messages
Status	Message	When
`400`	`Project id is invalid.`

listProject

Return a page of projects.

TransportPOST, xml_request

Request fields7

Required0

Request fields

listProject request fields
Path	Type	Required	Description
`filter`	element	No	Container for search and paging options. All are optional.
`filter/client_id`	integer (Invoicera identifier)	No	Return only records for this client.
`filter/task_id`	integer (Invoicera identifier)	No	Return only records for this task.
`filter/project_name`	string	No	Return only projects with this name.
`filter/project_status`	string	No	Project status to return.
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listProject">
  <filter>
    <client_id></client_id>
    <task_id></task_id>
    <project_name></project_name>
    <project_status></project_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <projects page="1" per_page_record="100" total_pages="1" total_records="1">
    <project>
      <!-- one project record -->
    </project>
  </projects>
</response>

Response fields

listProject response fields
Path	Description
`projects/project`	One entry per project.

Errors

listProject error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Tasks

5 methods

createTask

Create a task and optionally link it to projects. Returns the new task_id.

TransportPOST, xml_request

Request fields6

Required1

Request fields

createTask request fields
Path	Type	Required	Description	Accepted values
`name`	string	Yes	Task name. Required.
`description`	string	No	Description.
`task_billable`	string	No	Y if time on the task is billable, N if not. Defaults to N.	`Y` `N`
`task_rate`	decimal (up to 2 decimal places)	No	Hourly rate for the task.
`projects`	element	No	Container for projects to link to the task. Repeat <project_id> for each project.
`projects/project_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a project to link.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createTask">
  <name>[NAME]</name>
  <description>[DESCRIPTION]</description>
  <task_billable>Y</task_billable>
  <task_rate>30.00</task_rate>
  <projects>
    <project_id>[PROJECT_ID]</project_id>
  </projects>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <task_id>[TASK_ID]</task_id>
</response>

Response fields

createTask response fields
Path	Description
`task_id`	Identifier of the new task.

Errors

createTask error messages
Status	Message	When
`400`	`Task rate is invalid.`
`400`	`Please provide valid data.`	name is missing.

updateTask

Change an existing task.

TransportPOST, xml_request

Request fields7

Required1

Request fields

updateTask request fields
Path	Type	Required	Description	Accepted values
`task_id`	integer (Invoicera identifier)	Yes	Task identifier returned by createTask or listTask.
`name`	string	No	Task name.
`description`	string	No	Description.
`task_billable`	string	No	Y if time on the task is billable, N if not. Defaults to N.	`Y` `N`
`task_rate`	decimal (up to 2 decimal places)	No	Hourly rate for the task.
`projects`	element	No	Container for projects to link to the task. Repeat <project_id> for each project.
`projects/project_id`	integer (Invoicera identifier) · repeatable	No	Identifier of a project to link.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateTask">
  <task_id>[TASK_ID]</task_id>
  <name>[NAME]</name>
  <description>[DESCRIPTION]</description>
  <task_billable>Y</task_billable>
  <task_rate>30.00</task_rate>
  <projects>
    <project_id>[PROJECT_ID]</project_id>
  </projects>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateTask error messages
Status	Message	When
`400`	`Task rate is invalid.`
`403`	`Task is not associated with your account.`

deleteTask

Delete one or more tasks.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><task id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteTask request fields
Path	Type	Required	Description	Accepted values
`task_id`	integer (Invoicera identifier) · repeatable	Yes	Task to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteTask">
  <task_id>[TASK_ID]</task_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteTask response fields
Path	Description
`failure`	Present only when some tasks could not be deleted.

getTask

Return one task with its projects.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getTask request fields
Path	Type	Required	Description	Accepted values
`task_id`	integer (Invoicera identifier)	Yes	Task to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getTask">
  <task_id>[TASK_ID]</task_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <task>
    <task_id>[TASK_ID]</task_id>
    <task_name>[TASK_NAME]</task_name>
    <task_description>[DESCRIPTION]</task_description>
    <task_billable>Y</task_billable>
    <task_rate>5.00</task_rate>
    <created_date>2026-01-15 00:00:00</created_date>
    <status>Active</status>
    <project>
      <project_id>[PROJECT_ID]</project_id>
    </project>
  </task>
</response>

Response fields

getTask response fields
Path	Description
`task/task_id`	Task identifier.
`task/task_billable`	Y or N.
`task/task_rate`	Hourly rate.
`task/project/project_id`	Projects the task is linked to.

listTask

Return a page of tasks.

TransportPOST, xml_request

Request fields7

Required0

Request fields

listTask request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/project_id`	integer (Invoicera identifier)	No	Return only records for this project.
`filter/task_name`	string	No	Return only tasks with this name.
`filter/task_billable`	string	No	Y for billable tasks, N for the rest.	`Y` `N`
`filter/task_status`	string	No	Task status to return. See allowed values. Defaults to Active.	`Active` `Archived` `Deleted`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listTask">
  <filter>
    <project_id></project_id>
    <task_name></task_name>
    <task_billable></task_billable>
    <task_status></task_status>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <tasks page="1" per_page_record="100" total_pages="1" total_records="1">
    <task>
      <!-- one task record -->
    </task>
  </tasks>
</response>

Response fields

listTask response fields
Path	Description
`tasks/task`	One entry per task.

Errors

listTask error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Time logs

5 methods

createTimeLog

Record time worked on a project task. Returns the new timelog_id.

TransportPOST, xml_request

Request fields6

Required4

Request fields

createTimeLog request fields
Path	Type	Required	Description	Accepted values
`project_id`	integer (Invoicera identifier)	Yes	Project the time belongs to. Required.
`task_id`	integer (Invoicera identifier)	Yes	Task the time belongs to. Required. The task must be linked to the project.
`work_date`	date (YYYY-MM-DD)	Yes	Date the work was done.
`hours_worked`	decimal (up to 2 decimal places)	Yes	Hours worked. Must be greater than zero.
`notes`	string	No	Notes stored with the time entry.
`billed`	string	No	Yes if the time has already been billed. Defaults to No.	`Yes` `No`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createTimeLog">
  <project_id>[PROJECT_ID]</project_id>
  <task_id>[TASK_ID]</task_id>
  <work_date>2026-01-15</work_date>
  <hours_worked>2.5</hours_worked>
  <notes>[NOTES]</notes>
  <billed>No</billed>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <timelog_id>[TIMELOG_ID]</timelog_id>
</response>

Response fields

createTimeLog response fields
Path	Description
`timelog_id`	Identifier of the new time entry.

Errors

createTimeLog error messages
Status	Message	When
`400`	`Project id is invalid.`
`400`	`Task id is invalid.`
`400`	`Work date is invalid.`
`400`	`Hours is invalid.`	hours_worked is zero, negative or not a number.
`400`	`Task is not associated with provided project.`
`400`	`Please provide valid data.`	A required field is missing.

updateTimeLog

Change an existing time entry.

TransportPOST, xml_request

Request fields7

Required1

Request fields

updateTimeLog request fields
Path	Type	Required	Description	Accepted values
`timelog_id`	integer (Invoicera identifier)	Yes	Time entry identifier returned by createTimeLog or listTimeLog.
`project_id`	integer (Invoicera identifier)	No	Project the time belongs to.
`task_id`	integer (Invoicera identifier)	No	Task the time belongs to. The task must be linked to the project.
`work_date`	date (YYYY-MM-DD)	No	Date the work was done.
`hours_worked`	decimal (up to 2 decimal places)	No	Hours worked. Must be greater than zero.
`notes`	string	No	Notes stored with the time entry.
`billed`	string	No	Yes if the time has already been billed. Defaults to No.	`Yes` `No`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="updateTimeLog">
  <timelog_id>[TIMELOG_ID]</timelog_id>
  <project_id>[PROJECT_ID]</project_id>
  <task_id>[TASK_ID]</task_id>
  <work_date>2026-01-15</work_date>
  <hours_worked>2.5</hours_worked>
  <notes>[NOTES]</notes>
  <billed>No</billed>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

updateTimeLog error messages
Status	Message	When
`400`	`Hours is invalid.`
`403`	`Timelog is not associated with your account.`

deleteTimeLog

Delete one or more time entries.

TransportPOST, xml_request

Request fields1

Required1

The response is status 200 even when some identifiers could not be deleted. Those are listed in a <failure> element, for example <failure><timelog id="[ID]" /></failure>. Check it before treating the delete as complete.

Request fields

deleteTimeLog request fields
Path	Type	Required	Description	Accepted values
`timelog_id`	integer (Invoicera identifier) · repeatable	Yes	Time entry to delete. Repeat the element to delete more than one.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteTimeLog">
  <timelog_id>[TIMELOG_ID]</timelog_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Response fields

deleteTimeLog response fields
Path	Description
`failure`	Present only when some entries could not be deleted.

getTimeLog

Return one time entry.

TransportPOST, xml_request

Request fields1

Required1

Request fields

getTimeLog request fields
Path	Type	Required	Description	Accepted values
`timelog_id`	integer (Invoicera identifier)	Yes	Time entry to return. One identifier per request.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getTimeLog">
  <timelog_id>[TIMELOG_ID]</timelog_id>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <timelog>
    <project_id>[PROJECT_ID]</project_id>
    <task_id>[TASK_ID]</task_id>
    <work_date>2026-01-15</work_date>
    <hours_worked>4.00</hours_worked>
    <notes></notes>
    <log_status>Active</log_status>
  </timelog>
</response>

Response fields

getTimeLog response fields
Path	Description
`timelog/work_date`	Date worked.
`timelog/hours_worked`	Hours.
`timelog/log_status`	Entry status.

listTimeLog

Return a page of time entries.

TransportPOST, xml_request

Request fields7

Required0

Request fields

listTimeLog request fields
Path	Type	Required	Description	Accepted values
`filter`	element	No	Container for search and paging options. All are optional.
`filter/project_id`	integer (Invoicera identifier)	No	Return only records for this project.
`filter/task_id`	integer (Invoicera identifier)	No	Return only records for this task.
`filter/work_date`	date (YYYY-MM-DD)	No	Return only time entries for this date.
`filter/billed`	string	No	Filter time entries by billed state (Yes or No).	`Yes` `No`
`filter/page`	integer	No	Page to return. Defaults to 1.
`filter/per_page_record`	integer	No	Records per page, from 1 to 100. Defaults to 100. Values above 100 return 100.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listTimeLog">
  <filter>
    <project_id></project_id>
    <task_id></task_id>
    <work_date></work_date>
    <billed></billed>
    <page>1</page>
    <per_page_record>25</per_page_record>
  </filter>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <timelogs page="1" per_page_record="100" total_pages="1" total_records="1">
    <timelog>
      <timelog_id>[TIMELOG_ID]</timelog_id>
      <project_id>[PROJECT_ID]</project_id>
      <task_id>[TASK_ID]</task_id>
      <work_date>2026-01-15</work_date>
      <hours_worked>4.00</hours_worked>
      <notes></notes>
      <log_status>Active</log_status>
    </timelog>
  </timelogs>
</response>

Response fields

listTimeLog response fields
Path	Description
`timelogs/timelog`	One entry per time entry.

Errors

listTimeLog error messages
Status	Message	When
`400`	`Per page record is invalid.`	per_page_record is not a whole number of 1 or more.
`400`	`Page is invalid.`	page is not a whole number of 1 or more.
`404`	`Data not found. Kindly check the request.`	No record matches the filter.

Account and supporting operations

8 methods

getAccountInfo

Return your account company name, owner name, country and currency. A safe first call to test your token.

TransportPOST, xml_request

Request fields0

Required0

Request fields

This method takes no request fields. Send the root element on its own.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="getAccountInfo">
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <account>
    <company>[COMPANY_NAME]</company>
    <name>[ACCOUNT_OWNER_NAME]</name>
    <country_code>USA</country_code>
    <currency_code>USD</currency_code>
  </account>
</response>

Response fields

getAccountInfo response fields
Path	Description
`account/company`	Company name.
`account/name`	Account owner name.
`account/country_code`	Account country code.
`account/currency_code`	Base currency code.

Errors

getAccountInfo error messages
Status	Message	When
`404`	`Data not found.`

createInvoiceFromTimeTracking

Create an invoice that bills unbilled time entries, plus any extra lines. Returns the new invoice_id.

TransportPOST, xml_request

Request fields48

Required7

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Each time entry must exist and not already be billed.

Request fields

createInvoiceFromTimeTracking request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`invoice_title`	string	No	Title shown on the invoice.
`number`	string	No	Document number shown on the invoice. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Document date. Defaults to today when left out.
`due_date`	date (YYYY-MM-DD)	No	Date payment is due.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Invoice status. Any other value, or no value, saves the invoice as a draft.	`draft` `sent` `paid`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`time_entries`	element	No	Container for the time entries to bill. Repeat <time_entry> for each entry.
`time_entries/time_entry`	element · repeatable	No	One time entry to add as a line.
`time_entries/time_entry/id`	integer (Invoicera identifier)	Yes	Time entry identifier (timelog_id). The entry must not already be billed.
`time_entries/time_entry/name`	string	No	Line item name.
`time_entries/time_entry/type`	string	Yes	Line type. Use Time. If you leave the element out, the line is rejected.	`Time`
`time_entries/time_entry/description`	string	No	Line item description.
`time_entries/time_entry/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`time_entries/time_entry/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`time_entries/time_entry/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`time_entries/time_entry/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`time_entries/time_entry/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`time_entries/time_entry/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`time_entries/time_entry/tax1_type`	string	No	Type of the first tax. Only Normal is accepted. Defaults to Normal.
`time_entries/time_entry/tax2_name`	string	No	Name of the second tax on the line.
`time_entries/time_entry/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.
`time_entries/time_entry/tax2_type`	string	No	Type of the second tax: Normal or Compound. Compound applies the second tax on top of the first. Defaults to Normal.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`items/item/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`items/item/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`items/item/tax1_type`	string	No	Type of the first tax. Only Normal is accepted. Defaults to Normal.	`Normal`
`items/item/tax2_name`	string	No	Name of the second tax on the line.
`items/item/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.
`items/item/tax2_type`	string	No	Type of the second tax: Normal or Compound. Compound applies the second tax on top of the first. Defaults to Normal.	`Normal` `Compound`
`additional_charges`	element	No	Container for one or more extra charges, such as shipping.
`additional_charges/additional_charge`	element · repeatable	No	One extra charge.
`additional_charges/additional_charge/name`	string	No	Name of the charge, for example Shipping.
`additional_charges/additional_charge/type`	string	No	How amount is applied: Percent or Fixed. Defaults to Percent.	`Percent` `Fixed`
`additional_charges/additional_charge/amount`	decimal (up to 2 decimal places)	No	Charge value, read as a percentage or a fixed amount depending on type.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createInvoiceFromTimeTracking">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <invoice_title>[INVOICE_TITLE]</invoice_title>
  <number></number>
  <date>2026-01-15</date>
  <due_date>2026-02-14</due_date>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <time_entries>
    <time_entry>
      <id>[TIMELOG_ID]</id>
      <name>[NAME]</name>
      <type>Time</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax1_percent>10</tax1_percent>
      <tax1_type>Normal</tax1_type>
      <tax2_name></tax2_name>
      <tax2_percent></tax2_percent>
      <tax2_type></tax2_type>
    </time_entry>
  </time_entries>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax1_percent>10</tax1_percent>
      <tax1_type>Normal</tax1_type>
      <tax2_name></tax2_name>
      <tax2_percent></tax2_percent>
      <tax2_type></tax2_type>
    </item>
  </items>
  <additional_charges>
    <additional_charge>
      <name>Shipping</name>
      <type>Fixed</type>
      <amount>10.00</amount>
    </additional_charge>
  </additional_charges>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

createInvoiceFromTimeTracking response fields
Path	Description
`invoice_id`	Identifier of the new invoice.

Errors

createInvoiceFromTimeTracking error messages
Status	Message	When
`400`	`Client id is not exists.`	client_id does not belong to your account.
`400`	`Date is invalid.`	A date is not a real date in YYYY-MM-DD form.
`400`	`Due Date is invalid.`	due_date is not a valid date.
`400`	`Schedule Date is invalid.`	schedule_date is not a valid date.
`400`	`Time-entry id is required.`
`400`	`Time-entry id is not valid or already billed.`

createInvoiceFromExpense

Create an invoice that bills unbilled expenses, plus any extra lines. Returns the new invoice_id.

TransportPOST, xml_request

Request fields41

Required7

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Each expense must belong to the client, be active and not already be invoiced.

Request fields

createInvoiceFromExpense request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`invoice_title`	string	No	Title shown on the invoice.
`number`	string	No	Document number shown on the invoice. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Document date. Defaults to today when left out.
`due_date`	date (YYYY-MM-DD)	No	Date payment is due.
`late_fee`	integer (Invoicera identifier)	No	Identifier of an active late-fee rule. Get it from listLateFee. Leave empty for no late fee.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Invoice status. Any other value, or no value, saves the invoice as a draft.	`draft` `sent` `paid`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`expenses`	element	No	Container for the expenses to bill. Repeat <expense> for each expense.
`expenses/expense`	element · repeatable	No	One expense to add as a line.
`expenses/expense/id`	integer (Invoicera identifier)	Yes	Expense identifier (expense_id). The expense must not already be billed.
`expenses/expense/name`	string	No	Line item name.
`expenses/expense/type`	string	Yes	Line type. Use Expense. If you leave the element out, the line is rejected.	`Expense`
`expenses/expense/description`	string	No	Line item description.
`expenses/expense/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`expenses/expense/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`expenses/expense/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`expenses/expense/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`expenses/expense/tax1_name`	string	No	Name of the first tax on the line, for example VAT.
`expenses/expense/tax2_name`	string	No	Name of the second tax on the line.
`expenses/expense/tax1_percent`	decimal (up to 2 decimal places)	No	Rate of the first tax, as a percentage.
`expenses/expense/tax2_percent`	decimal (up to 2 decimal places)	No	Rate of the second tax, as a percentage.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	Yes	How discount is applied: Percent or Fixed. Send the element on every line; an empty element is treated as Percent.	`Percent` `Fixed`
`additional_charges`	element	No	Container for one or more extra charges, such as shipping.
`additional_charges/additional_charge`	element · repeatable	No	One extra charge.
`additional_charges/additional_charge/name`	string	No	Name of the charge, for example Shipping.
`additional_charges/additional_charge/type`	string	No	How amount is applied: Percent or Fixed. Defaults to Percent.	`Percent` `Fixed`
`additional_charges/additional_charge/amount`	decimal (up to 2 decimal places)	No	Charge value, read as a percentage or a fixed amount depending on type.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createInvoiceFromExpense">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <invoice_title>[INVOICE_TITLE]</invoice_title>
  <number></number>
  <date>2026-01-15</date>
  <due_date>2026-02-14</due_date>
  <late_fee></late_fee>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <expenses>
    <expense>
      <id>[EXPENSE_ID]</id>
      <name>[NAME]</name>
      <type>Expense</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
      <tax1_name>[TAX_NAME]</tax1_name>
      <tax2_name></tax2_name>
      <tax1_percent>10</tax1_percent>
      <tax2_percent></tax2_percent>
    </expense>
  </expenses>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
    </item>
  </items>
  <additional_charges>
    <additional_charge>
      <name>Shipping</name>
      <type>Fixed</type>
      <amount>10.00</amount>
    </additional_charge>
  </additional_charges>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

createInvoiceFromExpense response fields
Path	Description
`invoice_id`	Identifier of the new invoice.

Errors

createInvoiceFromExpense error messages
Status	Message	When
`400`	`Client id is not exists.`	client_id does not belong to your account.
`400`	`Date is invalid.`	A date is not a real date in YYYY-MM-DD form.
`400`	`Due Date is invalid.`	due_date is not a valid date.
`400`	`Late Fee is invalid or inactive.`	late_fee is not an active late-fee identifier.
`400`	`Schedule Date is invalid.`	schedule_date is not a valid date.
`400`	`Expense id is required.`
`400`	`Expense [ID] is not assigned to this client or not active or already invoiced.`	An expense is not billable for this client.

createInvoiceFromEstimate

Create an invoice from the fields you send. This method runs createInvoice: it takes no estimate identifier and does not read, copy or link an estimate.

TransportPOST, xml_request

Request fields26

Required3

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Send the lines you want in <items>, as you would for createInvoice. The new invoice has no link to any estimate.

Request fields

createInvoiceFromEstimate request fields
Path	Type	Required	Description	Accepted values
`client`	element	No	Container for the client being billed.
`client/client_id`	integer (Invoicera identifier)	Yes	Identifier of an existing client in your account. Use the client_id returned by createClient or listClient.
`client/address`	string	No	Client address to print on the document. If left out, no address is copied to the document.
`invoice_title`	string	No	Title shown on the invoice.
`number`	string	No	Document number shown on the invoice. If left out, or if the number is already in use, Invoicera assigns the next number in your sequence.
`date`	date (YYYY-MM-DD)	No	Document date. Defaults to today when left out.
`due_date`	date (YYYY-MM-DD)	No	Date payment is due.
`schedule_date`	date (YYYY-MM-DD)	No	Date the document is scheduled for.
`po_number`	string	No	Purchase order or reference number shown on the document.
`status`	string	No	Document status. See allowed values.	`draft` `sent` `viewed` `paid`
`notes`	string	No	Notes shown on the document.
`terms`	string	No	Terms shown on the document, such as payment terms.
`items`	element	No	Container for one or more line items. Repeat <item> for each line.
`items/item`	element · repeatable	No	One line item.
`items/item/name`	string	Yes	Line item name. Required on every line.
`items/item/type`	string	Yes	Line item type: Product or Service. An empty element is treated as Product. If you leave the element out, the line is rejected.	`Product` `Service`
`items/item/description`	string	No	Line item description.
`items/item/unit_cost`	decimal (up to 2 decimal places)	No	Price per unit.
`items/item/quantity`	decimal (up to 2 decimal places)	No	Number of units. Must not be negative.
`items/item/discount`	decimal (up to 2 decimal places)	No	Discount on the line. Read as a percentage or a fixed amount, depending on discount_type.
`items/item/discount_type`	string	No	How discount is applied: Percent or Fixed. An empty element is treated as Percent.	`Percent` `Fixed`
`additional_charges`	element	No	Container for one or more extra charges, such as shipping.
`additional_charges/additional_charge`	element · repeatable	No	One extra charge.
`additional_charges/additional_charge/name`	string	No	Name of the charge, for example Shipping.
`additional_charges/additional_charge/type`	string	No	How amount is applied: Percent or Fixed. Defaults to Percent.	`Percent` `Fixed`
`additional_charges/additional_charge/amount`	decimal (up to 2 decimal places)	No	Charge value, read as a percentage or a fixed amount depending on type.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="createInvoiceFromEstimate">
  <client>
    <client_id>[CLIENT_ID]</client_id>
    <address>[ADDRESS]</address>
  </client>
  <invoice_title>[INVOICE_TITLE]</invoice_title>
  <number></number>
  <date>2026-01-15</date>
  <due_date>2026-02-14</due_date>
  <schedule_date></schedule_date>
  <po_number>[PO_NUMBER]</po_number>
  <status>draft</status>
  <notes>[NOTES]</notes>
  <terms>[TERMS]</terms>
  <items>
    <item>
      <name>[ITEM_NAME]</name>
      <type>Service</type>
      <description>[DESCRIPTION]</description>
      <unit_cost>100.00</unit_cost>
      <quantity>2</quantity>
      <discount></discount>
      <discount_type>Percent</discount_type>
    </item>
  </items>
  <additional_charges>
    <additional_charge>
      <name>Shipping</name>
      <type>Fixed</type>
      <amount>10.00</amount>
    </additional_charge>
  </additional_charges>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <invoice_id>[INVOICE_ID]</invoice_id>
</response>

Response fields

createInvoiceFromEstimate response fields
Path	Description
`invoice_id`	Identifier of the new invoice.

Errors

createInvoiceFromEstimate error messages
Status	Message	When
`400`	`Client id is not exists.`	client_id does not belong to your account.
`400`	`Date is invalid.`	A date is not a real date in YYYY-MM-DD form.
`400`	`Due Date is invalid.`	due_date is not a valid date.
`400`	`Schedule Date is invalid.`	schedule_date is not a valid date.
`400`	`Name is required.`	A line has no name.
`400`	`Cost is invalid.`	unit_cost is not a number with up to two decimal places.
`400`	`Quantity is invalid.`	quantity is negative or not a number.
`400`	`Type is invalid.`	type is not Product or Service, or the element is missing.
`400`	`Discount type is invalid.`	discount_type is not Percent or Fixed.

invoiceOfflinePayment

Record a payment received outside Invoicera, such as cash or cheque, against one or more invoices.

TransportPOST, xml_request

Request fields7

Required3

Repeat <invoice> to record several payments in one request.
Use a method name returned by listOfflinePaymentMethod.

Request fields

invoiceOfflinePayment request fields
Path	Type	Required	Description	Accepted values
`invoice`	element · repeatable	No	One payment to record. Repeat <invoice> to record payments against more than one invoice.
`invoice/id`	integer (Invoicera identifier)	Yes	Identifier of the invoice being paid. Required.
`invoice/amount`	decimal (up to 2 decimal places)	Yes	Amount received.
`invoice/method`	string	Yes	Payment method name, for example Cash or Cheque. Use a name returned by listOfflinePaymentMethod.
`invoice/date`	date (YYYY-MM-DD)	No	Date the payment was received.
`invoice/notes`	string	No	Note stored with the payment.
`invoice/client_notification`	string	No	Set to 1 to email the client a payment notification. Any other value sends nothing.	`1` `0`

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="invoiceOfflinePayment">
  <invoice>
    <id>[INVOICE_ID]</id>
    <amount>100.00</amount>
    <method>[PAYMENT_METHOD]</method>
    <date>2026-01-20</date>
    <notes>[PAYMENT_NOTES]</notes>
    <client_notification>0</client_notification>
  </invoice>
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200"></response>

Errors

invoiceOfflinePayment error messages
Status	Message	When
`400`	`Invoice id is required.`	invoice/id is missing.
`400`	`Method is required.`	invoice/method is missing.
`400`	`Amount is invalid.`	invoice/amount is not a valid amount.
`400`	`Date is invalid.`	invoice/date is not a valid date.

listLateFee

Return the active late-fee rules in your account. Use an id as late_fee on invoices.

TransportPOST, xml_request

Request fields0

Required0

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Request fields

This method takes no request fields. Send the root element on its own.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listLateFee">
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <late_fees total="1">
    <late_fee>
      <id>[LATE_FEE_ID]</id>
      <name>[LATE_FEE_NAME]</name>
    </late_fee>
  </late_fees>
</response>

Response fields

listLateFee response fields
Path	Description
`late_fees@total`	Number of rules.
`late_fees/late_fee/id`	Late-fee identifier.
`late_fees/late_fee/name`	Late-fee name.

Errors

listLateFee error messages
Status	Message	When
`404`	`Data not found. Kindly check the request.`	No active late-fee rule exists.

listTax

Return the taxes set up in your account. Use an id as tax1 or tax2 on expenses.

TransportPOST, xml_request

Request fields0

Required0

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Request fields

This method takes no request fields. Send the root element on its own.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listTax">
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <taxes total="1">
    <tax>
      <id>[TAX_ID]</id>
      <name>[TAX_NAME]</name>
      <type>Normal</type>
      <value>10.00</value>
    </tax>
  </taxes>
</response>

Response fields

listTax response fields
Path	Description
`taxes/tax/id`	Tax identifier.
`taxes/tax/name`	Tax name.
`taxes/tax/type`	Tax type.
`taxes/tax/value`	Tax rate as a percentage.

Errors

listTax error messages
Status	Message	When
`404`	`Data not found. Kindly check the request.`	No tax is set up.

listOfflinePaymentMethod

Return the offline payment method names you can use with invoiceOfflinePayment.

TransportPOST, xml_request

Request fields0

Required0

Not on the old API help pages. Documented from the request template and XML processor in the Invoicera application.

Request fields

This method takes no request fields. Send the root element on its own.

Request example

<?xml version="1.0" encoding="utf-8"?>
<request method="listOfflinePaymentMethod">
</request>

Response example

<?xml version="1.0" encoding="utf-8"?>
<response status="200">
  <payment_modes total="2">
    <payment_mode>Cash</payment_mode>
    <payment_mode>Cheque</payment_mode>
  </payment_modes>
</response>

Response fields

listOfflinePaymentMethod response fields
Path	Description
`payment_modes/payment_mode`	One method name per element.

Errors

listOfflinePaymentMethod error messages
Status	Message	When
`404`	`Data not found. Kindly check the request.`

Not supported

Do not build against names without a public request contract.

The XML processor recognises these names, but they have no public request template and are not supported. They are listed so that a name seen elsewhere is not mistaken for part of this reference.

addInvoiceLineItemNot supported. No request fields are documented.
exportInvoicePDFNot supported. No request fields are documented.
getInvoiceLogNot supported. No request fields are documented.
getInvoiceLogDetailNot supported. No request fields are documented.
invOfflinePaymentNot supported. No request fields are documented.
invoiceOnlinePaymentNot supported. No request fields are documented.
updateInvoiceLineItemNot supported. No request fields are documented.

Before production

Confirm account access and limits before you scale.

Account access and allowances can differ by plan. Confirm them with Invoicera before planning bulk imports or scheduled synchronisation.

01
Confirm access Verify the account token with getAccountInfo and confirm the method set you need.
02
Validate fields Test required and optional fields with representative non-sensitive records.
03
Handle responses Parse XML success and error responses, including failure and invalid lists, and retain a safe correlation record.
04
Control retries Prevent a timeout or repeated request from creating duplicate commercial records.

Build against the documented method surface.

Find the token

Post the XML envelope

Read the XML status

Reconcile every write

First request

First response

cURL

Sample PHP request

Endpoint and version

Authentication

Request format

Responses and status

Paging through lists

Dates

Amounts and quantities

Currency, country and language codes

Empty and missing elements

Identifiers

Limits

First call

Invoices

Estimates

Recurring invoices

Clients

Staff

Products and services

Expenses

Projects

Tasks

Time logs

Account and supporting operations

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Response fields

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example

Response example

Errors

Request fields

Request example

Response example

Request fields

Request example

Response example

Response fields

Errors

Request fields

Request example