invoice | BigCommerce Developer Center

Get the details of an invoice. Requires IP authentication.

Arguments

invoiceIdIntegerRequired

The invoice id. This field is required.

Returns

an optional Object

idString

createdAtInteger

The created timestamp of the invoice

updatedAtInteger

The updated timestamp of the invoice

storeHashString

The store's store hash

customerIdString

The customer id of the invoice

externalIdString

The external id of the invoice

externalCustomerIdString

The external customer id of the invoice

invoiceNumberString

The invoice number of the invoice

typeString

The type of the invoice

dueDateInteger

The due date of the invoice

statusInteger

The status of the invoice. (0: open, 1: partial paid, 2: completed)

orderNumberString

The order number of the invoice

purchaseOrderNumberString

The purchase order number of the invoice

detailsGenericScalar

The details of the invoice

pendingPaymentCountInteger

The pending payment count of the invoice

sourceInteger

The source of the invoice

originalBalanceObject

The original balance of the invoice

openBalanceObject

The open balance of the invoice

notAllowedPayInteger

Can this invoice allow payment

bcInformationObject

The information of the invoice

extraFieldslist of optional Objects

The extra fields of the invoice

timeOffsetInteger

The time offset

storeInfoObject

The store information

channelIdInteger

The channel id of the invoice

channelNameString

The channel name of the invoice

companyInfoObject

Company information of invoice

orderUserIdInteger

The order user id

1	{
2	"data": {
3	"invoice": {
4	"id": "example",
5	"createdAt": 0,
6	"updatedAt": 0,
7	"storeHash": "example",
8	"customerId": "example",
9	"externalId": "example",
10	"externalCustomerId": "example",
11	"invoiceNumber": "example",
12	"type": "example",
13	"dueDate": 0
14	}
15	}
16	}

1	query ExampleQuery($invoiceId: Int) {
2	invoice(invoiceId: $invoiceId) {
3	id
4	createdAt
5	updatedAt
6	storeHash
7	customerId
8	externalId
9	externalCustomerId
10	invoiceNumber
11	type
12	dueDate
13	}
14	}

1	{
2	"invoiceId": 0
3	}