mba-cli document

3 commands

Read documents (key-scoped)

Synopsis#

bash

mba-cli document <command> [flags]

Available commands#

mba-cli document getGet one document by id

Retrieve a document by id Returns the document with the given `id`. Related: `List documents`. Get one document by id

--id

string

Document record id

GET/documents/{id}

mba-cli document get-by-referenceGet one document by reference type and id

Retrieve a document by reference Returns the document linked to a `referenceType` + `referenceId` pair (e.g. an invoice or booking). Related: `List documents`. Get one document by reference type and id

--ref-id	string	Reference id
--type	string	Reference type

GET/documents/reference/{referenceType}/{referenceId}

mba-cli document lsList documents

List documents Returns the documents for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by document type. Related: `Retrieve a document by reference`. List documents

--all	bool = false	Return all rows (paginate=false)
--document-type	string	Query parameter documentType (from the API spec)
--limit	int = 20	Query parameter limit (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)
--reference-type	string	Query parameter referenceType (from the API spec)

GET/documents

Was this page helpful?