Skip to main content
POST
/
companies
/
{company_id}
/
invoices
/
find
Find Invoices
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "auto_charges": "<unknown>",
    "billed_customer_id": "<unknown>",
    "currency": "<unknown>",
    "customer_id": "<unknown>",
    "due": {
      "eq": "<unknown>",
      "gt": "<unknown>",
      "gte": "<unknown>",
      "lte": "<unknown>"
    },
    "due_date": {
      "eq": "<unknown>",
      "gte": "<unknown>",
      "lt": "<unknown>",
      "lte": "<unknown>"
    },
    "hide_zero": "<unknown>",
    "invoice_date": {
      "eq": "<unknown>",
      "gte": "<unknown>",
      "lt": "<unknown>",
      "lte": "<unknown>"
    },
    "invoice_number": "<unknown>",
    "invoice_sent": "<unknown>",
    "managed_externally": "<unknown>",
    "owner_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "paid": {
      "eq": "<unknown>",
      "gt": "<unknown>",
      "gte": "<unknown>",
      "lte": "<unknown>"
    },
    "paid_date": {
      "eq": "<unknown>",
      "gte": "<unknown>",
      "lt": "<unknown>",
      "lte": "<unknown>"
    },
    "payment_methods": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_pricing_ids": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_pricing_tags": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "product_tags": {
      "condition": "AND",
      "values": [
        "<string>"
      ]
    },
    "search": "<unknown>",
    "status": "PENDING",
    "statuses": "PENDING",
    "subscription_id": "<unknown>",
    "total": {
      "eq": "<unknown>",
      "gt": "<unknown>",
      "gte": "<unknown>",
      "lte": "<unknown>"
    },
    "uuid": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "auto_charges": true,
      "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": "<unknown>",
          "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": "<unknown>",
            "inherited_from_type": "<unknown>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": "<unknown>",
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "customer_integration_metadata": {},
        "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": "<unknown>",
        "parent_customer_id": "<unknown>",
        "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": "<unknown>",
      "invoice_date": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "number": "<string>",
      "paid": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "paid_date": "<unknown>",
      "pdf_link": "<unknown>",
      "prorated_amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "status": "<string>",
      "sub_total": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "subscription_id": "<unknown>",
      "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

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