Skip to main content
POST
/
contracts
/
{id}
/
schedules
Create Contract Schedule
curl --request POST \
  --url https://v1.api.flux-os.com/contracts/{id}/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '
{
  "production_month": "2023-12-25",
  "volume": 123,
  "volume_measurement_unit": "<unknown>",
  "status": "<unknown>"
}
'
{
  "data": {
    "production_month": "2023-12-25",
    "volume": 123,
    "id": "<string>",
    "contract": {
      "external_id": "<string>",
      "id": "<string>"
    },
    "status": {
      "name": "<string>",
      "short_code": "<string>",
      "id": "<string>"
    },
    "volume_measurement_unit": {
      "name": "<string>",
      "abbreviation": "<string>",
      "id": "<string>",
      "html_symbol": null
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "estimated_qualities": [
      {
        "value": 123,
        "id": "<string>",
        "measurement_property": {
          "name": "<string>",
          "short_code": "<string>",
          "id": "<string>"
        },
        "measurement_unit": {
          "name": "<string>",
          "abbreviation": "<string>",
          "id": "<string>",
          "html_symbol": null
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "chains": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "legs": [
          {
            "position": 123,
            "chain": "<unknown>",
            "volume": 123,
            "id": "<string>",
            "mode": {
              "name": "<string>",
              "short_code": "<string>",
              "id": "<string>"
            },
            "source_well": {
              "id": "<string>",
              "name": null
            },
            "source_commercial_facility": {
              "name": "<string>",
              "id": "<string>",
              "lsd": null,
              "section": null,
              "township": null,
              "range": null,
              "meridian": null
            },
            "source_facility": {
              "name": "<string>",
              "id": "<string>"
            },
            "source_land_description": {
              "description": "<string>",
              "latitude": 123,
              "longitude": 123,
              "id": "<string>",
              "survey_system": {
                "name": "<string>",
                "short_code": "<string>",
                "id": "<string>"
              },
              "unit": {
                "name": "<string>",
                "short_code": "<string>",
                "id": "<string>"
              }
            },
            "destination_commercial_facility": {
              "name": "<string>",
              "id": "<string>",
              "lsd": null,
              "section": null,
              "township": null,
              "range": null,
              "meridian": null
            },
            "destination_facility": {
              "name": "<string>",
              "id": "<string>"
            },
            "volume_measurement_unit": {
              "name": "<string>",
              "abbreviation": "<string>",
              "id": "<string>",
              "html_symbol": null
            },
            "custodian_organization": {
              "name": "<string>",
              "id": "<string>",
              "image_url": null
            },
            "custodian_entity": {
              "legal_name": "<string>",
              "id": "<string>"
            },
            "is_custody_transfer": false,
            "is_chain_source": false,
            "is_chain_destination": false,
            "fob": false,
            "carrier_organization": {
              "name": "<string>",
              "id": "<string>",
              "image_url": null
            },
            "carrier_entity": {
              "legal_name": "<string>",
              "id": "<string>"
            },
            "carrier_user": {
              "first_name": "<string>",
              "last_name": "<string>",
              "id": "<string>"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Path Parameters

id
integer
required

The contract ID.

Body

application/json
production_month
string<date>
required
volume
number
required
volume_measurement_unit
any
required
status
any

Response

Contract schedule successfully created.

data
object