Documents

Name	Type	Path
GetDocuments	GET	/api/Document
		Get a list of documents with a search filter.
GetDocumentByIntRef	GET	/api/Document/intref/{intRef}
		Get a document by the internal reference.
GetDocument	GET	/api/Document/{idOrDocNo}
		Get a document by id or document number.
GetDocumentMatchDetails	GET	/api/Document/{idOrDocNo}/match/details
		Get document match details.
GetDocumentMatchSummary	GET	/api/Document/{idOrDocNo}/match/outstanding/amount
		Get document match summary (amount only).
GetDocumentMatchReverse	GET	/api/Document/{idOrDocNo}/match/reverse
		Get document match reverse details.
CreateDocument	POST	/api/Document
		Create a document.
AddAllocationToDocument	POST	/api/Document/{docIdOrCode}/allocation
		Add an allocation to the document.
SubmitDocument	POST	/api/Document/{docId}/submit
		Submit the document for authorisation and posting.
AddDocumentDetailLine	POST	/api/Document/{docRef}/detail
		Add a document detail line.
ConvertDocumentType	POST	/api/Document/{fromDocId}/convert/{toDocType}
		Convert a document to another type.
AbandonDocument	POST	/api/Document/{idOrDocNo}/abandon
		Abandon a draft document.
DisputeDocument	POST	/api/Document/{idOrDocNo}/dispute
		Dispute a document.
UnauthoriseDocument	POST	/api/Document/{idOrDocNo}/unauthorise
		Unauthorise an approved document (non GL documents only).
UnpostDocument	POST	/api/Document/{idOrDocNo}/unpost
		Unpost a document.
UpdateDocumentDetailLineObsolete	PATCH	/api/Document/detail/{docDetailId}
		Update a document detail line.
UpdateDocumentDetailLine	PATCH	/api/Document/{docRef}/detail/{docDetailRef}
		Update a document detail line.
UpdateDocument	PATCH	/api/Document/{idOrDocNo}
		Update a document.
AmendDocument	PATCH	/api/Document/{idOrDocNo}/amend
		Amend a document.
DeleteDocumentDetailLine	DELETE	/api/Document/{docRef}/detail/{docDetailRef}
		Delete a document detail line.

---

Updated April 2024