The Class InvoicesDto.
name | data type | description |
---|---|---|
invoices | array of InvoiceDto | The invoices. |
paging | PagingAndFiltering | The paging. |
actionStatus | ActionStatus | The status response of the web service response. |
Example
{ "invoices" : [ { "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" : "DRAFT", "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" : "STRIPE", "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" : "R", "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" : "DETAILLED", "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" : "PPAID", "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" : "DRAFT", "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" : "STRIPE", "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" : "L", "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" : "EXPORTED", "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" : "PENDING", "ratedTransactionsToLink" : [ 12345, 12345 ], "paymentIncidents" : [ "...", "..." ], "sendPaymentDate" : 12345, "initialCollectionDate" : 12345, "writeOffAmount" : 12345.0, "paymentDate" : 12345, "statusDate" : 12345, "xmlDate" : 12345, "pdfDate" : 12345, "emailSentDate" : 12345, "paymentStatus" : "PENDING_PLAN", "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 } ], "paging" : { "fullTextFilter" : "...", "filters" : { "property1" : { }, "property2" : { } }, "fields" : "...", "offset" : 12345, "limit" : 12345, "sortBy" : "...", "sortOrder" : "ASCENDING", "multiSortOrder" : "...", "totalNumberOfRecords" : 12345, "loadReferenceDepth" : 12345 }, "actionStatus" : { "status" : "WARNING", "errorCode" : { }, "message" : "...", "entityId" : 12345, "entityCode" : "...", "nrAffected" : 12345, "json" : "..." } }