Request Header Parameters

Any API Call

These header parameters apply to all calls to all APIs if not explicitly stated otherwise.

Header parameter	Type	Description	Value example
Accept	String	Defines the content types that client is able to accept	application/json
Accept-Language	String	May contain the preferred language for response. Supported language values in eInvoicing solution are “en” and “ar”. If supplied by caller and if supported by the API, system will try to return textual data in language preferred. If not supplied, default system language is used.	ar
Content-type	String	Defines the type of the message. eInvoicing relies on JSON based content.	application/json

These header parameters apply to calls to APIs that require authentication and authorization of the callers.

Header parameter	Type	Description	Value example
Authorization	String	Must contain access token issued prior to this call by identity service.	Bearer <Token value>

These header parameters apply to all calls to all APIs if not explicitly stated otherwise.

Header parameter	Type	Description	Value example
Content-type	String	Defines the type of the message returned. In eInvoicing is is primarily JSON but can also be XML and octet stream for binary content.	application/json
correlationId	String	Defines the unique string value that can be used to track the calls in the system that were made during a single session. Helps in resolving potential problems with integration.	JHDSJ8882POY72SG-2828
X-Rate-Limit-Limit	String	A value representing the configured time limit for this API (examples, 5s, 5m, 5h, 5d, etc …)	5m
X-Rate-Limit-Remaining	Number	A number representing the remaining allowed requests count for this client against API.	2000
X-Rate-Limit-Reset	DateTime	Time in which the count will reset, assuming no further calls were attempted	2020-05-04T12:23:41.6181792Z