API Reference

Report a credit note

post
https://api.wafeq.com/v1/zatca/simplified-credit-notes/report/

Reports a single credit note. Optionally, send the credit note using specified channels.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
channels
array of objects
length ≤ 1

The channels to send the document

channels
document
object
required

The document data

string
enum
Defaults to en
  • ar - Arabic
  • en - English

Full information for LanguageEnum

Allowed:
metadata
object

The metadata of the document

string

The reference of the document

template
object

The template of the document

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

Updated 5 months ago

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

Updated 5 months ago