Invoices

If the query param statusFilter is not present, all invoice are listed. If statusFilter=PAID (case-sensitive), only paid invoice (instant or deferred) are included. If statusFilter=UNPAID (case-sensitive), only unpaid invoices (that are finalised) are included.

Rate limit: 3000 requests per minute.

Request

Responses

Retrieve the invoice by id.

In countries like Canada, Government collects taxes at national and state level. To show these different taxes, we have taxItems. So Tax calculation will have multiple taxes to be considered.

Tax summaries can be constructed by grouping on the taxAmountLabel property.

e.g. multiple tax items - Canada.

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
//InvoiceItem (“item1”)
  {
  // other invoice item properties...

   taxItems: [
      {
        id: “taxItem1",
        tax: 5.00,
        taxPercent: 10.00,
        taxId: null,
        taxAmountLabel: “GST”
      },
      {
        id: “taxItem2",
        tax: 10.00,
        taxPercent: 20.00,
        taxId: “bc_tax_id_456”,
        taxAmountLabel: “HST”
      }
    ]
  },

//InvoiceItem (“item2”)
  {
  // other invoice item properties...

   taxItems: [
      {
        id: “taxItem1",
        tax: 3.00,
        taxPercent: 10.00,
        taxId: null,
        taxAmountLabel: “GST”
      },
      {
        id: “taxItem2",
        tax: 6.00,
        taxPercent: 20.00,
        taxId: “bc_tax_id_456”,
        taxAmountLabel: “HST”
      }
    ]
  }

Consumers themselves will need to calculate TaxSummary as below.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  taxSummary[
    {
      id: “taxItem1”,
      tax: 8.00,     // summed GST of both invoice items
      taxPercent: 10.00,
      taxId: null,
      taxAmountLabel: “GST”
    },
    {
      id: “taxItem2”,
      tax: 16.00,     // summed HST of both invoice items
      taxPercent: 20.00,
      taxId: “bc_tax_id_456",
      taxAmountLabel: “HST”
     }
   ]
  }

Rate limit: 3000 requests per minute.

Request

Responses