Org
DocumentRef
DocumentRef is used to describe an existing document or a specific part of it’s contents.
Schema ID
https://gobl.org/draft-0/org/document-ref
Properties
| Title | Property | Type | Req. | Description |
|---|---|---|---|---|
| UUID | uuid | string | Universally Unique Identifier. | |
| Type | type | cbc.Key | Type of the document referenced. | |
| Issue Date | issue_date | cal.Date | IssueDate reflects the date the document was issued. | |
| Series | series | cbc.Code | Series the referenced document belongs to. | |
| Code | code | cbc.Code | true | Source document’s code or other identifier. |
| Currency | currency | currency.Code | Currency used in the document, if different from the parent’s currency. | |
| Lines | lines | array of integer | Line index numbers inside the document, if relevant. | |
| Identities | identities | array of org.Identity | List of additional codes, IDs, or SKUs which can be used to identify the document or its contents, agreed upon by the supplier and customer. | |
| Period | period | cal.Period | Tax period in which the referred document had an effect required by some tax regimes and formats. | |
| Reason | reason | string | Human readable description on why this reference is here or needs to be used. | |
| Description | description | string | Additional details about the document. | |
| Stamps | stamps | array of head.Stamp | Seals of approval from other organizations that may need to be listed. | |
| URL | url | string | Link to the source document. | |
| Tax | tax | tax.Total | Tax total breakdown from the original document in the provided currency. Should only be included if required by a specific tax regime or addon. | |
| Payable | payable | num.Amount | Payable is the total amount that is payable in the referenced document. Only needed for specific tax regimes or addons. This may also be used in some scenarios to determine the proportion of the referenced document that has been paid, and calculate the remaining amount due and taxes. | |
| Extensions | ext | tax.Extensions | Extensions for additional codes that may be required. | |
| Meta | meta | cbc.Meta | Meta contains additional information about the document. |