Orders

Accept or Reject an Order

Returned when an unexpected error occurs while processing the request.

post/api/v2/partner/orders/{id}/organisation_approval

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/orders/{id}/organisation_approval
  • Auth: API key in header Authorization

Path parameters

idinteger required

Id of the order to be approved

Request body

status'Accepted' | 'Rejected' required

The decision on the order. Options: 'Accepted' or 'Rejected'

additional_commentstring

This field should be absent or an empty string if the status is "Accepted"

If the status is "Rejected" then this field is available for freeform text, but is usually non-mandatory. The field becomes mandatory (more information must be supplied here) if the rejection_reasons array includes any reason set to scheme_limitation, fixed_term_contract, personal_hr_reason, or other_reason.

comment_sent_to_employeeboolean

When additional_comment is provided, set to true to send the comment to the employee; false or omitted to not send

Example request

{
  "rejection_reasons": [
    {
      "reason": "other_reason",
      "additional_information": "Missing documents"
    }
  ],
  "additional_comment": "Incomplete application"
}

Response

Order status updated successfully

successboolean

Example response

{
  "success": true,
  "order": {
    "id": 123,
    "client_id": "ABC123",
    "employee_id": "EMP456",
    "title": "Mr",
    "first_name": "John",
    "surname": "Doe",
    "email": "john.doe@example.com",
    "effective_date": "2025-05-13T14:00:00Z",
    "dispatch_date": "2025-05-20T14:00:00Z",
    "total_amount_to_recover": "1200.0",
    "total_end_of_agreement_inc_vat": "1200.0",
    "amount_per_pay_period": "100.0",
    "total_existing_active_orders_value": 1800,
    "nmw_for_this_age_bracket": "6.4",
    "order_number": 123,
    "duration": 12,
    "benefit_type": "Home and Electronics",
    "benefit_name": "Home and Electronics / My Organisation",
    "telephone_number": "07123456789",
    "mobile_number": "07123456789",
    "address1": "123 Street",
    "address2": "Apt 4B",
    "city": "London",
    "county": "Greater London",
    "postcode": "W1A 1AA",
    "ni_number": "QQ123456C",
    "date_of_birth": "1990-01-01",
    "job_title": "Software Engineer",
    "job_location": "Head Office",
    "job_grade": "G7",
    "partner_user_identifier": "USR789",
    "approval_status": "Accepted",
    "order_status": "Order authorised",
    "order_management_order_status": "Active",
    "enabled": true,
    "national_minimum_wage_check_complete": true,
    "basic_details_check_complete": true,
    "order_details_check_complete": true,
    "products": [
      {
        "ItemNo": "SKU001",
        "ItemName": "Laptop",
        "ItemDescription": "15-inch Ultrabook",
        "ItemQty": 1,
        "ItemValue": 1200,
        "ItemImage": "https://example.com/images/macbook_pro.jpg"
      }
    ],
    "comments": [
      {
        "name": "John Admin",
        "comment": "The employee cancelled the order because",
        "partner_user_id": "ABC123",
        "created_at": "2025-01-10T14:30:00Z",
        "comment_sent_to_employee": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.