Delete Invoice Collection

POST

/api/v0/invoice/delete

invoice-controller

Request

Body Params application/json

invoiceIds

array[string]

optional

List of invoice IDs to be deleted

Example

{
    "invoiceIds": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v0/invoice/delete' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invoiceIds": [
        "string"
    ]
}'

Responses

🟢200OK

application/json

Body

errorResponse

object (ErrorResponse)

optional

apiSubErrors

array[object (ApiSubError)]

optional

errorMessage

string

optional

errorType

enum<string>

optional

Allowed values:

CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR

requestId

string

optional

timestamp

string

optional

Example:

yyyy-MM-dd HH:mm:ss

payload

object (DeleteInvoiceResponse)

optional

failureInvoices

array[object (DeleteInvoice) {2}]

optional

successInvoices

array[object (DeleteInvoice) {2}]

optional

response_code

integer <int32>

optional

response_message

string

optional

Example

{
    "errorResponse": {
        "apiSubErrors": [
            {}
        ],
        "errorMessage": "string",
        "errorType": "CLIENT_REQUEST_ABORT",
        "requestId": "string",
        "timestamp": "yyyy-MM-dd HH:mm:ss"
    },
    "payload": {
        "failureInvoices": [
            {
                "invoiceId": "string",
                "message": "string"
            }
        ],
        "successInvoices": [
            {
                "invoiceId": "string",
                "message": "string"
            }
        ]
    },
    "response_code": 0,
    "response_message": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠422Unprocessable Request

🔴500Server Error

Modified at 2024-10-10 08:34:46

Dispatch Invoice Collection

searchCollectionInvoices