DTO equivalent of DunningDocument entity.
| name | data type | description |
|---|---|---|
| auditableField | array of AuditableFieldDto | |
| dunningDocumentId | string | DunningDocument Id |
| customerAccountCode | string | Customer account Code |
| subscriptionCode | string | Subscription Code |
| payment | array of PaymentDto | List of payments. |
| dueInvoice | array of InvoiceDto | The tax aggregates |
Example
{
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"dunningDocumentId" : "...",
"customerAccountCode" : "...",
"subscriptionCode" : "...",
"payment" : [ {
"type" : "...",
"description" : "...",
"paymentMethod" : "CASH",
"occTemplateCode" : "...",
"amount" : 12345.0,
"customerAccountCode" : "...",
"reference" : "...",
"bankLot" : "...",
"depositDate" : 12345,
"bankCollectionDate" : 12345,
"collectionDate" : 12345,
"dueDate" : 12345,
"transactionDate" : 12345,
"listAoIdsForMatching" : [ 12345, 12345 ],
"isToMatching" : true,
"paymentOrder" : "...",
"fees" : 12345.0,
"comment" : "...",
"paymentInfo" : "...",
"paymentInfo1" : "...",
"paymentInfo2" : "...",
"paymentInfo3" : "...",
"paymentInfo4" : "...",
"paymentInfo5" : "...",
"paymentInfo6" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"type" : "...",
"description" : "...",
"paymentMethod" : "STRIPE",
"occTemplateCode" : "...",
"amount" : 12345.0,
"customerAccountCode" : "...",
"reference" : "...",
"bankLot" : "...",
"depositDate" : 12345,
"bankCollectionDate" : 12345,
"collectionDate" : 12345,
"dueDate" : 12345,
"transactionDate" : 12345,
"listAoIdsForMatching" : [ 12345, 12345 ],
"isToMatching" : true,
"paymentOrder" : "...",
"fees" : 12345.0,
"comment" : "...",
"paymentInfo" : "...",
"paymentInfo1" : "...",
"paymentInfo2" : "...",
"paymentInfo3" : "...",
"paymentInfo4" : "...",
"paymentInfo5" : "...",
"paymentInfo6" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ],
"dueInvoice" : [ {
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"invoiceId" : 12345,
"invoiceType" : "...",
"billingAccountCode" : "...",
"sellerCode" : "...",
"subscriptionCode" : "...",
"subscriptionId" : 12345,
"orderNumber" : "...",
"status" : "NEW",
"dueDate" : 12345,
"invoiceDate" : 12345,
"categoryInvoiceAgregate" : [ {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ { }, { } ],
"discountAggregate" : [ { }, { } ]
}, {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ { }, { } ],
"discountAggregate" : [ { }, { } ]
} ],
"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" : "WIRETRANSFER",
"xmlFilename" : "...",
"xml" : "...",
"pdfFilename" : "...",
"pdf" : "...",
"autoValidation" : true,
"returnXml" : true,
"returnPdf" : true,
"sendByEmail" : true,
"includeBalance" : true,
"recordedInvoiceDto" : {
"productionDate" : 12345,
"invoiceDate" : 12345,
"auditableField" : [ { }, { } ],
"netToPay" : 12345.0,
"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" : "I",
"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" : "...",
"paymentHistory" : [ { }, { } ],
"collectionDate" : 12345,
"journalCode" : "...",
"status" : "REJECTED",
"reason" : "FORCED",
"accountingExportFile" : "...",
"accountingDate" : 12345
},
"netToPay" : 12345.0,
"invoiceMode" : "AGGREGATED",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"dueBalance" : 12345.0,
"isDraft" : true,
"checkAlreadySent" : true,
"overrideEmail" : "...",
"sentByEmail" : true,
"paymentScheduleInstancesDto" : {
"paging" : { },
"actionStatus" : { },
"instance" : [ { }, { } ]
},
"dunningEntryDate" : 12345,
"dunningLastModification" : 12345,
"dunningStatus" : "...",
"realTimeStatus" : "ABANDONED",
"ratedTransactionsToLink" : [ 12345, 12345 ],
"paymentIncidents" : [ "...", "..." ],
"sendPaymentDate" : 12345,
"initialCollectionDate" : 12345,
"writeOffAmount" : 12345.0,
"paymentDate" : 12345,
"statusDate" : 12345,
"xmlDate" : 12345,
"pdfDate" : 12345,
"emailSentDate" : 12345,
"paymentStatus" : "PENDING",
"paymentStatusDate" : 12345,
"startDate" : 12345,
"endDate" : 12345,
"rawAmount" : 12345.0,
"discountRate" : 12345.0,
"discountAmount" : 12345.0,
"isAlreadyAppliedMinimum" : true,
"isAlreadyAddedDiscount" : true,
"discountPlanCode" : "...",
"lastAppliedRate" : 12345.0,
"lastAppliedRateDate" : 12345
}, {
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"invoiceId" : 12345,
"invoiceType" : "...",
"billingAccountCode" : "...",
"sellerCode" : "...",
"subscriptionCode" : "...",
"subscriptionId" : 12345,
"orderNumber" : "...",
"status" : "VALIDATED",
"dueDate" : 12345,
"invoiceDate" : 12345,
"categoryInvoiceAgregate" : [ {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ { }, { } ],
"discountAggregate" : [ { }, { } ]
}, {
"categoryInvoiceCode" : "...",
"description" : "...",
"userAccountCode" : "...",
"itemNumber" : 12345,
"amountWithoutTax" : 12345.0,
"amountTax" : 12345.0,
"amountWithTax" : 12345.0,
"subCategoryInvoiceAgregateDto" : [ { }, { } ],
"discountAggregate" : [ { }, { } ]
} ],
"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" : "PAYPAL",
"xmlFilename" : "...",
"xml" : "...",
"pdfFilename" : "...",
"pdf" : "...",
"autoValidation" : true,
"returnXml" : true,
"returnPdf" : true,
"sendByEmail" : true,
"includeBalance" : true,
"recordedInvoiceDto" : {
"productionDate" : 12345,
"invoiceDate" : 12345,
"auditableField" : [ { }, { } ],
"netToPay" : 12345.0,
"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" : "...",
"paymentHistory" : [ { }, { } ],
"collectionDate" : 12345,
"journalCode" : "...",
"status" : "REJECTED",
"reason" : "CLOSED_PERIOD",
"accountingExportFile" : "...",
"accountingDate" : 12345
},
"netToPay" : 12345.0,
"invoiceMode" : "AGGREGATED",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"dueBalance" : 12345.0,
"isDraft" : true,
"checkAlreadySent" : true,
"overrideEmail" : "...",
"sentByEmail" : true,
"paymentScheduleInstancesDto" : {
"paging" : { },
"actionStatus" : { },
"instance" : [ { }, { } ]
},
"dunningEntryDate" : 12345,
"dunningLastModification" : 12345,
"dunningStatus" : "...",
"realTimeStatus" : "PAID",
"ratedTransactionsToLink" : [ 12345, 12345 ],
"paymentIncidents" : [ "...", "..." ],
"sendPaymentDate" : 12345,
"initialCollectionDate" : 12345,
"writeOffAmount" : 12345.0,
"paymentDate" : 12345,
"statusDate" : 12345,
"xmlDate" : 12345,
"pdfDate" : 12345,
"emailSentDate" : 12345,
"paymentStatus" : "NONE",
"paymentStatusDate" : 12345,
"startDate" : 12345,
"endDate" : 12345,
"rawAmount" : 12345.0,
"discountRate" : 12345.0,
"discountAmount" : 12345.0,
"isAlreadyAppliedMinimum" : true,
"isAlreadyAddedDiscount" : true,
"discountPlanCode" : "...",
"lastAppliedRate" : 12345.0,
"lastAppliedRateDate" : 12345
} ]
}