Enkash Developer Portal
Home
Home
Login
  1. invoice-controller
  • Back to home
  • Account Receivable APIs
  • Get Authentication Token Copy
    • Get Authentication Token
  • Customer Management
    • Customer Apis
      • Activate customer
      • createBulkCustomer
      • bulkUpdate
      • Deactivate customer
      • deleteCustomerByCustomerId
      • updateCustomer
  • Customer Contacts Management
    • Customer Apis
      • getCustomerContactDetails
  • Invoice Management
    • invoice-controller
      • createInvoice
        POST
      • invoiceBulkUpload
        POST
      • Dispatch Invoice Collection
        POST
      • Delete Invoice Collection
        POST
      • searchCollectionInvoices
        POST
      • getInvoice
        GET
      • updateInvoice
        PATCH
  • Payment Reminders
    • customer-reminder-controller
      • createCustomerReminder
      • getCustomerReminders
      • getCustomerReminder
      • deleteReminder
      • updateCustomerReminder
  • Bharat Connect 2.0 AR
    • Payment Confirmation Request
    • Change Invoice Status Request
    • Bulk Create Invoice
  1. invoice-controller

Dispatch Invoice Collection

POST
/api/v0/invoice/bulk/dispatch
invoice-controller

Request

Body Params application/json
invoiceIds
array[string]
optional
List of invoice IDs to be dispatched
partialPaymentAllowed
boolean 
optional
Indicates if partial payments are allowed for the dispatched invoices
Example
{
    "invoiceIds": [
        "string"
    ],
    "partialPaymentAllowed": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/invoice/bulk/dispatch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invoiceIds": [
        "string"
    ],
    "partialPaymentAllowed": true
}'

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 (ErrorResponse) 
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": {
        "apiSubErrors": [
            {}
        ],
        "errorMessage": "string",
        "errorType": "CLIENT_REQUEST_ABORT",
        "requestId": "string",
        "timestamp": "yyyy-MM-dd HH:mm:ss"
    },
    "response_code": 0,
    "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2025-07-07 18:44:45
Previous
invoiceBulkUpload
Next
Delete Invoice Collection
Built with