PUT POS/v3.1/Sales/Invoices/MarkAsPaid Try Now

Marks invoices as paid.

Request Information

URI Parameters

None.

Body Parameters

The request.

Collection of MarkInvoicesAsPaidRequest
NameDescriptionTypeAdditional information
InvoiceId
Gets the invoice identifier.
 string
Required
PaymentModeId
Gets the payment mode identifier.
 string
Required
ReferenceNumber
Gets the reference number.
 string
Conditional - Mandatory when Payment mode is PayPal
Note
Gets the note.
 string
Max length: 255
Optional
PaymentDate
Gets the payment date.
 date
Optional - PaymentDate should not be older than created date of invoice and should not be future date. If not given then current date will considered as PaymentDate

Request Formats

application/json, text/json

Sample: 
[
  {
    "InvoiceId": "",
    "PaymentModeId": "",
    "ReferenceNumber": "",
    "Note": "",
    "PaymentDate": "2024-11-27T13:30"
  }
]

Response Information

Resource Description

MarkInvoicesAsPaidResponse
NameDescriptionTypeAdditional information
Successful
The successful Invoice Ids.
 Collection of string
None.
Status
BulkActionStatus
None.
Errors
Collection of String
None.

Response Formats

application/json, text/json

Sample: 
{
  "Successful": [
    ""
  ],
  "Status": "Success",
  "Errors": [
    {
      "ErrorMessage": "",
      "Item": ""
    }
  ]
}