Tereina Logo
API docs by Redocly

Tereina Integration Service API (1.0.0)

Download OpenAPI specification:

Tereina Development Team: dev@tereina.com License: Proprietary

Controllers exposed to be consumed by ERPs

Customer Integration

APIs for customer payment integration

Upload data block

Upload a single data block using streaming. Batch will auto-process when final data block is received.

path Parameters
batchId
required
string
dataBlockNumber
required
integer <int32>
Request Body schema: application/json

Stream of data containing data blocks of the type of the selected payloadObjectType. Supported object types: COMPANY, COMPANY_CODE, PAYMENT_REQUEST, INVOICE

One of
Array of objects (CompanyRelationRequestPayload)

List of company relationships with company codes

Array of objects (ContactRequestPayload)

List of contacts for the company

Array of objects (AddressRequestPayload)

List of addresses for the company

Array of objects (CorporateIdentifierRequestPayload)

List of corporate identifiers for the company

Array of objects (BankAccountRequestPayload)

List of bank accounts for the company

name
string
number
string
referenceId
string
companyCodeReferenceId
string
registeredCountry
string
registeredState
string

Responses

Request samples

Content type
application/json
Example
{
  • "companyRelations": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ],
  • "corporateIdentifiers": [
    ],
  • "bankAccounts": [
    ],
  • "name": "string",
  • "number": "string",
  • "referenceId": "string",
  • "companyCodeReferenceId": "string",
  • "registeredCountry": "string",
  • "registeredState": "string"
}

Confirm transfer completion

Confirms that the client has successfully received and processed all items in an outbound batch. This marks all batch items as COMPLETE and the batch status as COMPLETE_SUCCESS. The batch is then removed from the pending queue.

path Parameters
batchId
required
string

Responses

Initiate batch job with data block transfer

Creates a new batch job and returns data block transfer parameters. Batch will auto-process when all data blocks are uploaded.

Request Body schema: application/json
required
clientRefId
required
string

Client reference ID

referenceId
required
string

Reference ID for the batch

payloadObjectType
required
any (PayloadObjectType)
Enum: "COMPANY_CODE" "COMPANY" "INVOICE" "PURCHASE_ORDER" "PAYMENT_REQUEST" "PAYMENT_STATUS" "BANK_STATEMENT"

Type of payload object being uploaded

totalPayloadSize
required
integer <int64>

Total size of the payload in bytes

totalLineItemCount
integer <int32>

Total number of the line item objects in this batch

Responses

Request samples

Content type
application/json
{
  • "clientRefId": "client_123",
  • "referenceId": "batch_sap_20241006",
  • "payloadObjectType": "COMPANY_CODE",
  • "totalPayloadSize": 104857600,
  • "totalLineItemCount": 200
}

Create and process a batch of records (single data block)

Accepts a complete batch of data in various formats (JSON, CSV, XML, ISO) using streaming. The format is determined by client configuration and validated against expected schema. For large payloads, use the data block transfer endpoints instead.

query Parameters
clientRefId
required
string
referenceId
required
string
payloadObjectType
required
string
totalLineItemCount
required
integer <int32>
totalPayloadSize
required
integer <int64>
Request Body schema: application/json

Stream of data containing the full batch payload. Supported object types: COMPANY, COMPANY_CODE, PAYMENT_REQUEST, INVOICE

One of
Array of objects (CompanyRelationRequestPayload)

List of company relationships with company codes

Array of objects (ContactRequestPayload)

List of contacts for the company

Array of objects (AddressRequestPayload)

List of addresses for the company

Array of objects (CorporateIdentifierRequestPayload)

List of corporate identifiers for the company

Array of objects (BankAccountRequestPayload)

List of bank accounts for the company

name
string
number
string
referenceId
string
companyCodeReferenceId
string
registeredCountry
string
registeredState
string

Responses

Request samples

Content type
application/json
Example
{
  • "companyRelations": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ],
  • "corporateIdentifiers": [
    ],
  • "bankAccounts": [
    ],
  • "name": "string",
  • "number": "string",
  • "referenceId": "string",
  • "companyCodeReferenceId": "string",
  • "registeredCountry": "string",
  • "registeredState": "string"
}

Get batch for transfer

Retrieves the complete batch with all pending items and their transformed payloads for client pickup. Only returns batches in PENDING status that are ready for transfer.

path Parameters
batchId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "124ABCDEF",
  • "createdDate": "2023-12-01T10:15:30+01:00[Europe/Paris]",
  • "lastUpdatedDate": "2023-12-02T10:15:30+01:00[Europe/Paris]",
  • "lastUpdatedBy": "1234ABCXYZ",
  • "version": 0,
  • "referenceId": "payment_request_123",
  • "groupReferenceId": "payment_group_123",
  • "status": "OPEN",
  • "reasonCode": "REJ_004",
  • "additionalInfo": "Error due to missing amount"
}

Get batch job status by batch ID

Returns current status of the batch job including data block transfer progress, missing data blocks, and processing state.

path Parameters
batchId
required
string

Responses

Get batch job status by reference ID

Returns current status of the batch job by external reference ID, including data block transfer progress, missing data blocks, and processing state.

path Parameters
referenceId
required
string

Responses

Get pending outbound batches

Returns all outbound batches in PENDING or PARTIAL_PENDING status that are waiting for the client to pick up. Optionally filter by payload object type (e.g., COMPANY, INVOICE).

query Parameters
payloadObjectType
any (PayloadObjectType)
Enum: "COMPANY_CODE" "COMPANY" "INVOICE" "PURCHASE_ORDER" "PAYMENT_REQUEST" "PAYMENT_STATUS" "BANK_STATEMENT"

Payload objects supported by the integration service

Responses