plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Invoice

Invoice

A legacy invoice header: the description, date and hourly rate a project was billed at before sales invoices replaced it.

View as Markdown
Summary view
InvoiceList, 11 fields. What a list returns by default.
Detail view
Invoice, 11 fields. The default for a single read and for every write.
Read with
api:read:invoicesandinvoices::read
Write with
api:write:invoicesandinvoices::create

It can be listed, read and created, but never edited or deleted through the API: both are always refused. Its rows are not exposed in any form, so there is no line-item total here.

Used by

GETList invoices/invoicesInvoiceList
POSTCreate an invoice/invoicesInvoice
GETRead an invoice/invoices/{invoice}Invoice

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

project_idinteger

Project this invoice was raised for.

projectRef or ProjectSummary

The project this invoice was raised for.

user_idinteger or nullServer-assigned

Employee the invoice is attributed to. Assigned from the authenticated user on create and never writable; null once that user is deleted.

userRef or UserSummary or null

The employee this invoice is attributed to. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.

descriptionstringMultiline

What was invoiced, as free text. This is the field ?q= searches.

datedate (YYYY-MM-DD)

Invoice date, a zone-free calendar date. Newest first is the default sort.

hourly_ratedecimal (2 dp)≥ 0

Hourly rate this invoice was billed at, as a decimal string with two places. Never rounded or rescaled.

2 decimal places, not negative

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync. It also feeds the ETag revision, because a legacy invoice has no version field.

Variants

InvoiceList 11 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

InvoiceSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: project_id, project, user_id, user, description, created_at, updated_at, links

hourly_rate narrows from decimal (2 dp) ≥ 0 to decimal (2 dp).

InvoiceLinks 1 field

The links object on this resource.

Keys: self