System Banks

Gather endpoints that provide functionalities for managing system banks. These functionalities include reading system banks, upserting system bank data, deleting system bank data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

Delete Bank Data

Delete system bank data with the given parameters.

SecurityapiKey

Request

Request Body schema: application/json

dataSourceId	string (BusinessPartnerStorageDataSourceId) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e"
externalIds	Array of strings (BusinessPartnerExternalId) List of External IDs to delete data. Example: ["The ID managed in the customer's SAP systems."]

Responses

200

post/system/banks/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataSourceId": "648824a691d8d2503d65103e",
"externalIds": ["The ID managed in the customer's SAP systems."
]
}

Response samples

application/json

{"entriesToRemove": "10"
}

List System Banks

List system banks with the given parameters.

SecurityapiKey

Request

query Parameters

dataSourceIds	Array of strings (BusinessPartnerStorageDataSourceId) Data Source IDs. Example: dataSourceIds=648824a691d8d2503d65103e
externalId	string (BusinessPartnerExternalId) External ID. Example: externalId=The ID managed in the customer's SAP systems.
limit	integer <int32> [ 1 .. 100 ] Default: 50 Number of results that should be fetched. Maximum 100 results can be returned in one page. Example: limit=50
startAfter	string Indicator for the next page. Example: startAfter=5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a

Responses

200

