Skip to main content
Action provides a suggestion about what to do next with the document.

​
Schema ID

https://gobl.org/draft-0/bill/status#/$defs/Action

​
Properties

TitlePropertyTypeDescription
Keykeycbc.KeyKey helps determine what to do next.
DescriptiondescriptionstringDescription includes human readable details about what steps should be take next.
Extensionsexttax.ExtensionsExtensions for local or format focussed data

​
Key Values

ValueDescription
noneNo action required.
provideMissing information requested without re-issuing invoice.
reissueRequest to re-issue a corrected invoice.
credit-fullRequest to fully cancel the referenced invoice with a credit note.
credit-partialRequest to issue partial credit note for corrections only.
credit-amountRequest to repay the amount paid on the invoice.
otherRequested action is not defined by code.

​
Validation Rules

FieldTestValidation Code / Message
key
  • Present
GOBL-BILL-ACTION-01
Action key is required
key
  • One of [none, provide, reissue, credit-full, credit-partial, credit-amount, other]
GOBL-BILL-ACTION-02
Action key is not valid