Retrieve invoice by ID

Retrieve an invoice by ID

GET /invoices/{invoiceId}

Retrieve invoice by ID

cURL

curl --request GET \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/invoices/{invoiceId} \
  --header 'x-api-key: <api-key>'

200

{
  "error": false,
  "response": {}
}

Authorizations

x-api-key · string · header · required

Path Parameters

invoiceId · string · required

Query Parameters

rel[public_link] · string

For getting single latest public link for the Invoice

rel[public_links] · string

For getting all public links for the Invoice

Response

200

application/json

Successful response

error · boolean

false when the request succeeds.

Example:

false

response · object

The requested record.