Skip to main content

Get Client Invoice

GET /tms/client-invoice/{clientInvoiceUuid}

Description​

This endpoint is used to retrieve the details of a single client invoice using the unique client invoice UUID.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code.
  • clientInvoiceUuid (string, path, required): The UUID of the client invoice.

Responses​

Success Response (200)​

The Success Response (200) is returned when the client invoice details are successfully retrieved. This response provides the status, message, and data related to the client invoice.

Media Type​

  • Controls Accept header.

Example Value​

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

Error Responses​

Invalid client invoice id reference supplied (400)

The Invalid client invoice id reference supplied (400) response indicates that the client invoice UUID provided is invalid.

Resource not found (404)​

The Resource not found (404) response indicates that the client invoice resource could not be found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/client-invoice/{clientInvoiceUuid} \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!