Update Purchase Order

PATCH 
https://secure.fleetio.com/api/v1/purchase_orders/:number

Update a Purchase Order

Request

Path Parameters

number stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The Purchase Order Number

application/json

Body

descriptionstringnullable
label_listLabelListParameters (string)
A comma separated list of tags associated with this record. The only delimiter allowed is a comma (,). Please remove any commas from your labels before saving the record.
Possible values: <= 255 characters
Example: High Priority
vendor_idId (integer)
Possible values: >= 1
part_location_idinteger
The Fleetio ID of the Part Location for the Part being purchased.
Possible values: >= 1
numberPurchaseOrderNumber (integer)
Must be unique within the scope of your Account. You can either generate your own number or leave it blank and Fleetio will generate one for you. Fleetio will use the next number in the sequence based on your existing Purchase Orders. This becomes the unique identifier, even in endpoints. Id is never used.
Example: 1207
discount_typeDiscountType (string)nullable
The type of discount applied to this record.
Possible values: [fixed, percentage]
Default value: percentage
discount_percentagefloat
The discount percentage. This field should be present when discount_type is set to percentage.
discountnumber
The actual value of the discount
shippingnumber
The cost of shipping
tax_1_percentagenumber
The primary tax percentage amount. This field should be present when tax_1_type is set to percentage.
tax_1float
The primary tax amount.
tax_1_typeTaxType (string)nullable
The type of tax to apply to this record.
Possible values: [fixed, percentage]
Default value: percentage
tax_2_percentagenumber
The secondary tax percentage amount. This field should be present when tax_2_type is set to percentage. Note that this secondary tax must be configured in your Account Settings.
tax_2float
The secondary tax amount. Note that this secondary tax must be configured in your Account Settings.
tax_2_typeTaxType (string)nullable
The type of tax to apply to this record.
Possible values: [fixed, percentage]
Default value: percentage
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
purchase_order_line_items_attributes object[]
Array [
part_idinteger
The Fleetio ID of the Part being purchased.
Possible values: >= 1
quantityinteger
How many of this Part to be purchased.
Possible values: >= 0
unit_costfloat
The cost of this Part (per unit).
]

Responses

204

OK

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

number — pathrequired

Body

{
  "description": "string",
  "label_list": "High Priority",
  "vendor_id": 0,
  "part_location_id": 0,
  "number": 1207,
  "discount_type": "percentage",
  "discount_percentage": 0,
  "discount": 0,
  "shipping": 0,
  "tax_1_percentage": 0,
  "tax_1": 0,
  "tax_1_type": "percentage",
  "tax_2_percentage": 0,
  "tax_2": 0,
  "tax_2_type": "percentage",
  "custom_fields": {},
  "purchase_order_line_items_attributes": [
    {
      "part_id": 0,
      "quantity": 0,
      "unit_cost": 0
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!