billingAccountDto Data Type

The Class BillingAccountDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints wrapped by description
bankCoordinates bankCoordinatesDto element 0/1     Field was deprecated in 4.6 version. Use 'paymentMethods' field on CustomerAccount entity instead.
billingCycle string element 1/1 required   The billing cycle.
ccedEmails string element 0/1     a list of emails separated by comma
country string element 1/1 required   The country.
customerAccount string element 1/1 required   The customer account.
discountPlanForInstantiation discountPlanDto element 0/unbounded   discountPlansForInstantiation List of discount plans. Use in instantiating DiscountPlanInstance.
discountPlanForTermination string element 0/unbounded   discountPlansForTermination List of discount plans to be disassociated in a BillingAccount
discountPlanInstance discountPlanInstanceDto element 0/unbounded   discountPlanInstances Use to return the active discount plans for this entity.
electronicBilling boolean element 0/1     The electronic billing.
email string element 0/1     The email.
emailTemplate string element 0/1     Email Template code
invoices invoiceDto element 0/unbounded     The invoices.
invoicingThreshold decimal element 0/1     The invoicing threshold.
language string element 1/1 required   The language.
mailingType string element 0/1     Mailing type
minimumAmountEl string element 0/1     Expression to determine minimum amount value
minimumAmountElSpark string element 0/1     Expression to determine minimum amount value - for Spark
minimumLabelEl string element 0/1     Expression to determine rated transaction description to reach minimum amount value
minimumLabelElSpark string element 0/1     Expression to determine rated transaction description to reach minimum amount value - for Spark
nextInvoiceDate dateTime element 0/1     The next invoice date.
paymentMethod paymentMethodEnum element 0/1     Field was deprecated in 4.6 version. Use 'paymentMethods' field on CustomerAccount entity instead.
paymentTerms string element 0/1     Field was deprecated in 4.6 version. Use custom fields instead.
phone string element 0/1     The phone.
status accountStatusEnum element 0/1     The status.
statusDate dateTime element 0/1     The status date.
subscriptionDate dateTime element 0/1     The subscription date.
terminationDate dateTime element 0/1     The termination date.
terminationReason string element 0/1     The termination reason.
userAccounts userAccountsDto element 0/1     Use for GET / LIST only.
Properties inherited from accountDto
code string attribute 1/1     The code
description string attribute 0/1     The description
id long attribute 0/1     The id.
auditable auditableDto element 0/1      
auditableField auditableFieldDto element 0/unbounded   auditableFields  
businessAccountModel businessEntityDto element 0/1     The business account model.
contactInformation contactInformationDto element 0/1     The contact information.
customFields customFieldsDto element 0/1     The custom fields.
externalRef1 string element 0/1     The external ref 1.
externalRef2 string element 0/1     The external ref 2.
jobTitle string element 0/1     The job title.
name nameDto element 0/1     The name.
registrationNo string element 0/1     The registration no.
updatedCode string element 0/1     The updated code.
vatNo string element 0/1     The vat no.

Example

