Get Invoice

GET

companies

{company_id}

invoices

{uuid}

Get Invoice

curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/{uuid} \
  --header 'Authorization: Bearer <token>'

{
  "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_'.

uuid

string

required

The resource UUID

Response

200 - application/json

auto_charges

boolean

Whether the invoice is automatically charged to the payment method on file for the customer

billed_customer_id

string

The billed customer ID for the invoice. This matches the customer_id by default, but can be set to another parent customer ID

created_at

string<date-time>

The date the invoice was created

currency

string

The currency of the invoice

customer

object

The expanded customer details for the invoice

Show child attributes

customer.address

object

The address of the customer

Show child attributes

customer.address.address_line_1

string

customer.address.address_line_2

string

customer.address.city

string

customer.address.country

string

2-character country code (ISO 3166-1 alpha-2)

customer.address.place_id

null | string

customer.address.state

string

customer.address.zip

string

customer.arr

object

The ARR of the customer

Show child attributes

customer.arr.currency

string

customer.arr.value_in_cents

integer<int64>

customer.billing_emails

string[] | null

The additional emails to cc on customer's invoices

customer.company_id

string

The company ID of the customer

customer.computed_entitlements

object[] | null

The computed entitlements for the customer

Show child attributes

customer.computed_entitlements.entitlement_id

string

customer.computed_entitlements.id

string

customer.computed_entitlements.inherited_from_id

null | string

customer.computed_entitlements.inherited_from_type

null | string

customer.computed_entitlements.key

string

customer.computed_entitlements.name

string

customer.computed_entitlements.original_value

any

customer.computed_entitlements.overridden

null | boolean

customer.computed_entitlements.type

string

customer.computed_entitlements.value

any

customer.created_at

string<date-time>

The date the customer was created

customer.customer_integration_metadata

object

Show child attributes

customer.customer_integration_metadata.{key}

object

Show child attributes

customer.customer_integration_metadata.{key}.avalara

object

Show child attributes

customer.customer_integration_metadata.{key}.avalara.entity_code

string

customer.email

string

The email of the customer

customer.exclude_from_metrics

boolean

Whether to exclude this customer and related fields from any metrics in Maple

customer.id

string

The ID of the customer in Maple

customer.identifier

string

The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier

customer.integration_references

object[]

The integration references of this customer in third-party applications connected to Maple

Show child attributes

customer.integration_references.integration_icon

string

customer.integration_references.integration_id

string

customer.integration_references.integration_key

string

customer.integration_references.integration_name

string

customer.integration_references.reference_type

string

customer.integration_references.remote_id

string

customer.integration_references.remote_type

string

customer.locale

string

The locale of the customer

customer.managed_externally

boolean

Whether this customer is managed outside of Maple

customer.metadata

object

The metadata as key-value pairs attached to this customer

customer.mrr

object

The MRR of the customer

Show child attributes

customer.mrr.currency

string

customer.mrr.value_in_cents

integer<int64>

customer.name

string

The name of the customer

customer.org_name

string

The name of the company or the organization this customer is a part of

customer.owner_id

null | string

The company user ID of person in Maple assigned to manage this customer

customer.parent_customer_id

null | string

The customer ID of the parent customer assigned in Maple

customer.phone

string

The phone number of the customer

customer.status

string

The status of the customer such as ACTIVE or ARCHIVED

customer.title

string

The title of the customer, such as CEO, VP

customer.updated_at

string<date-time>

The date the customer was last updated

customer_id

string

The customer ID for the invoice

due

object

The total amount due on the invoice after any payments

Show child attributes

due.currency

string

due.value_in_cents

integer<int64>

due_date

string<date-time>

The date the invoice total is due

hosted_link

null | string

The hosted link for the invoice

invoice_date

string<date-time>

The date for the invoice

name

string

The name of the invoice

number

string

The invoice number for the invoice

paid

object

The total amount paid against the invoice

Show child attributes

paid.currency

string

paid.value_in_cents

integer<int64>

paid_date

null | string<date-time>

The date the invoice was paid

pdf_link

null | string

The PDF link for the invoice

prorated_amount

object

Any prorated amounts for the invoice

Show child attributes

prorated_amount.currency

string

prorated_amount.value_in_cents

integer<int64>

status

string

The status of the invoice such as PAID, DRAFT, VOID or PENDING

sub_total

object

The subtotal of the invoice which is prior to applying credits

Show child attributes

sub_total.currency

string

sub_total.value_in_cents

integer<int64>

subscription_id

null | string

The subscription ID for the invoice, if is not a one-time invoice

total

object

The final total of the invoice after applying all credits, discounts and taxes

Show child attributes

total.currency

string

total.value_in_cents

integer<int64>

updated_at

string<date-time>

The last date the invoice was updated

uuid

string

The unique identifier for the invoice

Update InvoiceUpdate invoice properties by UUID. To update status, refer to specific status update endpoints

⌘I

Get Invoice

curl --request GET \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/{uuid} \
  --header 'Authorization: Bearer <token>'

{
  "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>"
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Response