Skip to main content
POST
/
purchase-orders
/
{purchaseOrderId}
/
payments
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_date": "2024-01-15",
  "payment_type": "check",
  "paid_amount": 500,
  "remarks": "Check #1234"
}
'
{
  "data": {
    "id": 123,
    "order_numbers": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "order_status": "active",
    "order_date": "2023-12-25",
    "invoice_date": "2023-12-25",
    "arrival_due_date": "2023-12-25",
    "requested_ship_date": "2023-12-25",
    "order_type": 123,
    "incoterm": "<string>",
    "tracking_info": "<string>",
    "payment_terms": "<string>",
    "supplier_id": 123,
    "item_count": 123,
    "total_qty_ordered": 123,
    "total_qty_received": 123,
    "total_qty_remaining": 123,
    "order_cost": 123,
    "total_tax": 123,
    "total_shipping_cost": 123,
    "total_cost": 123,
    "total_paid": 123,
    "total_due": 123,
    "down_payment": 123,
    "public_note": "<string>",
    "private_note": "<string>",
    "starred": true,
    "items": [
      {
        "id": 123,
        "purchase_order_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "quantity": 123,
        "unit_price": 123,
        "unit": "<string>",
        "tax": 123,
        "discount_amount": 123,
        "line_total": 123,
        "received_quantity": 123,
        "source_sku": "<string>",
        "product": {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "retail_price": 123,
          "wholesale_price": 123,
          "variant_attributes": {},
          "sku": "<string>",
          "upc": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "supplier": {
      "id": 123,
      "status": 123,
      "name": "<string>",
      "description": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "contact_name": "<string>",
      "contact_email": "<string>",
      "contact_phone": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "payments": [
      {
        "id": 123,
        "payment_date": "2023-12-25",
        "payment_type": "cash",
        "paid_amount": 123,
        "remarks": "<string>",
        "external_id": "<string>",
        "created_by": {
          "id": 123,
          "name": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "ship_to": {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "default_ship_to_address": "ship_to_address"
    },
    "warehouse": {
      "id": 123,
      "name": "<string>"
    },
    "location": {
      "id": 123,
      "name": "<string>"
    },
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ],
    "fulfillment_orders": [
      {
        "id": 123,
        "order_number": "<string>",
        "order_status": "<string>"
      }
    ]
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

​
purchaseOrderId
integer
required

ID of the purchase order

Body

application/json
​
payment_date
string<date>
required

Date of the payment (YYYY-MM-DD)

Example:

"2024-01-15"

​
payment_type
enum<string>
required

Type of payment

Available options:
cash,
credit_card,
debit_card,
check,
bank_transfer
Example:

"check"

​
paid_amount
number<float>
required

Amount paid

Required range: x >= 0.01
Example:

500

​
remarks
string | null

Payment remarks or notes

Maximum string length: 1000
Example:

"Check #1234"

​
external_id
string | null

External payment reference ID

Maximum string length: 255
Example:

"PAY-EXT-12345"

Response

Payment created successfully

​
data
object