Access Point Management Service (1.0.0)

Download OpenAPI specification:

REST API for access point management

participant

add the participant to elma service

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Request Body schema: application/json

icd	string An International Code Designator (ICD) value, which uniquely identifies the authority which issued the code to the organization, up to 4 digits
country	string country of the participant- ISO 3166-1:Alpha2 Country code
sendMailFlag	boolean Participant needs mail notification(true/false) for inbound ehf- only for Zirius ERP users
organizationIdentifier	string An organization identifier, up to a maximum of 35 characters.
name	string Organization name
	Array of objects (AddParticipantRequestProcesses) list of processes to be registered for participant, must not be null.
	object

Responses

Request samples

Payload

Content type

application/json

{"icd": "string",
"country": "string",
"sendMailFlag": true,
"organizationIdentifier": "string",
"name": "string",
"processes": [{"identifier": "string"
}
],
"contact": {"phoneNumber": "string",
"name": "string",
"email": "string"
}
}

Response samples

200
400
500

Content type

application/json

{"code": "string",
"message": "string",
"participantInfo": {"participantId": "string",
"identifier": "string",
"processes": [{"processId": 0,
"identifier": "string",
"capabilities": [{"identifier": "string",
"title": "string"
}
],
"visible": true,
"restricted": true,
"documentTypes": [{"identifier": "string",
"visible": true,
"qualifiedIdentifier": "string",
"title": "string"
}
],
"domain": "string",
"alias": "string",
"title": "string",
"qualifiedIdentifier": "string",
"requiredICDs": ["string"
],
"dependencies": [{"identifier": "string",
"qualifiedIdentifier": "string",
"title": "string"
}
]
}
],
"lastModificationDate": "string",
"organizationIdentifier": "string",
"contact": {"phoneNumber": "string",
"name": "string",
"email": "string"
},
"registrationDate": "string",
"name": "string",
"icd": "string",
"qualifiedIdentifier": "string",
"deleteDate": "string"
}
}

update the participant to elma service

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Request Body schema: application/json

participantId required	string
sendMailFlag	boolean Participant needs mail notification(true/false) for inbound ehf- only for Zirius ERP users
	Array of objects (AddParticipantRequestProcesses) list of processes to be registered for participant, must not be null.
	object

Responses

Request samples

Payload

Content type

application/json

{"participantId": "string",
"sendMailFlag": true,
"processes": [{"identifier": "string"
}
],
"contact": {"phoneNumber": "string",
"name": "string",
"email": "string"
}
}

Response samples

200
400
500

Content type

application/json

{"code": "string",
"message": "string",
"participantInfo": {"participantId": "string",
"identifier": "string",
"processes": [{"processId": 0,
"identifier": "string",
"capabilities": [{"identifier": "string",
"title": "string"
}
],
"visible": true,
"restricted": true,
"documentTypes": [{"identifier": "string",
"visible": true,
"qualifiedIdentifier": "string",
"title": "string"
}
],
"domain": "string",
"alias": "string",
"title": "string",
"qualifiedIdentifier": "string",
"requiredICDs": ["string"
],
"dependencies": [{"identifier": "string",
"qualifiedIdentifier": "string",
"title": "string"
}
]
}
],
"lastModificationDate": "string",
"organizationIdentifier": "string",
"contact": {"phoneNumber": "string",
"name": "string",
"email": "string"
},
"registrationDate": "string",
"name": "string",
"icd": "string",
"qualifiedIdentifier": "string",
"deleteDate": "string"
}
}

get participant info from elma service

Authorizations:

gateWayApiAuth

query Parameters

participantId

required

string

participant id

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"code": "string",
"message": "string",
"participantInfo": {"participantId": "string",
"identifier": "string",
"processes": [{"processId": 0,
"identifier": "string",
"capabilities": [{"identifier": "string",
"title": "string"
}
],
"visible": true,
"restricted": true,
"documentTypes": [{"identifier": "string",
"visible": true,
"qualifiedIdentifier": "string",
"title": "string"
}
],
"domain": "string",
"alias": "string",
"title": "string",
"qualifiedIdentifier": "string",
"requiredICDs": ["string"
],
"dependencies": [{"identifier": "string",
"qualifiedIdentifier": "string",
"title": "string"
}
]
}
],
"lastModificationDate": "string",
"organizationIdentifier": "string",
"contact": {"phoneNumber": "string",
"name": "string",
"email": "string"
},
"registrationDate": "string",
"name": "string",
"icd": "string",
"qualifiedIdentifier": "string",
"deleteDate": "string"
}
}

to remove participant from elma service

Authorizations:

gateWayApiAuth

query Parameters

participantId

required

string

participant id

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"code": "200",
"message": "success",
"messageArgs": ["string"
]
}

get all participants associated with the tenant

Authorizations:

gateWayApiAuth

query Parameters

