curl --request POST \
--url https://api.rootfi.dev/v4/payments/orders \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_id": 123,
"contact_id": "<string>",
"currency_id": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"item_id": "<string>",
"tax_amount": 123,
"discount_amount": 123
}
],
"status": "PENDING"
}
'{
"rootfi_id": 157,
"rootfi_created_at": "2024-01-22T05:07:31.465Z",
"rootfi_updated_at": "2024-01-22T05:07:31.000Z",
"rootfi_company_id": 1089,
"platform_id": "123456",
"rootfi_deleted_at": "2023-11-07T05:31:56Z",
"platform_unique_id": "<string>",
"raw_data": {},
"data_hash": "<string>",
"contact_id": "<string>",
"currency_id": "<string>",
"status": "PENDING",
"payment_status": "DRAFT",
"total_amount": 123,
"total_discount": 123,
"total_tax": 123,
"created_at": "<string>",
"updated_at": "<string>",
"invoice_id": "<string>",
"invoice_ids": [
"<string>"
],
"line_items": [
{
"rootfi_id": 123,
"item_id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"tax_amount": 123,
"discount_amount": 123,
"total_amount": 123
}
],
"transactions": [
{
"rootfi_id": 123,
"platform_id": "<string>",
"type": "PAYMENT",
"amount": 123,
"currency_id": "<string>",
"status": "DRAFT",
"payment_method_type": "CARD",
"gateway": "<string>",
"description": "<string>",
"created_at": "<string>"
}
]
}Create a new order in the payment platform.
curl --request POST \
--url https://api.rootfi.dev/v4/payments/orders \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_id": 123,
"contact_id": "<string>",
"currency_id": "<string>",
"line_items": [
{
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"item_id": "<string>",
"tax_amount": 123,
"discount_amount": 123
}
],
"status": "PENDING"
}
'{
"rootfi_id": 157,
"rootfi_created_at": "2024-01-22T05:07:31.465Z",
"rootfi_updated_at": "2024-01-22T05:07:31.000Z",
"rootfi_company_id": 1089,
"platform_id": "123456",
"rootfi_deleted_at": "2023-11-07T05:31:56Z",
"platform_unique_id": "<string>",
"raw_data": {},
"data_hash": "<string>",
"contact_id": "<string>",
"currency_id": "<string>",
"status": "PENDING",
"payment_status": "DRAFT",
"total_amount": 123,
"total_discount": 123,
"total_tax": 123,
"created_at": "<string>",
"updated_at": "<string>",
"invoice_id": "<string>",
"invoice_ids": [
"<string>"
],
"line_items": [
{
"rootfi_id": 123,
"item_id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"tax_amount": 123,
"discount_amount": 123,
"total_amount": 123
}
],
"transactions": [
{
"rootfi_id": 123,
"platform_id": "<string>",
"type": "PAYMENT",
"amount": 123,
"currency_id": "<string>",
"status": "DRAFT",
"payment_method_type": "CARD",
"gateway": "<string>",
"description": "<string>",
"created_at": "<string>"
}
]
}| Field | Type | Required | Description |
|---|---|---|---|
| contact_id | string | Yes | Reference to the Contact |
| currency_id | string | Yes | ISO 4217 currency code |
| line_items | array | Yes | Items in this order |
| status | string | No | Order status (default: pending) |
| Field | Type | Required | Description |
|---|---|---|---|
| item_id | string | No | Reference to an Item/Product |
| description | string | Yes | Description of the item |
| quantity | integer | Yes | Number of units |
| unit_amount | number | Yes | Price per unit |
| tax_amount | number | No | Tax for this line item |
| discount_amount | number | No | Discount applied |
Order created successfully
V4 Order model with embedded transactions.
The unique ID we assign for that data's information
157
The date at which RootFi first synced this data
"2024-01-22T05:07:31.465Z"
The latest date at which RootFi updated this data
"2024-01-22T05:07:31.000Z"
The ID of the company in the accounting platform
1089
An unique custom RootFi ID made from platform's unique_id.
"123456"
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Reference to the Contact.
ISO 4217 currency code.
Current order status (PENDING, PROCESSING, COMPLETED, CANCELED, ON_HOLD, UNKNOWN).
PENDING, PROCESSING, COMPLETED, CANCELED, ON_HOLD, UNKNOWN Payment state of the order (DRAFT, PENDING, PAID, PARTIALLY_PAID, FAILED, REFUNDED, PARTIALLY_REFUNDED, VOIDED, UNKNOWN).
DRAFT, PENDING, PAID, PARTIALLY_PAID, FAILED, REFUNDED, PARTIALLY_REFUNDED, VOIDED, UNKNOWN Total order amount.
Total discount amount.
Total tax amount.
Original creation timestamp from platform (ISO 8601).
Last update timestamp from platform (ISO 8601).
Reference to the primary Invoice.
References to all related invoices.
Items included in this order.
Show child attributes
All payment transactions for this order.
Show child attributes