Table of Contents Business Partner create Business Partner Attribut delete Business Partner Attribut Get Business Partner by bp number Get Business Partner by bp attribute Get Subscriptions Get Payment Details Get PurchaseOrders Create business partner Change Address Create Bouncemessage / push bounces Search bp address Get BP by email BP deletion Business Partner This page describes the business partner rest web services. create Business Partner Attribut URL POST: /rest/{client}/bp/{bpNumber}/attributes?sp={sp}&type={type}&value={value} Parameter Description client Mandantennummer sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) bpNumber Business Partner number type Attribut type value Attribut value Corresponding SOAP Service: https://doc.dsb-ccb.net/en/ccbconnect/avs3/obj/bp/createattribute Response The response is a Json Document including the result. ElementDescription resultCodeOK or NOT_OK resultMessageList of result Messages delete Business Partner Attribut URL DELETE: /rest/{client}/bp/{bpNumber}/attributes?sp={sp}&type={type}&value={value} Parameter Description client Mandantennummer sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) bpNumber Business Partner number type Attribut type value Attribut value Corresponding SOAP Service: https://doc.dsb-ccb.net/en/ccbconnect/avs3/obj/bp/deleteattribute Response The response is a Json Document including the result. ElementDescription resultCodeOK or NOT_OK resultMessageList of result Messages Get Business Partner by bp number URL GET: /rest/{client}/bp/{bpNumber} Parameter Description bpNumber business partner number client client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) getAllAdresses liefere alle, auch die zukünftigen Adressen (default: false) filter comma seperated list of filters Filters are sent as request parameter with a comma seperated list of key-value-pairs. Example: &filter=filter1,filter2[key1=value1;key2=value2],filter2 List of available filters Corresponing SOAP Service: getByBpNumber Response The response is a JSON document containing a business partner. JSON Businesspartner Example { "salutationCode": "", "titleCodeAcademic": "", "titleAcademic": "", "titleCodeRoyal": "", "jobTitle": "", "lastName1": "", "lastName2": "", "firstName": "", "nickName": "", "street": "", "streetSuffix": "", "streetNumberSuffix": "", "addressLine1": "", "addressLine2": "", "addressLine3": "", "zipcode": "", "countryCode": "", "city": "", "district": "", "regionCode": "", "regionText": "", "company1": "", "company2": "", "company3": "", "company4": "", "department": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "poBoxCountryCode": "", "majorCustomerZipcode": "", "addressSource": "", "advertisement": "", "category": "", "bpNumber": "", "bpNumberExternal": "", "bpGroup": "", "euSalesTaxNumber": "", "dateOfBirth ": "", "bicMasterNumber ": "", "sector": "", "listOfCommunication": [ { "communicationDefault": "", "communicationValue": "", "communicationType": "" } ], "listOfAttribute": [ { "value": "", "type": "" } ] } Element Definitions Parameter Typ/ Length Description salutationCode C / 2 Salutation titleCodeAcademic C / 4 Title-academic titleAcademic C / 15 Academic title in clear text (for example Dr.) titleCodeRoyal C / 4 Title of nobility titleRoyal C / 15 Title of nobility in clear text jobTitle C / 35 Title of job in clear text lastName1 C / 40 lastname 1 lastName2 C / 40 lastname 2 firstName C / 40 Firstname(s) nickName C / 40 Nickame street C / 50 street streetSuffix C / 40 street suffix streetNumber C / 10 house number streetNumberSuffix C / 10 house number suffix addressLine1 C / 35 address line 1 (UK addresses) addressLine2 C / 35 address line 2 (UK addresses) addressLine3 C / 35 address line 3 (UK addresses) zipcode C / 10 zipcode country-code C / 3 country (ISO) city C / 40 city district C / 25 Additon to city (for example district, area….) regionCode C / 3 Regions-Code (federal state, province, county) regionText C / 25 Regions-as clear text (federal state, province, county) company1 C / 35 firm line 1 company2 C / 35 firm line 1 company3 C / 40 firm line 1 company4 C / 40 firm line 1 department C / 30 department poBox C / 10 po box poBoxZipcode C / 10 po box zipcode poBoxCity C / 40 po box city poBoxCountryCode C / 3 po box country majorCustomerZipcodeC / 10 Major-customer-zipcode addressSource C / 10 Address-source Code table, contents states faculty advertisement C / 1 Mark if advertisement should be send category C / 2 Type of address bpNumber C / 10 Businesspartner Number bpNumberExternal C / 20 Business partner-No. of an external system bpGroup C /4 Customer group Code table, contents states faculty euSalesTaxNumber C / 14 EG-UST ID number dateOfBirth D / 10 Date of birth format: JJJJ-MM-TT masterNumber C / 10 Partner-ID of master (for example firm of contact person) sector C / 10 sector listOfcommunication - communicationDefault C / 1 Is this the default communication of this type Y / N - communicationtype C / 2 type of communication (Wertebereich) - communcationvalue C / 50 value of communication listOfAttribute - type C / 6 Function of business partner attributes For example type of address - value C / 50 Attribute value of business partner Get Business Partner by bp attribute URL GET: /rest/{client}/bp/attributes Parameter Description client client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) type Type of the attribute value Value of the attribute getAllAdresses liefere alle, auch die zukünftigen Adressen (default: false) filter comma seperated list of filters Filters are sent as request parameter with a comma seperated list of key-value-pairs. Example: &filter=filter1,filter2[key1=value1;key2=value2],filter2 List of available filters Corresponing SOAP Service: getByBpAttribute]] Response The response is a JSON document containing a business partner. JSON Businesspartner Example { "salutationCode": "", "titleCodeAcademic": "", "titleAcademic": "", "titleCodeRoyal": "", "jobTitle": "", "lastName1": "", "lastName2": "", "firstName": "", "nickName": "", "street": "", "streetSuffix": "", "streetNumberSuffix": "", "addressLine1": "", "addressLine2": "", "addressLine3": "", "zipcode": "", "countryCode": "", "city": "", "district": "", "regionCode": "", "regionText": "", "company1": "", "company2": "", "company3": "", "company4": "", "department": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "poBoxCountryCode": "", "majorCustomerZipcode": "", "addressSource": "", "advertisement": "", "category": "", "bpNumber": "", "bpNumberExternal": "", "bpGroup": "", "euSalesTaxNumber": "", "dateOfBirth ": "", "bicMasterNumber ": "", "sector": "", "listOfCommunication": [ { "communicationDefault": "", "communicationValue": "", "communicationType": "" } ], "listOfAttribute": [ { "value": "", "type": "" } ] } Element Definitions Parameter Typ/ Length Description salutationCode C / 2 Salutation titleCodeAcademic C / 4 Title-academic titleAcademic C / 15 Academic title in clear text (for example Dr.) titleCodeRoyal C / 4 Title of nobility titleRoyal C / 15 Title of nobility in clear text jobTitle C / 35 Title of job in clear text lastName1 C / 40 lastname 1 lastName2 C / 40 lastname 2 firstName C / 40 Firstname(s) nickName C / 40 Nickame street C / 50 street streetSuffix C / 40 street suffix streetNumber C / 10 house number streetNumberSuffix C / 10 house number suffix addressLine1 C / 35 address line 1 (UK addresses) addressLine2 C / 35 address line 2 (UK addresses) addressLine3 C / 35 address line 3 (UK addresses) zipcode C / 10 zipcode country-code C / 3 country (ISO) city C / 40 city district C / 25 Additon to city (for example district, area….) regionCode C / 3 Regions-Code (federal state, province, county) regionText C / 25 Regions-as clear text (federal state, province, county) company1 C / 35 firm line 1 company2 C / 35 firm line 1 company3 C / 40 firm line 1 company4 C / 40 firm line 1 department C / 30 department poBox C / 10 po box poBoxZipcode C / 10 po box zipcode poBoxCity C / 40 po box city poBoxCountryCode C / 3 po box country majorCustomerZipcodeC / 10 Major-customer-zipcode addressSource C / 10 Address-source Code table, contents states faculty advertisement C / 1 Mark if advertisement should be send category C / 2 Type of address bpNumber C / 10 Businesspartner Number bpNumberExternal C / 20 Business partner-No. of an external system bpGroup C /4 Customer group Code table, contents states faculty euSalesTaxNumber C / 14 EG-UST ID number dateOfBirth D / 10 Date of birth format: JJJJ-MM-TT masterNumber C / 10 Partner-ID of master (for example firm of contact person) sector C / 10 sector listOfcommunication - communicationDefault C / 1 Is this the default communication of this type Y / N - communicationtype C / 2 type of communication (Wertebereich) - communcationvalue C / 50 value of communication listOfAttribute - type C / 6 Function of business partner attributes For example type of address - value C / 50 Attribute value of business partner Get Subscriptions URL GET: /rest/{client}/bp/{bpNumber}/subscriptions Corresponing SOAP Service: SubscriptionOrder::getByBpNumber. Parameter Description bpNumber business partner number returnOnlyActive return only active subscriptions (default) or all fromHit If the result set should be reduced, the you can pass here then first hit, that should be returned. maxHitCount Number of the max.returned hits Additional common parameters ParameterDescription client client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) readProductsales Read product sales orders. PS orders must be read in a separate request than standard subscriptions. publication Filter for publication (optional) returnAddressType Define which role will be available in the response (AG, WE, VM, RE). Default: WE returnAddressTimepointDefine wich address should be returned (mandatory) 'L' = Address at last shipment date 'A' = active address 'Z' = Address at future shipment date returnExtendedCommunicationDatareturn extended communication data (true/false) Default: false returnRenewalPaymentDataReturn additional renewal payment data true = Yes false = No (Default) returnRenewalIssueRemainingtrue = Yes return remaining issues regarding the whole subscription Otherwise Return remaining isssues regarding the current cycle (Default) returnCurrentSuspencionDataReturn additional data of the current suspension. If there is no current suspension the next in time is returned. true = Yes false = No (Default) returnExtendedPremiumDataReturn extended premium data true = Yes false = No (Default) returnHolidayAddresses BETA BETA Returns holiday addresses true = Yes false = No (Default) filter comma seperated list of filters Filters are sent as request parameter with a comma seperated list of key-value-pairs. Example: &filter=filter1,filter2[key1=value1;key2=value2],filter2 List of available filters A business partner can have a lot of of subscriptions (maybe thousands), so this request can take very long. We recommendate to limit the response with the maxHitCount parameter and read the subscriptions step by step if necessary. Example: Request: /rest/{client}/bp/{bpNumber}/subscriptions?maxHitCount=100 If the response contains 100 subscriptions there are maybe more. So use a second request to read them: /rest/{client}/bp/{bpNumber}/subscriptions?fromHit=101&maxHitCount=100 and so on until the response contains less than 100 subscriptions. Response The response is a JSON document containing an array of subscriptions. JSON Subscription Order Example { "orderNumber": "4807309861", "dsbUrposLief": "000001", "publication": "00000310", "publicationName": "Publication", "edition": "00000310", "mixType": "01", "purchaseFrequency": "VA", "deliveryType": "DM", "orderStatus": "I", "isRenewal" : true, "isTimebased" : true, "orderCurrency": "GBP", "issueNrFrom": "000000265", "issueNrTo": "000000277", "issueNrFirstBill": "", "validFrom": "2014-03-08", "validTo": "2015-02-24", "endReason": "900", "promotionSource": "MP2123", "prSourceVar": "", "referenceDoc": "10995ABC123456789", "custOrderNumber": "", "custOrderDate": "2014-01-24", "subscrPhase": "IF1", "priceGroup": "", "priceKey": "CP02", "paymentMethod": "", "subOProcessedPMD": { "subPaymentMethod": "660", "subPaymentMethodText": "Method" }, "billingFrequency": "Y1", "billingFrequencyShortDescription": "", "quantity": "1", "salesOrganization": "0100", "dsbMedia1": "", "dsbMedia2": "", "dsbMedia3": "", "dsbMedia4": "", "dsbMedia2b": "", "dsbMedia7": "", "agentNumber": "", "materialNumber": "", "premiumDescription": "", "premiumDispatchDate": null, "billingPayedTo": "", "issueNumberNextBill": "", "issueNumberFromLastBill": "", "issueNumberToLastBill": "", "currentDunningLevel": "00", "conditionTermCommitmentPeriod": "1", "conditionTermCancelationPeriod": "1", "conditionTermRenewal": "1", "salesSource": "REN1", "advertisingMedium": "MP2ED02", "salesDocumentType": "REN", "validFromEvt": "2014-02-25", "validToEvt": "2015-01-28", "validFromOnSaleDate": "2014-03-15", "validToOnSaleDate": "2015-02-15", "dispatchType": "", "dispatchText": "", "contractAccountBalance": "0.00", "postageKey": "DM", "productType": "ON", "isCombiSubscription": false, "renewal": { "expiryDate": "2015-02-15", "expiryIssueNr": "000000277", "currentCycleNumberOfIssues": 13, "currentCycleExpiryDate": "2015-02-15", "currentCycleExpiryIssueNr": "000000277", "currentCycleStartDate": "2014-03-15", "currentCycleStartIssueNr": "000000265", "currentCycleAcceptanceDate": "2014-02-04", "currentCycleOffer": "ED1C2", "currentCycleOfferType": "RN", "currentCycleOfferDescription": "", "currentCycleOfferMarketingText": "", "currentCyclePaidAmount": "20.00", "currentCycleBundlePaidAmount": "0.00", "offerClassification": "", "offerClassificationDefinition": "", "orderCurrency": "GBP", "renewalDueDate": "2014-02-04", "numberIssuesRemaining": 0, "renewalBundleComponent" : "M", "autoRenewal": false, "autoRenewalNextPaymentAmount": 0, "autoRenewalNextPaymentFrequencyCode": "", "autoRenewalNextPaymentFrequencyText": "", "autoRenewalNextPaymentDate": null, "autoRenewalLastPaymentAmount": 0, "autoRenewalLastPaymentFrequencyCode": "", "autoRenewalLastPaymentFrequencyText": "", "autoRenewalLastPaymentDate": null, "autoRenewalActualClaimCounter": 2, "autoRenewalIncreaseClaimCounter": 0 }, "currentSuspension": { "suspendedFromDate": null, "suspendedToDate": null, "suspendedFromIssueNr": "", "suspendedFromIssueDesc": "Description", "suspendedToIssueNr": "", "suspendedToIssueDesc": "Description", "suspendedReasonCode": "" }, "currentChangeInfo": { "futureMixType": null, "futureMixTypeFromIssueNr": null, "futureMixTypeToIssueNr": null, "formerMixType": null, "formerMixTypeToIssueNr": null, "futureDeliveryQuantity": null, "futureDeliveryQuantityFromIssueNr": null, "formerDeliveryQuantity": null, "formerDeliveryQuantityToIssueNr": null, "futureDeliveryType": null, "futureDeliveryTypeFromIssueNr": null, "formerDeliveryType": null, "formerDeliveryTypeToIssueNr": null, "futureDispatchType": null, "futureDispatchTypeFromIssueNr": null, "formerDispatchType": null, "formerDispatchTypeToIssueNr": null, "futureDispatchText": null, "futureDispatchTextFromIssueNr": null, "formerDispatchText": null, "formerDispatchTextToIssueNr": null }, "bundles": [], "businessPartners": [], "orderAttributes": [], "productSalesOrder" : { "status" : "", "statusDescription" : "", "positions" : [ { "positionNumber" : 1, "articleNumber" : "ABC", "externalArticleNumber" : "AY-32", "status" : "", "statusDescription" : "", "textVariant" : "", "articleDescription" : "", "activity" : "", "articleGroup" : "" } ] }} Element Definitions Field name Type Description orderNumber C Subscription no. dsbUrposLief C Reference to the original delivery position publication C publication publication-name C name of publication edition C edition mixType C mix-type purchaseFrequency C Purchase frequency deliveryType C delivery type orderStatus C the status of the order isRenewal B is this a renewal sub ? isTimebased B is this a timebased Renewal-Sub (true/false) ? orderCurrency C currency code of the subscription issueNrFrom C Copy no. of first delivered distribution edition. issueNrTo C Copy no. of last delivered distribution edition. issueNrFirstBill C Copy no. of 1. invoice. validFrom D Start of the of delivery. validTo D Date of end of delivery, filled only when a subscription has been cancelled. validFromEvt D validToEvt D Valid until EVT, whereas EVT means “first shipment date”. validFromOnSaleDate D Valid from date validToOnSaleDate D Valid to date endReason C Reason for delivery stop. The values are client dependent. promotionSource C Source code prSourceVar C Source code-Variation referenceDoc C Reference evidence. Comprises order number of the old system. Apart from that it is identical with the field order-number. custOrderNumber C customer order number custorderDate D The date where the customer order was entered into the system. subscrPhase C phase where the subscription is at the moment priceGroup C Price group of customer stipulates possible reductions on basic price. priceKey C Price-key of customer Stipulates the basic price. paymentMethod C Payment-method: E → payment per direct debit. K→ payment per credit card. R → payment per invoice. For foreign customers are probably further payment methods provided. subOProcessedPMD * subPaymentMethod C Subtype of Payment-method * subPaymentMethodText C Subtype text of Payment-method billingFrequency C billing frequency billingFrequencyShortDescription C billing frequency short description quantity C quantity salesOrganization C Sales-organization dsbMedia1 C Field for free disposal. Is stored with the order. dsbMedia2 C Field for free disposal. Is stored with the order. dsbMedia3 C Field for free disposal. Is stored with the order. dsbMedia4 C Field for free disposal. Is stored with the order. dsbMedia2b C Field for free disposal. Is stored with the order. dsbMedia7 C Field for free disposal. Is stored with the order. agentNumber C Agent-number materialNumber C Premium number (Material-number of goods premium) premiumDescription C Premium description premiumDispatchDate C Premium dispatch date billingPayedTo C Billing-payed-to copy no. issueNumberNextBill C Issue no. of next invoice issueNumberFromLastBill C Issue no. from last bill issueNumberToLastBill C Issue no. to last bill currentDunningLevel C Current-dunning-level conditionTermCommitmentPeriod C duration of commitment-period (regular cancellation after x months possible) conditionTermCancelationPeriod C Terms of contract: cancellation-period conditionTermRenewal N Terms of contract: extension of commitment-period salesSource C Sales source advertisingMedium C Advertising medium salesDocumentType C Sales document type dispatchType C Dispatch type dispatchText C Dispatch text contractAccountBalance C contract account balance \\Note! This value is only updated daily. In case of collective billing, the value could be added up from more than one contracts. negative leading sign = customer credit balance positive leading sign = bills receivable postageKey C productType C BETA Kind of Medium (ON,….) Mapping should be requested with service MasterData.getMasterData isCombiSubscriptionBBETA Is it a combi subscription true/false(default) renewal expiryDate C The date at the which the subscription as a whole, will expire. expiryIssueNr C The last Issue number that the subscriber will receive. renewalDueDate C Due date for next payment numberIssuesRemaining N The number of issues, still to deliver. If the requestflag returnRenewalIssueRemaining is set to 'Y', the number of issues over the whole Subscription period is returned, otherwise, only the number of issues in the current cycle is returned. currentCycleNumberOfIssues N The number of issues that are in the renewal cycle currentCycleStartIssueNr C Issue number at the start of the renewal cycle. currentCycleStartDate C Start date of the renewal cycle currentCycleExpiryIssueNr C Issue number at the end of the renewal cycle. currentCycleExpiryDate C End date of the renewal cycle currentCycleAcceptanceDate C The date at which the subscriber accepted the renewal of their subscription. currentCycleOffer C Offer from current cycle currentCycleOfferType C Offer type of the offer from current cycle (RN, DD or BU) currentCycleOfferDescription C Offer description of the offer from current cycle (if filled) currentCycleOfferMarketingText C Marketingtext of the offer from current cycle (if filled) offerClassification C Classification(Bundle, Membership, Normal etc.) B = bundle N = normal M = membership offerClassificationDefinition C Offer classification definition currentCyclePaidAmount C Amount of the current order cycle currentCycleBundlePaidAmount C Amount of the whole bundle. Only relevant if it’s a valid bundled subscription orderCurrency C Order currency renewalBundleComponent C M = Master, S = Slave autoRenewal B subscription is auto renewal (true/false) autoRenewalNextPaymentAmount C Amount of the next collection in the regarding subscription currency autoRenewalNextPaymentFrequencyCode C Frequency code of the next payment collection autoRenewalNextPaymentFrequencyText C Frequency text/description of the next payment collection autoRenewalNextPaymentDate C Date of the next payment collection autoRenewalLastPaymentAmount C Amount of the last collection in the regarding subscription currency autoRenewalLastPaymentFrequencyCode C Frequency code of the last payment collection autoRenewalLastPaymentFrequencyText C Frequency text/description of the last payment collection autoRenewalLastPaymentDate C Date of the last payment collection autoRenewalActualClaimCounter N actual claim counter autoRenewalIncreaseClaimCounter N increase claim counter bundles bundleOrderNumber C Order number of this bundled Element publication C publication edition C edition quantity N quantity currentSuspension suspendedFromDate C Suspension from date suspendedToDate C Suspension to date suspendedFromIssueNr C Suspension from issue number suspendedFromIssueDesc C Suspension from issue number description suspendedToIssueNr C Suspension to issue number suspendedToIssueDesc C Suspension to issue number description suspendedReasonCode C Suspension reason code currentChangeInfo (to obtain this data, please contact your customer consultant. The customizing flag x_change_info must be set.) futureMixType C Future mix type futureMixTypeFromIssueNr C Issue nr. from futureMixTypeToIssueNr C Issue nr. to formerMixType C Former mix type formerMixTypeToIssueNr C Issue nr. to futureDeliveryQuantity N Future delivery quantity futureDeliveryQuantityFromIssueNr C From issue nr formerDeliveryQuantity N Former delivery quantity formerDeliveryQuantityToIssueNr C To issue nr futureDeliveryType C Future delivery type futureDeliveryTypeFromIssueNr C From issue nr formerDeliveryType C Former delivery type formerDeliveryTypeToIssueNr C To issue nr. futureDispatchType C Future dispatch type futureDispatchTypeFromIssueNr C From issue nr. formerDispatchType C Former dispatch type formerDispatchTypeToIssueNr C To issue nr. futureDispatchText C Future dispatch text futureDispatchTextFromIssueNr C From issue nr. formerDispatchText C Former dispatch text formerDispatchTextToIssueNr C To issue nr. productSalesOrder productsales order data of orders that are read with the readProductSales option. status C statusDescription C positions productsales order positions positionNumber N articleNumber C externalArticleNumber C status C statusDescription C textVariant C articleDescription C activity C articleGroup C businessPartners JSON Business Partner Example { "role": "WE", "bpNumber": "1006346741", "fullSalutation": "Dear Mrs Customer", "lastName1": "Customer", "lastName2": "", "firstName": "Anne", "dateOfBirth": "", "fullLastName": "Customer", "nameAddition": "", "jobTitle": "", "title": "", "salutationCode": "02", "salutation": "Mrs", "company1": "", "company2": "", "company3": "", "department": "", "zipcode": "NN4 7BF", "street": "", "streetSuffix": "", "streetNumber": "", "streetNumberSuffix": "", "addressLine1": "1 Main Road", "addressLine2": "", "addressLine3": "", "regionCode": "NH", "regionText": "Northamptonshire", "fullStreet": "", "poBoxZipcode": "", "poBox": "", "poBoxCity": "", "majorCustZip": "", "city": "NORTHAMPTON", "district": "", "countryCode": "GB", "country": "United Kingdom", "advertisement": "Y", "blockTag": "N", "euSalesTaxNumber": "", "bicMasterNumber": "", "sector": "", "mobilePhoneNumber": "", "phoneNumber": "", "faxNumber": "", "emailAddress": "customer@example.com", "bpExtCommunication": [], "bpAttributes": [], "bpHolidayAddress": [] } Element Definitions Field name Description role C Type of business partner. AG = orderer WE = consignee RE = invoice recipient bpNumber C Business partner no. fullSalutation C Mounted personal salutation lastName1 C Lastname 1 lastName2 C Lastname 2 firstName C First-name fullLastName C Mounted last-name nameAddition C Name-addition, for example profession jobTitle C Job title title C Academic Title salutationCode C Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms. salutation C Salutation company1 C 1. line of company address. If this field is filled is the above name the contact person of the firm. company2 C 2. line of company address. Contains for example section or continuation of firm address. company3 C 3. line of company address department C department zipcode C zipcode street C Street with house no. and addition to house no. streetSuffix C Addition to street streetName C Street Name streetNumber C Street Number streetNumberSuffix C Street Number Suffix addressLine1 C Address line 1 for UK addresses addressLine2 C Address line 2 for UK addresses addressLine3 C Address line 3 for UK addresses poBoxZipcode C Po-box-zipcode poBox C Po-box poBoxCity C Po-box-city majorCustZip C Major-cust-zip city C City district C Addition of city regionCode C Region-Code (federal state, province, county) regionText C Region as cleartext (e.g. County…) countryCode C Two letter ISO 3166-1 alpha-2 country-code country C country advertisement C Advertisement permitted; Y / N blockTag C General block-tag ( X = put block-tag ) euSalesTaxNumber C EU sales tax id dateOfBirth D Birthdate (YYYY-MM-DD) bicMasterNumber C Partner-ID of master (for example company of contact person) sector C branch mobilePhoneNumber C Mobile Telephone-No.: pre code + termination phoneNumber C Telephone no..: pre code + termination faxNumber C Fax-No.: pre code + termination emailAddress C IS-M: e-mail number bpExtCommunication Extended communication data (only with request parameter returnExtendedCommunicationData=true) communicationType C Communication Types; Values communicationValue C Communication value communicationDefault C Default value Y / N bpAttributes JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value bpHolidayAddress Redirect addresses JSON Attributes Example "bpHolidayAddress": [ { "validFrom": "2009-11-08", "validTo": "2009-12-08", "street": "", "streetNumber": "", "streetNumberSuffix": "", "zipcode": "", "zipcodeExtension": "", "city": "", "district": "", "poBox": "", "poBoxExtension": "", "poBoxZipcode": "", "poBoxCity": "", "majorCustZip": "", "majorCustZipExtension": "", "countryCode": "" }, ... ] Element Definition ParameterTypeLengthDescription validFrom C 10 validity of the redirection validTo C 10 validity of the redirection street C 35 Street streetNumber C 10 Street number streetNumberSuffix C 8 Street number extension zipcode C 10 Zipcode zipcodeExtension C 4 Zipcode extension city C 35 City district C 35 District poBox C 35 Po box poBoxExtension C 4 Po box extension poBoxZipcode C 10 Po box zipcode poBoxCity C 35 Po box city majorCustZip C 10 Zipcode of company majorCustZipExtension C 4 Zipcode extension of company countryCode C 3 Country code orderAttributes JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value Get Payment Details URL GET: /rest/{client}/bp/{bpNumber}/payment-details Parameter Description bpNumber business partner number client client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) Corresponing SOAP Service: PaymentDetails::getByBpNumber. Response The response is a JSON document containing the payment details. { "account" : { "listOfDebitAccount" : [ { "debitAccountId" : "0001", "debitBankName" : "Pkundenbank", "debitBankCode" : "00010010", "debitCountryCode" : "DE", "debitAccountNumber" : "11111111", "debitAccountHolder" : "Testet", "debitContinuous" : true, "iban" : "DE00000000000000000000", "bic" : "xxxxxxxxXXX" } ] }, "bpNumber" : "0000520000" } Get PurchaseOrders URL GET: /rest/{client}/bp/{bpNumber}/purchase-orders Parameter Description bpNumber business partner number client client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) only-delivery Return also purchase-orders where the business-partner has the role “consignee”. Default value is “false”. date-from Reduce the result, so that purchase orders before that date are not returned. Format YYYY-MM-DD date-to Reduce the result, so that purchase orders after that date are not returned. Format YYYY-MM-DD filter comma seperated list of filters Filters are sent as request parameter with a comma seperated list of key-value-pairs. Example: &filter=filter1,filter2[key1=value1;key2=value2],filter2 List of available filters Corresponing SOAP Service: getPurchaseOrders. Response The response is a JSON document containing an array of key values of the bp's purchase orders. With the order number you can call get by order number to recieve order details. JSON Purchase Order extract Example { "client": "5244", "serviceProvider": "032", "purchaseOrderNumber": "3000261", "purchaseOrderId": "0000000253", "dateOfPurchaseOrder": "2017-09-26", "dateOfPurchaseOrderSystem": "2017-10-04", "purchaseOrderState": "L1", "roleType": "AG" } Field description field name type description client C VHS client serviceProvider C VHS service provider purchaseOrderNumber N Order number (VHS/3) purchaseOrderId C Order identification or external order number dateOfPurchaseOrder D Order date (client) dateOfPurchaseOrderSystem D Order date (system) purchaseOrderState C Order status roleType C Role, of the BP; AG(customer) oder WE(consignee) Create business partner Create a business partner. This service is buffered. To transfer the bp into the backend system an additional transfer job must be provided. Please request this job from your dsb account manager. URL POST: /rest/{client}/bp ParameterDescription client client id sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to use some sales orgas of the client) Request Body The Body of the Post Request contains a JSON document with a bp. JSON Business Partner Example { "salutationCode" : "01", "lastName1" : "Y", "firstName" : "X", "addressLine1" : "Blitz Media Ltd, Unit 1, Torfaen Bu", "zipcode" : "N1C 4AP", "countryCode" : "GB", "city" : "LONDON", "bpCommunicationsList" : [ { "communicationType" : "T", "communicationValue" : "123" } ], "bpAttributesList" : [], "avsAttributes" : { "salesOrganization" : "0100", "distributionChannel" : "01", "division" : "01" } } Element Definitions Field name TypeLengthDescription bpNumber C 10 Business partner no. lastName1 C 35 Lastname 1 lastName2 C 35 Lastname 2 firstName C 35 First-name nickName C 35 jobTitle C 35 Job title salutationCode C 2 Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms. prefix C 4 titleCodeAcademic C 4 Academic title code, e.g. 0027 = Dr titleAcademic C 15Academic Title, e.g. Dr. titleCodeRoyal C 4Royal title code titleRoyal C 15Royal title company1 C 401. line of company address. If this field is filled is the above name the contact person of the firm. company2 C 402. line of company address. Contains for example section or continuation of firm address. company3 C 40 3. line of company address department C 30 department zipcode C 10 zipcode street C 50Street with house no. and addition to house no. streetSuffix C 40 Addition to street streetNumber C 10 Street Number streetNumberSuffix C 10 Street Number Suffix addressLine1 C 35Address line 1 for UK addresses addressLine2 C 35Address line 2 for UK addresses addressLine3 C 35Address line 3 for UK addresses poBoxZipcode C 10Po-box-zipcode poBox C 10 Po-box poBoxCity C 40 Po-box-city poBoxCountryCode C 2 Po-box-country-code majorCustomerZipcodeC 10Major-cust-zip city C 40 City district C 40 Addition of city regionCode C 3 Region-Code (federal state, province, county) regionText C 25 Region as cleartext (e.g. County…) countryCode C 2 Two letter ISO 3166-1 alpha-2 country-code advertisement C 1 Advertisement permitted; Y / N block B General block-tag blockReason C 2 block reason euSalesTaxNumber C 14EU sales tax id addressSource C 10 source of the address dateOfBirth D Birthdate (YYYY-MM-DD) masterNumber C 10Partner-ID of master (for example company of contact person) sector C 10 branch bpCommunicationsList communicationType C 2Communication Types; Values communicationValue C 50 Communication value communicationDefault C 1Default value Y / N avsAttributes salesOrganizationC 4 (mandatory) distributionChannelC 2 (mandatory) divisionC 2 (mandatory) bpAttributesList JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value Response The service returns the id of the request. Corresponding SOAP Service: createBpBuffered. Change Address Changes an address of a business partner. This service is buffered. To transfer the changes into the backend system an additional transfer job must be provided. Please request this job from your dsb account manager. URL POST: /rest/{clientId}/bp/{bp-number}/address ParameterDescription bp-numberbusiness partner number clientId client ID sp service provider. (mandatory if the user account can use different service provider values) so sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) Request Body The Body of the Post Request contains a JSON document with the changed address fields. JSON Business Partner Change Example Change or add address fields: { "lastName1": "Customer", "firstName": "Anne", "salutationCode": "02", "zipcode": "NN4 7BF", "addressLine1": "1 Main Road", "regionCode": "NH", "regionText": "Northamptonshire", "city": "NORTHAMPTON", "countryCode": "GB" } Delete address fields: { "poBox": {"action": "DELETE"} } To change communication data you have to specify which value you want to change, because there can be many. Update telephone number: { "bpCommunicationsList": [ { "communicationType" : { "value" : "T", "action" : "UPDATE" }, "communicationValue" : { "value" : "123", "oldValue" : "456", // the old value you want to update "action" : "UPDATE" } } ] } Add new additional telephone number: "bpCommunicationsList": [ { "communicationType" : "T", "communicationValue" : "123" } ] Delete telephone number: { "bpCommunicationsList": [ { "communicationType" : { "value" : "T", "action" : "DELETE" }, "communicationValue" : { "value" : "123", // the old value you want to delete "action" : "DELETE" } } ] } Element Definitions Field name Description lastName1 C 40 Lastname 1 lastName2 C 40 Lastname 2 firstName C 40 First-name jobTitle C 35 Job title salutationCode C 2 Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms. titleCodeAcademic C 4 Academic title code, e.g. 0027 = Dr titleAcademic C 15Academic Title, e.g. Dr. titleCodeRoyal C 4Royal title code titleRoyal C 15Royal title company1 C 401. line of company address. If this field is filled is the above name the contact person of the firm. company2 C 402. line of company address. Contains for example section or continuation of firm address. company3 C 40 3. line of company address department C 30 department zipcode C 10 zipcode street C 50Street with house no. and addition to house no. streetSuffix C 40 Addition to street streetNumber C 10 Street Number streetNumberSuffix C 10 Street Number Suffix addressLine1 C 35Address line 1 for UK addresses addressLine2 C 35Address line 2 for UK addresses addressLine3 C 35Address line 3 for UK addresses poBoxZipcode C 10Po-box-zipcode poBox C 10 Po-box poBoxCity C 40 Po-box-city majorCustomerZipcodeC 10Major-cust-zip city C 40 City district C 40 Addition of city regionCode C 3 Region-Code (federal state, province, county) regionText C 25 Region as cleartext (e.g. County…) countryCode C 2 Two letter ISO 3166-1 alpha-2 country-code advertisement C 1 Advertisement permitted; Y / N block C 1General block-tag ( Y = put block-tag ) euSalesTaxNumber C 14EU sales tax id dateOfBirth D Birthdate (YYYY-MM-DD) masterNumber C 10Partner-ID of master (for example company of contact person) sector C 10 branch bpCommunicationsList communicationType C 2Communication Types; Values communicationValue C 50 Communication value communicationDefault C 1Default value Y / N Corresponing SOAP Service: changeBpAddressBuffered. The service returns the request id. Create Bouncemessage / push bounces (Use only with appropriate Backendintegration in the ccb Suite) This service creates a new bounce message within the ccb suite Path mapping(intern): /net/dsb/commons/Email/pushBounces-1.0.0 URL POST: /rest/{client}/bp/{bpNumber}/bounces?sp={sp}&so={so} ParameterType/LengthDescription client C/3Client ID bpNumber C/10Businesspartner number(mandatory) sp C/3service provider. (service provider. (mandatory if the user account can use different service provider values) so N/4sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) Request body ElementType/LengthDescription bPoolObjNrAN/16Brief-Pool-Object-Number (mandatory) smtRcAN/3Returncode from STMP Server (e.g. 550) (mandatory) smtpMsgAN/132Textual message (z.B. „550 Requested action not taken: mailbox unavailable“) (mandatory) smtpAddrAN/241TO-Address (mandatory) smtpSubjectAN/255Title of the email (mandatory) { "bPoolObjNr“: "“, "smtpRc": "", "smtpMsg": "", "smtpAddr": "", "smtpSubject": "", } Response The response is a JSON structure. ElementDescription messageAdditional message successtrue/false Search bp address This service searches for business partner Path mapping(intern): /net/dsb/avs/BpSearch/searchByAddress-2.0.0 URL POST: /rest/{client}/bpsearch?sp={sp}&so={so} ParameterType/LengthDescription client C/3Client ID sp C/3service provider. (service provider. (mandatory if the user account can use different service provider values) so C/4sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client) maxHits N max. number of results to return ( default: 20 ) fallbackSearch BIf the element is not specified then it is equal to an empty element or loaded with N. This is the standard case. If the element is explicitly filled with Y then it has the effect that there will be made an internally extended search with for example Wildcards. Therefore it can be lead to extended sample space. This search extension will only be executed if no result could be determined on he first search stage.(default: false) searchContact BSearch also contact-person?. Default is „false“.Attention: This parameter is actually not supported in AVS/3. It is intended for future developments Request body { "company": "My Comp.", "firstName": "Andy", "lastName": "Smith", "zipcode": "22334", "city": "London", "street": "High Cross Lane", "countryCode": "GB", "bpCommunicationsList": [ { "communicationValue": "andy@hotmail.com", "communicationType": "WW" } ] } Response The response is a JSON structure. [ { "client": "651", "bpNumber": "1055346513", "salutationCode": "01", "firstName": "Andy", "lastName": "Smith", "zipcode": "22334", "city": "London", "street": "High Cross Lane", "countryCode": "GB", "streetSuffix": "High Cross Lane", "bpCommunicationsList": [ { "communicationValue": "andy@hotmail.com", "communicationType": "WW", "communicationDefault": true }, { "communicationValue": "+447917000000", "communicationType": "T" } ], "validFrom": "0001-01-01", "validTo": "2011-06-05" } ] Get BP by email Reads a BP by the email address. Path mapping(intern): /net/dsb/avs3/Bp/search-1.0.0 SAP REST: /GET_GP_BY_EMAIL or /SEARCH_RFZAS URL GET: /rest/{client}/bp?sp={sp}&so={so}&email={address} Parameter Type/Length Description client C/3 Client ID sp C/3 service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4 sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) email C email address Response The response is a JSON structure. { "listOfBps": [ "4012543721" ] } Corresponing SOAP Service: searchByAddress BP deletion Service allows to delete BP's identical to the dialog deletion in ccb suite. Path mapping(intern): /net/dsb/avs3/Bp/deleteBp-1.0.0 URL POST: /rest/{client}/bp/{bpNumber}?sp={sp}&dryRun=true… Parametertype/lengthdescription client C/3Client bpNumber C/10BP number (mandatory) sp C/3service provider. dryRun Btrue = Testrun false or not provided = live run (default) Response Example Response Body JSON: { "wasCurrentlyDeleted": false, "wasPreviouslyDeleted": false, "messages": [ "I: 1006481701 Old Value: No Manual Deletion", "I: 4008854251 Order deletable", "E: 4016250930 order ist active", "E: 1006481701 has open orders" ] } ElementDescription wasCurrentlyDeletedFlag, if BP was deleted during the web service call wasPreviouslyDeletedInformation that BP was already deleted before the web service call messagesConsists out of Indicator („I“ - Information or „E” - Error) . Text HTTP Response StateDescription 404 BP doesn't exist This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.OKMore information