{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"metadata","type":"basic","slug":"meta-data","excerpt":"Contains metadata keys and values","body":"These **metadata** objects are contained in the **metaData** array in the [transactionMetaData](doc:transaction-meta-data) object. \n\n###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`metaKey`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Key name of transaction metadata.\\n40 characters max.\",\n \"1-0\": \"`metaValue`\",\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\": \"`metaDescription`\",\n \"2-1\": \"*string*\",\n \"2-2\": \"Optional\",\n \"2-3\": \"Description of transaction metadata.\\n40 characters max.\",\n \"3-0\": \"`isVisible`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Property controlling whether the transaction metadata is visible in the invoice (`Y`) or hidden (`N`). \\nPossible values: `Y`, `N`\\nDefault value: `N`\"\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\": \"`metaKey`\",\n \"0-1\": \"*string*\",\n \"1-0\": \"`metaValue`\",\n \"1-1\": \"*string*\",\n \"2-0\": \"`metaDescription`\",\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-0\": \"`isVisible`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Property controlling whether the transaction metadata is visible in the invoice (`Y`) or hidden (`N`). \\nPossible values: `Y`, `N`\\nDefault value: `N`\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]","updates":[],"order":28,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a51e4adca83b015f8acb2b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"61a51e4adca83b015f8acaf1","version":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a51e4adca83b015f8acae6","61a51e4adca83b015f8acae7","61a51e4adca83b015f8acae8","61a51e4adca83b015f8acae9","61a51e4adca83b015f8acaea","61a51e4adca83b015f8acaeb","61a51e4adca83b015f8acaec","61a51e4adca83b015f8acaed","61a51e4adca83b015f8acaee","61a51e4adca83b015f8acaef","61a51e4adca83b015f8acaf0","61a51e4adca83b015f8acaf1","61a51e4adca83b015f8acaf2","61a51e4adca83b015f8acaf3","61a51e4adca83b015f8acaf4","61a51e4adca83b015f8acaf5","61a51e4adca83b015f8acaf6","61a51e4adca83b015f8acaf7","61a51e4adca83b015f8acaf8","61a51e4adca83b015f8acaf9"],"_id":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed21a76106200102eaec3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-06T12:42:42.841Z","githubsync":"","__v":0}metadata
Contains metadata keys and values
These metadata objects are contained in the metaData array in the transactionMetaData object.
Request
Property Name
Type
Required
Description
metaKey
string
Optional
Key name of transaction metadata.
40 characters max.
metaValue
string
Optional
Value of transaction metadata.
500 characters max.
metaDescription
string
Optional
Description of transaction metadata.
40 characters max.
isVisible
string
Optional
Property controlling whether the transaction metadata is visible in the invoice (Y) or hidden (N).
Possible values: Y, N
Default value: N
Property Name
Type
Description
metaKey
string
Key name of transaction metadata.
40 characters max.
metaValue
string
Value of transaction metadata.
500 characters max.
metaDescription
string
Description of transaction metadata.
40 characters max.
isVisible
string
Property controlling whether the transaction metadata is visible in the invoice (Y) or hidden (N).
Possible values: Y, N
Default value: N
