Invoices

The Invoices API lets you list Invoices in a Workspace.

The Invoice object

{
  "id": "1",
  "number": "0000000006",
  "amount": 1000,
  "tax_mount": 100,
  "total_mount": 1100,
  "currency": "USD",
  "status": "open",
  "memo": "Thank you for your business!",
  "footer_notes": null,
  "customer": {
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "country": null,
    "company_name": null,
    "tax_id": null,
    "phone": null,
    "address": "Some str 22",
    "city": null,
    "state": null,
    "zip": null
  },
  "items": [
    {
      "id": "1",
      "charge_id": "1",
      "title": "redesign",
      "amount": 1000,
      "currency": "USD",
      "quantity": 1,
      "group": "Acme website",
      "full_title": "Acme website -- redesign",
      "created_at": "2021-11-04T13:54:42+00:00"
    }
  ],
  "tax_items": [
    {
      "id" : "1",
      "title" : "TAX",
      "tax_percentage" : 10,
      "created_at" : "2021-11-04T13:54:42+00:00",
    }
  ],
  "date": "2021-11-04T00:00:00+00:00",
  "due_date_in_days": 14,
  "due_date": "2021-11-18T13:54:56+00:00",
  "is_past_due": false,
  "paid_at": null,
  "voided_at": null,
  "marked_uncollectible_at": null,
  "created_at": "2021-11-04T13:53:59+00:00",
  "updated_at": "2021-11-04T13:54:56+00:00"
}
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

Attributes


id string

Unique identifier of the Invoice.


number string

The number of the Invoice.


amount float

The amount of the Invoice.


tax_amount float

The tax amount of the Invoice.


total_amount float

The total amount of the Invoice.


currency string

The currency of the Invoice.


status string

The status of the Invoice. Can be draft, open, paid, void, uncollectible.


memo string|null

The memo of the Invoice.


footer_notes string|null

The footer notes of the Invoice.


customer array

The customer of the Invoice. See the Invoice Customer object.


items InvoiceItem[]

The items of the Invoice. See the Invoice Item object.


tax_items InvoiceTaxItem[]

The items of the Invoice. See the Invoice Tax Item object.


date datetime|null

The date of the Invoice.


due_date_in_days int|null

The number of due days of the Invoice.


due_date datetime|null

The due date of the Invoice.


is_past_due bool

Whether the Invoice is past due.


paid_at datetime|null

The datetime when the Invoice was paid.


voided_at datetime|null

The datetime when the Invoice was voided.


marked_uncollectible_at datetime|null

The datetime when the Invoice was marked as uncollectible.


created_at datetime

The creation datetime of the Invoice.


updated_at datetime

The datetime when the Invoice was updated.



The Invoice Customer object

"customer": {
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "country": null,
  "company_name": null,
  "tax_id": null,
  "phone": null,
  "address": "Some str 22",
  "city": null,
  "state": null,
  "zip": null
},
1
2
3
4
5
6
7
8
9
10
11
12
13
14

name string

The name of the customer.


first_name string

The first name of the customer.


last_name string

The last name of the customer.


email string

The email of the customer.


country string|null

The country of the customer.


company_name string|null

The company name of the customer.


tax_id string|null

The tax/vat id of the customer's company.


phone string|null

The phone of the customer.


address string|null

The street address of the customer.


city string|null

The city of the customer.


state string|null

The state of the customer.


zip string|null

The country of the customer.



The Invoice Item object

{
  "id": "1",
  "charge_id": "1",
  "title": "redesign",
  "amount": 1000,
  "currency": "USD",
  "quantity": 1,
  "group": "Acme website",
  "full_title": "Acme website -- redesign",
  "created_at": "2021-11-04T13:54:42+00:00"
}
1
2
3
4
5
6
7
8
9
10
11

id string

The id of the Invoice Item.


charge_id string

The id of the Charge.


title string

The title of the item.


amount float

The amount of the item.


currency string

