Retrieve an invoice

GET

invoices

{id}

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

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

Authorizations

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string

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

Path Parameters

string

required

The id of an invoice.

Response

200

application/json

invoice

object

invoice.amount

number

invoice.company

object

invoice.companyRef

string

invoice.createDate

string

invoice.currencyCode

string

invoice.dueDate

string

invoice.id

string

invoice.issueDate

string

Datetime when invoice was made ready for payment.

invoice.items

object[]

invoice.locationRef

string

invoice.membershipRef

string

invoice.netAmount

number

invoice.number

string

invoice.pdfUrl

string

invoice.status

enum<string>

Available options:

canceled,

draft,

failed,

issued,

paid,

pending,

processing,

succeeded,

voided

invoice.taxAmount

number

invoice.timezoneId

string

invoice.transaction

object

invoice.user

object

invoice.voidDate

string

Create an invoice Pay an invoice

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

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

Getting Started

Endpoints

OAuth

Authorizations

Headers

Path Parameters

Response