Get invoice hypermedia links.

Retrieves only the hypermedia links of an invoice.

PATH:

/v1/clients/{clientId}/invoices/{invoiceNumber}/links

PATH PARAMETERS:

clientId

required

integer

Your assigned clientId.

invoiceNumber

required

string

The invoice number.

RESPONSES:

200 Returned when the invoice links are retrieved successfully.

RESPONSE SCHEMA:

_links

array of _links

Links to other API endpoints which can be used to take actions.

Array () [

method	string HTTP Method.
href	string API Endpoint URL.
rel	string Name of endpoint.
target	string Enum: api browser no description in swagger file

]

401 Returned when the request has a missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type	string no description in swagger file
category	string Enum: BusinessError TechnicalError no description in swagger file
title	string no description in swagger file
message	string no description in swagger file
detail	string There is an error message.
customerFacingMessage	string no description in swagger file

403 Returned when the requester is lacking permissions.

RESPONSE SCHEMA:

type	string no description in swagger file
category	string Enum: BusinessError TechnicalError no description in swagger file
title	string no description in swagger file
message	string no description in swagger file
detail	string There is an error message.
customerFacingMessage	string no description in swagger file

404 Returned when the invoice is not found.

RESPONSE SCHEMA:

type	string no description in swagger file
category	string Enum: BusinessError TechnicalError no description in swagger file
title	string no description in swagger file
message	string no description in swagger file
detail	string There is an error message.
customerFacingMessage	string no description in swagger file

500 Returned when some internal error happens.

RESPONSE SCHEMA:

type	string no description in swagger file
category	string Enum: BusinessError TechnicalError no description in swagger file
title	string no description in swagger file
message	string no description in swagger file
detail	string There is an error message.
customerFacingMessage	string no description in swagger file

Path

get

/v1/clients/{clientId}/invoices/{invoiceNumber}/links

Response samples

200401403404500

              {
                  
"_links": [...{
                              "method": "string",
                            
                              "href": "string",
                            
                              "rel": "string",
                            
                              "target": "string"
                            
}
]
}

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string", 
 "detail": "string", 
 "customerFacingMessage": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string", 
 "detail": "string", 
 "customerFacingMessage": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string", 
 "detail": "string", 
 "customerFacingMessage": "string" 
}
                

            

              {
                   "type": "string", 
 "category": "string", 
 "title": "string", 
 "message": "string", 
 "detail": "string", 
 "customerFacingMessage": "string" 
}
                

            