Skip to main content
POST
/
companies
/
{company_id}
/
invoices
/
find
Find Invoices
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "auto_charges": true,
    "billed_customer_id": "<string>",
    "currency": "<string>",
    "customer_id": "<string>",
    "due": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "due_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "hide_zero": true,
    "invoice_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "invoice_number": "<string>",
    "invoice_sent": true,
    "managed_externally": true,
    "paid": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "paid_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lt": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "search": "<string>",
    "subscription_id": "<string>",
    "total": {
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lte": 123
    },
    "uuid": "<string>"
  },
  "sort_key": "createdAtDesc"
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find"

payload = {
"pagination": {
"from_key": "<string>",
"limit": 20
},
"include_meta": True,
"query": {
"auto_charges": True,
"billed_customer_id": "<string>",
"currency": "<string>",
"customer_id": "<string>",
"due": {
"eq": 123,
"gt": 123,
"gte": 123,
"lte": 123
},
"due_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"hide_zero": True,
"invoice_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"invoice_number": "<string>",
"invoice_sent": True,
"managed_externally": True,
"paid": {
"eq": 123,
"gt": 123,
"gte": 123,
"lte": 123
},
"paid_date": {
"eq": "2023-11-07T05:31:56Z",
"gte": "2023-11-07T05:31:56Z",
"lt": "2023-11-07T05:31:56Z",
"lte": "2023-11-07T05:31:56Z"
},
"search": "<string>",
"subscription_id": "<string>",
"total": {
"eq": 123,
"gt": 123,
"gte": 123,
"lte": 123
},
"uuid": "<string>"
},
"sort_key": "createdAtDesc"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pagination: {from_key: '<string>', limit: 20},
include_meta: true,
query: {
auto_charges: true,
billed_customer_id: '<string>',
currency: '<string>',
customer_id: '<string>',
due: {eq: 123, gt: 123, gte: 123, lte: 123},
due_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
hide_zero: true,
invoice_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
invoice_number: '<string>',
invoice_sent: true,
managed_externally: true,
paid: {eq: 123, gt: 123, gte: 123, lte: 123},
paid_date: {
eq: '2023-11-07T05:31:56Z',
gte: '2023-11-07T05:31:56Z',
lt: '2023-11-07T05:31:56Z',
lte: '2023-11-07T05:31:56Z'
},
search: '<string>',
subscription_id: '<string>',
total: {eq: 123, gt: 123, gte: 123, lte: 123},
uuid: '<string>'
},
sort_key: 'createdAtDesc'
})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pagination' => [
'from_key' => '<string>',
'limit' => 20
],
'include_meta' => true,
'query' => [
'auto_charges' => true,
'billed_customer_id' => '<string>',
'currency' => '<string>',
'customer_id' => '<string>',
'due' => [
'eq' => 123,
'gt' => 123,
'gte' => 123,
'lte' => 123
],
'due_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'hide_zero' => true,
'invoice_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'invoice_number' => '<string>',
'invoice_sent' => true,
'managed_externally' => true,
'paid' => [
'eq' => 123,
'gt' => 123,
'gte' => 123,
'lte' => 123
],
'paid_date' => [
'eq' => '2023-11-07T05:31:56Z',
'gte' => '2023-11-07T05:31:56Z',
'lt' => '2023-11-07T05:31:56Z',
'lte' => '2023-11-07T05:31:56Z'
],
'search' => '<string>',
'subscription_id' => '<string>',
'total' => [
'eq' => 123,
'gt' => 123,
'gte' => 123,
'lte' => 123
],
'uuid' => '<string>'
],
'sort_key' => 'createdAtDesc'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find"

