Documents

A document in e-invoicing refers to a formal, structured piece of information that contains details related to invoicing: e.g financial data, payment details, tax information etc. or any other information relevant to the company's operations, services, or interactions with clients and partners. Every Banqup document is associated with a unique UUID that is stored in the Banqup database as documentId. The UUID is generated when a new file is received/uploaded into Banqup and is necessary when performing document actions via the Banqup APIs.

📄️ Approve documents

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Approve documents with provided IDs on the given space <br/> Scope: space_write

📄️ Complete documents

Complete documents with provided IDs on the given space

📄️ Dispute documents

Dispute documents with provided IDs on the given space

📄️ Mark documents as paid

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Mark documents with provided IDs on the given space as paid <br/> Scope: space_write

📄️ Mark documents as refused

📄️ Mark documents as resolved

📄️ Mark documents as unpaid

📄️ Mark documents as won't be paid

📄️ Partially approve documents

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Partially approve documents with provided IDs on the given space <br/> Scope: space_write

📄️ Refuse documents

Refuse documents with provided IDs on the given space

📄️ Reject documents

Reject documents with provided IDs on the given space

📄️ Suspend documents

Suspend documents with provided IDs on the given space

📄️ Get list of document attachments

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of document attachments by documentId on the given space, with the option to filter out the result, and support pagination. <br/> Scope: space_read

📄️ Create document attachment

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create attachment of the given document <br/> Scope: space_write

📄️ Get document attachment info

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document's attachment information by its ID on the given space <br/> Scope: space_read

📄️ Delete document attachment

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document attachment by its ID on the given space. <br/> Scope: space_write

📄️ Update document attachment

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update attachment of the given document <br/> Scope: space_write

📄️ Retrieve document attachment content

Retrieve document attachment content by its ID on the given space <br/> Scope: space_read

📄️ Get list of document representations

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of document representations on the given space,

📄️ Create document representation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create document representation on the given space <br/> Scope: space_write

📄️ Get document representation info

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document representation information by its ID on the given space <br/> Scope: space_read

📄️ Delete document representation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document representation by its ID on the given space <br/> Scope: space_write

📄️ Update document representation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update document representation by its ID on the given space <br/> Scope: space_write

📄️ Retrieve document content

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve document content by its ID on the given space <br/> Scope: space_read

📄️ Write content to document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Set the content of document by its ID on the given space <br/> Scope: space_write

📄️ Mark document as completed

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Mark document on the given space as completed <br/> Scope: space_write

📄️ Get list of documents

Get list of documents on the given space, with options to filter out the result.

📄️ Create document

Create document on the given space

📄️ Get list of documents in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of documents in the given folder, with options to filter out the result.

📄️ Create document in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create document in the given folder. It can optionally contain line items. <br/> Scope: space_write

📄️ Get document info

Get document information by its ID on the given space

📄️ Delete document

Delete document by its ID on the given space. Will cascade delete associated balance offsets.

📄️ Update document

Update document by its ID on the given space by sending json with the changes

📄️ Get document info in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document information by its ID in the given folder <br/> Scope: space_read

📄️ Delete document in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document by its ID in the given folder. Will cascade delete associated balance offsets. <br/> Scope: space_write

📄️ Update document in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update document by its ID in the given folder by sending json with the changes <br/> Scope: space_write

📄️ Get count of documents

Get count of documents on the given space

📄️ Count documents in folder

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get count of documents in the given folder <br/> Scope: space_read

📄️ Get files that linked to document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get files that linked to document by its ID on the given space <br/> Scope: space_read

📄️ Link files to document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Link files to document <br/> Scope: space_write

📄️ Update document with JSON patch

Update document by its ID on the given space by sending JSON patch

📄️ Update document in folder via JSON patch

📄️ Get line items

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve document line items <br/> Scope: space_read

📄️ Create line item(s)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create line item(s) in the document. New line items are added to the existing ones <br/> Scope: space_write

📄️ Get line item

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get line item detail <br/> Scope: space_read

📄️ Delete line item

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete line item <br/> Scope: space_write

📄️ Update line item

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update line item <br/> Scope: space_write

📄️ Get document tasks

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of document tasks on the given document in the given space. The API supports pagination. <br/> Scope: space_read