The currency of the item.


quantity string

The quantity of the item.


group string

The group title of the item.


full_title string

The full title of the item.


created_at datetime

The creation datetime of the item.



The Invoice Tax Item object

{
  "id" : "1",
  "title" : "TAX",
  "tax_percentage" : 10,
  "created_at" : "2021-11-04T13:54:42+00:00",
}
1
2
3
4
5
6

id string

The id of the Invoice Tax Item.


title string

The title of the tax item.


tax_percentage float

The tax amount (in percentage).


created_at datetime

The creation datetime of the tax item.




List Invoices

GET /v1/invoices

curl 'https://{workspace}.kitchen.co/api/v1/invoices' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

status string optional

The status of the invoice. Can be open, paid, void, uncollectible, draft, or over-due.


Response

{
  "data": [
    {
      "id": "1",
      "number": "0000000006",
      "amount": 1000,
      "tax_mount": 100,
      "total_mount": 1100,
      "currency": "USD",
      "status": "open",
      "memo": "Thank you for your business!",
      "footer_notes": null,
      "customer": {
        "name": "John Doe",
        "email": "[email protected]",
        "country": "Bulgaria",
        "company_name": "ACME INC",
        "tax_id": "11111111111",
        "phone": "2222222222",
        "address": "Some str 22",
        "city": "Varna",
        "state": "Varna",
        "zip": "9000"
      },
      "items": [
        {
          "id": "1",
          "charge_id": "1",
          "title": "redesign",
          "amount": 1000,
          "currency": "USD",
          "quantity": 1,
          "group": "Acme website",
          "full_title": "Acme website -- redesign",
          "created_at": "2021-11-04T13:54:42+00:00"
        }
      ],
      "tax_items": [
        {
          "id" : "1",
          "title" : "TAX",
          "tax_percentage" : 10,
          "created_at" : "2021-11-04T13:54:42+00:00",
        }
      ],
      "date": "2021-11-04T00:00:00+00:00",
      "due_date_in_days": 14,
      "due_date": "2021-11-18T13:54:56+00:00",
      "is_past_due": false,
      "paid_at": null,
      "voided_at": null,
      "marked_uncollectible_at": null,
      "created_at": "2021-11-04T13:53:59+00:00",
      "updated_at": "2021-11-04T13:54:56+00:00"
    }
  ],
  "meta": {}
}
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
59
60



Retrieve a Invoice

GET /v1/invoices/{invoice_id}

curl 'https://{workspace}.kitchen.co/api/v1/invoices/{invoice_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

invoice_id string required


Response

{
  "id": "1",
  "number": "0000000006",
  "amount": 1000,
  "tax_mount": 100,
  "total_mount": 1100,
  "currency": "USD",
  "status": "open",
  "memo": "Thank you for your business!",
  "footer_notes": null,
  "customer": {
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "country": null,
    "company_name": null,
    "tax_id": null,
    "phone": null,
    "address": "Some str 22",
    "city": null,
    "state": null,
    "zip": null
  },
  "items": [
    {
      "id": "1",
      "charge_id": "1",
      "title": "redesign",
      "amount": 1000,
      "currency": "USD",
      "quantity": 1,
      "group": "Acme website",
      "full_title": "Acme website -- redesign",
      "created_at": "2021-11-04T13:54:42+00:00"
    }
  ],
  "tax_items": [
    {
      "id" : "1",
      "title" : "TAX",
      "tax_percentage" : 10,
      "created_at" : "2021-11-04T13:54:42+00:00",
    }
  ],
  "date": "2021-11-04T00:00:00+00:00",
  "due_date_in_days": 14,
  "due_date": "2021-11-18T13:54:56+00:00",
  "is_past_due": false,
  "paid_at": null,
  "voided_at": null,
  "marked_uncollectible_at": null,
  "created_at": "2021-11-04T13:53:59+00:00",
  "updated_at": "2021-11-04T13:54:56+00:00"
}
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