get/system/banks

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "100",
"values": [{"names": "Swiss National Bank",
"contact": {"emails": [{"address": "info@cdq.com",
"type": {"name": "Bank contact email",
"url": "https://meta.cdq.com/Bank_account/bank/contact/contact_email/type",
"technicalKey": "BANK_CONTACT_EMAIL_TYPE"
}
}
],
"phoneNumbers": [{"countryPrefix": "0041",
"number": "58 631 00 00",
"type": {"name": "Bank contact phone number",
"url": "https://meta.cdq.com/Bank_account/bank/contact/phone_number/type",
"technicalKey": "BANK_CONTACT_PHONE_TYPE_PHONE"
},
"value": "0041 58 631 00 00"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Bank contact website",
"url": "https://meta.cdq.com/Bank_account/bank/contact/website/type",
"technicalKey": "BANK_CONTACT_WEBSITE_TYPE"
}
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Bank_account/bank/identifier/type",
"name": "Bank SWIFT Code",
"technicalKey": "WR_BSC"
},
"value": "CH1234567890123456789",
"issuingBody": {"name": "Bank Identifier Code",
"url": "https://meta.cdq.com/Bank_account/bank/identifier/issuing_body",
"technicalKey": "BIC"
},
"status": {"name": "Active",
"technicalKey": "ACTIVE"
}
}
],
"addresses": [{"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"fipsCode": "SZ15",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": ["9000"
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"openingHours": [{"openingHour": "09:00 AM",
"closingHour": "05:00 PM",
"weekday": "Monday"
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postalCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"postOfficeBox": "Postfach 460"
},
"cdqId": "CDQID-1234567890"
}
],
"externalId": "DE2357422",
"relations": [{"startedAt": "2024-11-22T13:19:58Z",
"endedAt": "2024-11-22T13:19:58Z",
"type": {"technicalKey": "BRANCH",
"name": "Organizational Unit"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
],
"dataSourceId": "648824a691d8d2503d65103e",
"rawData": { },
"id": "CH1234567890123456789",
"createdAt": "2024-11-22T13:19:58Z",
"lastModifiedAt": "2024-11-22T13:19:58Z"
}
]
}

Upsert Bank Data

Upsert system bank data with the given parameters.

SecurityapiKey

Request

Request Body schema: application/json

	Array of objects (BankUpsertRequest) List of banks to be upserted.
dataTransformationDefinitionId	string Unique identifier for a data transformation definition. Example: "SAP.ODM"

Responses

200

post/system/banks/upsert

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataTransformationDefinitionId": "SAP.ODM",
"banks": [{"names": "Swiss National Bank",
"contact": {"emails": [{"address": "info@cdq.com",
"type": {"name": "Bank contact email",
"url": "https://meta.cdq.com/Bank_account/bank/contact/contact_email/type",
"technicalKey": "BANK_CONTACT_EMAIL_TYPE"
}
}
],
"phoneNumbers": [{"countryPrefix": "0041",
"number": "58 631 00 00",
"type": {"name": "Bank contact phone number",
"url": "https://meta.cdq.com/Bank_account/bank/contact/phone_number/type",
"technicalKey": "BANK_CONTACT_PHONE_TYPE_PHONE"
},
"value": "0041 58 631 00 00"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Bank contact website",
"url": "https://meta.cdq.com/Bank_account/bank/contact/website/type",
"technicalKey": "BANK_CONTACT_WEBSITE_TYPE"
}
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Bank_account/bank/identifier/type",
"name": "Bank SWIFT Code",
"technicalKey": "WR_BSC"
},
"value": "CH1234567890123456789",
"issuingBody": {"name": "Bank Identifier Code",
"url": "https://meta.cdq.com/Bank_account/bank/identifier/issuing_body",
"technicalKey": "BIC"
},
"status": {"name": "Active",
"technicalKey": "ACTIVE"
}
}
],
"addresses": [{"version": {"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"fipsCode": "SZ15",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": ["9000"
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"openingHours": [{"openingHour": "09:00 AM",
"closingHour": "05:00 PM",
"weekday": "Monday"
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postalCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"postOfficeBox": "Postfach 460"
},
"cdqId": "CDQID-1234567890"
}
],
"externalId": "DE2357422",
"relations": [{"startedAt": "2024-11-22T13:19:58Z",
"endedAt": "2024-11-22T13:19:58Z",
"type": {"technicalKey": "BRANCH",
"name": "Organizational Unit"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
],
"dataSourceId": "648824a691d8d2503d65103e",
"rawData": { }
}
]
}

Response samples

application/json

{"numberOfAccepted": "10",
"numberOfFailed": "1",
"failures": [{"bank": {"names": "Swiss National Bank",
"contact": {"emails": [{"address": "info@cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "0041",
"number": "58 631 00 00",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "0041 58 631 00 00"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
]
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Bank_account/bank/identifier/type",
"name": "Bank SWIFT Code",
"technicalKey": "WR_BSC"
},
"value": "CH1234567890123456789",
"issuingBody": {"name": "Bank Identifier Code",
"url": "https://meta.cdq.com/Bank_account/bank/identifier/issuing_body",
"technicalKey": "BIC"
},
"status": {"name": "Active",
"technicalKey": "ACTIVE"
}
}
],
"addresses": [{"version": {"characterSet": {"name": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
},
"identifyingName": {"value": "John Doe"
},
"externalId": "1",
"metadata": {"primaryProvenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"language": {"name": null,
"technicalKey": null
}
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"fipsCode": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": ["9000"
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"openingHours": [{"openingHour": null,
"closingHour": null,
"weekday": null
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"locality": "Sankt Gallen",
"district": "City center",
"postalCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"mailbox": "Postfach 460",
"postOfficeBox": "Postfach 460"
},
"cdqId": "CDQID-1234567890"
}
],
"externalId": "DE2357422",
"relations": [{"startedAt": "2024-11-22T13:19:58Z",
"endedAt": "2024-11-22T13:19:58Z",
"type": {"technicalKey": "BRANCH",
"name": "Organizational Unit"
},
"startNode": "FR.RC:5664645",
"endNode": "FR.RC:5664645"
}
],
"dataSourceId": "648824a691d8d2503d65103e",
"rawData": { },
"id": "CH1234567890123456789",
"createdAt": "2024-11-22T13:19:58Z",
"lastModifiedAt": "2024-11-22T13:19:58Z"
},
"message": "This record could not be stored due to timeout."
}
]
}