Create purchase order
Creates a new purchase order to track purchase commitments before invoices are received. This endpoint handles three types of purchase orders with comprehensive validation and automatic folio generation.
Purchase Order Types
1. Against Invoice
Single invoice purchase order with exactly one item at 100%.
Use case: Simple purchases with a single invoice expected.
Example: Purchasing office equipment for $10,000 CLP.
2. By Milestone
Multiple named deliverables with individual percentages.
Use case: Projects with defined stages and separate invoicing for each stage.
Example: Software project with Design (30%), Development (50%), Testing (20%).
3. By Percentage
Multiple payment stages with percentages (no names required).
Use case: Service contracts with payment schedule.
Example: Consulting service with 30% advance, 50% mid-project, 20% final payment.
Prerequisites
Before creating a purchase order, you need:
-
Business Partner: The vendor/supplier for this purchase
- Must be pre-registered and approved
- Find partners: GET /v1/erp/payouts/business_partners
-
Company: The company making the purchase
- User must be a member with appropriate role
- Required roles: admin, owner, or member
Validation Rules
General Rules (All Types)
- amount_cents: Integer, >= 0, in the minor unit of currency — not always a hundredth. CLP → whole pesos (10000 is $10.000). USD → cents (99000 is US$990). UF/CLF → ten-thousandths of a UF (400000 is 40 UF). See Amounts and currency.
- description: Required field for purchase reference
- currency: Must be exactly one of CLP, UF, CLF, USD — case-sensitive, so clp or uf is rejected. UF is normalized to its ISO code CLF on save, which is what reads back.
- items: Must have at least one item
- percentages: Item percentages must sum to exactly 100%
- custom columns: every custom column the company marked as required_on_purchase_orders must have a value, sent in custom_column_values or coming from the column's default_value. Otherwise 422 with errors: ["<label> es obligatoria para solicitar una orden de compra"] and nothing is created. Once created, a required value cannot be emptied (PATCH /v1/custom_column_values answers 422); orders created before the column was required stay editable.
Type-Specific Rules
AgainstInvoice:
- Must have exactly 1 item
- Item percentage must be 100%
- Item name is optional (not required)
ByMilestone:
- Must have at least 1 item
- Each item must have a name
- Item percentages must sum to 100%
ByPercentage:
- Must have at least 2 items
- Item names are optional (not required)
- Item percentages must sum to 100%
Automatic Features
Folio Generation
System automatically generates a folio: a per-company sequential integer (1, 2, 3, ...), unique within the company. It is not a formatted string.
Item Amount Calculation
System automatically calculates item amounts based on percentages:
- Formula: item.amount_cents = (total_amount_cents × percentage / 100).round
- Automatically recalculated when total amount changes
Creator Tracking
System automatically assigns current authenticated user as creator (user_id).
Workflow
- Purchase order is created with status draft
- Admin/creator assigns reviewers to items (if approval required)
- Reviewers approve or reject items independently
- When fiscal invoice arrives, it's linked to approved items
- Linked items can be paid via bank transactions
- When all items are paid, purchase order is considered complete
Important Notes
- Regular users can only create purchase orders for companies they are members of
- All amounts are integers in the minor unit of the order's currency: whole pesos for CLP, cents for USD, ten-thousandths for UF/CLF. See Amounts and currency
- Item amounts are automatically calculated from percentages
- With tax_treatment (taxable / exempt) the order is entered by its net_amount_cents and amount_cents is calculated as the gross total (net + 19 % IVA when taxable), which is what the order is matched against on the invoice
- Full audit trail is maintained for all changes
Request
- Base URLhttps://api.cardda.com
- URLhttps://api.cardda.com/v1/erp/payouts/purchase_orders
- AuthHTTP bearer
Parameters
Request body
Example request
{
"purchase_order": {
"type": "Erp::Payouts::PurchaseOrders::AgainstInvoice",
"business_partner_id": "8e668a4e-8485-4248-86cc-a7a2201cf8c3",
"description": "Office equipment - 5 laptops",
"amount_cents": 10000000,
"tax_treatment": "taxable",
"net_amount_cents": 8403361,
"currency": "CLP",
"items_attributes": [
{
"number": 1,
"name": "Design and Requirements Analysis",
"percentage": 100
}
],
"custom_column_values": [
{
"custom_column_id": "c0ffee00-1111-2222-3333-444455556666",
"value": "ti"
}
]
}
}Response
Purchase order created successfully
Changes
No recorded changes to this operation across all 1 revision of this API.