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 '{
  "include_meta": true,
  "pagination": {
    "from_key": "<string>",
    "limit": 20
  },
  "query": {
    "auto_charges": true,
    "billed_customer_id": "<string>",
    "currency": "<string>",
    "customer_id": "<string>",
    "due": {
      "eq": 123,
      "gte": 123,
      "lte": 123
    },
    "due_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "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",
      "lte": "2023-11-07T05:31:56Z"
    },
    "invoice_number": "<string>",
    "invoice_sent": true,
    "managed_externally": true,
    "paid": {
      "eq": 123,
      "gte": 123,
      "lte": 123
    },
    "paid_date": {
      "eq": "2023-11-07T05:31:56Z",
      "gte": "2023-11-07T05:31:56Z",
      "lte": "2023-11-07T05:31:56Z"
    },
    "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": "<string>",
    "status": "PENDING",
    "statuses": [
      "<string>"
    ],
    "subscription_id": "<string>",
    "total": {
      "eq": 123,
      "gte": 123,
      "lte": 123
    },
    "uuid": "<string>"
  },
  "sort_key": "createdAtDesc"
}'
{
  "pagination": {
    "from_key": "<string>",
    "limit": 123
  },
  "results": [
    {
      "auto_charges": true,
      "billed_customer_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "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
      },
      "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

Company ID. It should have a prefix 'cmp_'.

Body

application/json

Response

200 - application/json

OK

The response is of type object.