Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.laportenard.com/llms.txt

Use this file to discover all available pages before exploring further.

All payment endpoints require authentication.

​
List payment methods

POST /pos-api/v1/payments/methods
Returns the available payment methods configured for the POS session.

​
Response

{
  "payment_methods": [
    {
      "id": 1,
      "name": "Cash",
      "type": "cash"
    },
    {
      "id": 2,
      "name": "Credit Card",
      "type": "card"
    }
  ]
}

​
Check customer credit

POST /pos-api/v1/customers/credit-check
Checks whether a customer is eligible for credit payment at the requested amount.

​
Request

{
  "partner_id": 42,
  "amount": 1500.00
}

​
Response

{
  "eligible": true,
  "credit_limit": 5000.00,
  "current_balance": 1200.00,
  "available_credit": 3800.00
}
See Credit payments for the full payment flow.

​
Create credit note

POST /pos-api/v1/orders/credit-note
Creates a partial credit note for an order with voided items. Only non-voided items are included in the credit note.

​
Request

{
  "pos_reference": "NU/CFG1/S42/1709123456789-3f7a"
}

​
Response

{
  "success": true,
  "credit_note_id": 123,
  "lines": [
    {
      "product_name": "Grilled Chicken",
      "quantity": 1,
      "price_unit": 450.00,
      "is_voided": false
    }
  ]
}
Requires the refund permission. The order must have an NCF and no prior credit note.