Working with Invoices

The following API commands enable you to work with Invoices.

invoices #

Compatibility Note

This command is available from activeCollab 4.1.5 and cannot be used with previous releases.

This command lists all Issued, Paid and Canceled Invoices in activeCollab.

Method: GET

The invoice status values are:

1 - Issued but not paid
2 - Paid
3 - Canceled

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<invoices>
  <invoice>
    <id> ... </id>
    <number> ... </number>
    <client>
      <id> ... </id>
      <name> ... </name>
      <address> ... </address>
    </client>
    <currency>
      <id> ... </id>
      <code> ... </code>
    </currency>
    <language>
      <id> ... </id>
      <code> ... </code>
    </language>
    <project_id> ... </project_id>
    <amount>
      <subtotal> ... </subtotal>
      <tax> ... </tax>
      <total> ... </total>
      <paid_amount> ... </paid_amount>
      <balance_due> ... </balance_due>
    </amount>
    <note> ... </note>
    <purchase_order_number> ... </purchase_order_number>
    <status>1</status>
    <created_on> ... </created_on>
    <issued_on> ... </issued_on>
    <due_on> ... </due_on>
    <items>
      <item>
        <num>1</num>
        <description> ... </description>
        <quantity> ... </quantity>
        <unit_cost> ... </unit_cost>
        <subtotal> ... </subtotal>
        <first_tax>
          <value> ... </value>
          <name> ... </name>
          <rate> ... </rate>
        </first_tax>
        <second_tax>
          <value> ... </value>
          <is_compound> ... </is_compound>
          <name> ... </name>
          <rate> ... </rate>
        </second_tax>
        <total> ... </total>
      </item>
      ...
    </items>
    <permalink> ... </permalink>
    <private_note> ... </private_note>
    </invoice>
    ...
</invoices>

« Prev

Back to the Top

activeCollab Help Center

Working with Invoices

invoices #