Get Client Invoices

GET /tms/client-invoice

Description

This endpoint retrieves all client invoices based on the provided filters and query parameters. It supports pagination and various filtering options to refine the search results.

Parameters

• tenantId (string, header, required): The ID of the tenant.
• countryCode (string, header, required): The country code.
• pageNumber (integer, query, optional): The page number for pagination.
• pageSize (integer, query, optional): The number of records per page.
• status (array[string], query, optional): Filter by invoice status.
• orderStatus (array[string], query, optional): Filter by order status.
• clientName (array[string], query, optional): Filter by client name.
• trackingCode (array[string], query, optional): Filter by tracking code.
• searchValue (string, query, optional): A search value to filter invoices.
• startDate (string, query, optional): Filter by start date.
• endDate (string, query, optional): Filter by end date.

Responses

Success Response (200)

The Success Response (200) is returned when the client invoices are successfully retrieved. This response indicates the success of the operation and provides additional details.

Response Fields

Field	Type	Description
status	boolean	Indicates the success of the request.
statusCode	integer	Numeric code representing the status of the response (e.g., 0 for success).
message	string	A message indicating the outcome of the operation.
data	object	Contains the retrieved client invoices.
errors	array	An array of objects providing details about any errors encountered during the request.

Example

JSON:

{
  "status": true,
  "statusCode": 0,
  "message": "Client invoices retrieved successfully",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Media Type

application/json: The response is in JSON format. Error Responses

Invalid Reference (400)

The Invalid Reference (400) response is returned when an invalid reference is supplied in the request.

Not Found (404)

The Not Found (404) response is returned when the requested resource cannot be found.