Invoices

Download schema

Endpoints for viewing team invoices.

List invoices

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/invoices

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all invoices issued to a team.

List invoices › path Parameters

teamSlug

string · required

team slug

List invoices › query Parameters

page

integer · min: 1

Page number to return.

Default: 1

per_page

integer · min: 1 · max: 100

Number of items to return per page.

Default: 50

app_id

string · enum

Application identifier to filter invoices by.

Enum values:

domainchief

certchief

deploychief

tny

flowguard

backupchief

socketchief

serverchief

sort

string · enum

Invoice date sort direction. Use desc for newest first or asc for oldest first.

Enum values:

asc

desc

Default: desc

expand[]

string[]

Related resource to include. The supported value is lines.

Enum values:

lines

List invoices › Responses

Paginated set of TeamInvoice

TeamInvoice[] · required

object · required

GET/v1/teams/{teamSlug}/invoices

curl https://account.chief.app/api/v1/teams/:teamSlug/invoices \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "number": "number",
      "app": {
        "id": "domainchief",
        "name": "name"
      },
      "status": "draft",
      "invoice_date": "2024-08-25T15:00:00Z",
      "total": 0,
      "currency": "EUR",
      "line_count": 0,
      "memo": "memo",
      "payment_pending": true,
      "hosted_url": "hosted_url",
      "pdf_url": "pdf_url",
      "lines": [
        {
          "id": "id",
          "source_team": {
            "slug": "slug",
            "name": "name"
          },
          "description": "description",
          "amount": 0,
          "category": {
            "key": "key",
            "label": "label"
          },
          "resource": {
            "id": "id",
            "type": "type",
            "label": "label"
          },
          "period_start": "2024-08-25T15:00:00Z",
          "period_end": "2024-08-25T15:00:00Z"
        }
      ]
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Show invoice

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/invoices/{invoiceId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retrieve a single invoice issued to a team.

Show invoice › path Parameters

teamSlug

string · required

team slug

invoiceId

string · required

invoice identifier

Show invoice › query Parameters

expand[]

string[]

Related resource to include. The supported value is lines.

Enum values:

lines

Show invoice › Responses

TeamInvoice

TeamInvoice · required

GET/v1/teams/{teamSlug}/invoices/{invoiceId}

curl https://account.chief.app/api/v1/teams/:teamSlug/invoices/:invoiceId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "id",
    "number": "number",
    "app": {
      "id": "domainchief",
      "name": "name"
    },
    "status": "draft",
    "invoice_date": "2024-08-25T15:00:00Z",
    "total": 0,
    "currency": "EUR",
    "line_count": 0,
    "memo": "memo",
    "payment_pending": true,
    "hosted_url": "hosted_url",
    "pdf_url": "pdf_url",
    "lines": [
      {
        "id": "id",
        "source_team": {
          "slug": "slug",
          "name": "name"
        },
        "description": "description",
        "amount": 0,
        "category": {
          "key": "key",
          "label": "label"
        },
        "resource": {
          "id": "id",
          "type": "type",
          "label": "label"
        },
        "period_start": "2024-08-25T15:00:00Z",
        "period_end": "2024-08-25T15:00:00Z"
      }
    ]
  }
}

json

application/json

Connected applications Members