Items
A page number within the paginated result set.
GET /api/v4/invoices/items/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Get successful
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"remote_id": "ITEM_123",
"description": "Gas transportation"
}
]
}
The id of the invoice item in your system
ITEM_123
Default description when a user selects this invoice item for an invoice line
Gas transportation
POST /api/v4/invoices/items/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"remote_id": "ITEM_123",
"description": "Gas transportation"
}
Create successful
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"remote_id": "ITEM_123",
"description": "Gas transportation"
}
If you choose to identify an object with its remote_id
instead of its uid
then
-
replace the
uid
value with theremote_id
value in the URL -
specify
lookup_field=remote_id
in the query parameters
Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id
(see path parameters)
DELETE /api/v4/invoices/items/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Empty body
No content
If you choose to identify an object with its remote_id
instead of its uid
then
-
replace the
uid
value with theremote_id
value in the URL -
specify
lookup_field=remote_id
in the query parameters
Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id
(see path parameters)
The id of the invoice item in your system
ITEM_123
Default description when a user selects this invoice item for an invoice line
Gas transportation
PATCH /api/v4/invoices/items/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"remote_id": "ITEM_123",
"description": "Gas transportation"
}
Update successful
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"remote_id": "ITEM_123",
"description": "Gas transportation"
}
Last updated
Was this helpful?