Invoices

Invoices

Get all invoices

get

/api/c1/invoices

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Header parameters

Acceptstring · enumRequired

The client must specify an Accept header.

Possible values:

Responses

200

OK

application/vnd.api+json

401

Unauthorized

application/vnd.api+json

get/api/c1/invoices

GET /api/c1/invoices HTTP/1.1
Host: api.plock.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/vnd.api+json

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "invoices",
      "id": "2002",
      "attributes": {
        "amount": "1000.00",
        "accountId": "5001",
        "erpId": "fn123",
        "subscriptionId": "4342",
        "currency": "EUR",
        "invoiceType": "In arrears",
        "periodStart": "2026-01-01",
        "periodEnd": "2026-01-01",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "dueAt": "2026-01-01T00:00:00.000Z",
        "paymentStatus": "Paid"
      },
      "relationships": {
        "subscriptions": "text",
        "accounts": "text",
        "invoice-items": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}

Get specific invoice

get

/api/c1/invoices/{invoiceId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

invoiceIdintegerRequired

Plock invoice ID

Query parameters

Header parameters

Acceptstring · enumRequired

The client must specify an Accept header.

Possible values:

Responses

200

OK

application/vnd.api+json

401

Unauthorized

application/vnd.api+json

404

Not found

application/vnd.api+json

get/api/c1/invoices/{invoiceId}

GET /api/c1/invoices/{invoiceId} HTTP/1.1
Host: api.plock.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/vnd.api+json

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": {
    "type": "invoices",
    "id": "2002",
    "attributes": {
      "amount": "1000.00",
      "accountId": "5001",
      "erpId": "fn123",
      "subscriptionId": "4342",
      "currency": "EUR",
      "invoiceType": "In arrears",
      "periodStart": "2026-01-01",
      "periodEnd": "2026-01-01",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "dueAt": "2026-01-01T00:00:00.000Z",
      "paymentStatus": "Paid"
    },
    "relationships": {
      "subscriptions": "text",
      "accounts": "text",
      "invoice-items": "text"
    },
    "links": {
      "self": "text"
    }
  }
}

Get items for a specific invoice

get

/api/c1/invoices/{invoiceId}/invoice-items

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

invoiceIdintegerRequired

Plock invoice ID

Query parameters

Header parameters

Acceptstring · enumRequired

The client must specify an Accept header.

Possible values:

Responses

200

OK

application/vnd.api+json

401

Unauthorized

application/vnd.api+json

404

Not found

application/vnd.api+json

get/api/c1/invoices/{invoiceId}/invoice-items

GET /api/c1/invoices/{invoiceId}/invoice-items HTTP/1.1
Host: api.plock.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/vnd.api+json

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "text"
  },
  "data": [
    {
      "type": "invoice-items",
      "id": "3001",
      "attributes": {
        "unit_amount": 10,
        "quantity": 100,
        "amount": 1104.45,
        "rebate": -10.45,
        "breakdown": {
          "rebate": -10.45
        },
        "product_name": "API Calls",
        "plan_name": "Bronze plan",
        "description": "A description text",
        "type": "Revenue"
      },
      "relationships": {
        "invoices": "text"
      },
      "links": {
        "self": "text"
      }
    }
  ]
}