Scope Usage
Last updated
Last updated
Name | Description | Endpoint |
---|---|---|
This API only supports company-level access tokens.
The request returns a list of financial documents that are ready to be processed. The request can include parameters to limit the results.
Parameters
Name | Type | Format | Description |
---|---|---|---|
Headers
DocumentFormatAs: Value can be text or JSON. This determines the document format that’s returned from the API.
RFC 7235 Authorization - Bearer token that identifies the caller. This is the Company access token.
Payload
None.
Status Codes
200 OK
400 Bad Request
500 Internal Server Error
Headers
correlationid
is a specific custom header used for technical support in the form of a RFC 4122 universally unique identifier (UUID) URN Namespace.
RFC 7231 Content-Type
RFC 7230 Content-Length
Payload
Financial Documents
Response
Allows an external system to acknowledge that it has successfully retrieved one or more financial transactions from Turium Enigma and will begin processing those transactions. The transactions in the POST request are then taken out of the ready queue.
An app should execute the POST request immediately after the GET request. Eliminating any time between the requests will avoid a variance between the ERP and Turium Enigma. For example, if there is a time lag, the customer administrator could use the Turium Enigma Processor tool to recall or send a report (or invoice) back to the report owner where he or she can change it or even delete it. This would create a discrepancy between Turium Enigma and the ERP.
URI
Parameters
Headers
RFC 7235 Authorization - Bearer token that identifies the caller. This is the Company access token.
RFC 7231 Content-Type
Payload
AcknowledgeRequest
Status Codes
200 OK
400 Bad Request
500 Internal Server Error
Headers
correlationid
is a specific custom header used for technical support in the form of a RFC 4122 universally unique identifier (UUID) URN Namespace.
RFC 7231 Content-Type
RFC 7230 Content-Length
Payload
AcknowledgeResponse
Request
Response
This response shows both success and failure service code examples.
Allows financial posting results to be sent to Turium Enigma.
URI
Parameters
Headers
RFC 7235 Authorization - Bearer token that identifies the caller. This is the Company access token.
RFC 7231 Content-Type
Payload
Confirmation Request
Status Codes
200 OK
400 Bad Request
500 Internal Server Error
Headers
correlationid
is a specific custom header used for technical support in the form of a RFC 4122 universally unique identifier (UUID) URN Namespace.
RFC 7231 Content-Type
RFC 7230 Content-Length
Payload
Posting Confirmation Response
Request
Response
This response shows both success and failure service code examples.
Allows financial payment results to be sent to Turium Enigma.
URI
Parameters
Headers
RFC 7235 Authorization - Bearer token that identifies the caller. This is the Company access token.
RFC 7231 Content-Type
Payload
Payment Confirmation Request
Status Codes
200 OK
400 Bad Request
500 Internal Server Error
Headers
correlationid
is a specific custom header used for technical support in the form of a RFC 4122 universally unique identifier (UUID) URN Namespace.
RFC 7231 Content-Type
RFC 7230 Content-Length
Payload
Payment Confirmation Response
Response
This response shows both success and failure service code examples.
The Financial Integration Service will return service codes based on the success and failure of individual records for acknowledging and posting confirmation of documents.
AcknowledgeResponseItem
PostingConfirmationResponseItem
PaymentConfirmationResponseItem
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Code | Description | Category |
---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
Name | Type | Format | Description |
---|---|---|---|
FISVC
Read financial transactions and write financial transaction acknowledgements and confirmations.
GET, POST
docType
string
path
Required The financial document type to return. Only one type of transaction can be retrieved at a time.
page
int32
query
Starting page number.
limit
int32
query
Number of records to return per page. Default: 25.
docId
string
query
The transaction unique identifier, it could be expense report ID, payment request ID or cash advance ID. If specified, a single document that matches docId
is returned.
ignoreDocumentStatus
string
query
Ignores the financial documents status. If yes
, a document is returned regardless of status. If no
, only documents that have not been acknowledged/confirmed are returned. Supported values: yes
, no
. (See note below)
systemId
string
query
The external system ID that processed the document. Maximum 50 characters.
docType
string
path
Required The financial document type. Only one type of transaction can be acknowledged at a time. Supported values: expense
, invoice
, cashadvance
, payroll
, requestobligation
.
docType
string
path
Required The financial document type to return. Only one type of transaction can be retrieved at a time.
confirmationRequest
-
body
Required The JSON request to be posted.
docType
string
path
Required The financial document type to return. Only one type of transaction can be retrieved at a time.
confirmationRequest
body
Required The JSON request to be posted.
0
Successfully processed
Any
99
System ID in request does not match system ID in FI database.
Any
101
This document was previously acknowledged.
Acknowledge
102
This document has been recalled.
Acknowledge
103
This document is not ready.
Acknowledge
104
This document does not exist in the FI database.
Acknowledge
105
This document is not of type (expense, invoice, cashadvance).
Acknowledge
111
This document has not been acknowledged.
Posting
112
This document has been recalled.
Posting
113
Confirmation has been posted for this document.
Posting
114
Document is not in a known state.
Posting
115
This document is not of type (expense, invoice, cashadvance).
Posting
116
This document does not exist in the FI database.
Posting
198
Invalid request - this same request will not work if tried again.
Posting
199
Unknown error, please try again later.
Any
213
Payment confirmation has been posted for this document.
Posting
298
Invalid payment request - this same request will not work if tried again.
Posting
content
Array
FIDocument
The result collection.
page
string
PageMetadata
Pagination details.
links
Array
Link
Pagination links.
id
string
-
The unique identifier for the document.
docType
string
-
Transaction type. Supported values: expense
, invoice
, cashadvance
, payroll
, requestobligation
.
companyId
string
-
Unique identifier for the company. Maximum 32 characters.
entityId
string
-
Unique identifier for the entity. Maximum 32 characters.
companyUuid
string
UUID
UUID for the company. Maximum 36 characters.
erpSystemId
string
-
The external System ID that processed the document. Maximum 50 characters.
document
Array
-
The JSON financial document.
docStatus
string
-
The financial document status. Supported values: READY
, ACKNOWLEDGED
, POSTING_CONFIRMED_SUCCESS
, POSTING_CONFIRMED_FAILURE
.
size
int32
-
The number of transactions returned on the page.
totalElements
int32
-
The count of elements returned.
totalPages
int32
-
Total number of pages that are available.
number
int32
-
Page location for which the result is returned, for example: first page starts with 0, second page starts with 1.
rel
string
-
Relation of link, for example: first
, self
, next
, last
.
href
string
-
Complete URL for the paginated link.
hreflang
string
-
Link language, if any.
media
string
-
Media type, if any.
title
string
-
Link title, if any.
type
string
-
Link type, if any.
deprecation
string
-
Deprecated indication, if any.
ids
Array
string
The unique identifiers list for the financial documents.
systemId
string
-
The external system ID that acknowledged the documents.
AcknowledgeResponse
array
AcknowledgeResponseItem
The JSON response.
acknowledgeResult
string
-
Acknowledge processing result. Supported values are: SUCCESS
or FAILURE
.
code
Int32
Service Codes
The Financial Integration Service Code. This is a particular code based on the success and failure of individual records for Acknowledging documents.
docId
string
-
The financial document unique identifier. Maximum 32 characters.
errorMessage
string
-
The error message, if any.
systemId
string
-
The external system ID that acknowledged the documents. Maximum 50 characters.
systemId
string
-
Required The external system ID that acknowledged the documents, it can be an empty string. Maximum 50 characters.
postingConfirmations
Array
Posting Confirmation request item
Posting confirmations JSON request.
docId
string
-
Required The financial document ID to confirm. Maximum 32 characters.
overallPostingStatusCode
string
-
Required Posting status. VALUES: error or success.
postingDocs
array
Posting Documents Details
Posting documents details, if any.
systemMessages
array
System Messages
Required Messages to post to Turium Enigma, if any.
companyId
string
-
Required External system organizational unit ID. Maximum 32 characters.
documentNumber
string
-
External system document identifier. Maximum 80 characters.
fiscalYear
int32
-
External system fiscal year.
paymentRelevantLineItems
array
-
Payment relevant line items. This array is usually empty.
postingDate
string
YYYY-MM-DD
External system posting date.
TransactionLineItemId
string
-
Report relevant line item id.
messageId
string
-
External System message identifier.
messageLanguage
string
-
Message Language code, example EN
, FR
.
messageLongText
array
-
Message text, will be posted on the audit trail. Maximum 1300 characters.
messageShortText
string
-
Message text, will be posted on the audit trail. Maximum 1300 characters.
PostingConfirmationResponse
array
Posting Confirmation Response Item
The JSON response body.
postingConfirmationResult
string
-
Posting confirmation result. Supported values: SUCCESS
, SYSTEM_ERROR_OCCURRED
, NOT_YET_ACKNOWLEDGED
, DOCUMENT_NOT_FOUND
, FAILURE
, WAS_RECALLED
detailMessage
string
-
Posting confirmation message.
code
Int32
-
The Financial Service return code.
docId
string
-
The document ID. Maximum 32 characters.
errorMessage
string
-
The error message, if any.
systemId
string
-
The external system ID that acknowledged the document. Maximum 50 characters.
systemId
string
-
Required The external system ID that acknowledged the documents, it can be an empty string. Maximum 50 characters.
processingConfirmation
Array
Payment Confirmation Request Item
Payment confirmations JSON request.
docId
string
-
The financial document ID to confirm. Maximum 32 characters.
processingStatusCode
string
-
Payment status. Supported values: CP
, PP
, RE
, OB
(Completely Paid, Partially paid, Reversal, Obsolete). Maximum 3 characters.
additionalMessage
string
-
Reversal message or obsolete message, if any.
clearingDetails
array
Payment Documents Details
Payment documents details, if any.
clearingDate
string
-
Date the payment cleared.
clearingAmount
double
-
Amount cleared.
clearingCurrency
string
-
Currency value.
receiver
array
Receiver Details
Receiver details.
clearingReference
array
Clearing Reference Details
Clearing reference details.
receiverId
string
-
Receiver ID.
receiverName
double
-
Name of receiver.
receiverType
string
-
Type of receiver.
companyCode
string
-
Company code.
financialDocumentId
string
-
Document ID in ERP.
fiscalYear
string
-
Fiscal year.
paymentRef
string
-
Payment reference ID. Must be unique for each confirmation.
paymentMethod
string
-
Payment method Where E
= Electronic Fund Transfer or C
= Check.
PaymentConfirmationResponse
array
Payment Confirmation Response Item
The JSON response body
paymentConfirmationResult
string
-
Payment confirmation result. Supported values: SUCCESS
, SYSTEM_ERROR_OCCURRED
, NOT_POSTING_CONFIRMED
, DOCUMENT_NOT_FOUND
, FAILURE
, NOOP
paymentRef
string
-
Any message corresponding to payment reference being processed.
detailMessage
string
-
Payment confirmation message.
code
Int32
-
The financial service return code.
docId
string
-
The document ID. Maximum 32 characters.
errorMessage
string
-
The error message, if any.
systemId
string
-
The external system ID that acknowledged the document. Maximum 50 characters.