/billing/invoices

GET

/billing/invoices

const url = 'https://api.chatfood.app/billing/invoices?page=1&size=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.chatfood.app/billing/invoices?page=1&size=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer
ApiKey

Parameters

Query Parameters

accountId

string format: uuid

page

integer format: int32

default: 1

size

integer format: int32

default: 20

Responses

200

object

count

integer format: int64

value

Array<object>

nullable

object

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

categoryCounts

Array<object>

nullable

object

categoryId

string format: uuid

nullable

categoryName

string

nullable

count

integer format: int32

object

count

integer format: int64

value

Array<object>

nullable

object

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

categoryCounts

Array<object>

nullable

object

categoryId

string format: uuid

nullable

categoryName

string

nullable

count

integer format: int32

Example

{
  "value": [
    {
      "status": "Open",
      "basis": "ActiveLeadsEndOfPeriod"
    }
  ]
}

object

count

integer format: int64

value

Array<object>

nullable

object

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

categoryCounts

Array<object>

nullable

object

categoryId

string format: uuid

nullable

categoryName

string

nullable

count

integer format: int32

Example

{
  "value": [
    {
      "status": "Open",
      "basis": "ActiveLeadsEndOfPeriod"
    }
  ]
}