Loading...
Loading...
Integrate ARMS IT e-invoicing solution with your systems using our RESTful API
All API requests require authentication using an API key. Include your API key in the request header.
Header Name:
X-API-KEYcurl -X GET https://api.example.com/v1/invoices \
-H "X-API-KEY: your-api-key-here"⚠️ Security Note: Keep your API key secure and never expose it in client-side code or public repositories. If your API key is compromised, contact support immediately to regenerate it.
All API endpoints are relative to the base URL:
https://api.armsit.ng/v1Note: Replace api.armsit.ng with your actual API endpoint URL.
/invoicesRetrieve a list of invoices. Supports pagination and filtering.
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
pageSize | integer | Items per page (default: 20, max: 100) |
status | string | Filter by status (Draft, ReadyForClearance, Cleared) |
customerId | string (UUID) | Filter by customer ID |
GET /v1/invoices?page=1&pageSize=20&status=Draft
Headers:
X-API-KEY: your-api-key-here{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"invoiceNumber": "INV-2025-001",
"issueDate": "2025-01-15T00:00:00Z",
"status": "Draft",
"customer": {
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Acme Corporation"
},
"taxExclusiveAmount": 100000.00,
"taxInclusiveAmount": 107500.00,
"payableAmount": 107500.00,
"currency": "NGN"
}
],
"page": 1,
"pageSize": 20,
"totalCount": 45,
"totalPages": 3
}/invoicesCreate a new invoice. The invoice will be created in Draft status.
{
"invoiceNumber": "INV-2025-001",
"issueDate": "2025-01-15",
"invoiceTypeCode": "380",
"customerId": "660e8400-e29b-41d4-a716-446655440000",
"note": "Optional invoice note",
"items": [
{
"productId": "770e8400-e29b-41d4-a716-446655440000",
"description": "Product description",
"quantity": 10,
"unitCode": "C62",
"unitPrice": 10000.00,
"taxCategoryCode": "S"
}
]
}| Field | Type | Required | Description |
|---|---|---|---|
invoiceNumber | string | Yes | Unique invoice number |
issueDate | date (YYYY-MM-DD) | Yes | Invoice issue date |
invoiceTypeCode | string | Yes | 380 (Standard) or 381 (Credit Note) |
customerId | string (UUID) | Yes | Customer ID |
note | string | No | Optional invoice note |
items | array | Yes | Array of invoice items (minimum 1) |
/customersRetrieve a list of customers. Supports pagination and search.
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
pageSize | integer | Items per page (default: 20, max: 100) |
search | string | Search by name, email, or TIN |
/customersCreate a new customer.
{
"name": "Acme Corporation",
"tin": "12345678-0001",
"email": "contact@acme.com",
"phone": "+2348012345678",
"street": "123 Business Street",
"city": "Lagos",
"state": "Lagos",
"country": "NG",
"postalCode": "100001"
}/customers/{id}Update an existing customer. Include only the fields you want to update.
/customers/{id}Delete a customer. Customers with existing invoices will be soft-deleted.
/productsRetrieve a list of products. Supports pagination and search.
/productsCreate a new product.
{
"name": "Product Name",
"description": "Product description",
"hsCode": "1234.56.78",
"sku": "PROD-001",
"unitPrice": 10000.00,
"unitCode": "C62",
"taxCategoryCode": "S"
}/products/{id}Update an existing product. Include only the fields you want to update.
/products/{id}Delete (deactivate) a product. Products are soft-deleted and can be reactivated.
The API uses standard HTTP status codes to indicate success or failure. Error responses follow a consistent format.
| Code | Description |
|---|---|
200 | OK - Request successful |
201 | Created - Resource created successfully |
204 | No Content - Request successful, no response body |
400 | Bad Request - Invalid request data |
401 | Unauthorized - Missing or invalid API key |
404 | Not Found - Resource not found |
422 | Unprocessable Entity - Validation errors |
500 | Internal Server Error - Server error |
{
"error": {
"code": "VALIDATION_ERROR",
"message": "One or more validation errors occurred",
"details": {
"invoiceNumber": ["Invoice number is required"],
"customerId": ["Customer ID must be a valid UUID"]
},
"timestamp": "2025-01-15T10:30:00Z"
}
}For API support, integration assistance, or to request your API key, please contact our support team.