invoices

List invoices

Lists on or more invoices for the authenticated/specified user.

Request

HTTP GET to /invoices

Parameters

* Requried if ID is specified

Example:

APIURL/invoices.xml?apikey=338934897438&state=6

Response

<invoices>
  <invoice>
    <id>1044</id>
    <number>796</number>
    <prefix>F</prefix>
    <orderedby>Homer Simpson</orderedby>
	<orderedbycustomerid>23</orderedbycustomerid>
    <totalamount>17000</totalamount>
    <rest>17000</rest>
    <invoicedate>2015-01-11</invoicedate>
    <duedate>2015-01-21</duedate>
    <payeddate/>
    <state>
      <number>2</number>
      <value>Pending</value>
    </state>
    <reminderamount>2500</reminderamount>
    <company>
      <id>1</id>
      <name>Acme INC.</name>
    </company>
  </invoice>
  <invoice>
     ...
  </invoice>
</invoices>

Create invoice

Create an invoice for the authenticated/specified user. There are three alternatives:

1. Create an invoice and set status "Not sent"
2. Create an invoice and send it by e-mail
3. Create an invoice and send ut by "Central print". See Invoice distribution for more information

Request

HTTP POST to /invoices

Parameters

* Required if "distributionmethod" is specified.

Important information about invoice distribution 

• Read the Invoice distribution documentation to understand what features BRP has support for and how to get up and running with invoice distribution.
• If "distributionmethod" is not specified the invoice will automatically be set to status 1, "Not sent". See invoice status info below.
• If "distributionmethod" is specified BRP will attempt to distribute the invoice using the specified method. If successful the invoice will receive status 9, "Waiting to be sent". If unsuccessful the invoices will retain it's original status, 1, "Not sent".
• The "distributionmethod=email" requires that the customer (or other recipient) has a valid e-mail address and an ID for a specific template, "templateid". The ID can be found in BRP by selection Report templates from the Settings menu.
• The "distributionmethod=centralprint21grams" requires that the customer (or other recipient) has a valid post address.
• The invoice will be sent and managed by the scheduled activity "Invoice distribution". Once sent the status will be modified to "Sent", this is also logged on the History tab for each specific invoice. If BRP is unable to send the invoice the status will be reset to 1, "Not sent", and any error messages will also be found on the History tab for each invoice.

Example:

APIURL/invoices.xml?apikey=338934897438&orderid=66

Response

The same as "List invoices".

Status

See Invoice status for more detailed information in regards to each specific state.
The "Number" is constant. The "Value" can however vary due to locale and future development. The meaning will however not change over time. "Number=1" will always refer to an invoice this is not sent, irregardless of the contextual lable. Always use "Number" and keep your own list for the values.