invoiceDto Data Type

DTO equivalent of Invoice entity.

Namespace
(Default)
Subtypes
generateInvoiceResultDto
Properties
name data type type namespace min/max occurs constraints wrapped by description
amountTax decimal element 0/1     The amount tax.
amountWithTax decimal element 0/1     The amount with tax.
amountWithoutTax decimal element 0/1     The amount without tax.
autoValidation boolean element 0/1     A request-only parameter. True if invoice should be assigned a number. Defaults to True.
billingAccountCode string element 1/1 required   The billing account code.
categoryInvoiceAgregate categoryInvoiceAgregateDto element 1/unbounded required categoryInvoiceAgregates The category invoice aggregates.
checkAlreadySent boolean element 1/1     Before sending the invoice, check if not already sent
customFields customFieldsDto element 0/1     The custom fields.
discount decimal element 0/1     The discount.
dueBalance decimal element 0/1     The total due is a snapshot at invoice generation time of the due balance (not exigible) before invoice calculation+invoice amount. Due balance is a "future" dueBalance (the due balance at the invoice due date).
dueDate dateTime element 1/1 required   The due date.
includeBalance boolean element 0/1     A request-only parameter. True if currently due balance should be returned
invoiceDate dateTime element 1/1 required   The invoice date.
invoiceId long element 0/1     The invoice id.
invoiceIdToLink long element 0/unbounded   listInvoiceIdToLink The list invoice id to link.
invoiceMode invoiceModeEnum element 1/1 required   The invoice mode.
invoiceNumber string element 0/1     The invoice number.
invoiceType string element 1/1 required   The invoice type.
isDraft boolean element 0/1     A flag to generate a draft invoice
netToPay decimal element 0/1     The net to pay.
orderNumber string element 0/1     Order number
overrideEmail string element 0/1     Override Email defined in the billing entity
paymentMethod paymentMethodEnum element 0/1     The payment method.
pdf base64Binary element 0/1     The pdf.
pdfFilename string element 0/1     The pdf filename.
recordedInvoiceDto recordedInvoiceDto element 0/1     The recorded invoice dto.
returnPdf boolean element 0/1     A request-only parameter. True if currently PDF invoice should be returned.
returnXml boolean element 0/1     A request-only parameter. True if currently XML invoice should be returned.
sellerCode string element 0/1     Code of the Seller
sentByEmail boolean element 1/1     True if the invoice is sent, false otherwise
subscriptionCode string element 0/1     Code of the subscription
taxAggregate taxInvoiceAggregateDto element 1/unbounded required taxAggregates The tax aggregates
xml string element 0/1     The xml.
xmlFilename string element 0/1     The xml filename.
Properties inherited from auditableEntityDto
auditable auditableDto element 0/1      
auditableField auditableFieldDto element 0/unbounded   auditableFields  

Example

<Invoice>
  <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>
          <itemNumber>...</itemNumber>
          <accountingCode>...</accountingCode>
          <description>...</description>
          <taxCode>...</taxCode>
          <taxPercent>...</taxPercent>
          <amountWithoutTax>...</amountWithoutTax>
          <amountTax>...</amountTax>
          <amountWithTax>...</amountWithTax>
          <invoiceSubCategoryCode>...</invoiceSubCategoryCode>
          <userAccountCode>...</userAccountCode>
          <ratedTransactions>
            <ratedTransaction/>
          </ratedTransactions>
        </subCategoryInvoiceAgregateDto>
      </listSubCategoryInvoiceAgregateDto>
      <discountAggregates>
        <discountAggregate>
          <discountPlanItemCode>...</discountPlanItemCode>
          <discountPercent>...</discountPercent>
        </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>
    <id>...</id>
    <dueDate>...</dueDate>
    <type>...</type>
    <transactionDate>...</transactionDate>
    <transactionCategory>...</transactionCategory>
    <reference>...</reference>
    <accountingCode>...</accountingCode>
    <amount>...</amount>
    <amountWithoutTax>...</amountWithoutTax>
    <taxAmount>...</taxAmount>
    <matchingAmount>...</matchingAmount>
    <unMatchingAmount>...</unMatchingAmount>
    <matchingStatus>...</matchingStatus>
    <code>...</code>
    <description>...</description>
    <customerAccount>...</customerAccount>
    <excludedFromDunning>...</excludedFromDunning>
    <orderNumber>...</orderNumber>
    <matchingAmounts/>
    <otherCreditAndCharge/>
    <recordedInvoice/>
    <rejectedPayment/>
    <bankLot>...</bankLot>
    <bankReference>...</bankReference>
    <bankCollectionDate>...</bankCollectionDate>
    <depositDate>...</depositDate>
    <paymentMethod>...</paymentMethod>
    <customFields/>
    <paymentInfo>...</paymentInfo>
    <paymentInfo1>...</paymentInfo1>
    <paymentInfo2>...</paymentInfo2>
    <paymentInfo3>...</paymentInfo3>
    <paymentInfo4>...</paymentInfo4>
    <paymentInfo5>...</paymentInfo5>
    <paymentInfo6>...</paymentInfo6>
    <billingAccountName>...</billingAccountName>
  </recordedInvoiceDto>
  <netToPay>...</netToPay>
  <invoiceMode>...</invoiceMode>
  <customFields>
    <customField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </customField>
    <inheritedCustomField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </inheritedCustomField>
  </customFields>
  <dueBalance>...</dueBalance>
  <isDraft>...</isDraft>
  <checkAlreadySent>...</checkAlreadySent>
  <overrideEmail>...</overrideEmail>
  <sentByEmail>...</sentByEmail>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
</Invoice>