⬆️Request and Response

Request to the API endpoint

Retrieves a list of orders that meet the specified criteria

GET https://api.alephcrm.com/v2/orders/{orderId}/documents

Query Parameters

Name	Type	Description
API_KEY*	String	(default=none)
accountId *	Integer	(default=none)
documentFormat*	String
documentType*	Integer

200: OK File with the requested invoice

400: Bad Request {"Status": integer, "Message": string}

401: Unauthorized {"Status": integer, "Message": string}

403: Forbidden {"Status": integer, "Message": string}

404: Not Found {"Status": integer, "Message": string}

412: Precondition Failed {"Status": integer, "Message": string}

429: Too Many Requests {"Status": integer, "Message": string}

500: Internal Server Error String

Parameters details

API_KEY

The API_KEY that was provided.

accountId

The Alephee account ID of the documents you are trying to get.

orderId

The Alephee order ID of the documents you are trying to get.

documentType

Specify the requested document type. Available values are: 0 = Invoice 1 = Receipt 2 = Electronic fiscal invoice 7 = Shipping label (not available yet)

documentFormat

Specify the download format of the requested document. Available values are “pdf”, “xml” (without quotes) DO NOT send the documentFormat parameter when using the following document types: 1 = Receipt IT IS MANDATORY to send the documentFormat parameter when using the following document types: 0 = Invoice