Create Invoice | BigCommerce Developer Center

Create Invoice

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Request

invoiceNumberstringRequired

Invoice no.

originalBalanceobjectRequired

Original balance

openBalanceobjectRequired

Open balance , when it is <= 0, status will be auto set to 2

customerIdstringRequired

B2B Edition Company ID

typestringOptionalDefaults to Invoice

Invoice type

dueDateintegerOptional

The due date for this invoice, specified as a Unix timestamp. If left empty, it will be set to the current date plus a pre-configured number of days (set in your B2B Edition control panel settings).

statusenumOptional

Invoice status. Possible values: 0: Open (default) 1: Partially paid 2: Completed

The status will automatically be set to Completed (2) when the open balance becomes zero or negative.

Allowed values:

orderNumberstringOptional

BigCommerce order ID associated with this invoice.

purchaseOrderNumberstringOptional

PO Number

issuedAtdoubleOptional

When the invoice was created. The current timestamp is the default.

detailsobjectOptional

Invoice details

sourceenumOptional

The source of the invoice. Possible values: 0: B2B Edition 1: External

Allowed values:

externalIdstringOptional

ERP Invoice ID

externalCustomerIdstringOptional

ERP Customer ID

channelIdintegerOptional

BigCommerce Channel ID

externalPdfUrlstringOptional

The URL of an externally hosted PDF file to be associated with this invoice. The file size must not exceed 5 MB. Ensure that the file hosting service supports Cross-Origin Resource Sharing (CORS) to allow our system to access the file.

termsConditionsstringOptional

Terms & Conditions. Visible on the default Invoice PDF.

extraFieldslist of objectsOptional

Response

codedouble

200

dataobject

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/ip/invoices"
4
5	payload = {
6	"invoiceNumber": "0000001",
7	"originalBalance": {
8	"code": "USD",
9	"value": 100
10	},
11	"openBalance": {
12	"code": "USD",
13	"value": 100
14	},
15	"customerId": "12345",
16	"dueDate": 1619161808,
17	"status": 0,
18	"issuedAt": 1619161808,
19	"details": {
20	"header": {
21	"costLines": [
22	{
23	"amount": {
24	"code": "USD",
25	"value": "90.00"
26	},
27	"description": "Subtotal"
28	},
29	{
30	"amount": {
31	"code": "USD",
32	"value": "10.00"
33	},
34	"description": "Freight"
35	},
36	{
37	"amount": {
38	"code": "USD",
39	"value": "0.00"
40	},
41	"description": "Sales Tax"
42	}
43	],
44	"billingAddress": {
45	"city": "Chengdu",
46	"state": "Sichuan",
47	"country": "China",
48	"street1": "TianFuWuJie",
49	"street2": "",
50	"zipCode": "12345",
51	"lastName": "Test",
52	"firstName": "B2B"
53	},
54	"shippingAddresses": [
55	{
56	"city": "Chengdu",
57	"state": "Sichuan",
58	"country": "China",
59	"street1": "TianFuWuJie",
60	"street2": "",
61	"zipCode": "12345",
62	"lastName": "Test",
63	"firstName": "B2B"
64	}
65	]
66	},
67	"details": { "lineItems": [
68	{
69	"sku": "Test-1",
70	"quantity": "2",
71	"unitPrice": {
72	"code": "USD",
73	"value": "40.00"
74	},
75	"description": "A custom product requires a description."
76	}
77	] }
78	},
79	"channelId": 1
80	}
81	headers = {
82	"X-Auth-Token": "<apiKey>",
83	"Content-Type": "application/json"
84	}
85
86	response = requests.post(url, json=payload, headers=headers)
87
88	print(response.json())

1	{
2	"code": 200,
3	"data": {
4	"id": 12
5	},
6	"meta": {
7	"message": "Success"
8	}
9	}