generateInvoiceResultDto Data Type

Invoice generate request DTO

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
accountOperationId long element 0/1 The account operation id.
amount decimal element 0/1 The amount.
invoiceTypeCode string element 0/1 The invoice type code.
temporaryInvoiceNumber string element 0/1 The temporary invoice number.
Properties inherited from invoiceDto
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 The billing account code.
categoryInvoiceAgregate categoryInvoiceAgregateDto element 1/unbounded 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 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 The invoice date.
invoiceId long element 0/1 The invoice id.
invoiceIdToLink long element 0/unbounded The list invoice id to link.
invoiceMode invoiceModeEnum element 1/1 The invoice mode.
invoiceNumber string element 0/1 The invoice number.
invoiceType string element 1/1 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 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  

Example

<GenerateInvoiceResult>
  <temporaryInvoiceNumber>...</temporaryInvoiceNumber>
  <invoiceTypeCode>...</invoiceTypeCode>
  <amount>...</amount>
  <accountOperationId>...</accountOperationId>
  <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>
</GenerateInvoiceResult>