json/v1.0/recurring.json in sk_api_schema-0.3.4 vs json/v1.0/recurring.json in sk_api_schema-0.4.0
- old
+ new
@@ -1,19 +1,22 @@
{ "type":"object",
"title": "recurring",
"description": "An recurring is used as an template for new invoices.",
"properties":{
"id":{
- "description": "UUID assigned by SK",
+ "description":"Unique identifier - UUID",
"identity":true,
"readonly":true,
- "type":"string"
+ "type":"string",
+ "maxLength": 22,
+ "minLength":22
},
"number":{
"description": "Unique name to identify the document. Unlike all other document this one has no number schema and not auto assign",
"type":"string",
- "required":true
+ "required":true,
+ "maxLength": 50
},
"address_field":{
"description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
"type":"string"
},
@@ -38,32 +41,36 @@
"enum":["yearly", "monthly", "weekly", "quarterly", "biweekly", "sixmonthly"],
"type":"string",
"required":true
},
"payment_method":{
- "description": "How the document is beeing payed. Used in new payments.",
+ "description": "How the document is being payed. Used in new payments.",
"enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
"type":"string"
},
"external_ref":{
"description": "Some external reference, whatever this may be.",
- "type":"string"
+ "type":"string",
+ "maxLength": 255
},
"title":{
- "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your recurring [number]'",
- "type":"string"
+ "description": "The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your recurring [number]'",
+ "type":"string",
+ "maxLength": 255
},
"notes_before":{
- "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
- "type":"string"
+ "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.",
+ "type":"string",
+ "format":"text"
},
"notes_after":{
"description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
- "type":"string"
+ "type":"string",
+ "format":"text"
},
- "tag_list": {
- "description": "Space separated list of tags.",
+ "tag_list":{
+ "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
"type":"string"
},
"language":{
"description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.",
"type":"string",
@@ -75,15 +82,19 @@
"type":"object",
"properties":{"$ref":"./client.json#properties"}
},
"client_id":{
"description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
- "type":"string"
+ "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"
+ "type":"string",
+ "maxLength": 22,
+ "minLength":22
},
"line_items":{
"description": "Line items for the document",
"type":"array",
"properties":{"$ref":"./line_item.json#properties"}
@@ -142,10 +153,10 @@
"description": "Results per page. Default is 10, max is 100",
"type":"number"
},
"filter[q]":{
"title" : "Search",
- "description": "Search in title, number, addressfield",
+ "description": "Search in title, number, address field",
"type":"string"
},
"filter[tags]":{
"title" : "Tags",
"description": "Filter by a space delimited list of tags",