Stop Invoice

PUT /api/v1/Invoice/stop

Description

This endpoint is used to stop a previously created invoice, based on the unique identifier provided in the request body. The invoice status will be updated to 'Stopped', and no further actions can be performed on it. It returns a StopInvoiceResponseResponse object containing details of the stopped invoice.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• None

Request Body:

• An object of type StopInvoiceRequest

URL:

• PUT: {{baseUrl API url}}/api/v1/Invoice/stop

Response:

• A StopInvoiceResponseResponse object containing the details of the stopped invoice.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request Body:

{
  "InvoiceId": "1234567890"
}

Example:

Request:

PUT /api/v1/Invoice/stop
{
  "InvoiceId": "1234567890"
}

Method: PUT

/api/v1/Invoice/stop

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "invoiceId": "<uuid>"
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "invoiceId": "<uuid>"
  }
}