Docs API

GET /docs

List Business Documents

Return business documents matching the documented filters and pagination options.

Parameters

Responses

Example

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

POST /docs

Create Business Document

Create a business document from the supplied request data.

Request body

Responses

Example

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

POST /docs/accounting-sync/bulk

Update Accounting Sync Selection

One reviewed selection of documents, committed atomically with their audit events.

Request body

Responses

Example

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

DELETE /docs/bulk-draft

Bulk Delete Draft Documents

Delete multiple draft business documents in one request. Documents that are no longer drafts are skipped.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/docs/bulk-draft \
  -H "Authorization: Bearer $TOKEN"

POST /docs/bulk-payment

Record Bulk Document Payment

Record payments for multiple eligible business documents in one request.

Request body

Responses

Example

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

GET /docs/export/csv

Export Business Documents to CSV

Export business documents to CSV.

Parameters

Responses

Example

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

POST /docs/import

Import Business Document

Import one document 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/docs/import \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /docs/import/batch

Batch Import Business Documents

Import multiple business documents in one request.

Request body

Responses

Example

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

GET /docs/numbered

Find Documents by Number

Return the identifiers of the business documents whose number is exactly the given number.

Parameters

Responses

Example

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

GET /docs/sequences

Get Document Numbering Sequences

Return document numbering sequences.

Responses

Example

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

PATCH /docs/sequences/{doc_type}

Update Document Numbering Sequence

Update document numbering sequence with the supplied fields.

Parameters

Request body

Responses

Example

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

POST /docs/shipment

Create Shipping Document from Source Documents

Create shipping document from source documents from the supplied request data.

Request body

Responses

Example

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

GET /docs/summary

Get Business Document Summary

Return business document summary.

Parameters

Responses

Example

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

GET /docs/{entity_id}

Get Business Document

Return business document.

Parameters

Responses

Example

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

PATCH /docs/{entity_id}

Update Business Document

Update business document with the supplied fields.

Parameters

Request body

Responses

Example

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

DELETE /docs/{entity_id}

Delete Draft Business Document

Delete a draft document. Finalized documents cannot be deleted; void them instead.

Parameters

Responses

Example

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

POST /docs/{entity_id}/apply-to-bill

Apply Supplier Credit to Bill

Apply a supplier credit note to a bill or purchase order of the same supplier, reducing what is owed to the supplier.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/apply-to-invoice

Apply Credit Note to Invoice

Apply a credit note's balance to an open invoice, reducing what the customer owes.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/back-to-memo

Back To Memo

Send chosen lines of a draft invoice back to the memos they were invoiced from: their goods go back on their memo lines, the lines leave the invoice, and the fixed amounts of a memo none of whose lines stay come off the invoice's header (released_header_money). A chosen line of the invoice's own did not come from a memo, so it stays on the invoice and is named in ``skipped``; a choice of only such lines is refused. The answer: ``removed``: the line ids it takes off the invoice; ``reopened_memos``: the memos the lines go back to; ``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/docs/:entity_id/back-to-memo \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /docs/{entity_id}/close

Close Business Document

Close a memo once every line has been sold, kept or returned. A memo with lines still out cannot be closed. Reopen reverses it.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/cn-refund

Refund Credit Note

Refund a credit note's balance to the customer as money paid out.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/convert

Convert Business Document

Create a new document from this one, such as an invoice from a quotation or a bill from a purchase order.

Parameters

Request body

DocConvertBody, optional

Responses

Example

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

POST /docs/{entity_id}/files

Upload Document File

Upload a file and attach it to a document.

Parameters

Responses

Example

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

GET /docs/{entity_id}/files/{file_id}

Download Document File

Download a file attached to a doc (invoice, bill, etc.).

Parameters

Responses

Example

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

DELETE /docs/{entity_id}/files/{file_id}

Delete Document File

Delete a file attached to a document.

Parameters

Responses

Example

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

PATCH /docs/{entity_id}/files/{file_id}/description

Update Document File Description

Update document file description with the supplied fields.

Parameters

Responses

Example

curl -X PATCH http://localhost:8000/docs/:entity_id/files/:file_id/description \
  -H "Authorization: Bearer $TOKEN"

PATCH /docs/{entity_id}/files/{file_id}/tag

Tag Document File

Set the tag on a file attached to a document, such as receipt or contract.

Parameters

Responses

Example

curl -X PATCH http://localhost:8000/docs/:entity_id/files/:file_id/tag \
  -H "Authorization: Bearer $TOKEN"

POST /docs/{entity_id}/finalize

Finalize Business Document

Finalize a draft document. It gets its number and posts to the ledger, and can no longer be edited freely.

Parameters

Responses

Example

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

POST /docs/{entity_id}/fulfill-lines

Fulfill Document Lines

Mark selected lines as fulfilled, taking their items out of stock.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/invoice-lines

Invoice Lines

Invoice chosen goods out on a memo onto a new invoice or a draft invoice of the same customer (Invoice selected). With ``dry_run``, what it would do, writing nothing. The answer: ``target_doc_id``: the invoice the goods are billed on; ``draw_id``: the draw's id on the memo; ``event_id``: the id of the event that records the draw; ``invoiced``: how many memo lines it bills; ``memo_ref``: the memo's number; ``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.

