Skip to main content
POST
Close delivery note

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id
string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Path Parameters

id
string<uuid>
required

Response

OK

A delivery note and its received lines.

dnNumber
string
required

Human delivery-note number. Required and unique within the organisation.

id
string<uuid>

Unique identifier of the delivery note.

organisationId
string<uuid>

The organisation that owns the delivery note.

supplierId
null | string<uuid>

The supplier the goods were received from, if assigned.

externalRef
null | string

Caller's own reference for the note (a reverse pointer to the platform's record), if any.

purchaseOrderId
null | string<uuid>

Loose header link to a purchase order, if one was provided. Optional.

receivedAt
null | string<date-time>

When the goods were received, if recorded.

status
enum<string>

Lifecycle status: Draft, Open, PartiallyMatched, FullyMatched (all derived from matching), or the manual terminal states Closed / Cancelled.

Available options:
Draft,
Open,
PartiallyMatched,
FullyMatched,
Closed,
Cancelled
lines
object[]

The received lines, in display order.

createdAt
string<date-time>

When the delivery note was created.

updatedAt
string<date-time>

When the delivery note was last updated.