Jump to Content
API Reference
Developer ConsoleAPI Status Page

Update the metadata of an existing credit note

patch
https://api.wafeq.com/v1/zatca/simplified-credit-notes/{id}/

Update the metadata of an existing credit note. The keys you send are merged into the credit note'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 credit note is what was reported to ZATCA and cannot change. Metadata values must be non-empty strings, and keys cannot contain . or start with $.

Path Params
stringrequired

The unique identifier of the document.

Body Params

Metadata changes to merge into the document.

metadataobject

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.

Connected accounts should be used only for Platforms and White Label integrations that onboard customers and report documents on their behalf. Omit the X-ZATCA-Connected-Account-Id header when registering devices or reporting documents for your own organization. See the Platforms and White Label guide.

stringrequired

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

Response

Updated 2 days ago