List Bills

curl --request GET \
  --url https://api.meow.com/v1/bills \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.meow.com/v1/bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.meow.com/v1/bills"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.meow.com/v1/bills")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.meow.com/v1/bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

const url = 'https://api.meow.com/v1/bills';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.meow.com/v1/bills");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.meow.com/v1/bills")
  .get()
  .addHeader("x-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.meow.com/v1/bills")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

{
  "bills": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "CANCELED",
      "vendor_name": "<string>",
      "creation_source": "USER",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "invoice_number": "<string>",
      "description": "<string>",
      "memo": "<string>",
      "bill_date": "2023-12-25",
      "bill_due_date": "2023-12-25",
      "bill_total": "<string>",
      "currency": "AED",
      "payment_type": "ACH",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "submitted_at": "2023-11-07T05:31:56Z",
      "submitted_by": "<string>",
      "paid_at": "2023-11-07T05:31:56Z",
      "paid_by": "<string>",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "canceled_by": "<string>",
      "bill_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ordinal": 123
    }
  ],
  "page": {
    "nextOffset": "qwer123454q2f"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

bills

List Bills

curl --request GET \
  --url https://api.meow.com/v1/bills \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.meow.com/v1/bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.meow.com/v1/bills"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.meow.com/v1/bills")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.meow.com/v1/bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

const url = 'https://api.meow.com/v1/bills';
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.meow.com/v1/bills");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.meow.com/v1/bills")
  .get()
  .addHeader("x-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.meow.com/v1/bills")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

{
  "bills": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "CANCELED",
      "vendor_name": "<string>",
      "creation_source": "USER",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "invoice_number": "<string>",
      "description": "<string>",
      "memo": "<string>",
      "bill_date": "2023-12-25",
      "bill_due_date": "2023-12-25",
      "bill_total": "<string>",
      "currency": "AED",
      "payment_type": "ACH",
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "submitted_at": "2023-11-07T05:31:56Z",
      "submitted_by": "<string>",
      "paid_at": "2023-11-07T05:31:56Z",
      "paid_by": "<string>",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "canceled_by": "<string>",
      "bill_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ordinal": 123
    }
  ],
  "page": {
    "nextOffset": "qwer123454q2f"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id

string<uuid>

Optional entity_id to scope requests to a specific entity.

Query Parameters

statuses

enum<string>[] | null

Filter to one or more bill statuses, as a list. Omit to return every status.

Available options:

CANCELED,

DRAFT_PROCESSING,

DRAFT,

PAYMENT_INFO_NEEDED,

PENDING,

APPROVED,

REJECTED,

SCHEDULED,

PAYMENT_INITIATED,

PAYMENT_DELIVERED,

PAYMENT_FAILED,

PAYMENT_CANCELED

contact_id

string<uuid>[] | null

Filter to one or more vendor contacts, as a list. Use list_contacts to find contact IDs.

amount_min

Only return bills with a total at or above this amount.

amount_max

Only return bills with a total at or below this amount.

bill_date_from

string<date> | null

Only return bills dated on or after this date.

bill_date_to

string<date> | null

Only return bills dated on or before this date.

due_date_from

string<date> | null

Only return bills due on or after this date.

due_date_to

string<date> | null

Only return bills due on or before this date.

string | null

Free-text search over vendor name and bill number.

sort_by

enum<string> | null

Field to sort by. Defaults to the bill's due date.

Available options:

VENDOR_NAME,

STATUS,

AMOUNT,

PAYMENT_DATE,

BILL_DATE,

CREATED_TIME,

BILL_DUE_DATE,

INVOICE_NUMBER,

DESCRIPTION,

PAYMENT_TYPE,

CATEGORY

sort_descending

boolean

default:false

Sort descending instead of ascending.

limit

integer

default:10

Maximum number of results to return.

Required range: 1 <= x <= 100

offset

string | null

Opaque offset identifier for pagination. Use the nextOffset from a previous response.

Maximum string length: 100

Response

Successful Response

bills

BillSummaryResponse · object[]

required

List of bills.

Show child attributes

page

PageMetadata · object | null

Pagination metadata.

Show child attributes

⌘I

Overview

Core API

Billing

Billpay

Onboarding

Partner Onboarding

Partner Webhooks

Webhooks

Global Webhooks

Sandbox

List Bills

Authorizations

Headers

Query Parameters

Response