Create business partner with delivery channel(s)
Prerequisites
- Valid JSON with metadata
- Banqup permissions
- Delivery channels are installed and activated in the Network Connectors app
Terminology
- "Business partners" refers to customers and suppliers.
- The technical terms for "business partner" and "delivery channel" are "connection" and "connector," respectively.
Step 1: Create business partner with delivery channel(s)
Based on the country of the business partner, all delivery channels available in Banqup are activated when creating the business partner.
Available delivery channels in Banqup: Peppol, Email, KSeF.
Endpoint: /solution/business/v1/spaces/{spaceId}/network/connections
Path parameter:
spaceId
Requires a JSON request body (see
curlexample below).
curl -L -X POST 'https://{{serverURL}}/solution/business/v1/spaces/{spaceId}/network/connections' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-d '{
"type": "BUSINESS",
"globalIdentifiers": {
"be:en": "0428074917",
"be:vat": "BE0428074917",
"global:email": [
"john@example.com"
],
"global:phoneNumber": [ "+33612345678" ]
},
"alias": "UP",
"connectionStatus": "CONNECTED",
"relationTypes": [
"CUSTOMER"
],
"addresses": {
"main": {
"streetName": "Fleurs",
"house": "80728",
"postalCode": "3110",
"city": "Antwerp",
"country": "Belgium",
"countryCode": "BE"
}
},
"tags": [
"favorite",
"liked"
],
"active": true,
"metadata": {
"department": "Accounting",
"logo": "https://somelinks.com/logo.jpg",
"website": "https://mycompanywebsite.com",
"notes": "some notes",
"industry": "Agriculture, Forestry And Fishing"
},
"legalName": "ABC Group",
"tradeName": "ABC",
"businessType": "ENTERPRISE"
}'
Successful response:
{
"type": "BUSINESS",
"id": "dc416b68-eeac-430f-a4fa-0441ae1b1768",
"globalIdentifiers": {
"global:email": [
"john@example.com"
],
"be:en": "0428074917",
"be:vat": "BE0428074917",
"global:participantId": "0208:0428074917",
"global:phoneNumber": [
"+33612345678"
]
},
"assignedAccountId": "000001",
"alias": "UP",
"connectionStatus": "CONNECTED",
"relationTypes": [
"CUSTOMER"
],
"addresses": {
"main": {
"streetName": "Fleurs",
"buildingNumber": "80728",
"postalCode": "3110",
"city": "Antwerp",
"country": "Belgium",
"countryCode": "BE"
}
},
"tags": [
"favorite",
"liked"
],
"active": true,
"createdAt": "2026-04-16T12:09:08.058444Z",
"metadata": {
"logo": "https://somelinks.com/logo.jpg",
"notes": "some notes",
"website": "https://mycompanywebsite.com",
"industry": "Agriculture, Forestry And Fishing",
"department": "Accounting"
},
"connectors": [
{
"extensionId": "baf65c82-e645-4c75-89f1-69df0c017ec3",
"active": true,
"name": "peppol",
"namespace": "com.unifiedpost.btx.connectors",
"settings": {
"matches": {
"docTypes": [
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
}
],
"participantId": {
"value": "0208:0428074917",
"scheme": "iso6523-actorid-upis"
}
}
}
},
{
"extensionId": "c1fc7056-dfb3-4e55-9922-8fc76473a17e",
"active": true,
"name": "email",
"namespace": "com.unifiedpost.btx.connectors",
"settings": {
"email": "john@example.com"
}
}
],
"legalName": "ABC Group",
"tradeName": "ABC",
"businessType": "ENTERPRISE"
}
Step 2: Update delivery channel(s) of business partner
Use case 1: Activate/deactivate a delivery channel
Endpoint: /datastore/documents/transaction/v3/spaces/{spaceId}/connections/{connectionId}/connectors
Path parameters:
spaceIdconnectionId
Requires a JSON request body (see
curlexample below - deactivating the Email delivery channel).
curl -L -X PUT 'https://{{serverURL}}/datastore/documents/transaction/v3/spaces/{spaceId}/connections/{connectionId}/connectors' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-d '[
{
"name": "peppol",
"active": true,
"settings": {
"matches": {
"docTypes": [
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
}
],
"participantId": {
"value": "9925:BE0428074917",
"scheme": "iso6523-actorid-upis"
}
}
},
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "baf65c82-e645-4c75-89f1-69df0c017ec3"
},
{
"name": "email",
"active": false,
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "c1fc7056-dfb3-4e55-9922-8fc76473a17e",
"searchResults": []
}
]'
Successful response:
[
{
"name": "peppol",
"active": true,
"settings": {
"matches": {
"docTypes": [
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
}
],
"participantId": {
"value": "9925:BE0428074955",
"scheme": "iso6523-actorid-upis"
}
}
},
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "baf65c82-e645-4c75-89f1-69df0c017ec3"
},
{
"name": "email",
"active": false,
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "c1fc7056-dfb3-4e55-9922-8fc76473a17e",
"searchResults": []
}
]
Use case 2: Change the Peppol participant ID
Endpoint: /solution/business/v1/spaces/{spaceId}/network/connections/{connectionId}
Path parameters:
spaceIdconnectionId
Requires a JSON request body (see
curlexample below).
curl -L -X PATCH 'https://{{serverURL}}/solution/business/v1/spaces/{spaceId}/network/connections/{connectionId}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-d '{
"type": "BUSINESS",
"globalIdentifiers": {
"be:en": "0428074917",
"be:vat": "BE0428074917",
"global:participantId": "9925:BE0428074917",
"global:email": [ "john@example.com" ]},
"addresses": {
"main": {
"streetName": "St-Hendriksvoorplein",
"buildingNumber": "44",
"postalCode": "1200",
"city": "Sint-Lambrechts-Woluwe",
"country": "Belgium",
"countryCode": "BE"
},
"registration": {
"country": "Belgium",
"countryCode": "BE"
}
}
}'
Successful response:
{
"type": "BUSINESS",
"id": "dc416b68-eeac-430f-a4fa-0441ae1b1768",
"globalIdentifiers": {
"be:en": "0428074917",
"be:vat": "BE0428074917",
"global:participantId": "9925:BE0428074917",
"global:email": [
"john@example.com"
]
},
"assignedAccountId": "000001",
"alias": "UP",
"connectionStatus": "CONNECTED",
"relationTypes": [
"CUSTOMER"
],
"addresses": {
"main": {
"streetName": "St-Hendriksvoorplein",
"buildingNumber": "44",
"postalCode": "1200",
"city": "Sint-Lambrechts-Woluwe",
"country": "Belgium",
"countryCode": "BE"
},
"registration": {
"country": "Belgium",
"countryCode": "BE"
}
},
"tags": [
"favorite",
"liked"
],
"active": true,
"createdAt": "2026-04-14T13:27:29.059239Z",
"metadata": {
"logo": "https://somelinks.com/logo.jpg",
"notes": "some notes",
"website": "https://mycompanywebsite.com",
"industry": "Agriculture, Forestry And Fishing",
"department": "Accounting"
},
"connectors": [
{
"extensionId": "baf65c82-e645-4c75-89f1-69df0c017ec3",
"active": true,
"name": "peppol",
"namespace": "com.unifiedpost.btx.connectors",
"settings": {
"matches": {
"participantId": {
"scheme": "iso6523-actorid-upis",
"value": "9925:BE0428074917"
},
"docTypes": [
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1"
},
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1"
},
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
},
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1"
},
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
},
{
"scheme": "busdox-docid-qns",
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1"
}
]
}
}
},
{
"extensionId": "c1fc7056-dfb3-4e55-9922-8fc76473a17e",
"active": true,
"name": "email",
"namespace": "com.unifiedpost.btx.connectors",
"settings": {
"email": "john@example.com"
}
}
],
"legalName": "ABC Group",
"tradeName": "ABC",
"businessType": "ENTERPRISE"
}
Step 3: View business partner's delivery channels
Endpoint: /datastore/documents/transaction/v2/spaces/{spaceId}/connections/{connectionId}
Path parameters:
spaceIdconnectionId
curl -L 'https://{{serverURL}}/datastore/documents/transaction/v2/spaces/{spaceId}/connections/{connectionId}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_TOKEN'
Successful response:
{
"type": "business",
"id": "dc416b68-eeac-430f-a4fa-0441ae1b1768",
"globalIdentifiers": {
"be:en": "0428074917",
"be:vat": "BE0428074917",
"global:email": [
"john@example.com"
],
"global:participantId": "9925:BE0428074917"
},
"assignedAccountId": "000001",
"alias": "UP",
"connectionStatus": "CONNECTED",
"relationTypes": [
"CUSTOMER"
],
"addresses": {
"main": {
"streetName": "St-Hendriksvoorplein",
"buildingNumber": "44",
"postalCode": "1200",
"city": "Sint-Lambrechts-Woluwe",
"country": "Belgium",
"countryCode": "BE"
},
"registration": {
"country": "Belgium",
"countryCode": "BE"
}
},
"tags": [
"favorite",
"liked"
],
"active": true,
"createdAt": "2026-04-14T13:27:29.059239Z",
"metadata": {
"logo": "https://somelinks.com/logo.jpg",
"notes": "some notes",
"website": "https://mycompanywebsite.com",
"industry": "Agriculture, Forestry And Fishing",
"department": "Accounting"
},
"connectors": [
{
"name": "peppol",
"active": true,
"settings": {
"matches": {
"docTypes": [
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
"scheme": "busdox-docid-qns"
},
{
"value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:selfbilling:3.0::2.1",
"scheme": "busdox-docid-qns"
}
],
"participantId": {
"value": "9925:BE0428074955",
"scheme": "iso6523-actorid-upis"
}
}
},
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "baf65c82-e645-4c75-89f1-69df0c017ec3"
},
{
"name": "email",
"active": true,
"settings": {
"email": "john@example.com"
},
"namespace": "com.unifiedpost.btx.connectors",
"extensionId": "c1fc7056-dfb3-4e55-9922-8fc76473a17e"
}
],
"displayName": "ABC Group",
"legalName": "ABC Group",
"tradeName": "ABC",
"businessType": "ENTERPRISE"
}