Retrieve invoices

curl --request GET \
  --url https://api.spacebring.com/invoices/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "invoices": [
    {
      "prePaymentCreditAmount": 123,
      "postPaymentCreditAmount": 123,
      "amount": 123,
      "company": {
        "billingAddress": "<string>",
        "businessAddress": {
          "city": "<string>",
          "countryCode": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "postalCode": "<string>",
          "state": "<string>"
        },
        "createDate": "2023-11-07T05:31:56Z",
        "credits": {
          "expiring": 123,
          "permanent": 123
        },
        "dayPasses": {
          "expiring": 123
        },
        "deleteDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "legalName": "<string>",
        "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "metadata": {},
        "notes": "<string>",
        "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "taxId": "<string>",
        "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": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "resource": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "title": "<string>",
              "type": "dedicatedDesk"
            }
          },
          "createDate": "2023-11-07T05:31:56Z",
          "creditPackage": {
            "amount": 123
          },
          "currencyCode": "<string>",
          "description": "<string>",
          "discountedAmount": 123,
          "discounts": [
            {
              "coupon": {
                "amountOff": 123,
                "currencyCode": "<string>",
                "percentOff": 123
              }
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "netDiscountedAmount": 123,
          "netUnitAmount": 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
          },
          "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",
      "number": "<string>",
      "pdfUrl": "<string>",
      "status": "canceled",
      "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",
        "refund": {
          "amount": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "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>"
}

GET

invoices

Retrieve invoices

curl --request GET \
  --url https://api.spacebring.com/invoices/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "invoices": [
    {
      "prePaymentCreditAmount": 123,
      "postPaymentCreditAmount": 123,
      "amount": 123,
      "company": {
        "billingAddress": "<string>",
        "businessAddress": {
          "city": "<string>",
          "countryCode": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "postalCode": "<string>",
          "state": "<string>"
        },
        "createDate": "2023-11-07T05:31:56Z",
        "credits": {
          "expiring": 123,
          "permanent": 123
        },
        "dayPasses": {
          "expiring": 123
        },
        "deleteDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "legalName": "<string>",
        "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "metadata": {},
        "notes": "<string>",
        "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "taxId": "<string>",
        "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": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "resource": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "title": "<string>",
              "type": "dedicatedDesk"
            }
          },
          "createDate": "2023-11-07T05:31:56Z",
          "creditPackage": {
            "amount": 123
          },
          "currencyCode": "<string>",
          "description": "<string>",
          "discountedAmount": 123,
          "discounts": [
            {
              "coupon": {
                "amountOff": 123,
                "currencyCode": "<string>",
                "percentOff": 123
              }
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "netDiscountedAmount": 123,
          "netUnitAmount": 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
          },
          "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",
      "number": "<string>",
      "pdfUrl": "<string>",
      "status": "canceled",
      "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",
        "refund": {
          "amount": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "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

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

companyRef

string<uuid>

The id of the company

membershipRef

string<uuid>

The id of the membership

locationRef

string<uuid>

The id of the location.

issueDate

object

The date filter of items.

Show child attributes

issueDate.lte

string<date-time>

Get invoices with less issueDate. Example: issueDate[lte]=2021-05-21T10:00:00Z

issueDate.gte

string<date-time>

Get invoices with greater issueDate. Example: issueDate[gte]=2021-05-21T10:00:00Z

nextPageToken

string<uuid>

The token to get the next page of results

limit

integer<int64>

default:25

The number of items to return

Required range: 1 <= x <= 100

status

enum<string>

The status of an invoice.

Available options:

draft,

issued,

voided,

paid

Response

invoices

object[]

Show child attributes

invoices.prePaymentCreditAmount

number<float>

invoices.postPaymentCreditAmount

number<float>

invoices.amount

number<float>

invoices.company

object

Show child attributes

invoices.company.billingAddress

string

invoices.company.businessAddress

object

Show child attributes

invoices.company.businessAddress.city

string

invoices.company.businessAddress.countryCode

string

invoices.company.businessAddress.line1

string

invoices.company.businessAddress.line2

string

invoices.company.businessAddress.postalCode

string

invoices.company.businessAddress.state

string

invoices.company.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.company.credits

object

Show child attributes

invoices.company.credits.expiring

number

invoices.company.credits.permanent

number

invoices.company.dayPasses

object

Show child attributes

invoices.company.dayPasses.expiring

number

invoices.company.deleteDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.company.id

string

invoices.company.legalName

string

invoices.company.locationRef

string<uuid>

invoices.company.metadata

object

Use to attach key-value data to the object. Available only for admins.

invoices.company.notes

string

invoices.company.subscriptionRef

string<uuid>

invoices.company.taxId

string

invoices.company.title

string

invoices.companyRef

string<uuid>

invoices.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.currencyCode

string

invoices.dueDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.id

string<uuid>

invoices.issueDate

string<date-time>

Datetime when invoice was made ready for payment.

invoices.items

object[]

Show child attributes

invoices.items.amount

number<float>

invoices.items.booking

object

Show child attributes

invoices.items.booking.id

string<uuid>

invoices.items.booking.resource

object

Show child attributes

invoices.items.booking.resource.id

string<uuid>

invoices.items.booking.resource.title

string

invoices.items.booking.resource.type

enum<string>

Available options:

dedicatedDesk,

hotDesk,

office,

parkingLot,

room

invoices.items.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.items.creditPackage

object

Show child attributes

invoices.items.creditPackage.amount

number

invoices.items.currencyCode

string

invoices.items.description

string

invoices.items.discountedAmount

number

invoices.items.discounts

object[]

Show child attributes

invoices.items.discounts.coupon

object

Show child attributes

invoices.items.discounts.coupon.amountOff

number

One of amountOff or percentOff must be present.

invoices.items.discounts.coupon.currencyCode

string

Currency code exists if amountOff is present.

invoices.items.discounts.coupon.percentOff

number

One of amountOff or percentOff must be present.

invoices.items.id

string<uuid>

invoices.items.invoiceRef

string<uuid>

invoices.items.netDiscountedAmount

number

invoices.items.netUnitAmount

number<float>

invoices.items.order

object

Show child attributes

invoices.items.order.id

string<uuid>

invoices.items.order.option

object

Show child attributes

invoices.items.order.option.id

string<uuid>

invoices.items.order.option.name

string

invoices.items.order.product

object

Show child attributes

invoices.items.order.product.id

string<uuid>

invoices.items.order.product.title

string

invoices.items.plan

object

Show child attributes

invoices.items.plan.id

string<uuid>

invoices.items.plan.title

string

invoices.items.quantity

number<integer>

invoices.items.tax

object

Show child attributes

invoices.items.tax.inclusive

boolean

invoices.items.tax.rate

number<float>

invoices.items.ticket

object

Show child attributes

invoices.items.ticket.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.items.ticket.id

string<uuid>

invoices.items.ticket.event

object

Show child attributes

invoices.items.ticket.event.endDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.items.ticket.event.id

string<uuid>

invoices.items.ticket.event.startDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.items.ticket.event.title

string

invoices.items.type

enum<string>

Available options:

booking,

creditPackage,

custom,

eventTicket,

order,

subscriptionItem

invoices.items.unitAmount

number<float>

invoices.locationRef

string<uuid>

invoices.membershipRef

string<uuid>

invoices.number

string

invoices.pdfUrl

string<uri>

invoices.status

enum<string>

Available options:

canceled,

draft,

failed,

issued,

paid,

pending,

processing,

succeeded,

voided

invoices.timezoneId

string

Timezone identifier for the location (e.g. 'Europe/Kyiv')

invoices.transaction

object

Show child attributes

invoices.transaction.amount

number<float>

invoices.transaction.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.transaction.id

string<uuid>

invoices.transaction.paymentMethod

object

Show child attributes

invoices.transaction.paymentMethod.id

string

invoices.transaction.paymentMethod.label

enum<string>

Available options:

American Express,

China UnionPay,

Diners Club,

Discover,

Japan Credit Bureau,

Mastercard,

Unknown,

Visa

invoices.transaction.paymentMethod.type

enum<string>

Available options:

external,

flow,

fondy,

freedompay,

kakaopay,

mercadopago,

paypal,

paystack,

plata,

stripe,

tap,

wayforpay

invoices.transaction.status

enum<string>

Available options:

canceled,

failed,

pending,

processing,

succeeded

invoices.transaction.refund

object

Show child attributes

invoices.transaction.refund.amount

number<float>

invoices.transaction.refund.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

invoices.transaction.refund.id

string<uuid>

invoices.user

object

Show child attributes

invoices.user.about

string

invoices.user.email

string

invoices.user.id

string<uuid>

invoices.user.name

string

invoices.user.phoneNumber

string

invoices.user.photoUrl

string

invoices.user.surname

string

invoices.voidDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

nextPageToken

string

Get comments for a post Create an invoice

⌘I

Getting started

Endpoints

Retrieve invoices

OAuth

Authorizations

Headers

Query Parameters

Response