page	integer Default: 0 Page number (0-based index)
size	integer Default: 10 Number of items per page

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"totalPages": 5,
"totalElements": 0,
"currentPage": 0,
"participants": [{"participantId": "0192:12345678",
"participantName": "Test Participant AS",
"identifier": "TEST123",
"qualifiedIdentifier": "TENANT-TEST123",
"contactDetails": {"name": "John",
"email": "participant@example.com",
"phone": "+1234567890"
},
"participantProcesses": [{"identifier": "1087db37-4862-42e2-9dc0-2b6a4c500c6f",
"qualifiedIdentifier": "cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:despatch_advice:3"
}
]
}
]
}

processes

get all elma processes from elma service

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"code": "string",
"message": "string",
"processList": {"items": [{"processId": 0,
"identifier": "string",
"capabilities": [{"capabilityId": 0,
"identifier": "string",
"title": "string"
}
],
"visible": true,
"restricted": true,
"documentTypes": [{"docTypeId": 0,
"identifier": "string",
"visible": true,
"qualifiedIdentifier": "string",
"title": "string"
}
],
"domain": "string",
"alias": "string",
"title": "string",
"qualifiedIdentifier": "string",
"requiredICDs": ["string"
],
"dependencies": [{"dependencyId": 0,
"identifier": "string",
"qualifiedIdentifier": "string",
"title": "string"
}
]
}
]
}
}

document

Generate pre-signed upload URL

Returns a pre-signed PUT URL for uploading a document. After the document is uploaded, the backend will tag the file with status=not_validated.

Authorizations:

gateWayApiAuth

query Parameters

filename

required

string

file name of the EHF xml

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"code": "string",
"message": "string",
"presignedUrl": "string",
"fileReference": "string"
}

validate the document before sending

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Request Body schema: application/json
required

fileReference

required

string

File Reference object key returned from upload step

Responses

Request samples

Payload

Content type

application/json

{"fileReference": "temp-upload/acme123_8fd3c5da_invoice.xml"
}

Response samples

200
400
500

Content type

application/json

{"valid": true,
"code": "VALIDATION_SUCCESS",
"message": "string"
}

sending the document after successful validation

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Request Body schema: application/json
required

fileReference

required

string

File Reference object key returned from upload step

Responses

Request samples

Payload

Content type

application/json

{"fileReference": "temp-upload/acme123_8fd3c5da_invoice.xml"
}

Response samples

400
500

Content type

application/json

{"code": "200",
"message": "success",
"messageArgs": ["string"
]
}

Get presigned URL to download invoice XML

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Request Body schema: application/json
required

fileReference

required

string

Responses

Request samples

Payload

Content type

application/json

{"fileReference": "storage-folder/invoice-123.xml"
}

Response samples

200

Content type

application/json

{"url": "https://your-bucket.amazonaws.com/storage-bucket/invoice-123.xml?X-Amz-Expires=...",
"code": 200,
"message": "Presigned URL for downloading EHF is generated successfully"
}

Get the status of the EHF submitted to be sent via Accesspoint

Authorizations:

gateWayApiAuth

query Parameters

jobId

required

string

the job ID(unique identifier), obtained in SendDocumentResponse of send method.

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200

Content type

application/json

{"status": "SUBMITTED",
"code": 200,
"message": "Status of the document fetched successfully"
}

Invoices

Get summary of inbound and outbound invoices for a tenant

Authorizations:

gateWayApiAuth

query Parameters

month required	integer Month (1-12)
year required	integer Year (2025)

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"tenantId": "aew-123",
"code": "200",
"message": "Success",
"outboundInvoices": [{"jobId": "abc-123",
"status": "SENT",
"date": "2024-11-08T10:30:00Z",
"downloadedEhf": true
}
],
"inboundInvoices": [{"jobId": "abc-123",
"status": "SENT",
"date": "2024-11-08T10:30:00Z",
"downloadedEhf": true
}
]
}

Get all the invoices which are not yet downloaded

Authorizations:

gateWayApiAuth

header Parameters

tenantId required	string tenant id
tenantSecret required	string tenant secret key
language required	string locale language

Responses

Response samples

200
400
500

Content type

application/json

{"code": "200",
"message": "success",
"pendingInvoices": [{"jobId": "abc-123",
"fileReference": "invoices/invoice-123.xml",
"createdDate": "2024-11-08T10:30:00Z"
}
]
}

Access Point Management Service (1.0.0)

participant

add the participant to elma service

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

update the participant to elma service

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

get participant info from elma service

Authorizations:

query Parameters

header Parameters

Responses

Response samples

to remove participant from elma service

Authorizations:

query Parameters

header Parameters

Responses

Response samples

get all participants associated with the tenant

Authorizations:

query Parameters

header Parameters

Responses

Response samples

processes

get all elma processes from elma service

Authorizations:

header Parameters

Responses

Response samples

document

Generate pre-signed upload URL

Authorizations:

query Parameters

header Parameters

Responses

Response samples

validate the document before sending

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

sending the document after successful validation

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get presigned URL to download invoice XML

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the status of the EHF submitted to be sent via Accesspoint

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Invoices

Get summary of inbound and outbound invoices for a tenant

Authorizations:

query Parameters

header Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required