payload := strings.NewReader("{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"include_meta\": true,\n \"query\": {\n \"auto_charges\": true,\n \"billed_customer_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"due\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"due_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"hide_zero\": true,\n \"invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"invoice_number\": \"<string>\",\n \"invoice_sent\": true,\n \"managed_externally\": true,\n \"paid\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"paid_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"search\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"total\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"uuid\": \"<string>\"\n },\n \"sort_key\": \"createdAtDesc\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"include_meta\": true,\n \"query\": {\n \"auto_charges\": true,\n \"billed_customer_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"due\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"due_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"hide_zero\": true,\n \"invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"invoice_number\": \"<string>\",\n \"invoice_sent\": true,\n \"managed_externally\": true,\n \"paid\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"paid_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"search\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"total\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"uuid\": \"<string>\"\n },\n \"sort_key\": \"createdAtDesc\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/find")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pagination\": {\n \"from_key\": \"<string>\",\n \"limit\": 20\n },\n \"include_meta\": true,\n \"query\": {\n \"auto_charges\": true,\n \"billed_customer_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"due\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"due_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"hide_zero\": true,\n \"invoice_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"invoice_number\": \"<string>\",\n \"invoice_sent\": true,\n \"managed_externally\": true,\n \"paid\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"paid_date\": {\n \"eq\": \"2023-11-07T05:31:56Z\",\n \"gte\": \"2023-11-07T05:31:56Z\",\n \"lt\": \"2023-11-07T05:31:56Z\",\n \"lte\": \"2023-11-07T05:31:56Z\"\n },\n \"search\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"total\": {\n \"eq\": 123,\n \"gt\": 123,\n \"gte\": 123,\n \"lte\": 123\n },\n \"uuid\": \"<string>\"\n },\n \"sort_key\": \"createdAtDesc\"\n}"

response = http.request(request)
puts response.read_body
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "auto_charges": true,
      "billed_customer": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "arr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "billing_emails": [
          "<string>"
        ],
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "customer_integration_metadata": {},
        "display_name": "<string>",
        "email": "<string>",
        "exclude_from_metrics": true,
        "id": "<string>",
        "identifier": "<string>",
        "integration_references": [
          {
            "integration_icon": "<string>",
            "integration_id": "<string>",
            "integration_key": "<string>",
            "integration_name": "<string>",
            "reference_type": "<string>",
            "remote_id": "<string>",
            "remote_type": "<string>"
          }
        ],
        "locale": "<string>",
        "managed_externally": true,
        "metadata": {},
        "mrr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "name": "<string>",
        "org_name": "<string>",
        "owner_id": "<string>",
        "parent_customer_id": "<string>",
        "phone": "<string>",
        "status": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "billed_customer_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "customer": {
        "address": {
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "place_id": "<string>",
          "state": "<string>",
          "zip": "<string>"
        },
        "arr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "billing_emails": [
          "<string>"
        ],
        "company_id": "<string>",
        "computed_entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "customer_integration_metadata": {},
        "display_name": "<string>",
        "email": "<string>",
        "exclude_from_metrics": true,
        "id": "<string>",
        "identifier": "<string>",
        "integration_references": [
          {
            "integration_icon": "<string>",
            "integration_id": "<string>",
            "integration_key": "<string>",
            "integration_name": "<string>",
            "reference_type": "<string>",
            "remote_id": "<string>",
            "remote_type": "<string>"
          }
        ],
        "locale": "<string>",
        "managed_externally": true,
        "metadata": {},
        "mrr": {
          "currency": "<string>",
          "value_in_cents": 123
        },
        "name": "<string>",
        "org_name": "<string>",
        "owner_id": "<string>",
        "parent_customer_id": "<string>",
        "phone": "<string>",
        "status": "<string>",
        "title": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "customer_id": "<string>",
      "due": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "due_date": "2023-11-07T05:31:56Z",
      "hosted_link": "<string>",
      "invoice_date": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "number": "<string>",
      "paid": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "paid_date": "2023-11-07T05:31:56Z",
      "pdf_link": "<string>",
      "prorated_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "refunded_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "revenue": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "status": "<string>",
      "sub_total": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "subscription_id": "<string>",
      "total": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
pagination
object
required

The pagination parameters for the request

include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

query
object | null

The find criteria for the invoice

sort_key
enum<string>
default:createdAtDesc
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc,
aToZ,
zToA,
invoiceDateAsc,
invoiceDateDesc,
dueDateAsc,
dueDateDesc,
totalAmountAsc,
totalAmountDesc

Response

200 - application/json

OK

pagination
object
results
object[] | null