📄️ Create document task

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create document task on the given document in the given space. <br/> Scope: space_write

📄️ Get document task info

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document task information by extension name on the given document in the given space. <br/> Scope: space_read

📄️ Delete document task

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete a document task by extension name on the given document in the given space. <br/> Scope: space_write

📄️ Update document task

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update document task by extension name on the given document in the given space. <br/> Scope: space_write

📄️ Get list of document relations

📄️ Create document relations

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create document relations for given document <br/> Scope: space_write

📄️ Delete document relation

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document relation by id on the given space <br/> Scope: space_write

📄️ Get balance offsets of a document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get balance offsets of a document on the given space <br/> Scope: space_read

📄️ Retrieve document list balance offsets

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve the balance offsets of a list of documents in the given space, ordered by document id. <br/> Scope: space_read

📄️ Get documents payment details

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get documents payment details by the IDs on the given space <br/> Scope: space_read

📄️ Create directory

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create a directory in the given folder and space <br/> Scope: space_write

📄️ Get directory details

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get details of directory on the given space. <br/> Scope: space_read

📄️ Delete directory

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete directory on the given space. <br/> Scope: space_write

📄️ Update directory details

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update directory details on the given space. <br/> Scope: space_write

📄️ Get directory contents

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get directories and documents in a directory <br/> Scope: space_read

📄️ Get root directory contents

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get the top-level (root) directories and documents <br/> Scope: space_read

📄️ Move directory

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Move a directory in another parent directory that belongs to the same space and the same folder. <br/> Scope: space_write

📄️ Get document lines v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve document lines v2 <br/> Scope: space_read

📄️ Replace document lines v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Replace lines v2 in the document. Overwrite all the lines of a document <br/> Scope: space_write

📄️ Create document lines v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create lines v2 in the document. New lines are added to the existing ones <br/> Scope: space_write

📄️ Get document line v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document line detail v2 <br/> Scope: space_read

📄️ Delete document line v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document line v2 <br/> Scope: space_write

📄️ Update document line v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update document line v2 <br/> Scope: space_write

📄️ Get document processing data

📄️ Create/Update document processing data.

📄️ Update document processing data

📄️ Get document raw OCR data

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get the raw OCR data of the document. <br/> Scope: space_read

📄️ Create/Update document raw OCR data

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create/Update raw OCR data of the document. <br/> Scope: space_write

📄️ Add document raw OCR data

This endpoint is no longer recommended.

📄️ Delete document raw OCR data

Delete the raw OCR data of the document

📄️ Update document raw OCR data

Update the raw OCR data of the document using json-patch operations.

📄️ Get document raw OCR lines

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get raw OCR lines of the document <br/> Scope: space_read

📄️ Create/Update document raw OCR lines

📄️ Add document raw OCR lines

This endpoint is no longer recommended.

📄️ Delete document raw OCR lines

Delete raw OCR lines of the document

📄️ Update document raw OCR lines

Update raw OCR lines of the document using json-patch operations.

📄️ Assign connection to document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Assign connection to document <br/> Scope: space_write

📄️ Bulk update documents v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Bulk update documents v2 <br/> Scope: space_write

📄️ Get list of documents v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of documents v2 on the given space, with options to filter out the result.

📄️ Create document v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create document v2 on the given space <br/> Scope: space_write

📄️ Get document info v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get document information v2 by its ID on the given space <br/> Scope: space_read

📄️ Delete document v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete document v2 by its ID on the given space. Will cascade delete associated balance offsets. <br/> Scope: space_write

📄️ Update document v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update document v2 by its ID on the given space by sending json with the changes <br/> Scope: space_write

📄️ Update document v2

📄️ Move document to a directory

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Move document on the given space to a directory <br/> Scope: space_write

📄️ Unassign connection from document

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Unassign connection from document <br/> Scope: space_write

📄️ Get document status

📄️ Create/Update document status of extension

📄️ Update document status of extension

📄️ Get document validation data

📄️ Create/update document validation data.

📄️ Update document validation data

📄️ Get documents payment details v2

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get documents payment details v2 by the IDs on the given space <br/> Scope: space_read

📄️ Get list of document categories

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of document categories with the given name and optional search term on the given space space. <br/> Scope: space_read