FinBaze for Platforms

Reference

Queries#

processDocumentInboxEmail#

Requires: scope process_documents:read · feature process_documents.

processDocumentInboxEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentSalesEmail#

Requires: scope process_documents:read · feature process_documents.

processDocumentSalesEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentRequestsEmail#

Address for purchase requests by email: requests+{company}@… (a message or forwarded quote becomes a draft purchase request).

Requires: scope process_documents:read · feature process_documents.

processDocumentRequestsEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentPackingEmail#

Address for packing slips / delivery notes: {company}+packing@…

Requires: scope process_documents:read · feature process_documents.

processDocumentPackingEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentCatchAllEmail#

Requires: scope process_documents:read · feature process_documents.

processDocumentCatchAllEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentLettersEmail#

Requires: scope process_documents:read · feature process_documents.

processDocumentLettersEmail(profileId: ID!): String!
ArgumentType
profileIdID!

processDocumentInbox#

Requires: scope process_documents:read · feature process_documents.

processDocumentInbox(profileId: ID!, status: ProcessDocumentInboxStatus!, search: String, category: ProcessDocumentCategory, allCategories: Boolean, relationId: ID, after: String): ProcessDocumentInboxPage!
ArgumentType
profileIdID!
statusProcessDocumentInboxStatus!
searchString
categoryProcessDocumentCategory
allCategoriesBoolean
relationIdID
afterString

processDocument#

Requires: scope process_documents:read · feature process_documents.

processDocument(id: ID!): ProcessDocument!
ArgumentType
idID!The id of the record to find.

processDocuments#

Requires: scope process_documents:read · feature process_documents.

processDocuments(paging: CursorPaging!, filter: ProcessDocumentFilter!, sorting: [ProcessDocumentSort!]!): ProcessDocumentConnection!
ArgumentType
pagingCursorPaging!Limit or page results.
filterProcessDocumentFilter!Specify to filter the records returned.
sorting[ProcessDocumentSort!]!Specify to sort results.

processDocumentsPlatformEmailDomain#

Requires: scope process_documents:read · feature process_documents.

processDocumentsPlatformEmailDomain: String!

processDocumentInboxMessagingAddress#

Requires: scope process_documents:read · feature process_documents.

processDocumentInboxMessagingAddress(profileId: ID!): String
ArgumentType
profileIdID!

Mutations#

uploadProcessDocuments#

Requires: scope process_documents:write · feature process_documents.

uploadProcessDocuments(profileId: ID!, files: [ProcessDocumentUploadInput!]!, comment: String): [ProcessDocument!]!
ArgumentType
profileIdID!
files[ProcessDocumentUploadInput!]!
commentString

uploadProcessDocumentForPayment#

Requires: scope process_documents:write · feature process_documents.

uploadProcessDocumentForPayment(monetaryAccountPaymentId: ID!, file: ProcessDocumentUploadInput!, contextText: String): UploadProcessDocumentForPaymentResult!
ArgumentType
monetaryAccountPaymentIdID!
fileProcessDocumentUploadInput!
contextTextString

rejectProcessDocument#

Requires: scope process_documents:write · feature process_documents.

rejectProcessDocument(id: ID!, reason: String): ProcessDocument!
ArgumentType
idID!
reasonString

removeProcessDocument#

Requires: scope process_documents:write · feature process_documents.

removeProcessDocument(id: ID!): ProcessDocument!
ArgumentType
idID!

restoreProcessDocument#

Requires: scope process_documents:write · feature process_documents.

restoreProcessDocument(id: ID!): ProcessDocument!
ArgumentType
idID!

retryProcessDocument#

Requires: scope process_documents:write · feature process_documents.

retryProcessDocument(id: ID!): ProcessDocument!
ArgumentType
idID!

createOneProcessDocument#

Requires: scope process_documents:write · feature process_documents.

createOneProcessDocument(profileId: ID!, input: CreateProcessDocumentInput!): ProcessDocument!
ArgumentType
profileIdID!
inputCreateProcessDocumentInput!

createManyProcessDocuments#

Requires: scope process_documents:write · feature process_documents.

createManyProcessDocuments(profileId: ID!, input: [CreateProcessDocumentInput!]!): [ProcessDocument!]!
ArgumentType
profileIdID!
input[CreateProcessDocumentInput!]!

updateOneProcessDocument#

Requires: scope process_documents:write · feature process_documents.

updateOneProcessDocument(input: UpdateOneProcessDocumentInput!): ProcessDocument!
ArgumentType
inputUpdateOneProcessDocumentInput!

updateManyProcessDocuments#

Requires: scope process_documents:write · feature process_documents.

updateManyProcessDocuments(input: UpdateManyProcessDocumentsInput!): UpdateManyResponse!
ArgumentType
inputUpdateManyProcessDocumentsInput!

deleteOneProcessDocument#

Requires: scope process_documents:write · feature process_documents.

deleteOneProcessDocument(input: DeleteOneProcessDocumentInput!): ProcessDocumentDeleteResponse!
ArgumentType
inputDeleteOneProcessDocumentInput!

deleteManyProcessDocuments#

Requires: scope process_documents:write · feature process_documents.

deleteManyProcessDocuments(input: DeleteManyProcessDocumentsInput!): DeleteManyResponse!
ArgumentType
inputDeleteManyProcessDocumentsInput!