Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

document-templates

  1. document-template-representation
  2. create-document-template
  3. delete-document-template
  4. get-binary-content
  5. get-missing-parameters
  6. search-document-template-by-id
  7. search-document-templates

1. document-template-representation

Description: A document template representation. A document template is a document containing place holders which will be filled dynamically when using the template in order to produce a final, maybe signed, document.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.
reference
The document template reference. Constraints: Text, Read-Write, 35 characters or less.
dateCreated
The creation date. Constraints: DateTime, Read-Only.
name
The document template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
fileName
The document template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.
content
The document template binary content. Constraints: Text, Read-Write.
missingParameters
The document template list of missing parameters. Constraints: List of strings, Read-Only.

2. create-document-template (relation)

Description: Creates a new document template in the database and its file in the files system.

Properties
reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
creditor » reference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.
binaryContent » content
The actual binary content. Constraints: Text, Read-Write.
name
The document template unique name. Constraints: Text, Mandatory, Read-Write, 35 characters or less.
fileName
The document template file name. Constraints: Text, Mandatory, Read-Write, 255 characters or less.

3. delete-document-template (relation)

Description: Delete a document template by id.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.

4. get-binary-content (relation)

Description: Download a document template by id. Returns the document template in a binary content resource.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.

5. get-missing-parameters (relation)

Description: Get missing required parameters in a document template by id. Returns a missing parameters resource with a list filled with the missing parameters if there is any missing ones.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.

6. search-document-template-by-id (relation)

Description: Search a document templates by mandatory id.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.

7. search-document-templates (relation)

Description: Search a list of document templates by mandatory creditorReference.

Properties
creditorReference
The unique identifier of a SlimPay account, allocated by SlimPay. Constraints: Text, 35 characters or less, Read-Write.