Record a payment on an invoice

Any signed in user. Adds one payment to a supplier invoice and advances the paid amount. The amount must be positive, and the invoice reads as paid once payments cover its total.

POST/api/v1/supplier-finance/invoices/{invoiceId}/payments

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

invoiceIdstringrequired

The supplier invoice the payment belongs to.

Request body

requiredapplication/json

amountnumberrequired

methodstring

referencestring

Responses

200

The invoice with the payment applied

idstringrequired

supplier_idstringrequired

branch_idstringrequired

invoice_nostringrequired

total_amountnumberrequired

paid_amountnumberrequired

statusstringrequired

due_datestring | nullrequired

notesstringrequired

created_bystringrequired

created_atstringrequired

400

amount must be positive

detailstringrequired

401

Not authenticated

detailstringrequired

404

Supplier invoice not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

invoiceIdpath*The supplier invoice the payment belongs to.

Bodyapplication/json

amountnumber*methodstringreferencestring

Request

curl -X POST 'http://localhost:8000/api/v1/supplier-finance/invoices/string/payments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 0,
  "method": "string",
  "reference": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/supplier-finance/invoices/string/payments", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"amount\": 0,\n  \"method\": \"string\",\n  \"reference\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/supplier-finance/invoices/string/payments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"amount\": 0,\n  \"method\": \"string\",\n  \"reference\": \"string\"\n}",
)

Response

{
  "id": "string",
  "supplier_id": "string",
  "branch_id": "string",
  "invoice_no": "string",
  "total_amount": 0,
  "paid_amount": 0,
  "status": "string",
  "due_date": "string",
  "notes": "string",
  "created_by": "string",
  "created_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}