POST api/Invoice/MarkAsPaid

Request Information

URI Parameters

None.

Body Parameters

InvoiceNotificationModel
NameDescriptionTypeAdditional information
InvoiceNumber

string

None.

Amount

decimal number

None.

AmountPaid

decimal number

None.

RemitaRetrievalReference

string

None.

InvoiceDate

date

None.

PaymentDate

date

None.

Status

string

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceNumber": "sample string 1",
  "Amount": 2.0,
  "AmountPaid": 3.0,
  "RemitaRetrievalReference": "sample string 4",
  "InvoiceDate": "2025-08-29T02:17:26.5925656+00:00",
  "PaymentDate": "2025-08-29T02:17:26.5925656+00:00",
  "Status": "sample string 7"
}

application/xml, text/xml

Sample:
<InvoiceNotificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cargo.Data.Model">
  <Amount>2</Amount>
  <AmountPaid>3</AmountPaid>
  <InvoiceDate>2025-08-29T02:17:26.5925656+00:00</InvoiceDate>
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <PaymentDate>2025-08-29T02:17:26.5925656+00:00</PaymentDate>
  <RemitaRetrievalReference>sample string 4</RemitaRetrievalReference>
  <Status>sample string 7</Status>
</InvoiceNotificationModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceNotificationModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.