Create a new invoice

POST 
https://core-prod.malipopay.co.tz/api/v1/invoice

Creates a new invoice for the project

Request

application/json

Body

Bodyrequired

customerstringrequired
Customer ID
Example: 6281559426fa29659c5ac38a
itemsobject[]required

Line items on the invoice

dueDatedaterequired
Invoice due date
Example: 2024-03-31
currencystringrequired
Currency code
Example: TZS
notesstring
Additional notes or payment instructions
Example: Payment due within 30 days
taxRatenumber
Tax rate as a percentage (e.g., 18 for 18%)
Example: 18

Example (auto)

{
  "customer": "6281559426fa29659c5ac38a",
  "items": [
    {}
  ],
  "dueDate": "2024-03-31",
  "currency": "TZS",
  "notes": "Payment due within 30 days",
  "taxRate": 18
}

Responses

201

Invoice created successfully

application/json

Schema

Schema

_idstring
Example: 64c2de5f1a3b7e9d0f5a2c81
referencestring
Unique invoice reference number
Example: INV-2024-001
customerstring
Customer ID
Example: 6281559426fa29659c5ac38a
itemsobject[]
subtotalnumber
Example: 500000
taxnumber
Example: 90000
totalnumber
Example: 590000
currencystring
Example: TZS
statusstring
Invoice status (DRAFT, SENT, PAID, OVERDUE, CANCELLED)
Example: SENT
dueDatedate
Example: 2024-03-31
notesstring
Example: Payment due within 30 days
projectstring
Example: 63db68a6c5f3e7682e23c2ca
deletedboolean
Example: false
createdAtdate-time
Example: 2024-03-01T10:00:00.000Z

Example (auto)

{
  "_id": "64c2de5f1a3b7e9d0f5a2c81",
  "reference": "INV-2024-001",
  "customer": "6281559426fa29659c5ac38a",
  "items": [
    {}
  ],
  "subtotal": 500000,
  "tax": 90000,
  "total": 590000,
  "currency": "TZS",
  "status": "SENT",
  "dueDate": "2024-03-31",
  "notes": "Payment due within 30 days",
  "project": "63db68a6c5f3e7682e23c2ca",
  "deleted": false,
  "createdAt": "2024-03-01T10:00:00.000Z"
}

400

Validation error

application/json

Schema

Schema

codeint32required
messagestringrequired

Example (auto)

{
  "code": 0,
  "message": "string"
}

500

Internal server error

application/json

Schema

Schema

codeint32required
messagestringrequired

Example (auto)

{
  "code": 0,
  "message": "string"
}

Authorization: apiToken

name: apiTokentype: apiKeyin: headerdescription: Project API key. Get yours from the Malipopay dashboard under Settings → API Keys.

• curl
• python
• nodejs
• php
• java
• go

• CURL

curl -L 'https://core-prod.malipopay.co.tz/api/v1/invoice' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'apiToken: <apiToken>' \
-d '{
  "customer": "6281559426fa29659c5ac38a",
  "items": [
    {}
  ],
  "dueDate": "2024-03-31",
  "currency": "TZS",
  "notes": "Payment due within 30 days",
  "taxRate": 18
}'

Request

Base URL

https://core-prod.malipopay.co.tz

Auth

apiToken

Body required

{
  "customer": "6281559426fa29659c5ac38a",
  "items": [
    {}
  ],
  "dueDate": "2024-03-31",
  "currency": "TZS",
  "notes": "Payment due within 30 days",
  "taxRate": 18
}

Response

Click the Send API Request button above and see the response here!