Invoices

Invoices, their lines and PDF.

GET/invoicesList invoices
GET/invoices/{invoice_id}An invoice
GET/invoices/{invoice_id}/linesInvoice lines
GET/invoices/{invoice_id}/messagesMessages about an invoice
GET/invoices/{invoice_id}/pdfInvoice PDF

List invoices

GET/invoices

Needs the permission invoice:read

Newest first, with what is still due.

Response 200

`id`required	string
`number`required	string
`issue_date`required	string
`amount_total`required	number
`currency`required	string
`status`required	string
`pdf_available`required	boolean
`amount_due`	number	default 0
`due_date`	string	default ""

curl "https://portal.nimag.net/api/v1/invoices" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "number": "string",
    "issue_date": "string",
    "amount_total": 0,
    "currency": "string",
    "status": "string",
    "pdf_available": true,
    "amount_due": 0,
    "due_date": ""
  }
]

An invoice

GET/invoices/{invoice_id}

Needs the permission invoice:read

Path

invoice_idrequired string

Response 200

`id`required	string
`number`required	string
`issue_date`required	string
`amount_total`required	number
`currency`required	string
`status`required	string
`pdf_available`required	boolean
`amount_due`	number	default 0
`due_date`	string	default ""

curl "https://portal.nimag.net/api/v1/invoices/{invoice_id}" \
  -H "Authorization: Bearer nck_…"

{
  "id": "string",
  "number": "string",
  "issue_date": "string",
  "amount_total": 0,
  "currency": "string",
  "status": "string",
  "pdf_available": true,
  "amount_due": 0,
  "due_date": ""
}

Invoice lines

GET/invoices/{invoice_id}/lines

Needs the permission invoice:read

Path

invoice_idrequired string

Response 200

`description`required	string
`quantity`required	number
`unit_price`required	number
`tax_label`required	string
`subtotal`required	number
`total`required	number

curl "https://portal.nimag.net/api/v1/invoices/{invoice_id}/lines" \
  -H "Authorization: Bearer nck_…"

[
  {
    "description": "string",
    "quantity": 0,
    "unit_price": 0,
    "tax_label": "string",
    "subtotal": 0,
    "total": 0
  }
]

Messages about an invoice

GET/invoices/{invoice_id}/messages

Needs the permission invoice:read

Path

invoice_idrequired string

Response 200

`author`required	string
`body`required	string
`created_at`required	string

curl "https://portal.nimag.net/api/v1/invoices/{invoice_id}/messages" \
  -H "Authorization: Bearer nck_…"

[
  {
    "author": "string",
    "body": "string",
    "created_at": "string"
  }
]

Invoice PDF

GET/invoices/{invoice_id}/pdf

Needs the permission invoice:read

The invoice as a PDF file.

Path

invoice_idrequired string

Response 200: Successful Response.

curl "https://portal.nimag.net/api/v1/invoices/{invoice_id}/pdf" \
  -H "Authorization: Bearer nck_…"

"string"