Skip to main content

Send Your First Invoice

Send a test invoice to verify your integration is working correctly.

Before You Begin​

Ensure you have completed:

API Integration​

Create Invoice:

curl -X POST https://qa.sender.api.barid.ae/api/v1/invoices \
  -H "X-Session: YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "endUserBaridId": "",
    "endUserUaePassId": "",
    "endUserEmiratesId": "",
    "generatedAtUtc": "",
    "amount": 1,
    "currency": "Aed",
    "dueDateUtc": "2025-11-14T11:31:37.222Z",
    "payable": true,
    "reference": "",
    "parts": [{
      "mimeType": "",
      "fileName": "",
      "base64Data": ""
    }]
  }'

Note: The payable property determines whether users can pay the invoice through Barid. Set to true to enable payment functionality.

For detailed request and response schemas, see the API Reference.

Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "endUserUaePassId": null,
  "senderId": "123e4567-e89b-12d3-a456-426614174000",
  "generatedAtUtc": "2025-11-14T11:31:37.222Z",
  "sentUtc": "2025-11-14T11:31:37.222Z",
  "amount": 1,
  "currency": "Aed",
  "dueDateUtc": "2025-11-14T11:31:37.222Z",
  "payable": true,
  "reference": "string"
}

Verify Invoice Creation​

Via API:

curl -X GET https://qa.sender.api.barid.ae/api/v1/invoices/INVOICE_ID \
  -H "X-Session: YOUR_SESSION_TOKEN"

Via Sender Client:

  1. Navigate to Invoices list
  2. Find your test invoice
  3. View details

Next Steps​

Once you've successfully sent a test invoice:

  1. Review best practices
  2. Set up production environment
  3. Configure monitoring and error handling

Support​

Need help with your first invoice?