Invoices
Retrieve invoices
Getting Started
Endpoints
- Benefit Applications
- Benefits
- Bookings
- Companies
- Event Tickets
- Feed Posts
- Invoices
- Invoice Items
- Locations
- Memberships
- Networks
- Orders
- Plans
- Products
- Resources
- Subscriptions
- Support Tickets
- Transactions
- Visitors
Invoices
Retrieve invoices
Retrieve all invoices based on certain parameters.
OAuth
Required scopes:invoices.readonly
or invoices
GET
/
invoices
/
v1
curl --request GET \
--url https://api.spacebring.com/invoices/v1 \
--header 'Authorization: Basic <encoded-value>'
{
"invoices": [
{
"amount": 123,
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issueDate": "2023-11-07T05:31:56Z",
"items": [
{
"amount": 123,
"booking": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "dedicatedDesk"
},
"startDate": "2023-11-07T05:31:56Z"
},
"createDate": "2023-11-07T05:31:56Z",
"creditPackage": {
"amount": 123
},
"currencyCode": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netAmount": 123,
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"quantity": 123,
"tax": {
"inclusive": true,
"rate": 123
},
"taxAmount": 123,
"ticket": {
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "2023-11-07T05:31:56Z",
"title": "<string>"
}
},
"type": "booking",
"unitAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netAmount": 123,
"number": "<string>",
"pdfUrl": "<string>",
"status": "canceled",
"taxAmount": 123,
"timezoneId": "<string>",
"transaction": {
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": {
"id": "<string>",
"label": "American Express",
"type": "external"
},
"status": "canceled"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"voidDate": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>"
}
Authorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Query Parameters
The id of the company
The id of the membership
The id of the location.
The token to get the next page of results
The number of items to return
Required range:
1 < x < 100
The status of an invoice.
Available options:
draft
, issued
, voided
, paid
Response
200
application/json
OK
Datetime when invoice was made ready for payment.
Available options:
booking
, creditPackage
, custom
, eventTicket
, order
, subscriptionItem
Available options:
canceled
, draft
, failed
, issued
, paid
, pending
, processing
, succeeded
, voided
Available options:
American Express
, China UnionPay
, Diners Club
, Discover
, Japan Credit Bureau
, Mastercard
, Unknown
, Visa
Available options:
external
, flow
, fondy
, freedompay
, kakaopay
, mercadopago
, paypal
, paystack
, plata
, stripe
, tap
, wayforpay
Available options:
canceled
, failed
, pending
, processing
, succeeded
curl --request GET \
--url https://api.spacebring.com/invoices/v1 \
--header 'Authorization: Basic <encoded-value>'
{
"invoices": [
{
"amount": 123,
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issueDate": "2023-11-07T05:31:56Z",
"items": [
{
"amount": 123,
"booking": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "dedicatedDesk"
},
"startDate": "2023-11-07T05:31:56Z"
},
"createDate": "2023-11-07T05:31:56Z",
"creditPackage": {
"amount": 123
},
"currencyCode": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netAmount": 123,
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"quantity": 123,
"tax": {
"inclusive": true,
"rate": 123
},
"taxAmount": 123,
"ticket": {
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "2023-11-07T05:31:56Z",
"title": "<string>"
}
},
"type": "booking",
"unitAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netAmount": 123,
"number": "<string>",
"pdfUrl": "<string>",
"status": "canceled",
"taxAmount": 123,
"timezoneId": "<string>",
"transaction": {
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": {
"id": "<string>",
"label": "American Express",
"type": "external"
},
"status": "canceled"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"voidDate": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>"
}