{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"meta-data","type":"basic","slug":"meta-data","excerpt":"Contains metadata keys and values","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`meta-key`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Key name of transaction metadata.\\n40 characters max.\",\n    \"1-0\": \"`meta-value`\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Value of transaction metadata.\\n500 characters max.\",\n    \"0-2\": \"Optional\",\n    \"1-1\": \"*string*\",\n    \"2-0\": \"`meta-description`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Description of transaction metadata.\\n40 characters max.\",\n    \"3-0\": \"`is-visible`\",\n    \"3-1\": \"*boolean*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Property controlling whether the transaction metadata is visible in the invoice (`true`) or hidden (`false`).\\nPossible values: `true`, `false`\\nDefault: `false`\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`meta-key`\",\n    \"0-1\": \"*string*\",\n    \"1-0\": \"`meta-value`\",\n    \"1-1\": \"*string*\",\n    \"2-0\": \"`meta-description`\",\n    \"2-1\": \"*string*\",\n    \"0-2\": \"Key name of transaction metadata.\\n40 characters max.\",\n    \"1-2\": \"Value of transaction metadata.\\n500 characters max.\",\n    \"2-2\": \"Description of transaction metadata.\\n40 characters max.\",\n    \"3-2\": \"Property controlling whether the transaction metadata is visible in the invoice (`true`) or hidden (`false`).\\nPossible values: `true`, `false`\\nDefault: `false`\",\n    \"3-1\": \"*boolean*\",\n    \"3-0\": \"`is-visible`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":31,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603d5be8af8f1a006113812a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"603d5be8af8f1a0061138107","version":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603d5be8af8f1a00611380fb","603d5be8af8f1a00611380fc","603d5be8af8f1a00611380fd","603d5be8af8f1a00611380fe","603d5be8af8f1a00611380ff","603d5be8af8f1a0061138100","603d5be8af8f1a0061138101","603d5be8af8f1a0061138102","603d5be8af8f1a0061138103","603d5be8af8f1a0061138104","603d5be8af8f1a0061138105","603d5be8af8f1a0061138106","603d5be8af8f1a0061138107","603d5be8af8f1a0061138108","603d5be8af8f1a0061138109","603d5be8af8f1a006113810a","603d5be8af8f1a006113810b","603d5be8af8f1a006113810c","603d5be8af8f1a006113810d","603d5be8af8f1a006113810e"],"_id":"603d5be8af8f1a00611381ba","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5ff4b747849e1b03c50684c7","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-01-06T12:42:42.841Z","githubsync":"","__v":0}

meta-data

Contains metadata keys and values

Request

Property Name
Type
Required
Description

meta-key

string

Optional

Key name of transaction metadata.
40 characters max.

meta-value

string

Optional

Value of transaction metadata.
500 characters max.

meta-description

string

Optional

Description of transaction metadata.
40 characters max.

is-visible

boolean

Optional

Property controlling whether the transaction metadata is visible in the invoice (true) or hidden (false).
Possible values: true, false
Default: false

Response

Property Name
Type
Description

meta-key

string

Key name of transaction metadata.
40 characters max.

meta-value

string

Value of transaction metadata.
500 characters max.

meta-description

string

Description of transaction metadata.
40 characters max.

is-visible

boolean

Property controlling whether the transaction metadata is visible in the invoice (true) or hidden (false).
Possible values: true, false
Default: false