Atlas DocumentationE invoicing
Update Invoice Payment Status
Update the payment status of an e-invoice. Allows marking an invoice as PENDING, PAID, or REJECTED.
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Path Parameters
reference*string
The invoice reference number
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/e-invoicing/invoices/REF-2026-001/payment-status" \ -H "Content-Type: application/json" \ -d '{ "payment_status": "PAID" }'{
"requestId": "3a6538fd-03f0-4b05-ba41-5d44769dd014",
"requestTimestamp": "2026-04-09 12:00:00",
"message": "Invoice payment status updated successfully.",
"statusCode": 200,
"data": {
"id": "019a1639-ce25-70b7-ab20-16fcb2bac023",
"invoiceReferenceNumber": "REF-2026-001",
"sourceReference": "SRC-2026-001",
"invoiceNumber": "INV-2026-001",
"systemInvoiceNumber": "SYS-INV-001",
"status": "VALIDATED",
"businessId": "019a1639-ce25-70b7-ab20-16fcb2bac023",
"businessState": "LIVE",
"invoiceType": "388",
"issueDate": "2026-04-09",
"documentCurrency": "NGN",
"taxCurrency": "NGN",
"paymentStatus": "PENDING",
"subtotalAmount": 100000,
"taxTotal": 7500,
"totalAmount": 107500,
"amountDue": 107500,
"supplierData": {
"name": "Acme Corp Ltd",
"email": "billing@acme.com",
"phoneNumber": "+2348012345678",
"tin": "12345678-0001",
"country": "NG",
"state": "Lagos",
"city": "Lagos",
"address": "123 Business Ave"
},
"payeeData": {
"name": "Customer Inc",
"email": "accounts@customer.com",
"phoneNumber": "+2348098765432",
"tin": "87654321-0001",
"country": "NG",
"state": "Abuja",
"city": "Abuja",
"address": "456 Client Street"
},
"taxRepresentativeData": {
"name": "Tax Rep Ltd",
"email": "rep@taxrep.com",
"phoneNumber": "+2348011111111",
"tin": "11111111-0001",
"country": "NG",
"state": "Lagos",
"city": "Lagos",
"address": "789 Tax Street"
},
"invoiceLineItems": [
{
"lineNumber": 1,
"description": "Software License",
"unit": "EA",
"quantity": 2,
"unitPrice": 50000,
"itemAmount": 100000,
"taxes": [
{
"name": "VAT",
"rate": 0.075,
"amount": 7500
}
],
"taxAmount": 7500,
"lineTotalExcludingTax": 100000,
"lineTotalIncludingTax": 107500
}
],
"discountData": {},
"notes": "Payment due within 30 days",
"paymentTerms": "Net 30",
"daysDue": 30,
"firsStatus": "SIGNED",
"firsApprovalDate": "2026-04-09 14:30:00",
"firsRejectionReason": null,
"digitalStamp": "abc123def456...",
"branding": {
"logo_url": "https://example.com/logo.png",
"primary_color": "#1A73E8",
"secondary_color": "#FF5722"
},
"paymentDetails": {
"bankName": "Access Bank",
"accountName": "Acme Corp Ltd",
"accountNumber": "0123456789"
},
"createdAt": "2026-04-09 12:00:00",
"updatedAt": "2026-04-09 14:30:00"
}
}{
"requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
"requestTimestamp": "2026-04-09 12:00:00",
"message": "Unauthenticated.",
"statusCode": 401
}{
"requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
"requestTimestamp": "2026-04-09 12:00:00",
"message": "Invoice not found.",
"statusCode": 404
}{
"requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
"requestTimestamp": "2026-04-09 12:00:00",
"message": "The payment status field is required.",
"statusCode": 422,
"errors": {}
}{
"requestId": "f006ad7b-096c-4254-8c7e-2d23a55b0b0e",
"requestTimestamp": "2026-04-09 12:00:00",
"message": "An error occurred while processing your request.",
"statusCode": 500
}How is this guide?