POST api/Payment/SaveOrUpdateInvoice
Used for saving or updating the invoice
Request Information
URI Parameters
None.
Body Parameters
Invoice object which contains the details to update or save the invoice
Invoice| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId |
Contains the InvoiceId, should be set for updating the Invoice |
integer |
None. |
| LstInvoiceMappedProject |
Contains the List of the projects mapped for the Contractor |
Collection of InvoiceMappedProject |
None. |
| Amount |
Contains the amount for the Payment request |
decimal number |
None. |
| ContractorId |
Contains the ContractorId for which Payment request is raised |
integer |
None. |
| ContractorName |
Contains the contractor name for which the invoice initiated for |
string |
None. |
| InitiatedOn |
Contains the Date and Time when the invoice initiated on |
date |
None. |
| InvoiceDueDate |
Contains the invoice due date |
date |
None. |
| InitiatedBy |
Contains the UserId, who initiated the invoice |
integer |
None. |
| InitiatedByUserName |
Contains the user name who initiated the invoice |
string |
None. |
| LastModifiedByUserName |
Contains the user name who last modified the invoice |
string |
None. |
| LastModifiedBy |
Contains the UserId, who last modified the invoice |
integer |
None. |
| LastModifiedOn |
Contains the Date and Time when the invoice last modified on |
date |
None. |
| ProcessorComments |
Contains the comments which we need to send to processor |
string |
None. |
| ContractorComments |
Contains the comments which we need to send to contractor after processing the invoice |
string |
None. |
| Status |
Contains the status of invoice |
string |
None. |
| SendEmailtoProcessor |
Flag which indicates to send email or not |
boolean |
None. |
| ObjInvoicePaymentDetail |
Contains the payment details of the invoice |
InvoicePaymentDetail |
None. |
Request Formats
application/json, text/json
{
"invoiceId": 1,
"lstInvoiceMappedProject": [
{
"invoiceMappedProjectId": 1,
"invoiceId": 2,
"projectId": 3,
"isSelected": true,
"projectName": "sample string 5",
"projectCode": "sample string 6",
"projectAmount": 7.0,
"miscellaneousAmount": 8.0,
"lstInvoiceMappedTask": [
{
"invoiceMappedTaskId": 1,
"invoiceMappedProjectId": 2,
"taskId": 3,
"projectId": 4,
"isSelected": true,
"comments": "sample string 6",
"taskRate": 7.0,
"taskAmount": 8.0,
"quantity": 9,
"taskName": "sample string 10",
"taskUnits": "sample string 11"
},
{
"invoiceMappedTaskId": 1,
"invoiceMappedProjectId": 2,
"taskId": 3,
"projectId": 4,
"isSelected": true,
"comments": "sample string 6",
"taskRate": 7.0,
"taskAmount": 8.0,
"quantity": 9,
"taskName": "sample string 10",
"taskUnits": "sample string 11"
}
]
},
{
"invoiceMappedProjectId": 1,
"invoiceId": 2,
"projectId": 3,
"isSelected": true,
"projectName": "sample string 5",
"projectCode": "sample string 6",
"projectAmount": 7.0,
"miscellaneousAmount": 8.0,
"lstInvoiceMappedTask": [
{
"invoiceMappedTaskId": 1,
"invoiceMappedProjectId": 2,
"taskId": 3,
"projectId": 4,
"isSelected": true,
"comments": "sample string 6",
"taskRate": 7.0,
"taskAmount": 8.0,
"quantity": 9,
"taskName": "sample string 10",
"taskUnits": "sample string 11"
},
{
"invoiceMappedTaskId": 1,
"invoiceMappedProjectId": 2,
"taskId": 3,
"projectId": 4,
"isSelected": true,
"comments": "sample string 6",
"taskRate": 7.0,
"taskAmount": 8.0,
"quantity": 9,
"taskName": "sample string 10",
"taskUnits": "sample string 11"
}
]
}
],
"amount": 2.0,
"contractorId": 3,
"contractorName": "sample string 4",
"initiatedOn": "2025-12-17T22:39:44.4765975-05:00",
"invoiceDueDate": "2025-12-17T22:39:44.4765975-05:00",
"initiatedBy": 7,
"initiatedByUserName": "sample string 8",
"lastModifiedByUserName": "sample string 9",
"lastModifiedBy": 1,
"lastModifiedOn": "2025-12-17T22:39:44.4765975-05:00",
"processorComments": "sample string 10",
"contractorComments": "sample string 11",
"status": "sample string 12",
"sendEmailtoProcessor": true,
"objInvoicePaymentDetail": {
"invoicePaymentDetailId": 1,
"invoiceId": 2,
"fundingSourceId": 1,
"edumindFundingSourceId": 1,
"amount": 3.0,
"status": "sample string 4",
"proceessedOn": "2025-12-17T22:39:44.4765975-05:00",
"dwollaTransactionId": "sample string 5"
}
}
text/html
{"invoiceId":1,"lstInvoiceMappedProject":[{"invoiceMappedProjectId":1,"invoiceId":2,"projectId":3,"isSelected":true,"projectName":"sample string 5","projectCode":"sample string 6","projectAmount":7.0,"miscellaneousAmount":8.0,"lstInvoiceMappedTask":[{"invoiceMappedTaskId":1,"invoiceMappedProjectId":2,"taskId":3,"projectId":4,"isSelected":true,"comments":"sample string 6","taskRate":7.0,"taskAmount":8.0,"quantity":9,"taskName":"sample string 10","taskUnits":"sample string 11"},{"invoiceMappedTaskId":1,"invoiceMappedProjectId":2,"taskId":3,"projectId":4,"isSelected":true,"comments":"sample string 6","taskRate":7.0,"taskAmount":8.0,"quantity":9,"taskName":"sample string 10","taskUnits":"sample string 11"}]},{"invoiceMappedProjectId":1,"invoiceId":2,"projectId":3,"isSelected":true,"projectName":"sample string 5","projectCode":"sample string 6","projectAmount":7.0,"miscellaneousAmount":8.0,"lstInvoiceMappedTask":[{"invoiceMappedTaskId":1,"invoiceMappedProjectId":2,"taskId":3,"projectId":4,"isSelected":true,"comments":"sample string 6","taskRate":7.0,"taskAmount":8.0,"quantity":9,"taskName":"sample string 10","taskUnits":"sample string 11"},{"invoiceMappedTaskId":1,"invoiceMappedProjectId":2,"taskId":3,"projectId":4,"isSelected":true,"comments":"sample string 6","taskRate":7.0,"taskAmount":8.0,"quantity":9,"taskName":"sample string 10","taskUnits":"sample string 11"}]}],"amount":2.0,"contractorId":3,"contractorName":"sample string 4","initiatedOn":"2025-12-17T22:39:44.4765975-05:00","invoiceDueDate":"2025-12-17T22:39:44.4765975-05:00","initiatedBy":7,"initiatedByUserName":"sample string 8","lastModifiedByUserName":"sample string 9","lastModifiedBy":1,"lastModifiedOn":"2025-12-17T22:39:44.4765975-05:00","processorComments":"sample string 10","contractorComments":"sample string 11","status":"sample string 12","sendEmailtoProcessor":true,"objInvoicePaymentDetail":{"invoicePaymentDetailId":1,"invoiceId":2,"fundingSourceId":1,"edumindFundingSourceId":1,"amount":3.0,"status":"sample string 4","proceessedOn":"2025-12-17T22:39:44.4765975-05:00","dwollaTransactionId":"sample string 5"}}
application/xml, text/xml
<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CapApi.Models">
<Amount>2</Amount>
<ContractorComments>sample string 11</ContractorComments>
<ContractorId>3</ContractorId>
<ContractorName>sample string 4</ContractorName>
<InitiatedBy>7</InitiatedBy>
<InitiatedByUserName>sample string 8</InitiatedByUserName>
<InitiatedOn>2025-12-17T22:39:44.4765975-05:00</InitiatedOn>
<InvoiceDueDate>2025-12-17T22:39:44.4765975-05:00</InvoiceDueDate>
<InvoiceId>1</InvoiceId>
<LastModifiedBy>1</LastModifiedBy>
<LastModifiedByUserName>sample string 9</LastModifiedByUserName>
<LastModifiedOn>2025-12-17T22:39:44.4765975-05:00</LastModifiedOn>
<LstInvoiceMappedProject>
<InvoiceMappedProject>
<InvoiceId>2</InvoiceId>
<InvoiceMappedProjectId>1</InvoiceMappedProjectId>
<IsSelected>true</IsSelected>
<LstInvoiceMappedTask>
<InvoiceMappedTask>
<Comments>sample string 6</Comments>
<InvoiceMappedProjectId>2</InvoiceMappedProjectId>
<InvoiceMappedTaskId>1</InvoiceMappedTaskId>
<IsSelected>true</IsSelected>
<ProjectId>4</ProjectId>
<Quantity>9</Quantity>
<TaskAmount>8</TaskAmount>
<TaskId>3</TaskId>
<TaskName>sample string 10</TaskName>
<TaskRate>7</TaskRate>
<TaskUnits>sample string 11</TaskUnits>
</InvoiceMappedTask>
<InvoiceMappedTask>
<Comments>sample string 6</Comments>
<InvoiceMappedProjectId>2</InvoiceMappedProjectId>
<InvoiceMappedTaskId>1</InvoiceMappedTaskId>
<IsSelected>true</IsSelected>
<ProjectId>4</ProjectId>
<Quantity>9</Quantity>
<TaskAmount>8</TaskAmount>
<TaskId>3</TaskId>
<TaskName>sample string 10</TaskName>
<TaskRate>7</TaskRate>
<TaskUnits>sample string 11</TaskUnits>
</InvoiceMappedTask>
</LstInvoiceMappedTask>
<MiscellaneousAmount>8</MiscellaneousAmount>
<ProjectAmount>7</ProjectAmount>
<ProjectCode>sample string 6</ProjectCode>
<ProjectId>3</ProjectId>
<ProjectName>sample string 5</ProjectName>
</InvoiceMappedProject>
<InvoiceMappedProject>
<InvoiceId>2</InvoiceId>
<InvoiceMappedProjectId>1</InvoiceMappedProjectId>
<IsSelected>true</IsSelected>
<LstInvoiceMappedTask>
<InvoiceMappedTask>
<Comments>sample string 6</Comments>
<InvoiceMappedProjectId>2</InvoiceMappedProjectId>
<InvoiceMappedTaskId>1</InvoiceMappedTaskId>
<IsSelected>true</IsSelected>
<ProjectId>4</ProjectId>
<Quantity>9</Quantity>
<TaskAmount>8</TaskAmount>
<TaskId>3</TaskId>
<TaskName>sample string 10</TaskName>
<TaskRate>7</TaskRate>
<TaskUnits>sample string 11</TaskUnits>
</InvoiceMappedTask>
<InvoiceMappedTask>
<Comments>sample string 6</Comments>
<InvoiceMappedProjectId>2</InvoiceMappedProjectId>
<InvoiceMappedTaskId>1</InvoiceMappedTaskId>
<IsSelected>true</IsSelected>
<ProjectId>4</ProjectId>
<Quantity>9</Quantity>
<TaskAmount>8</TaskAmount>
<TaskId>3</TaskId>
<TaskName>sample string 10</TaskName>
<TaskRate>7</TaskRate>
<TaskUnits>sample string 11</TaskUnits>
</InvoiceMappedTask>
</LstInvoiceMappedTask>
<MiscellaneousAmount>8</MiscellaneousAmount>
<ProjectAmount>7</ProjectAmount>
<ProjectCode>sample string 6</ProjectCode>
<ProjectId>3</ProjectId>
<ProjectName>sample string 5</ProjectName>
</InvoiceMappedProject>
</LstInvoiceMappedProject>
<ObjInvoicePaymentDetail>
<Amount>3</Amount>
<DwollaTransactionId>sample string 5</DwollaTransactionId>
<EdumindFundingSourceId>1</EdumindFundingSourceId>
<FundingSourceId>1</FundingSourceId>
<InvoiceId>2</InvoiceId>
<InvoicePaymentDetailId>1</InvoicePaymentDetailId>
<ProceessedOn>2025-12-17T22:39:44.4765975-05:00</ProceessedOn>
<Status>sample string 4</Status>
</ObjInvoicePaymentDetail>
<ProcessorComments>sample string 10</ProcessorComments>
<SendEmailtoProcessor>true</SendEmailtoProcessor>
<Status>sample string 12</Status>
</Invoice>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |