Technical description scope-rest-webservices

Partner API

Purpose

The Partner API offers read-only endpoints for retrieving business partner master data from Scope in an XML data format.

The API includes the following data:

• General partner information
• Registration IDs
• Partner contacts
• Selected debtor profile details
• Selected creditor profile details

API response

The API returns data in a XML format.

Current XML schema version 4: partner-v4.xsd

Imported schemas:

• commonDataTypes-v1.xsd

Starting with version 4, a new naming scheme has been introduced. Schema files for previous versions are not available online.

Examples:

• partners-example-4.0.xml

API documentation

The API is documented using an OpenAPI specification, enabling tools like Swagger to visualize the API and generate code in multiple programming languages.

Version 4: partner-api-4.0.json

Disclaimer: This technical description is not part of any contractual agreements.
This description is published by Riege Software under UPL license. Imprint. Privacy.
View project on GitHub