party
POST /party
create a party
Request
- Base URLhttps://www.weclapp.com/api/nullapi/v2
- AuthAPI key in header AuthenticationToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
dryRunboolean
Request body
idstring
versionstring
birthDateinteger
commercialLanguageIdstring
commissionBlockboolean
companystring
company2string
companySizeIdstring
competitorboolean
convertedOnDateinteger
createdDateinteger
currencyIdstring
customerboolean
customerActiveboolean
customerAllowDropshippingOrderCreationboolean
customerAmountInsuredstring number
customerAnnualRevenuestring number
customerBlockNoticestring
customerBlockedboolean
customerBusinessType'B2B' | 'B2C' | 'B2G'
customerCategoryIdstring
customerCreditLimitstring number
customerCurrentSalesStageIdstring
customerDebtorAccountIdstring
customerDebtorAccountingCodeIdstring
customerDefaultHeaderDiscountstring number
customerDefaultHeaderSurchargestring number
customerDefaultShippingCarrierIdstring
customerDefaultWarehouseIdstring
customerDeliveryBlockboolean
customerInsolventboolean
customerInsuredboolean
customerInternalNotestring
customerLossDescriptionstring
customerLossReasonIdstring
customerNonStandardTaxIdstring
customerNumberstring
customerNumberOldstring
customerPaymentMethodIdstring
customerSalesChannelstring
customerSalesOrderPaymentType'ADVANCE_PAYMENT' | 'COUNTER_SALES' | 'PART_PAYMENT' | 'PREPAYMENT' | 'STANDARD'
customerSalesProbabilityinteger
customerSatisfaction'NEUTRAL' | 'SATISFIED' | 'UNSATISFIED'
customerShipmentMethodIdstring
customerSupplierNumberstring
customerTermOfPaymentIdstring
customerUseCustomsTariffNumberboolean
deliveryAddressIdstring
deliveryEmailAddressesIdstring
descriptionstring
dunningAddressIdstring
dunningEmailAddressesIdstring
emailstring
emailHomestring
enableDropshippingInNewSupplySourcesboolean
eoriNumberstring
factoringboolean
faxstring
firstNamestring
fixPhone2string
fixedResponsibleUserboolean
formerSalesPartnerboolean
habitualExporterboolean
imageIdstring
invoiceAddressIdstring
invoiceBlockboolean
invoiceRecipientIdstring
lastModifiedDateinteger
lastNamestring
leadRatingIdstring
leadSourceIdstring
leadStatus'CONVERTED' | 'DISQUALIFIED' | 'NEW' | 'PREQUALIFIED' | 'QUALIFIED'
legalFormIdstring
middleNamestring
mobilePhone1string
mobilePhone2string
optInEmailboolean
optInLetterboolean
optInPhoneboolean
optInSmsboolean
parentPartyIdstring
partyType'ORGANIZATION' | 'PERSON' required
personCompanystring
personDepartmentIdstring
personRoleIdstring
phonestring
phoneHomestring
primaryAddressIdstring
primaryContactIdstring
publicPageExpirationDateinteger
publicPageUuidstring
purchaseEmailAddressesIdstring
purchaseViaPlafondboolean
quotationEmailAddressesIdstring
ratingIdstring
referenceNumberstring
regionIdstring
responsibleUserIdstring
salesInvoiceEmailAddressesIdstring
salesOrderEmailAddressesIdstring
salesPartnerboolean
salesPartnerDefaultCommissionFixstring number
salesPartnerDefaultCommissionPercentagestring number
salesPartnerDefaultCommissionType'FIX' | 'FIX_AND_MARGIN' | 'FIX_AND_REVENUE' | 'MARGIN' | 'NO_COMMISSION' | 'REVENUE'
salutation'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION'
sectorIdstring
supplierboolean
supplierActiveboolean
supplierCreditorAccountIdstring
supplierCreditorAccountingCodeIdstring
supplierCustomerNumberAtSupplierstring
supplierDefaultShippingCarrierIdstring
supplierInternalNotestring
supplierMergeItemsForOcrInvoiceUploadboolean
supplierMinimumPurchaseOrderAmountstring number
supplierNonStandardTaxIdstring
supplierNumberstring
supplierNumberOldstring
supplierOrderBlockboolean
supplierPaymentMethodIdstring
supplierShipmentMethodIdstring
supplierTermOfPaymentIdstring
tagsstring[]
taxIdstring
titleIdstring
vatIdentificationNumberstring
websitestring
xRechnungLeitwegIdstring
Response
party create response
idstring
versionstring
birthDateinteger
commercialLanguageIdstring
commissionBlockboolean
companystring
company2string
companySizeIdstring
competitorboolean
convertedOnDateinteger
createdDateinteger
currencyIdstring
customerboolean
customerActiveboolean
customerAllowDropshippingOrderCreationboolean
customerAmountInsuredstring number
customerAnnualRevenuestring number
customerBlockNoticestring
customerBlockedboolean
customerBusinessType'B2B' | 'B2C' | 'B2G'
customerCategoryIdstring
customerCreditLimitstring number
customerCurrentSalesStageIdstring
customerDebtorAccountIdstring
customerDebtorAccountingCodeIdstring
customerDefaultHeaderDiscountstring number
customerDefaultHeaderSurchargestring number
customerDefaultShippingCarrierIdstring
customerDefaultWarehouseIdstring
customerDeliveryBlockboolean
customerInsolventboolean
customerInsuredboolean
customerInternalNotestring
customerLossDescriptionstring
customerLossReasonIdstring
customerNonStandardTaxIdstring
customerNumberstring
customerNumberOldstring
customerPaymentMethodIdstring
customerSalesChannelstring
customerSalesOrderPaymentType'ADVANCE_PAYMENT' | 'COUNTER_SALES' | 'PART_PAYMENT' | 'PREPAYMENT' | 'STANDARD'
customerSalesProbabilityinteger
customerSatisfaction'NEUTRAL' | 'SATISFIED' | 'UNSATISFIED'
customerShipmentMethodIdstring
customerSupplierNumberstring
customerTermOfPaymentIdstring
customerUseCustomsTariffNumberboolean
deliveryAddressIdstring
deliveryEmailAddressesIdstring
descriptionstring
dunningAddressIdstring
dunningEmailAddressesIdstring
emailstring
emailHomestring
enableDropshippingInNewSupplySourcesboolean
eoriNumberstring
factoringboolean
faxstring
firstNamestring
fixPhone2string
fixedResponsibleUserboolean
formerSalesPartnerboolean
habitualExporterboolean
imageIdstring
invoiceAddressIdstring
invoiceBlockboolean
invoiceRecipientIdstring
lastModifiedDateinteger
lastNamestring
leadRatingIdstring
leadSourceIdstring
leadStatus'CONVERTED' | 'DISQUALIFIED' | 'NEW' | 'PREQUALIFIED' | 'QUALIFIED'
legalFormIdstring
middleNamestring
mobilePhone1string
mobilePhone2string
optInEmailboolean
optInLetterboolean
optInPhoneboolean
optInSmsboolean
parentPartyIdstring
partyType'ORGANIZATION' | 'PERSON' required
personCompanystring
personDepartmentIdstring
personRoleIdstring
phonestring
phoneHomestring
primaryAddressIdstring
primaryContactIdstring
publicPageExpirationDateinteger
publicPageUuidstring
purchaseEmailAddressesIdstring
purchaseViaPlafondboolean
quotationEmailAddressesIdstring
ratingIdstring
referenceNumberstring
regionIdstring
responsibleUserIdstring
salesInvoiceEmailAddressesIdstring
salesOrderEmailAddressesIdstring
salesPartnerboolean
salesPartnerDefaultCommissionFixstring number
salesPartnerDefaultCommissionPercentagestring number
salesPartnerDefaultCommissionType'FIX' | 'FIX_AND_MARGIN' | 'FIX_AND_REVENUE' | 'MARGIN' | 'NO_COMMISSION' | 'REVENUE'
salutation'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION'
sectorIdstring
supplierboolean
supplierActiveboolean
supplierCreditorAccountIdstring
supplierCreditorAccountingCodeIdstring
supplierCustomerNumberAtSupplierstring
supplierDefaultShippingCarrierIdstring
supplierInternalNotestring
supplierMergeItemsForOcrInvoiceUploadboolean
supplierMinimumPurchaseOrderAmountstring number
supplierNonStandardTaxIdstring
supplierNumberstring
supplierNumberOldstring
supplierOrderBlockboolean
supplierPaymentMethodIdstring
supplierShipmentMethodIdstring
supplierTermOfPaymentIdstring
tagsstring[]
taxIdstring
titleIdstring
vatIdentificationNumberstring
websitestring
xRechnungLeitwegIdstring