Trading partners
Learn how to manage endpoints for trading partners in your workspace.
Use Compliance Network to manage communication network endpoints for trading partners of the companies in your organization.
Add trading partner endpoint
A network should already exist.
- Go to Network.
- Click on a "non-workspace" Network to manage.
- Click on New endpoint.
- Enter required information:
- Enter a user friendly Name for your endpoint.
- Enter the SIREN number.
- Enter the SIRET number when registering a company branch.
- Enter the Code Routage to identify a specific department in your organization.
- Enter the Suffix identifier to create a virtual location for grouping your documents.
- Enter the Matricule Plateforme value to identify the PA that handles the delivery.
- Configure Invoices:
- Select Invoices.
- Click on Add Subtype.
- Select all that apply.
- Click Save.
- Select a distribution method, either push or pull.
- Select a plugin.
- Configure Lifecycles:
- Select Lifecycles.
- Click on Add Subtype
- Select all that apply.
- Click Save.
- Select a distribution method, either push or pull.
- Select a plugin.
- Click Save.
Edit trading partner endpoint
- Go to Network.
- Click on a "non-workspace" Network to manage.
- Click on an endpoint to manage.
- Click Edit.
- Update Invoices:
- Select Invoices.
- Add new or remove existing subtypes.
- Update the distribution method..
- Select a new plugin.
- Update Lifecycles:
- Select Lifecycles.
- Add new or remove existing subtypes.
- Update the distribution method.
- Select a new plugin.
- Click Save.
Add trading partner endpoint with Indirect Tax API
Learn how to add endpoints assigned to the workspace in Compliance Network using Indirect Tax API.
A network should already be available for configuration.
Upon successful creation, the API will return a JSON object containing status info.
Samples for adding a trading partner
Request sample
Request sample for adding a trading partner
curl --location --request POST 'https://api-test.sovos.com/v2/configurations/workspaces/networks/{networkId}/trading-partners/endpoints' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw ' {
"codeComponents":[
{
"field": SIREN / SIRET,
"value": SIREN-OR-SIRET-VALUE
}
],
"supportedDocuments":[
{
"type": SIREN / SIRET,
"subTypes": [
"Invoice",
"CreditNote"
],
"communication": {
"distributionMethod": Push / Pull,
"formatId": AVAILABLE-FORMAT-NAME
}
}
],
"tradingPartner": {
"name": "Trading Partner Name",
"businessIdentifiers": [
{
"type": "TaxId",
"value": SIREN / SIRET,
"name": "Company Name",
"countryCode": "FR"
}
]
}
}'
Response sample
Response sample for adding a trading partner
{
"status": 201,
"message": "Created",
"success": true,
"timestamp": 1741968114340,
"data":{
"id": "f728171e-…-37bc12d9fa8c",
"code": {
"value": "123456789_12345678954321",
"scheme": "0225"
}
}
}
Edit trading partner endpoint with Indirect Tax API
Learn how to update endpoints assigned to the workspace in Compliance Network using Indirect Tax API.
The endpoint should already exist.
Upon successful update, the API will return a JSON object containing status info.
Samples for updating a trading partner
Request sample
Request sample for updating a trading partner
curl --location --request PUT 'https://api-test.sovos.com/v2/configurations/workspaces/networks/{networkId}/trading-partners/endpoints/{endpointId}' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw ' {
"supportedDocuments":[
{
"type": SIREN / SIRET,
"subTypes": [
"Invoice",
"CreditNote"
],
"communication": {
"distributionMethod": Push / Pull,
"formatId": AVAILABLE-FORMAT-NAME
}
}
],
"tradingPartner": {
"name": "Trading Partner Name",
"businessIdentifiers": [
{
"type": "TaxId",
"value": SIREN / SIRET,
"name": "Company Name",
"countryCode": "FR"
}
]
}
}'
Response sample
Response sample for updating a trading partner
{
"status":200,
"message":"OK",
"success":true,
"timestamp":1741968114344
}
Get a trading partner endpoint with Indirect Tax API
Learn how to fetch partner endpoints assigned to a workspace in Compliance Network using Indirect Tax API.
The endpoint should already exist.
Upon successful update, the API will return a JSON object containing the endpoint configuration.
Samples for fetching a trading partner
Request sample
Request sample for fetching a trading partner
curl --location --request GET 'https://api-test.sovos.com/v2/configurations/workspaces/networks/{networkId}/trading-partners/endpoints/{endpointId}' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json'Response sample
Response sample for fetching a trading partner
{
"status":200,
"message":"OK",
"success":true,
"timestamp":1741968114349,
"data":{
"id":"7f176e1f-…-d447dc499306",
"code":{
"value":"999999999",
"scheme":"0225",
"components":[
{
"field":"SIREN",
"value":"999999999"
}
]
},
"validityPeriod":{
"start":"2026-09-01T00:00:00.0000000Z",
"end":"2029-09-01T00:00:00.0000000Z"
},
"supportedDocuments":[
{
"type":"Invoice",
"subTypes":[
"Invoice",
"CreditNote"
],
"communication":{
"distributionMethod":"Push",
"formatId":" FR-CIUSCII-1.0-INVOICE-1.0"
}
},
{
"type":"LifeCycles",
"subTypes":[
"LifeCycles"
],
"communication":{
"distributionMethod":"Push",
"formatId":"FR-CDAR-3.0-LIFECYCLE-1.0"
}
}
],
"tradingPartner":{
"name":"Trading Partner Name",
"businessIdentifiers":[
{
"type":"TaxId",
"value":"999999999",
"name":"Company Name",
"countryCode":"FR"
},
{
"type":"Gln",
"value":"1234578912345789",
"name":"Company Name",
"countryCode":"FR"
}
]
}
}
}Delete a trading partner endpoint with Indirect Tax API
Learn how to delete partner endpoints assigned to a workspace in Compliance Network using Indirect Tax API.
The endpoint should already exist.
Upon successful removal, the API will return a JSON object containing status info.
Samples for removing a trading partner
Request sample
Request sample for fetching a trading partner
curl --location --request DELETE 'https://api-test.sovos.com/v2/configurations/workspaces/networks/{networkId}/trading-partners/endpoints/{endpointId}' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json'Response sample
Response sample for fetching a trading partner
{
"status":200,
"message":"OK",
"success":true,
"timestamp":1741968114352,
"data":{}
}