/invoice/sendByEmail Resource

Web service for managing org.meveo.model.billing.Invoice.

POST /invoice/sendByEmail

Send invoice by Email.

Request Body
media type data type description
application/json InvoiceDto (JSON) the invoice DTO
application/xml invoiceDto (XML)
Response Body
media type data type description
application/json ActionStatus (JSON) "SUCCESS" if sent, "FAIL" else
application/xml actionStatus (XML)

Example

Request
POST /invoice/sendByEmail
Content-Type: application/json
Accept: application/json

                
{
  "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" : "CHECK",
  "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" : "R",
    "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" : "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" : "..."
    },
    "recordedInvoice" : { },
    "rejectedPayment" : {
      "rejectedType" : "M",
      "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" : "C",
      "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" : "AGGREGATED",
  "customFields" : {
    "customField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "DOUBLE",
      "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" : "MULTI_VALUE",
      "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",
      "fileValue" : "...",
      "formattedValue" : { },
      "guiPosition" : "..."
    } ],
    "inheritedCustomField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "BOOLEAN",
      "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" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "guiPosition" : "..."
    }, {
      "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",
      "fileValue" : "...",
      "formattedValue" : { },
      "guiPosition" : "..."
    } ]
  },
  "dueBalance" : 12345.0,
  "isDraft" : true,
  "checkAlreadySent" : true,
  "overrideEmail" : "...",
  "sentByEmail" : true
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "status" : "FAIL",
  "errorCode" : "ACTION_FORBIDDEN",
  "message" : "...",
  "entityId" : 12345,
  "entityCode" : "..."
}