> ## 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. # Update a purchase order payment > Update an existing payment for a purchase order. All fields are optional - only provided fields will be updated. The purchase order totals (`total_paid` and `total_due`) are automatically recalculated after the payment is updated. ## Payment Types Valid payment types: `cash`, `credit_card`, `debit_card`, `check`, `bank_transfer` ## Total Recalculation After updating a payment, the system automatically: - Recalculates `total_paid` by summing all payment amounts - Recalculates `total_due` as `total_cost - total_paid` ## OpenAPI ````yaml /api-reference/build.yaml put /purchase-orders/{purchaseOrderId}/payments/{paymentId} openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Purchase Orders description: Get and modify purchase orders - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /purchase-orders/{purchaseOrderId}/payments/{paymentId}: put: tags: - Purchase Orders summary: Update a purchase order payment description: > Update an existing payment for a purchase order. All fields are optional - only provided fields will be updated. The purchase order totals (`total_paid` and `total_due`) are automatically recalculated after the payment is updated. ## Payment Types Valid payment types: `cash`, `credit_card`, `debit_card`, `check`, `bank_transfer` ## Total Recalculation After updating a payment, the system automatically: - Recalculates `total_paid` by summing all payment amounts - Recalculates `total_due` as `total_cost - total_paid` operationId: updatePurchaseOrderPayment parameters: - in: path name: purchaseOrderId required: true schema: type: integer description: ID of the purchase order - in: path name: paymentId required: true schema: type: integer description: ID of the payment to update requestBody: required: true content: application/json: schema: type: object properties: payment_date: type: string format: date description: Date of the payment (YYYY-MM-DD) example: '2024-01-16' payment_type: type: string enum: - cash - credit_card - debit_card - check - bank_transfer description: Type of payment example: check paid_amount: type: number format: float minimum: 0.01 description: Amount paid example: 600 remarks: type: string maxLength: 1000 nullable: true description: Payment remarks or notes example: 'Updated check #1234' external_id: type: string maxLength: 255 nullable: true description: External payment reference ID example: PAY-EXT-12345 examples: update_amount: summary: Update payment amount value: paid_amount: 600 update_all_fields: summary: Update all payment fields value: payment_date: '2024-01-16' payment_type: bank_transfer paid_amount: 600 remarks: Updated payment external_id: PAY-EXT-12345 responses: '200': description: Payment updated successfully content: application/json: schema: type: object properties: data: type: object properties: id: type: integer description: Unique identifier for the purchase order order_numbers: type: array description: List of purchase order numbers items: type: string created_at: type: string format: date-time description: Timestamp when the purchase order was created updated_at: type: string format: date-time description: Timestamp when the purchase order was last updated order_status: type: string enum: - active - inactive - deleted description: Status of the purchase order order_date: type: string format: date description: Date when the purchase order was created invoice_date: type: string format: date description: Date when the purchase order was invoiced arrival_due_date: type: string format: date nullable: true description: Expected arrival date for the order requested_ship_date: type: string format: date nullable: true description: Requested shipping date order_type: type: integer description: Type of the order incoterm: type: string description: International Commercial Terms for the order tracking_info: type: string nullable: true description: Tracking information for the order payment_terms: type: string description: Payment terms for the order supplier_id: type: integer description: ID of the supplier item_count: type: integer description: Number of unique items in the order total_qty_ordered: type: number format: float description: Total quantity of line items ordered total_qty_received: type: number format: float description: Total quantity of line items received total_qty_remaining: type: number format: float description: >- Total quantity of line items remaining to be received (ordered - received) order_cost: type: number format: float description: Cost of the order before tax and shipping total_tax: type: number format: float description: Total tax amount total_shipping_cost: type: number format: float description: Total shipping cost total_cost: type: number format: float description: Total cost including tax and shipping total_paid: type: number format: float description: Total amount paid total_due: type: number format: float description: Total amount due down_payment: type: number format: float description: Down payment amount public_note: type: string nullable: true description: Public notes private_note: type: string nullable: true description: Private notes starred: type: boolean description: Whether the order is starred items: type: array description: Line items in the purchase order items: type: object properties: id: type: integer description: Line item ID purchase_order_id: type: integer description: ID of the parent purchase order created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp quantity: type: integer description: Quantity ordered unit_price: type: number format: float description: Price per unit unit: type: string description: Unit of measure tax: type: number format: float description: Tax amount discount_amount: type: number format: float description: Discount amount line_total: type: number format: float description: Total for this line item received_quantity: type: integer description: Quantity received source_sku: type: string nullable: true description: Source SKU product: type: object properties: id: type: integer name: type: string description: type: string nullable: true retail_price: type: number format: float wholesale_price: type: number format: float variant_attributes: type: object nullable: true sku: type: string upc: type: string created_at: type: string format: date-time updated_at: type: string format: date-time supplier: type: object properties: id: type: integer status: type: integer name: type: string description: type: string street_address: type: string city: type: string state: type: string zip: type: string country: type: string contact_name: type: string contact_email: type: string contact_phone: type: string created_at: type: string format: date-time updated_at: type: string format: date-time payments: type: array description: Array of payments for this purchase order items: type: object properties: id: type: integer description: Unique identifier for the payment payment_date: type: string format: date description: Date of the payment payment_type: type: string enum: - cash - credit_card - debit_card - check - bank_transfer description: Type of payment paid_amount: type: number format: float description: Amount paid remarks: type: string nullable: true description: Payment remarks or notes external_id: type: string nullable: true description: External payment reference ID created_by: type: object description: User who created the payment properties: id: type: integer description: User ID name: type: string nullable: true description: User full name created_at: type: string format: date-time description: Timestamp when the payment was created updated_at: type: string format: date-time description: Timestamp when the payment was last updated ship_to: type: object nullable: true description: Shipping address information properties: address_1: type: string nullable: true description: Primary street address address_2: type: string nullable: true description: Secondary address line city: type: string nullable: true description: City name state: type: string nullable: true description: State or province zip: type: string nullable: true description: ZIP or postal code country: type: string nullable: true description: Country name default_ship_to_address: type: string enum: - ship_to_address - warehouse nullable: true description: Default shipping address preference warehouse: type: object nullable: true description: Warehouse information properties: id: type: integer name: type: string location: type: object nullable: true description: Location information properties: id: type: integer name: type: string tags: type: array items: type: object properties: id: type: integer name: type: string description: type: string nullable: true icon: type: string nullable: true color: type: string nullable: true fulfillment_orders: type: array description: >- Linked fulfillment orders. Present when the relation is loaded; deduplicated by ID. items: type: object properties: id: type: integer order_number: type: string nullable: true order_status: type: string nullable: true '400': description: Bad request - validation error content: application/json: schema: type: object properties: message: type: string '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string '404': description: Purchase order or payment not found content: application/json: schema: type: object properties: message: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````