Update the metadata of an existing invoice

Update the metadata of an existing invoice. The keys you send are merged into the invoice's metadata: new keys are added, existing keys are overwritten, and keys you leave out are kept as they are. Set a key to null to remove it.

Only metadata can be updated; the rest of the invoice is what was reported to ZATCA and cannot change. Metadata values must be non-empty strings, and keys cannot contain . or start with $.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the document.

Body Params

Metadata changes to merge into the document.

metadata
object

The metadata keys to set. Keys left out are kept as they are; set a key to null to remove it.

Headers
string

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used as a branch name

string

The unique identifier of the connected account you're operating on behalf of

string
required

The zatca environment to use, available options are ['production', 'simulation']

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json