json/v1.0/order.json in sk_api_schema-0.6.1 vs json/v1.0/order.json in sk_api_schema-0.7.0
- old
+ new
@@ -95,21 +95,33 @@
"readonly":true,
"type":"object",
"properties":{"$ref":"./attachment.json#properties"}
},
"client":{
- "description": "The associated client. New documents cannot create a client, use client_id to set it.",
+ "description": "DEPRECATED: use contact",
"readonly":true,
"type":"object",
"properties":{"$ref":"./client.json#properties"}
},
"client_id":{
- "description": "The clients uuid. If a new client is assigned its language, address field are used if those fields are not set.",
+ "description": "DEPRECATED: use contact_id",
"type":"string",
"maxLength": 22,
"minLength":22
},
+ "contact":{
+ "description": "The contact for the document. Use contact_id field to set a contact.",
+ "readonly":true,
+ "type":"object",
+ "properties":{"$ref":"./contact.json#properties"}
+ },
+ "contact_id":{
+ "description": "The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.",
+ "type":"string",
+ "maxLength": 22,
+ "minLength":22
+ },
"team_id":{
"description": "A team uuid. If set only the team and its parent teams can see the record.",
"type":"string",
"maxLength": 22,
"minLength":22
@@ -217,13 +229,18 @@
"description": "A list of language codes, comma separated",
"type" : "string"
},
"filter[client_ids]":{
"title" : "Clients",
- "description": "A single or a list of client uuids, comma separated",
+ "description": "DEPRECATED use contact_ids",
"type" : "string"
},
+ "filter[contact_ids]":{
+ "title" : "Contacts",
+ "description": "A single or a list of contact uuids, comma separated",
+ "type" : "string"
+ },
"filter[ids]":{
"title" : "Documents",
"description": "A single or a list of document uuids, comma separated",
"type" : "string"
},
@@ -233,17 +250,18 @@
"type" : "string"
},
"sort_by":{
"title" : "Sort by",
"description": "Sort the results by the given field => number",
- "enum":["title", "number", "created_at", "updated_at", "client_id", "price_total", "price_tax", "date", "due_date"],
+ "enum":["title", "number", "created_at", "updated_at", "price_total", "price_tax", "date", "due_date"],
"type": "string"
},
"sort":{
"title" : "Sort",
"enum":["ASC","DESC"],
- "description": "Sort the results in ASC or DESC"
+ "description": "Sort the results in ASC or DESC",
+ "type": "string"
}
}
},
{ "rel": "destroy",
"href": "orders/{id}",
@@ -257,10 +275,10 @@
"href": "orders",
"method": "POST",
"properties" : {
"source" : {
"title" : "Source document id",
- "description": "Copies the source document(excl. number,date) and returns a new draft document.",
+ "description": "Copies the source(excl. number,date) and returns a new draft document. Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
"type" : "string"
}
}
},
{ "rel": "attachments",