<billingAccountDto code="..." description="..." id="...">
  <customerAccount>...</customerAccount>
  <billingCycle>...</billingCycle>
  <country>...</country>
  <language>...</language>
  <nextInvoiceDate>...</nextInvoiceDate>
  <subscriptionDate>...</subscriptionDate>
  <terminationDate>...</terminationDate>
  <electronicBilling>...</electronicBilling>
  <status>...</status>
  <statusDate>...</statusDate>
  <terminationReason>...</terminationReason>
  <email>...</email>
  <invoices>
    <invoiceId>...</invoiceId>
    <invoiceType>...</invoiceType>
    <billingAccountCode>...</billingAccountCode>
    <sellerCode>...</sellerCode>
    <subscriptionCode>...</subscriptionCode>
    <orderNumber>...</orderNumber>
    <dueDate>...</dueDate>
    <invoiceDate>...</invoiceDate>
    <categoryInvoiceAgregates>
      <categoryInvoiceAgregate>
        <categoryInvoiceCode>...</categoryInvoiceCode>
        <description>...</description>
        <userAccountCode>...</userAccountCode>
        <itemNumber>...</itemNumber>
        <amountWithoutTax>...</amountWithoutTax>
        <amountTax>...</amountTax>
        <amountWithTax>...</amountWithTax>
        <listSubCategoryInvoiceAgregateDto>
          <subCategoryInvoiceAgregateDto/>
        </listSubCategoryInvoiceAgregateDto>
        <discountAggregates>
          <discountAggregate/>
        </discountAggregates>
      </categoryInvoiceAgregate>
    </categoryInvoiceAgregates>
    <taxAggregates>
      <taxAggregate>
        <description>...</description>
        <itemNumber>...</itemNumber>
        <amountWithoutTax>...</amountWithoutTax>
        <amountTax>...</amountTax>
        <amountWithTax>...</amountWithTax>
        <taxCode>...</taxCode>
        <taxPercent>...</taxPercent>
        <accountingCode>...</accountingCode>
      </taxAggregate>
    </taxAggregates>
    <listInvoiceIdToLink>
      <invoiceIdToLink>...</invoiceIdToLink>
    </listInvoiceIdToLink>
    <invoiceNumber>...</invoiceNumber>
    <discount>...</discount>
    <amountWithoutTax>...</amountWithoutTax>
    <amountTax>...</amountTax>
    <amountWithTax>...</amountWithTax>
    <paymentMethod>...</paymentMethod>
    <xmlFilename>...</xmlFilename>
    <xml>...</xml>
    <pdfFilename>...</pdfFilename>
    <pdf>...</pdf>
    <autoValidation>...</autoValidation>
    <returnXml>...</returnXml>
    <returnPdf>...</returnPdf>
    <includeBalance>...</includeBalance>
    <recordedInvoiceDto>
      <productionDate>...</productionDate>
      <invoiceDate>...</invoiceDate>
      <netToPay>...</netToPay>
    </recordedInvoiceDto>
    <netToPay>...</netToPay>
    <invoiceMode>...</invoiceMode>
    <customFields>
      <customField/>
      <inheritedCustomField/>
    </customFields>
    <dueBalance>...</dueBalance>
    <isDraft>...</isDraft>
    <checkAlreadySent>...</checkAlreadySent>
    <overrideEmail>...</overrideEmail>
    <sentByEmail>...</sentByEmail>
    <auditable/>
    <auditableFields>
      <auditableField/>
    </auditableFields>
  </invoices>
  <invoicingThreshold>...</invoicingThreshold>
  <phone>...</phone>
  <minimumAmountEl>...</minimumAmountEl>
  <minimumAmountElSpark>...</minimumAmountElSpark>
  <minimumLabelEl>...</minimumLabelEl>
  <minimumLabelElSpark>...</minimumLabelElSpark>
  <userAccounts>
    <userAccount>
      <billingAccount>...</billingAccount>
      <billingAccountDescription>...</billingAccountDescription>
      <customerAccount>...</customerAccount>
      <customerAccountDescription>...</customerAccountDescription>
      <customer>...</customer>
      <customerDescription>...</customerDescription>
      <subscriptionDate>...</subscriptionDate>
      <terminationDate>...</terminationDate>
      <status>...</status>
      <statusDate>...</statusDate>
      <terminationReason>...</terminationReason>
      <subscriptions/>
    </userAccount>
  </userAccounts>
  <discountPlansForInstantiation>
    <discountPlanForInstantiation code="..." description="..." id="...">
      <startDate>...</startDate>
      <endDate>...</endDate>
      <defaultDuration>...</defaultDuration>
      <durationUnit>...</durationUnit>
      <customFields>
        <customField/>
        <inheritedCustomField/>
      </customFields>
      <discountPlanItems>
        <discountPlanItem code="...">
          <discountPlanCode>...</discountPlanCode>
          <invoiceCategoryCode>...</invoiceCategoryCode>
          <invoiceSubCategoryCode>...</invoiceSubCategoryCode>
          <expressionEl>...</expressionEl>
          <expressionElSpark>...</expressionElSpark>
          <disabled>...</disabled>
          <discountPlanItemType>...</discountPlanItemType>
          <discountValue>...</discountValue>
          <discountValueEL>...</discountValueEL>
          <discountValueElSpark>...</discountValueElSpark>
          <customFields/>
        </discountPlanItem>
      </discountPlanItems>
      <disabled>...</disabled>
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </discountPlanForInstantiation>
  </discountPlansForInstantiation>
  <discountPlansForTermination>
    <discountPlanForTermination>...</discountPlanForTermination>
  </discountPlansForTermination>
  <discountPlanInstances>
    <discountPlanInstance>
      <discountPlan>...</discountPlan>
      <billingAccount>...</billingAccount>
      <subscription>...</subscription>
      <startDate>...</startDate>
      <endDate>...</endDate>
      <customFields>
        <customField/>
        <inheritedCustomField/>
      </customFields>
    </discountPlanInstance>
  </discountPlanInstances>
  <mailingType>...</mailingType>
  <emailTemplate>...</emailTemplate>
  <ccedEmails>...</ccedEmails>
  <externalRef1>...</externalRef1>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <externalRef2>...</externalRef2>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <name>
    <title>...</title>
    <firstName>...</firstName>
    <lastName>...</lastName>
  </name>
  <updatedCode>...</updatedCode>
  <jobTitle>...</jobTitle>
  <businessAccountModel code="..." description="..." id="...">
    <updatedCode>...</updatedCode>
  </businessAccountModel>
  <customFields>
    <customField/>
    <inheritedCustomField/>
  </customFields>
  <vatNo>...</vatNo>
  <registrationNo>...</registrationNo>
  <contactInformation>
    <email>...</email>
    <phone>...</phone>
    <mobile>...</mobile>
    <fax>...</fax>
  </contactInformation>
</billingAccountDto>