weighings

Update an existing weighing.

PUT

/weighing/{weighingId}

curl --request PUT \
  --url https://api-sandbox.timeking.nl/api/external/v1/weighing/{weighingId} \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_custom_name": "<string>",
  "client_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "cubic_meters": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": 123,
  "description": "<string>",
  "id": 123,
  "invoiced": 123,
  "licenseplate": "<string>",
  "number": "<string>",
  "order_id": 123,
  "payment_type": "<string>",
  "processed": 123,
  "task_id": 123,
  "type": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": 123,
  "vehicle_custom_name": "<string>",
  "vehicle_id": 123,
  "weighbridge_id": 123,
  "weight_after": "<string>",
  "weight_before": "<string>",
  "weight_type_custom_name": "<string>",
  "weight_type_id": 123
}
'

{
  "data": {
    "result": "<string>",
    "weighing": {
      "client_custom_name": "<string>",
      "client_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": 123,
      "cubic_meters": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": 123,
      "description": "<string>",
      "id": 123,
      "invoiced": 123,
      "licenseplate": "<string>",
      "number": "<string>",
      "order_id": 123,
      "payment_type": "<string>",
      "processed": 123,
      "task_id": 123,
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": 123,
      "vehicle_custom_name": "<string>",
      "vehicle_id": 123,
      "weighbridge_id": 123,
      "weight_after": "<string>",
      "weight_before": "<string>",
      "weight_type_custom_name": "<string>",
      "weight_type_id": 123
    }
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Padparameters

weighingIdstringverplicht

The id of the weighing to perform the action on.

Body

Weighing object.

client_custom_namestring

The name of the client of this weighing when no existing client is selected.

client_idinteger

The ID of the client (klant) of this weighing, which is taken from the vehicle when left empty.

created_atstring

The date and time this weighing was created.

created_byinteger

The ID of the backend user who created this weighing, or 0 when it was not created by a backend user.

cubic_metersstring

The optional volume of this weighing in cubic meters (m³), used for prices per cubic meter. Returned as a numeric string, e.g. "12.50".

datestringverplicht

The date and time of this weighing.

deleted_atstring

The date and time this weighing was deleted, empty when it is not deleted.

deleted_byinteger

The ID of the backend user who deleted this weighing, or 0 when it was not deleted by a backend user.

descriptionstring

The description of this weighing.

idintegerverplicht

The ID of this weighing.

invoicedinteger

Whether this weighing is invoiced. Returned as 1 (yes) or 0 (no).

licenseplatestring

The license plate of the vehicle of this weighing.

numberstring

The unique number of this weighing, which is generated when left empty.

order_idinteger

The ID of the order (project) of this weighing.

payment_typestring

The payment method of this weighing, either 'cash' or 'invoice' (on account).

processedinteger

Whether this weighing is processed. Returned as 1 (yes) or 0 (no).

task_idinteger

The ID of the task (bon) of this weighing, which is matched on the vehicle and date when left empty.

typestring

The type of this weighing, either 'in' or 'out'.

updated_atstring

The date and time this weighing was last updated.

updated_byinteger

The ID of the backend user who last updated this weighing, or 0 when it was not updated by a backend user.

vehicle_custom_namestring

The name of the vehicle of this weighing when no existing vehicle is selected.

vehicle_idinteger

The ID of the vehicle of this weighing, which is matched on the license plate when left empty.

weighbridge_idinteger

The ID of the weighbridge of this weighing, which defaults to the first weighbridge.

weight_afterstring

The second (lowest) measured weight of this weighing in kilograms; the net weight is weight_before minus weight_after. Returned as a numeric string, e.g. "12.50".

weight_beforestring

The first (highest) measured weight of this weighing in kilograms. Returned as a numeric string, e.g. "12.50".

weight_type_custom_namestring

The name of the weight type of this weighing when no existing weight type is selected.

weight_type_idinteger

The ID of the weight type (weegsoort) of this weighing, which defaults to the first weight type.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team