v1

latestOpenAPI 3.1.12026-07-269084337.9 KB

Credit Note

Retrieve an credit note

Retrieves a single credit note.

get/zatca/credit-notes/{id}/

Path parameters

idstring required

The unique identifier of the document.

Headers

X-ZATCA-Branchstring

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-Idstring

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

X-ZATCA-Environmentstring required

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

Response

created_tsstring date-time required

The datetime in UTC when the document was created.

metadataobject required

The metadata of the document.

qr_code_datastring required

Base64 encoded QR code data.

referencestring required

The reference of the document.

reported_tsstring date-time required

The datetime in UTC when the document was reported/cleared.

{"stackTrail":"components:schemas:DocumentDetailRead:properties:response","oasType":"schema","type":"unknown","description":"The response from the ZATCA API."}

sent_tsstring date-time required

The datetime in UTC when the document was sent.

statusstring required

The status of the document.