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>'

import requests

url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/invoices/{invoiceId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/invoices/{invoiceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

401

{
  "message": "Unauthorized"
}

{
  "message": "Request URL or object not found"
}

{
  "message": "Internal Server Error"
}

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