Retrieve an invoice

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

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

GET

invoices

{id}

Retrieve an invoice

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

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

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

Path Parameters

string<uuid>

required

The id of an invoice.

Response

invoice

object

Show child attributes

invoice.prePaymentCreditAmount

number<float>

invoice.postPaymentCreditAmount

number<float>

invoice.amount

number<float>

invoice.company

object

Show child attributes

invoice.company.billingAddress

string

invoice.company.businessAddress

object

Show child attributes

invoice.company.businessAddress.city

string

invoice.company.businessAddress.countryCode

string

invoice.company.businessAddress.line1

string

invoice.company.businessAddress.line2

string

invoice.company.businessAddress.postalCode

string

invoice.company.businessAddress.state

string

invoice.company.createDate

string<date-time>

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

invoice.company.credits

object

Show child attributes

invoice.company.credits.expiring

number

invoice.company.credits.permanent

number

invoice.company.dayPasses

object

Show child attributes

invoice.company.dayPasses.expiring

number

invoice.company.deleteDate

string<date-time>

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

invoice.company.id

string

invoice.company.legalName

string

invoice.company.locationRef

string<uuid>

invoice.company.metadata

object

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

invoice.company.notes

string

invoice.company.subscriptionRef

string<uuid>

invoice.company.taxId

string

invoice.company.title

string

invoice.companyRef

string<uuid>

invoice.createDate

string<date-time>

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

invoice.currencyCode

string

invoice.dueDate

string<date-time>

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

invoice.id

string<uuid>

invoice.issueDate

string<date-time>

Datetime when invoice was made ready for payment.

invoice.items

object[]

Show child attributes

invoice.items.amount

number<float>

invoice.items.booking

object

Show child attributes

invoice.items.booking.id

string<uuid>

invoice.items.booking.resource

object

Show child attributes

invoice.items.booking.resource.id

string<uuid>

invoice.items.booking.resource.title

string

invoice.items.booking.resource.type

enum<string>

Available options:

dedicatedDesk,

hotDesk,

office,

parkingLot,

room

invoice.items.createDate

string<date-time>

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

invoice.items.creditPackage

object

Show child attributes

invoice.items.creditPackage.amount

number

invoice.items.currencyCode

string

invoice.items.description

string

invoice.items.discountedAmount

number

invoice.items.discounts

object[]

Show child attributes

invoice.items.discounts.coupon

object

Show child attributes

invoice.items.discounts.coupon.amountOff

number

One of amountOff or percentOff must be present.

invoice.items.discounts.coupon.currencyCode

string

Currency code exists if amountOff is present.

invoice.items.discounts.coupon.percentOff

number

One of amountOff or percentOff must be present.

invoice.items.id

string<uuid>

invoice.items.invoiceRef

string<uuid>

invoice.items.netDiscountedAmount

number

invoice.items.netUnitAmount

number<float>

invoice.items.order

object

Show child attributes

invoice.items.order.id

string<uuid>

invoice.items.order.option

object

Show child attributes

invoice.items.order.option.id

string<uuid>

invoice.items.order.option.name

string

invoice.items.order.product

object

Show child attributes

invoice.items.order.product.id

string<uuid>

invoice.items.order.product.title

string

invoice.items.plan

object

Show child attributes

invoice.items.plan.id

string<uuid>

invoice.items.plan.title

string

invoice.items.quantity

number<integer>

invoice.items.tax

object

Show child attributes

invoice.items.tax.inclusive

boolean

invoice.items.tax.rate

number<float>

invoice.items.ticket

object

Show child attributes

invoice.items.ticket.createDate

string<date-time>

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

invoice.items.ticket.id

string<uuid>

invoice.items.ticket.event

object

Show child attributes

invoice.items.ticket.event.endDate

string<date-time>

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

invoice.items.ticket.event.id

string<uuid>

invoice.items.ticket.event.startDate

string<date-time>

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

invoice.items.ticket.event.title

string

invoice.items.type

enum<string>

Available options:

booking,

creditPackage,

custom,

eventTicket,

order,

subscriptionItem

invoice.items.unitAmount

number<float>

invoice.locationRef

string<uuid>

invoice.membershipRef

string<uuid>

invoice.number

string

invoice.pdfUrl

string<uri>

invoice.status

enum<string>

Available options:

canceled,

draft,

failed,

issued,

paid,

pending,

processing,

succeeded,

voided

invoice.timezoneId

string

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

invoice.transaction

object

Show child attributes

invoice.transaction.amount

number<float>

invoice.transaction.createDate

string<date-time>

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

invoice.transaction.id

string<uuid>

invoice.transaction.paymentMethod

object

Show child attributes

invoice.transaction.paymentMethod.id

string

invoice.transaction.paymentMethod.label

enum<string>

Available options:

American Express,

China UnionPay,

Diners Club,

Discover,

Japan Credit Bureau,

Mastercard,

Unknown,

Visa

invoice.transaction.paymentMethod.type

enum<string>

Available options:

external,

flow,

fondy,

freedompay,

kakaopay,

mercadopago,

paypal,

paystack,

plata,

stripe,

tap,

wayforpay

invoice.transaction.status

enum<string>

Available options:

canceled,

failed,

pending,

processing,

succeeded

invoice.transaction.refund

object

Show child attributes

invoice.transaction.refund.amount

number<float>

invoice.transaction.refund.createDate

string<date-time>

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

invoice.transaction.refund.id

string<uuid>

invoice.user

object

Show child attributes

invoice.user.about

string

invoice.user.email

string

invoice.user.id

string<uuid>

invoice.user.name

string

invoice.user.phoneNumber

string

invoice.user.photoUrl

string

invoice.user.surname

string

invoice.voidDate

string<date-time>

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

Create an invoice Pay an invoice

⌘I

Getting started

Endpoints

Retrieve an invoice

OAuth

Authorizations

Headers

Path Parameters

Response