Search my EGS code usage requests

API allow taxpayers to retrieve list of code usages requests they created in the system.

Create EGS Code Usage Request Code Usage

Overview

Search my EGS code usage requests API is responsible for retrieving list of requests that were submitted to the solution by the taxpayer.

requests include both type of codes :

  • Code Usage : this is the taxpayer request to register usage of other taxpayer code.
  • Create New Code: This is the taxpayer request to register his internal codes in the e-invoice solution

Signature

Signature: GET /api/v1.0/codetypes/requests/my

Inputs

This API accepts standard eInvoicing API header parameters for authenticated call.

Query Parameters

Optional query strings parameters accepted:

Parameter Type Description Value example
ItemCode String Code that was registered by the taxpayer EG-113317713-1234
CodeName String Code name in English water bottle
CodeDescription String Code description that was provided by the taxpayer Water bottle, 600 mg, plastic bottle
ParentLevelName String Refer to the parent level name from the catalog EGS Level 4 Code - Brick
ParentItemCode String Parent item code 10006358
ActiveFrom Date Refer to the code end of validaity date in UTC 2021-03-21T00:00:00Z
ActiveTo Date Refer to the code end of validaity date in UTC 2021-05-21T23:59:00Z
Active Boolean Refer to the code beeing active true
Status String Possible values (Submitted, Approved, Rejected) Submitted
RequestType String Possible values (New, Reusage) New
OrderDirections String Possible values (Descending, Ascending) Will control sorting results based on the creation time of the request Descending
PageNumber Number Optional: number of the page to retrieve. Typically this parameter value is derived from initial parameter less call when caller learns total amount of page of certain size 3
pageSize Number Optional: number of the documents to retrieve per page. Page size cannot exceed system configured maximum page size for this API 20

Outputs

Successful Response

API returns HTTP status code 200.

The resulting structure is an array of objects of object ‘RequestsDetails’.

Requests Details contains:

Input parameter Type Description Value example
codeUsageRequestID Numeric Internal ID of the request submitted 58985
codeTypeName String Catalog name that the code was registered in EGS
codeID Numeric Internal code ID in the solution 942982
itemCode String Code that was registered by the taxpayer EG-113317713-1234
codeName String Code name in English water bottle
description String Code description that was provided by the taxpayer Water bottle, 600 mg, plastic bottle
parentCodeID Numeric Internal code ID of the parent in the solution 302982
parentItemCode String Parent item code 10006358
parentLevelName String Refer to the parent level name from the catalog EGS Level 4 Code - Brick
levelName String Refer to the level name of the code EGS Level 5 Code
requestCreationDateTimeUtc Date Refer to the request creation date on eInvoice system in UTC 2021-02-02T00:12:43.00Z
codeCreationDateTimeUtc Date Refer to the code creation date on eInvoice system in UTC 2021-02-02T00:12:43.900Z
activeFrom Date Refer to the code start validity date in UTC 2021-02-02T00:12:43.00Z
activeTo Date Refer to the code end of validaity date in UTC 2021-06-02T00:12:43.00Z
active Boolean Refer to the code status in the system true
status String Refer to the request status if approved or rejected Approved
ownerTaxpayer Owner Taxpayer Refer to the taxpayer who is the owner of the code  
requesterTaxpayer Requestor Taxpayer Refer to the taxpayer who initiated the code usage request  
codeCategorization Code Categorization Refer to the code levels/Category  

Owner Taxpayer Object

Input parameter Type Description Value example
rin String Refer to the taxpayer ID who own the code 113317713
name String Refer to the taxpayer name in English Samsung
nameAr String Refer to the taxpayer name in Arabic سامسونج

Requestor Taxpayer Object

Input parameter Type Description Value example
rin String Refer to the taxpayer ID who own the code 113317713
name String Refer to the taxpayer name in English Apple
nameAr String Refer to the taxpayer name in Arabic أبل

Code Categorization Object

Object which contains the lower level of the code (Possible values: level1, level2, level43, level4)

Input parameter Type Description Value example
name String Refer to code type level name in English Food/Beverage/Tobacco
nameAr String Refer to code type level name in Arabic الأطعمة/المشروبات/التبغ

Error Response

Error situations are reported back by this API through the standard error response.

Additional considerations

No additional considerations.

Back to homepage