Invoice generate request DTO
| name | data type | description |
|---|---|---|
| temporaryInvoiceNumber | string | The temporary invoice number. |
| invoiceTypeCode | string | The invoice type code. |
| amount | number | The amount. |
| accountOperationId | number | The account operation id. |
| auditable | AuditableDto | |
| auditableField | array of AuditableFieldDto | |
| invoiceId | number | The invoice id. |
| invoiceType | string | The invoice type. |
| billingAccountCode | string | The billing account code. |
| sellerCode | string | Code of the Seller |
| subscriptionCode | string | Code of the subscription |
| orderNumber | string | Order number |
| dueDate | number | The due date. |
| invoiceDate | number | The invoice date. |
| categoryInvoiceAgregate | array of CategoryInvoiceAgregateDto | The category invoice aggregates. |
| taxAggregate | array of TaxInvoiceAggregateDto | The tax aggregates |
| invoiceIdToLink | array of number | The list invoice id to link. |
| invoiceNumber | string | The invoice number. |
| discount | number | The discount. |
| amountWithoutTax | number | The amount without tax. |
| amountTax | number | The amount tax. |
| amountWithTax | number | The amount with tax. |
| paymentMethod | PaymentMethodEnum | The payment method. |
| xmlFilename | string | The xml filename. |
| xml | string | The xml. |
| pdfFilename | string | The pdf filename. |
| string | The pdf. | |
| autoValidation | boolean | A request-only parameter. True if invoice should be assigned a number. Defaults to True. |
| returnXml | boolean | A request-only parameter. True if currently XML invoice should be returned. |
| returnPdf | boolean | A request-only parameter. True if currently PDF invoice should be returned. |
| includeBalance | boolean | A request-only parameter. True if currently due balance should be returned |
| recordedInvoiceDto | RecordedInvoiceDto | The recorded invoice dto. |
| netToPay | number | The net to pay. |
| invoiceMode | InvoiceModeEnum | The invoice mode. |
| customFields | CustomFieldsDto | The custom fields. |
| dueBalance | number | 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). |
| isDraft | boolean | A flag to generate a draft invoice |
| checkAlreadySent | boolean | Before sending the invoice, check if not already sent |
| overrideEmail | string | Override Email defined in the billing entity |
| sentByEmail | boolean | True if the invoice is sent, false otherwise |
Example
{
"temporaryInvoiceNumber" : "...",
"invoiceTypeCode" : "...",
"amount" : 12345.0,
"accountOperationId" : 12345,
"auditable" : {
"created" : 12345,
"updated" : 12345,
"creator" : "...",
"updater" : "..."
},
"auditableField" : [ {
"entityClass" : "...",
"id" : 12345,
"fieldName" : "...",
"code" : "...",
"changeOrigin" : "...",
"auditable" : {
"created" : 12345,
"updated" : 12345,
"creator" : "...",
"updater" : "..."
},
"auditableField" : [ { }, { } ],
"description" : "...",
"originName" : "...",
"updatedCode" : "...",
"previousState" : "...",
"currentState" : "...",
"created" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"id" : 12345,
"fieldName" : "...",
"code" : "...",
"changeOrigin" : "...",
"auditable" : {
"created" : 12345,
"updated" : 12345,
"creator" : "...",
"updater" : "..."
},
"auditableField" : [ { }, { } ],
"description" : "...",
"originName" : "...",
"updatedCode" : "...",
"previousState" : "...",
"currentState" : "...",
"created" : "...",
"actor" : "..."
} ],
"invoiceId" : 12345,
"invoiceType" : "...",
"billingAccountCode" : "...",
"sellerCode" : "...",
"subscriptionCode" : "...",
"orderNumber" : "...",
"dueDate" : 12345,
"invoiceDate" : 12345,
"categoryInvoiceAgregate" : [ {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ {
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
}, {
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
} ],
"discountAggregate" : [ {
"discountPlanItemCode" : "...",
"discountPercent" : 12345.0,
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
}, {
"discountPlanItemCode" : "...",
"discountPercent" : 12345.0,
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
} ]
}, {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ {
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
}, {
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
} ],
"discountAggregate" : [ {
"discountPlanItemCode" : "...",
"discountPercent" : 12345.0,
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
}, {
"discountPlanItemCode" : "...",
"discountPercent" : 12345.0,
"itemNumber" : 12345,
"accountingCode" : "...",
"description" : "...",
"taxCode" : "...",
"taxPercent" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"invoiceSubCategoryCode" : "...",
"userAccountCode" : "...",
"ratedTransaction" : [ { }, { } ]
} ]
} ],
"taxAggregate" : [ {
"description" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"taxCode" : "...",
"taxPercent" : 12345.0,
"accountingCode" : "..."
}, {
"description" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"taxCode" : "...",
"taxPercent" : 12345.0,
"accountingCode" : "..."
} ],
"invoiceIdToLink" : [ 12345, 12345 ],
"invoiceNumber" : "...",
"discount" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"paymentMethod" : "CARD",
"xmlFilename" : "...",
"xml" : "...",
"pdfFilename" : "...",
"pdf" : "...",
"autoValidation" : true,
"returnXml" : true,
"returnPdf" : true,
"includeBalance" : true,
"recordedInvoiceDto" : {
"productionDate" : 12345,
"invoiceDate" : 12345,
"netToPay" : 12345.0,
"auditable" : {
"created" : 12345,
"updated" : 12345,
"creator" : "...",
"updater" : "..."
},
"auditableField" : [ {
"entityClass" : "...",
"id" : 12345,
"fieldName" : "...",
"code" : "...",
"changeOrigin" : "...",
"auditable" : { },
"auditableField" : [ { }, { } ],
"description" : "...",
"originName" : "...",
"updatedCode" : "...",
"previousState" : "...",
"currentState" : "...",
"created" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"id" : 12345,
"fieldName" : "...",
"code" : "...",
"changeOrigin" : "...",
"auditable" : { },
"auditableField" : [ { }, { } ],
"description" : "...",
"originName" : "...",
"updatedCode" : "...",
"previousState" : "...",
"currentState" : "...",
"created" : "...",
"actor" : "..."
} ],
"id" : 12345,
"dueDate" : 12345,
"type" : "...",
"transactionDate" : 12345,
"transactionCategory" : "DEBIT",
"reference" : "...",
"accountingCode" : "...",
"amount" : 12345.0,
"amountWithoutTax" : 12345.0,
"taxAmount" : 12345.0,
"matchingAmount" : 12345.0,
"unMatchingAmount" : 12345.0,
"matchingStatus" : "L",
"code" : "...",
"description" : "...",
"customerAccount" : "...",
"excludedFromDunning" : true,
"orderNumber" : "...",
"matchingAmounts" : {
"matchingAmount" : [ { }, { } ]
},
"otherCreditAndCharge" : {
"operationDate" : 12345,
"auditable" : { },
"auditableField" : [ { }, { } ],
"id" : 12345,
"dueDate" : 12345,
"type" : "...",
"transactionDate" : 12345,
"transactionCategory" : "CREDIT",
"reference" : "...",
"accountingCode" : "...",
"amount" : 12345.0,
"amountWithoutTax" : 12345.0,
"taxAmount" : 12345.0,
"matchingAmount" : 12345.0,
"unMatchingAmount" : 12345.0,
"matchingStatus" : "O",
"code" : "...",
"description" : "...",
"customerAccount" : "...",
"excludedFromDunning" : true,
"orderNumber" : "...",
"matchingAmounts" : { },
"otherCreditAndCharge" : { },
"recordedInvoice" : { },
"rejectedPayment" : { },
"bankLot" : "...",
"bankReference" : "...",
"bankCollectionDate" : 12345,
"depositDate" : 12345,
"paymentMethod" : "...",
"customFields" : { },
"paymentInfo" : "...",
"paymentInfo1" : "...",
"paymentInfo2" : "...",
"paymentInfo3" : "...",
"paymentInfo4" : "...",
"paymentInfo5" : "...",
"paymentInfo6" : "...",
"billingAccountName" : "..."
},
"recordedInvoice" : { },
"rejectedPayment" : {
"rejectedType" : "A",
"rejectedDate" : 12345,
"rejectedDescription" : "...",
"auditable" : { },
"rejectedCode" : "...",
"auditableField" : [ { }, { } ],
"id" : 12345,
"dueDate" : 12345,
"type" : "...",
"transactionDate" : 12345,
"transactionCategory" : "CREDIT",
"reference" : "...",
"accountingCode" : "...",
"amount" : 12345.0,
"amountWithoutTax" : 12345.0,
"taxAmount" : 12345.0,
"matchingAmount" : 12345.0,
"unMatchingAmount" : 12345.0,
"matchingStatus" : "O",
"code" : "...",
"description" : "...",
"customerAccount" : "...",
"excludedFromDunning" : true,
"orderNumber" : "...",
"matchingAmounts" : { },
"otherCreditAndCharge" : { },
"recordedInvoice" : { },
"rejectedPayment" : { },
"bankLot" : "...",
"bankReference" : "...",
"bankCollectionDate" : 12345,
"depositDate" : 12345,
"paymentMethod" : "...",
"customFields" : { },
"paymentInfo" : "...",
"paymentInfo1" : "...",
"paymentInfo2" : "...",
"paymentInfo3" : "...",
"paymentInfo4" : "...",
"paymentInfo5" : "...",
"paymentInfo6" : "...",
"billingAccountName" : "..."
},
"bankLot" : "...",
"bankReference" : "...",
"bankCollectionDate" : 12345,
"depositDate" : 12345,
"paymentMethod" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"paymentInfo" : "...",
"paymentInfo1" : "...",
"paymentInfo2" : "...",
"paymentInfo3" : "...",
"paymentInfo4" : "...",
"paymentInfo5" : "...",
"paymentInfo6" : "...",
"billingAccountName" : "..."
},
"netToPay" : 12345.0,
"invoiceMode" : "DETAILLED",
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "TEXT_AREA",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"guiPosition" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "LONG",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"guiPosition" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "DATE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"guiPosition" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "LIST",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"guiPosition" : "..."
} ]
},
"dueBalance" : 12345.0,
"isDraft" : true,
"checkAlreadySent" : true,
"overrideEmail" : "...",
"sentByEmail" : true
}