Parameters

Request body

Responses

Example

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

GET /docs/{entity_id}/notes

List Document Notes

Return document notes matching the documented filters and pagination options.

Parameters

Responses

Example

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

POST /docs/{entity_id}/notes

Add Document Note

Add a note to a document.

Parameters

Request body

Responses

Example

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

PATCH /docs/{entity_id}/notes/{note_id}

Update Document Note

Update document note with the supplied fields.

Parameters

Request body

Responses

Example

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

DELETE /docs/{entity_id}/notes/{note_id}

Delete Document Note

Delete a note from a document.

Parameters

Responses

Example

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

POST /docs/{entity_id}/payment

Record Document Payment

Record a payment received or made against a document.

Parameters

Request body

Responses

Example

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

DELETE /docs/{entity_id}/payments/{payment_index}

Delete Payment

Delete a payment entered by mistake. Unlike voiding, which posts a reversal that shows in the bank ledger, deleting removes the payment and its journal entry from all reports.

Parameters

Request body

Responses

Example

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

GET /docs/{entity_id}/pdf

Generate Document PDF

Return a PDF of the document with 'Powered by Celerp' footer branding.

Parameters

Responses

Example

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

POST /docs/{entity_id}/receive

Receive Purchase Order or Bill

Receive the goods on a purchase order or bill into stock.

Parameters

Request body

Responses

Example

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

DELETE /docs/{entity_id}/receive

Undo Goods Receipt

Undo receiving goods on a bill. The inventory items created by the receipt are removed and the inventory and accounts payable entry is reversed.

Parameters

Responses

Example

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

POST /docs/{entity_id}/receive-return

Receive Returned Goods

Receive goods returned on a credit note back into stock. Item costs come from the original invoice when there is one, not from the request.

Parameters

Request body

Responses

Example

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

DELETE /docs/{entity_id}/receive-return

Undo Returned-Goods Receipt

Undo receiving returned goods on a credit note. The inventory items created by the return are removed and the cost of goods sold entry is reversed.

Parameters

Responses

Example

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

POST /docs/{entity_id}/refund

Record Document Refund

Record a refund against a document.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/renumber

Renumber Business Document

Change a document's display number. The number must be unique in the company. Void documents cannot be renumbered.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/reopen

Reopen Business Document

Undo a Close: restore the memo to the status it held before closing.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/reprice

Reprice Document

Update the price of every catalog item line on a draft document 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/docs/:entity_id/reprice \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /docs/{entity_id}/reserve-lines

Reserve Document Lines

Set selected lines reserved/available on an invoice or memo (ledger-neutral).

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/return-items

Return Consignment Items

Return consignment items to the supplier and take them out of stock.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/revert-lines

Revert Document Fulfillment

Undo fulfillment on selected lines of a memo or invoice, putting the items back in stock. For bills, use undo receipt instead.

Parameters

Request body

Responses

Example

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

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

Revert Business Document to Draft

Return a finalized document to draft so it can be edited.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/scan

Scan Items Into Document

Add a scanned run of codes to a document as new lines. `barcode` holds the codes separated by commas. A code the document cannot take, such as an unknown code, an unavailable lot or a held quantity, is reported on its own and does not stop the rest. The lines that pass are written together. A repeated `run_key` returns the first answer without adding again.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/send

Send Business Document

Send a document to the contact by email, or mark it as sent.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/set-available

Set Lines Available

Set chosen lines of an invoice or memo as available in one request: holds are given back and shipped goods are taken back, and the lines it acts on change together or not at all. Lines with no inventory item, service lines and lines with nothing held or out 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 has anything held or out is refused (422), naming the lines. The answer: ``fulfillment_status``: the record's shipping status after the action; ``reverted``: the items it takes back whole; ``partially_returned``: for each line returned in part, the new in-stock item split off, with its ``item_id``, ``sku`` and ``quantity``; ``released``: the items whose hold it gives back; ``taken_back``: the shipped lines whose shipment it reverses, taking their goods back into stock, each with its number (``line``), name and ``line_id``; ``taken_back_notice``: the message naming those lines; ``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/docs/:entity_id/set-available \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /docs/{entity_id}/tax-rate

Set Memo Tax Rate

Work out the tax of an issued memo, entered as an amount with no rate, at a rate instead (memo_tax_rate_money), so part of the memo can be invoiced. With ``dry_run``, the figures it would store and their binding, writing nothing and holding no lock. A memo whose rate cannot be set is refused for that alone (its preview was refused too, so there is no binding to compare); otherwise the write stores only the preview whose binding it sends.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/unvoid

Unvoid Business Document

Restore a voided document to its previous status.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/void

Void Business Document

Void a document. Its ledger entries are reversed and it stays on record.

Parameters

Request body

Responses

Example

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

POST /docs/{entity_id}/void-payment

Void Document Payment

Void a payment. A reversing entry is posted and the payment stays on record.

Parameters

Request body

Responses

Example

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