Sign in

v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB
Invoices

Get Invoice

Retrieve a single invoice with its full line-item breakdown.

get/invoices/{invoice_id}

Path parameters

invoice_idnumber required
Example:11903

Invoice ID

Response

OK

idnumber required

Invoice ID

createdAtstring required
dateFromstring
dateTillstring
dueDatestring
expenseMaskstring
includeExpensesboolean
includeTimeboolean
issueDatestring
limitDateFromstring
limitDateTillstring
listAmountnumber

List amount in cents (without discount and taxes)

netAmountnumber

Net amount in cents (without taxes but with discount applied)

projectsstring[]
publicIdstring
status'draft' | 'sent' | 'paid' | 'deleted' | 'partial' required
timeMaskstring
totalAmountnumber

Total invoice amount in cents (with discount and taxes applied)

totalTimenumber

Total invoice time in seconds

validboolean

Example response

{
  "id": 2660155,
  "client": {
    "id": 4567,
    "name": "Client Name",
    "projects": [
      "ev:1234567890"
    ],
    "budget": {
      "type": "money",
      "budget": 100000,
      "period": "general"
    }
  },
  "createdAt": "2018-01-16 12:42:59",
  "createdBy": {
    "id": 1304,
    "name": "User Name",
    "headline": "CEO",
    "role": "admin",
    "status": "active"
  },
  "discount": {
    "amount": 4581,
    "rate": 25
  },
  "expenseMask": "%PROJECT% :: %CATEGORY%",
  "includeExpenses": true,
  "includeTime": true,
  "invoiceItems": [
    {
      "billedTime": 415860,
      "createdAt": "2017-02-22 16:11:33",
      "id": 52,
      "listAmount": 288793,
      "name": "Software Development",
      "netAmount": 288793,
      "position": 1,
      "taxable": 1,
      "totalAmount": 288793
    }
  ],
  "issueDate": "2019-03-22",
  "listAmount": 18325,
  "netAmount": 13744,
  "projects": [
    "gh:63301595"
  ],
  "publicId": "1020",
  "status": "draft",
  "tax": {
    "rate": 11,
    "amount": 1512
  },
  "timeMask": "%PROJECT%",
  "totalAmount": 15256,
  "totalTime": 43980,
  "valid": true
}