Schema ID
https://gobl.org/draft-0/bill/charge
Properties
| Title | Property | Type | Description |
|---|---|---|---|
| UUID | uuid | string | Universally Unique Identifier. |
| Index | i | integer | Line number inside the list of charges (calculated). |
| Key | key | cbc.Key | Key for grouping or identifying charges for tax purposes. A suggested list of keys is provided, but these may be extended by the issuer. |
| Code | code | cbc.Code | Code used by the issuer to refer to this charge. |
| Reason | reason | string | Reason why the charge was applied. |
| Informative | informative | boolean | When true, the charge amount is calculated and reported but does not affect the document totals. Used for costs that must be declared while being borne by the supplier, such as a stamp duty the issuer absorbs instead of passing on to the customer. |
| Base | base | num.Amount | Value used as the base for percent calculations instead of the invoice’s sum of lines. |
| Percent | percent | num.Percentage | Percentage to apply to the sum of all lines. |
| Amount | amount | num.Amount | Amount to apply (calculated if percent present). |
| Taxes | taxes | tax.Set | List of taxes to apply to the charge. Not allowed on informative charges. |
| Extensions | ext | tax.Extensions | Extension codes that apply to the charge. |
| Meta | meta | cbc.Meta | Additional semi-structured information. |
Key Values
| Value | Description |
|---|---|
stamp-duty | Stamp Duty |
outlay | Outlay |
tax | Tax |
customs | Customs |
delivery | Delivery |
packing | Packing |
handling | Handling |
insurance | Insurance |
storage | Storage |
admin | Administration |
cleaning | Cleaning |
Validation Rules
| Field | Test | Validation Code / Message |
|---|---|---|
percent |
| GOBL-BILL-CHARGE-01Percent is required when base is set |
taxes |
| GOBL-BILL-CHARGE-02Cannot be set on an informative charge |