Report a invoice

post

https://api.wafeq.com/v1/zatca/prepayment-simplified-invoices/report/

Reports a single invoice. Optionally, send the invoice using specified channels.

Body Params

channels

array of objects

length ≤ 1

The channels to send the document

channels

document

object

required

The document data

language

string

enum

Defaults to en

ar - Arabic
en - English

Full information for LanguageEnum

Allowed:

metadata

object

The metadata of the document

reference

string

The reference of the document

template

object

The template of the document

Headers

X-ZATCA-Branch

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

X-ZATCA-Connected-Account-Id

string

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

X-ZATCA-Environment

string

required

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

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The document was created and reported/cleared to ZATCA successfully

400The request was invalid or did not pass ZATCA validation rules

403No active device found, environment header is missing or invalid

424The request for reporting/clearing to ZATCA failed

500Unexpected error occurred while processing the request