Restaurant - Invoice

InvoiceController_findAll

GET

/restaurant/invoices

const url = 'https://api.inspow.tech/api/v1/restaurant/invoices?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D';
const options = {method: 'GET'};

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.inspow.tech/api/v1/restaurant/invoices?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D'

Parameters

Query Parameters

limit

required

number

Example

Number of items to return

offset

required

number

Example

Number of items to skip

sortBy

string

Example

createdAt

Field to sort the results (Deprecated, use sort instead)

sortOrder

string

Example

asc

Sort direction, either asc or desc (Deprecated, use sort instead)

searchQuery

string

Query search to filter items

query

string

Query to filter items in MongoDB query format

sort

string

Example

{"lastName": -1, "email": 1}

JSON string specifying sorting fields and order (e.g. { “lastName”: -1, “email”: 1 })

Responses

200

application/json

object

invoiceCode

required

Unique code for the invoice, e.g., INV-000123.

string

status

Status of the payment.

string

default: PENDING

Allowed values: PAID PENDING FAILED REVIEW

subscription

required

The ID of the subscription this invoice covers.

string

plan

required

The ID of the subscription this invoice covers.

string

dueDate

required

The due date for the invoice payment.

string format: date-time

paidAt

required

The timestamp when the invoice was paid.

string format: date-time

amount

required

Amount billed in this invoice.

number

paymentMethod

required

Payment method used for this invoice.

string

Allowed values: wompi_nequi wompi_pse stripe_card manual_transfer

businessDaysCount

Número de días hábiles facturados (solo para pricing per_business_day)

number

pricePerDay

Precio por día usado en el cálculo (solo para pricing per_business_day)

number

Example

{
  "invoiceCode": "INV-000123",
  "status": "PAID",
  "subscription": "645cc3d3f8a9c9a2b88a22f1",
  "plan": "645cc3d3f8a9c9a2b88a22f1",
  "dueDate": "2023-11-26T00:00:00.000Z",
  "paidAt": "2023-11-26T00:00:00.000Z",
  "amount": 45000,
  "paymentMethod": "wompi_nequi",
  "businessDaysCount": 20,
  "pricePerDay": 14000
}