Document API

The Document API enables you to upload and link documents to an open item in Isah Finance. The document file will be uploaded to the WebDAV server which contains all Isah Finance documents. The requirements for a successful file upload are:

settings for the connection to the WebDAV server
settings for the request size, in order to allow posting files that exceed 20 MB (20 MB is the default)
unique file names. The file name of the posted file should not exist on the server.
settings for a valid authorization token for the documents, in Isah Configuration Tool.

Call

finance-api/Documents/OpenItems/{company}

The call will upload the specified document and link it to the specified open item. Implement the call as a HTTP multipart request, so that both the document and the document properties can be sent in one call.

Parameters

Parameter	Description	Mandatory	Validations
Company	Company code	Y	Company code exists

Http Method

POST

Content Type

multipart/form-data

Parameter (body)	Description	Mandatory	Validations
Company	Company code	Y	Company code exists
InvoiceReference	Invoice reference	Y	Invoice reference present in the company/fiscal year
Debtor	Debtor code	Y*	Debtor present in the company/fiscal year
Creditor	Creditor code	Y*	Creditor present in the company/fiscal year
Language	...	Y	Language must exist
Type	…	Y	Document type must exist
Group	…	Y	Document group must exist
Status	…	Y	Document status must exist
Description	…	N	…
DocumentCode	...	N	...
Remark	...	N	...
file	...	Y	File must exist and must be accessible

filename: Full path + name of the local file
content: Stream with content of the file.

*: Either creditor or debtor must be specified.

Output

Http status code
If the call is successful, then the Document ID of the new document will be returned. If the call was not successful, then an error message will be returned.

Return Value

The return value of the call depends on the outcome:

In case of success, a success status code together with the document Id will be returned.
In case of errors, all error messages will be returned. Most errors are validation errors for the input values.