Lists API

GET /lists

List Inventory Lists

Return inventory lists matching the documented filters and pagination options.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists \
  -H "Authorization: Bearer $TOKEN"

POST /lists

Create Inventory List

Create an inventory list from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/lists \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/audit

Create Inventory Audit

Create an inventory audit from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/audit \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /lists/export/csv

Export Inventory Lists to CSV

Export inventory lists to CSV.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/export/csv \
  -H "Authorization: Bearer $TOKEN"

POST /lists/import

Import Inventory List

Import one list from a Celerp interchange record. Re-sending the same record does not create a duplicate.

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/import \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/import/batch

Batch Import Inventory Lists

Import multiple inventory lists in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/import/batch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /lists/numbered

Find Inventory Lists by Number

Return the identifiers of the inventory lists whose number is exactly the given number.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/numbered \
  -H "Authorization: Bearer $TOKEN"

GET /lists/summary

Get Inventory List Summary

Return inventory list summary.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/summary \
  -H "Authorization: Bearer $TOKEN"

POST /lists/writeoff

Create Inventory Write-Off

Create an inventory Write-Off from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/writeoff \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /lists/{entity_id}

Get Inventory List

Return inventory list.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/:entity_id \
  -H "Authorization: Bearer $TOKEN"

PATCH /lists/{entity_id}

Update Inventory List

Update inventory list with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/lists/:entity_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

DELETE /lists/{entity_id}

Delete Inventory List

Delete a draft list.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/lists/:entity_id \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/adjust

Apply Inventory Audit Adjustment

Finish an audit by setting each counted item's quantity to its count. Differences are measured against current stock and posted as shrinkage or overage.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/adjust \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/change-type

Change Inventory List Type

Change a draft or finalized list's type. Earlier activity stays in the history.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/change-type \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/convert

Convert Inventory List

Create a document from a list, such as an invoice from a quotation list.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/convert \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/duplicate

Duplicate Inventory List

Copy a list into a new draft.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/duplicate \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/finalize

Finalize Inventory List

Finalize a draft list. For an audit, each line's on-hand quantity is recorded at this point.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/finalize \
  -H "Authorization: Bearer $TOKEN"

PATCH /lists/{entity_id}/line-page

Update Inventory List Page

Update inventory list page with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/lists/:entity_id/line-page \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

PATCH /lists/{entity_id}/line/{item_id}

Set Inventory Audit Count

Set the physical count for an inventory audit line while the audit is in its counting stage.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/lists/:entity_id/line/:item_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/move

Execute Inventory Transfer

Move every item on a finalized transfer list to one location. It can be run again, since the list stays finalized.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/move \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /lists/{entity_id}/notes

List Inventory List Notes

Return inventory list notes matching the documented filters and pagination options.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/:entity_id/notes \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/notes

Add Inventory List Note

Add a note to a list.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/notes \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

PATCH /lists/{entity_id}/notes/{note_id}

Update Inventory List Note

Update inventory list note with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/lists/:entity_id/notes/:note_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

DELETE /lists/{entity_id}/notes/{note_id}

Delete Inventory List Note

Delete a note from a list.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/lists/:entity_id/notes/:note_id \
  -H "Authorization: Bearer $TOKEN"

GET /lists/{entity_id}/old-rule-total

Get List Old Rule Total

The total a list an earlier version totalled holds and the one the document rule gives it, as money text, or nulls when they agree: the list page offers Recalculate total on it.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/:entity_id/old-rule-total \
  -H "Authorization: Bearer $TOKEN"

GET /lists/{entity_id}/page

Get Paged Inventory List

Return paged inventory list.

Parameters

Responses

Example

curl -X GET http://localhost:8000/lists/:entity_id/page \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/recalculate-total

Recalculate List Total

Give a list an earlier version totalled the totals the document rule gives it, as a recorded change the user can undo (restore-total). A list that already agrees is left as is.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/recalculate-total \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/reprice

Reprice List

Update the price of every catalog item line on a draft list from a price list, in one step. If any line cannot be repriced, nothing changes.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/reprice \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/reserve-lines

Reserve Inventory List Lines

Reserve or release selected inventory list lines without posting an accounting entry.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/reserve-lines \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/restore-total

Restore List Total

Give a recalculated list back the totals it held before, until it is next edited.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/restore-total \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/revert-to-draft

Revert Inventory List to Draft

Return a finalized list to draft. Not possible once a final action, such as an audit adjustment, has run.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/revert-to-draft \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/scan

Scan Item into Inventory List

Scan a barcode or code into a list. What happens depends on the list type and status: in a draft it adds a line, in a finalized audit it counts the item.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/scan \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/send

Send Inventory List

Mark a finalized list as sent, and email it when a recipient is given.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/send \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/set-available

Set List Lines Available

Give back what chosen List lines hold. A List never ships, so a line whose goods are sold or out on memo is refused: they are taken back on the document that shipped them. Lines with no inventory item, service lines and lines holding nothing are left as they are and listed in the answer's ``skipped`` (each line's number, name, kind and line id), with ``skipped_notice`` saying why. A choice in which no line holds anything is refused (422), naming the lines. The answer: ``new_status``: the status the lines are set to; ``reserved``: the items it holds for this record; ``released``: the items whose hold it gives back; ``acted``: the line ids of the chosen lines it acts on; ``skipped``: the chosen lines it leaves as they are, each with its number (``line``), name, ``kind`` and ``line_id``; ``skipped_notice``: the messages saying why it leaves those lines; ``binding``: this answer as one digest; send it back with the action to have the action refused (409 ``lines.preview_differs``), changing nothing, if it would now do anything else.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/set-available \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/set-scanned

Mark Inventory List Lines Scanned

Mark audit lines as scanned or clear the mark. Pass item IDs to target specific lines, or none for all lines.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/set-scanned \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/undo-adjust

Undo Inventory Audit Adjustment

Reverse the most recent inventory audit adjustment, restore the prior stock quantities, and reopen the audit for further counting or adjustment.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/undo-adjust \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/undo-write-off

Undo Inventory Write-Off

Reverse a write-off. Its journal entry is voided and each written-off lot is available again.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/undo-write-off \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/unmark-sent

Clear Inventory List Sent Status

Clear the sent milestone (the list stays finalized).

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/unmark-sent \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/void

Void Inventory List

Void a list. It stays on record.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/void \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /lists/{entity_id}/write-off

Write Off Inventory Stock

Write off the stock on a list in one step: each line's quantity leaves stock and one balanced journal entry is posted. If any line cannot be written off, nothing is.

Parameters

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/write-off \
  -H "Authorization: Bearer $TOKEN"

POST /lists/{entity_id}/writeoff-line

Update Inventory Write-Off Line

Update inventory Write-Off line with the supplied fields.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/lists/:entity_id/writeoff-line \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'