| name | data type | constraints | description |
|---|---|---|---|
| provider | Provider | ||
| parentEntity | BusinessEntity | ||
| referenceCode | string | ||
| referenceDescription | string | ||
| version | number | ||
| historized | boolean | ||
| notified | boolean | ||
| auditable | Auditable | ||
| descriptionOrCode | string | ||
| parentEntityType | object | ||
| auditableFields | array of AuditableFieldHistory | ||
| id | number | ||
| descriptionAndCode | string | ||
| codeChanged | boolean | ||
| description | string | max size: 255, min size: 0 | |
| code | string | required, max size: 255, min size: 1 | |
| transient | boolean | ||
| descriptionI18n | map of string | ||
| appendGeneratedCode | boolean |
Example
{
"provider" : {
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"transient" : true,
"invoiceConfigurationOrDefault" : {
"defaultInvoiceMinimumAccountingArticle" : { },
"displayDetail" : true,
"displayProvider" : true,
"defaultDiscountAccountingArticle" : { },
"displayWalletOperations" : true,
"displaySubscriptions" : true,
"displayOffers" : true,
"displayEdrs" : true,
"displayUserAccountHierarchy" : true,
"displayPricePlans" : true,
"displayServices" : true,
"displayCfAsXML" : true,
"displayBillingCycle" : true,
"transient" : true,
"currentInvoiceNb" : 12345,
"version" : 12345,
"defaultInvoiceSubCategory" : { },
"displayOrders" : true,
"defaultAdvancedPaymentAccountingArticle" : { },
"displayTaxDetails" : true,
"defaultGenericAccountingArticle" : { },
"id" : 12345
},
"historized" : true,
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"customerAccount" : {
"DDPaymentMethods" : [ { }, { } ],
"preferredPaymentMethodType" : "WIRETRANSFER",
"tradingLanguage" : { },
"externalRef1" : "...",
"auditable" : { },
"vatNo" : "...",
"contactInformationNullSafe" : { },
"dueDateDelayEL" : "...",
"description" : "...",
"transient" : true,
"auditableFields" : [ { }, { } ],
"dueBalance" : "...",
"cfValues" : { },
"parentEntityType" : { },
"noMoreValidCard" : true,
"id" : 12345,
"legalEntityType" : { },
"accountType" : "...",
"preferredPaymentMethod" : { },
"isCompany" : true,
"addressbook" : { },
"paymentMethods" : [ { }, { } ],
"parentEntity" : { },
"minimumTargetAccount" : { },
"providerContact" : "...",
"checkPaymentMethods" : [ { }, { } ],
"paypalPaymentMethods" : [ { }, { } ],
"status" : "CLOSE",
"billingAccounts" : [ { }, { } ],
"actionDunnings" : [ { }, { } ],
"dunningDocuments" : [ { }, { } ],
"jobTitle" : "...",
"wirePaymentMethods" : [ { }, { } ],
"referenceDescription" : "...",
"checkThreshold" : "BEFORE_DISCOUNT",
"notified" : true,
"dateStatus" : 12345,
"uuid" : "...",
"name" : { },
"excludedFromPayment" : true,
"businessAccountModel" : { },
"paymentPlans" : [ { }, { } ],
"version" : 12345,
"auditedMethodPayments" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"minimumLabelEl" : "...",
"cfAccumulatedValues" : { },
"contactInformation" : { },
"descriptionAndCode" : "...",
"invoicingThreshold" : 12345.0,
"minimumArticle" : { },
"generalClientAccount" : { },
"counters" : {
"property1" : { },
"property2" : { }
},
"address" : { },
"externalRef2" : "...",
"creditCategory" : { },
"minimumAmountEl" : "...",
"thresholdPerEntity" : true,
"accountOperations" : [ { }, { } ],
"descriptionOrCode" : "...",
"password" : "...",
"minimumChargeTemplate" : { },
"customer" : { },
"parentCFEntities" : [ { }, { } ],
"tradingCurrency" : { },
"dateDunningLevel" : 12345,
"code" : "...",
"appendGeneratedCode" : true,
"contracts" : [ { }, { } ],
"defaultLevel" : true,
"referenceCode" : "...",
"stripePaymentMethods" : [ { }, { } ],
"historized" : true,
"codeChanged" : true,
"registrationNo" : "...",
"dunningLevel" : "R3",
"primaryContact" : { }
},
"currency" : {
"auditable" : { },
"transient" : true,
"auditableFields" : [ { }, { } ],
"version" : 12345,
"id" : 12345,
"notified" : true,
"description" : "...",
"systemCurrency" : true,
"symbol" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"historized" : true,
"descriptionEn" : "...",
"currencyCode" : "..."
},
"customer" : {
"businessAccountModel" : { },
"auditable" : { },
"address" : { },
"anonymized" : true,
"primaryContact" : { },
"registrationNo" : "...",
"contracts" : [ { }, { } ],
"minimumArticle" : { },
"contactInformation" : { },
"historized" : true,
"vatNo" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"counters" : {
"property1" : { },
"property2" : { }
},
"customerBrand" : { },
"uuid" : "...",
"accountType" : "...",
"defaultLevel" : true,
"seller" : { },
"version" : 12345,
"referenceCode" : "...",
"externalRef2" : "...",
"code" : "...",
"contactInformationNullSafe" : { },
"parentCFEntities" : [ { }, { } ],
"minimumChargeTemplate" : { },
"parentEntityType" : { },
"legalEntityType" : { },
"transient" : true,
"cfValues" : { },
"minimumLabelEl" : "...",
"description" : "...",
"descriptionOrCode" : "...",
"providerContact" : "...",
"additionalDetails" : { },
"customerAccounts" : [ { }, { } ],
"cfAccumulatedValues" : { },
"isCompany" : true,
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"externalRef1" : "...",
"checkThreshold" : "AFTER_DISCOUNT",
"jobTitle" : "...",
"thresholdPerEntity" : true,
"codeChanged" : true,
"name" : { },
"parentEntity" : { },
"addressbook" : { },
"minimumTargetAccount" : { },
"customerCategory" : { },
"anonymizationDate" : 12345,
"invoicingThreshold" : 12345.0,
"minimumAmountEl" : "...",
"appendGeneratedCode" : true
},
"active" : true,
"automaticInvoicing" : true,
"bankCoordinates" : {
"key" : "...",
"ics" : "...",
"bankCode" : "...",
"bankId" : "...",
"accountNumber" : "...",
"bic" : "...",
"issuerName" : "...",
"bankName" : "...",
"accountOwner" : "...",
"branchCode" : "...",
"iban" : "...",
"issuerNumber" : "..."
},
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"paymentMethods" : [ "PAYPAL", "WIRETRANSFER" ],
"paymentPlan" : true,
"invoiceConfiguration" : {
"defaultInvoiceMinimumAccountingArticle" : { },
"displayDetail" : true,
"displayProvider" : true,
"defaultDiscountAccountingArticle" : { },
"displayWalletOperations" : true,
"displaySubscriptions" : true,
"displayOffers" : true,
"displayEdrs" : true,
"displayUserAccountHierarchy" : true,
"displayPricePlans" : true,
"displayServices" : true,
"displayCfAsXML" : true,
"displayBillingCycle" : true,
"transient" : true,
"currentInvoiceNb" : 12345,
"version" : 12345,
"defaultInvoiceSubCategory" : { },
"displayOrders" : true,
"defaultAdvancedPaymentAccountingArticle" : { },
"displayTaxDetails" : true,
"defaultGenericAccountingArticle" : { },
"id" : 12345
},
"entreprise" : true,
"id" : 12345,
"discountAccountingCode" : "...",
"functionalCurrencyFlag" : true,
"country" : {
"auditableFields" : [ { }, { } ],
"transient" : true,
"auditable" : { },
"code" : "...",
"historized" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"language" : { },
"countryCode" : "...",
"id" : 12345,
"version" : 12345,
"description" : "...",
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"notified" : true,
"currency" : { }
},
"billingAccount" : {
"code" : "...",
"brAmountWithoutTax" : 12345.0,
"tradingCountry" : { },
"nextInvoiceDate" : 12345,
"subscriptionDate" : 12345,
"discountPlanInstances" : [ { }, { } ],
"minimumLabelEl" : "...",
"defaultLevel" : true,
"electronicBilling" : true,
"minimumAmountEl" : "...",
"notified" : true,
"cfValues" : { },
"minimumChargeTemplate" : { },
"parentUserAccounts" : [ { }, { } ],
"taxCategory" : { },
"minimumArticle" : { },
"invoices" : [ { }, { } ],
"parentEntityType" : { },
"tags" : [ { }, { } ],
"invoicePrefix" : "...",
"version" : 12345,
"registrationNo" : "...",
"providerContact" : "...",
"invoicingThreshold" : 12345.0,
"jobTitle" : "...",
"brAmountWithTax" : 12345.0,
"billingCycle" : { },
"accountType" : "...",
"externalRef1" : "...",
"checkThreshold" : "POSITIVE_RT",
"status" : "CANCELED",
"paymentMethod" : { },
"parentEntity" : { },
"totalInvoicingAmountWithoutTax" : 12345.0,
"legalEntityType" : { },
"discountRate" : 12345.0,
"name" : { },
"customerAccount" : { },
"statusDate" : 12345,
"descriptionAndCode" : "...",
"description" : "...",
"isCompany" : true,
"allDiscountPlanInstances" : [ { }, { } ],
"contracts" : [ { }, { } ],
"tradingLanguage" : { },
"ccedEmails" : "...",
"vatNo" : "...",
"terminationDate" : 12345,
"emailTemplate" : { },
"auditableFields" : [ { }, { } ],
"uuid" : "...",
"parentCFEntities" : [ { }, { } ],
"minRatedTransactions" : [ { }, { } ],
"descriptionOrCode" : "...",
"referenceDescription" : "...",
"businessAccountModel" : { },
"minInvoiceLines" : [ { }, { } ],
"exoneratedFromtaxes" : true,
"totalInvoicingAmountTax" : 12345.0,
"transient" : true,
"terminationReason" : { },
"taxCategoryResolved" : { },
"referenceCode" : "...",
"historized" : true,
"cfAccumulatedValues" : { },
"address" : { },
"counters" : {
"property1" : { },
"property2" : { }
},
"discountPlan" : { },
"mailingType" : "MANUAL",
"tradingCurrency" : { },
"appendGeneratedCode" : true,
"billingRun" : { },
"usersAccounts" : [ { }, { } ],
"minimumInvoiceSubCategory" : { },
"primaryContact" : { },
"externalRef2" : "...",
"id" : 12345,
"codeChanged" : true,
"contactInformation" : { },
"auditable" : { },
"thresholdPerEntity" : true,
"contactInformationNullSafe" : { },
"totalInvoicingAmountWithTax" : 12345.0
},
"paymentDeferral" : true,
"rumSequence" : {
"prefix" : "...",
"sequenceSize" : 12345,
"currentSequenceNb" : 12345
},
"disabled" : true,
"multicurrencyFlag" : true,
"userAccount" : {
"codeChanged" : true,
"historized" : true,
"cfAccumulatedValues" : { },
"jobTitle" : "...",
"name" : { },
"version" : 12345,
"descriptionAndCode" : "...",
"prepaidWallets" : {
"property1" : { },
"property2" : { }
},
"terminationDate" : 12345,
"contactInformationNullSafe" : { },
"id" : 12345,
"externalRef1" : "...",
"statusDate" : 12345,
"description" : "...",
"descriptionOrCode" : "...",
"auditable" : { },
"userAccounts" : [ { }, { } ],
"defaultLevel" : true,
"uuid" : "...",
"parentEntity" : { },
"legalEntityType" : { },
"contactInformation" : { },
"minimumAmountEl" : "...",
"notified" : true,
"address" : { },
"parentUserAccount" : { },
"cfValues" : { },
"primaryContact" : { },
"externalRef2" : "...",
"registrationNo" : "...",
"referenceCode" : "...",
"accountType" : "...",
"counters" : {
"property1" : { },
"property2" : { }
},
"billingAccount" : { },
"minimumArticle" : { },
"isCompany" : true,
"auditableFields" : [ { }, { } ],
"status" : "CANCELED",
"referenceDescription" : "...",
"subscriptionDate" : 12345,
"vatNo" : "...",
"providerContact" : "...",
"isConsumer" : true,
"parentCFEntities" : [ { }, { } ],
"minimumChargeTemplate" : { },
"terminationReason" : { },
"subscriptions" : [ { }, { } ],
"parentEntityType" : { },
"appendGeneratedCode" : true,
"businessAccountModel" : { },
"wallet" : { },
"minimumLabelEl" : "...",
"code" : "...",
"transient" : true
},
"gdprConfiguration" : {
"accountingLife" : 12345,
"deleteAccounting" : true,
"inactiveSubscriptionLife" : 12345,
"transient" : true,
"mailingLife" : 12345,
"deleteMailingLife" : true,
"customerProspectLife" : 12345,
"invoiceLife" : 12345,
"aoCheckUnpaidLife" : 12345,
"deleteAoCheckUnpaidLife" : true,
"id" : 12345,
"deleteInvoice" : true,
"version" : 12345,
"deleteCustomerProspect" : true,
"inactiveOrderLife" : 12345,
"deleteOrder" : true,
"deleteSubscription" : true
},
"code" : "...",
"multicountryFlag" : true,
"customerNoSequence" : {
"prefix" : "...",
"sequenceSize" : 12345,
"currentSequenceNb" : 12345
},
"levelDuplication" : true,
"displayFreeTransacInInvoice" : true,
"roundingMode" : "NEAREST",
"uuid" : "...",
"maximumDelay" : 12345,
"prepaidReservationExpirationDelayinMillisec" : 12345,
"description" : "...",
"interBankTitle" : {
"codeCentre" : "...",
"codeCreancier" : "...",
"codeEtablissementCreancier" : "...",
"nne" : "...",
"adresseTSA" : { }
},
"amountValidation" : true,
"cdrDeduplicationKeyEL" : "...",
"invoiceRounding" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"currentProvider" : true,
"email" : "...",
"recognizeRevenue" : true,
"parentCFEntities" : [ {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"dirtyCF" : true,
"CFValuesCopy" : { },
"uuid" : "..."
}, {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"dirtyCF" : true,
"CFValuesCopy" : { },
"uuid" : "..."
} ],
"version" : 12345,
"language" : {
"transient" : true,
"description" : "...",
"version" : 12345,
"auditableFields" : [ { }, { } ],
"historized" : true,
"notified" : true,
"auditable" : { },
"id" : 12345,
"languageCode" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionEn" : "..."
},
"invoiceRoundingMode" : "NEAREST",
"maximumDeferralPerInvoice" : 12345,
"notified" : true,
"multilanguageFlag" : true,
"paymentPlanPolicy" : {
"defaultInterestRate" : 12345,
"defaultInstallmentCount" : 12345,
"defaultStartingDateOfPlan" : "FIRST_DAY_OF_NEXT_MONTH",
"theresHoldForApproval" : 12345.0,
"clearingPriority" : "OLDEST",
"minInstallmentAmount" : 12345.0,
"allowedCreditCategories" : [ { }, { } ],
"allowCustomInstallmentPlan" : true,
"dunningDefaultPauseReason" : { },
"requireInternalApproval" : true,
"addInstallmentFee" : true,
"minAllowedReceivableAmount" : 12345.0,
"defaultFeePerInstallmentPlan" : 12345,
"defaultRecurrenceUnit" : "MONTH",
"allowedPaymentMethods" : [ "PAYPAL", "CASH" ],
"defaultBlockPayments" : true,
"maxPaymentPlanDuration" : 12345,
"splitEvenly" : true,
"maxAllowedReceivableAmount" : 12345.0,
"installmentAmountRounding" : 12345,
"actionOnRemainingAmount" : "FIRST",
"addInterestRate" : true
},
"rounding" : 12345,
"activateCascadingDiscounts" : true,
"gdprConfigurationNullSafe" : {
"accountingLife" : 12345,
"deleteAccounting" : true,
"inactiveSubscriptionLife" : 12345,
"transient" : true,
"mailingLife" : 12345,
"deleteMailingLife" : true,
"customerProspectLife" : 12345,
"invoiceLife" : 12345,
"aoCheckUnpaidLife" : 12345,
"deleteAoCheckUnpaidLife" : true,
"id" : 12345,
"deleteInvoice" : true,
"version" : 12345,
"deleteCustomerProspect" : true,
"inactiveOrderLife" : 12345,
"deleteOrder" : true,
"deleteSubscription" : true
}
},
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "OTHER",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
},
"referenceCode" : "...",
"referenceDescription" : "...",
"version" : 12345,
"historized" : true,
"notified" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"descriptionOrCode" : "...",
"parentEntityType" : { },
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "OTHER",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"id" : 12345,
"descriptionAndCode" : "...",
"codeChanged" : true,
"description" : "...",
"code" : "...",
"transient" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"appendGeneratedCode" : true
}