Invoices | PayrazeHQ API Docs

get

List of invoices

Authorizations

Query parameters

perPageintegerOptional

Number of items per page

Example: 100

pageintegerOptional

Page number

Example: 1

Responses

200

Invoices

application/json

Responseany

401

Request is unauthenticated

application/json

get

GET /api/v1/invoice/list HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "customer": "John Doe",
      "reference": "IN_3847",
      "date": "2024-01-01",
      "dueDate": "2024-02-01",
      "status": "Paid",
      "amount": 290887,
      "currency": {
        "id": 1,
        "name": "Ethereum",
        "code": "ETH"
      }
    }
  ],
  "currentPage": 1,
  "lastPage": 1,
  "itemsPerPage": 100,
  "pageItems": 4,
  "total": 4,
  "timestamp": "2024-05-29, 10:13:54"
}

post

Create a new invoice

Authorizations

Body

anyOptionalExample:

{"date":"2025-07-15","dueDate":"2025-07-24","biller":"Acme Corporation ltd","currencyId":3,"invoiceNumber":"INV-1001","client":"Jane Doe","poNumber":"PO-1212","items":[{"unit":"minute","unitsCount":10,"unitPrice":49},{"unit":"piece","unitsCount":500,"unitPrice":12.8}],"notes":"Thank you for your business.","terms":"Payment due within 17 days.","alreadyPaid":500}

Responses

200

Invoice successfully created

application/json

Responseany

401

Request is unauthenticated

application/json

500

Server error, something went wrong on the server

application/json

post

POST /api/v1/invoice/create HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "date": "2025-07-15",
  "dueDate": "2025-07-24",
  "biller": "Acme Corporation ltd",
  "currencyId": 3,
  "invoiceNumber": "INV-1001",
  "client": "Jane Doe",
  "poNumber": "PO-1212",
  "items": [
    {
      "unit": "minute",
      "unitsCount": 10,
      "unitPrice": 49
    },
    {
      "unit": "piece",
      "unitsCount": 500,
      "unitPrice": 12.8
    }
  ],
  "notes": "Thank you for your business.",
  "terms": "Payment due within 17 days.",
  "alreadyPaid": 500
}

{
  "message": "Invoice created successfully.",
  "timestamp": "2024-01-01 12:12:00"
}

get

Details of a single invoice

Authorizations

Path parameters

idintegerRequired

ID of the invoice

Example: 1

Responses

200

Invoice details

application/json

Responseany

401

Request is unauthenticated

application/json

get

GET /api/v1/invoice/edit/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "biller": "John Doe",
  "client": "ACME Corp.",
  "invoiceNumber": "IN_3847",
  "date": "2024-01-01",
  "dueDate": "2024-02-01",
  "poNumber": "PO_904846",
  "status": "Paid",
  "amount": 290887,
  "items": [
    {
      "unit": "Cleaning service",
      "unitsCount": 1,
      "unitPrice": 290887
    }
  ],
  "currency": {
    "id": 1,
    "name": "Ethereum",
    "code": "ETH"
  },
  "alreadyPaid": 0,
  "createdOn": "2024-01-01",
  "notes": "Thank you for your business.",
  "terms": "Payment due within 17 days."
}

put

Update an invoice

Authorizations

Path parameters

idintegerRequired

Invoice ID

Example: 1

Body

anyOptionalExample:

{"date":"2025-07-15","dueDate":"2025-07-24","biller":"Acme Corporation ltd","currencyId":3,"invoiceNumber":"INV-1001","client":"Jane Doe","poNumber":"PO-1212","items":[{"unit":"minute","unitsCount":10,"unitPrice":49},{"unit":"piece","unitsCount":500,"unitPrice":12.8}],"notes":"Thank you for your business.","terms":"Payment due within 17 days.","alreadyPaid":500}

Responses

200

Invoice successfully updated

application/json

Responseany

401

Request is unauthenticated

application/json

404

Invoice not found

application/json

500

Server error, something went wrong on the server

application/json

put

PUT /api/v1/invoice/update/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "date": "2025-07-15",
  "dueDate": "2025-07-24",
  "biller": "Acme Corporation ltd",
  "currencyId": 3,
  "invoiceNumber": "INV-1001",
  "client": "Jane Doe",
  "poNumber": "PO-1212",
  "items": [
    {
      "unit": "minute",
      "unitsCount": 10,
      "unitPrice": 49
    },
    {
      "unit": "piece",
      "unitsCount": 500,
      "unitPrice": 12.8
    }
  ],
  "notes": "Thank you for your business.",
  "terms": "Payment due within 17 days.",
  "alreadyPaid": 500
}

{
  "message": "Invoice updated successfully.",
  "timestamp": "2024-01-01 12:12:00"
}

delete

Delete an invoice

Authorizations

Path parameters

idintegerRequiredExample: 1

Responses

200

Invoice deleted successfully

application/json

Responseany

401

UnAuthentication

application/json

500

Server error, something went wrong on the server

application/json

delete

DELETE /api/v1/invoice/delete/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Invoice deleted successfully",
  "timestamp": "2024-01-01, 00:00:00"
}