Update Invoice | BigCommerce Developer Center

update an 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. |

Path parameters

invoiceIdstringRequired

Request

customerIdstringOptional>=1 character

B2B Edition Company ID

externalCustomerIdstringOptional>=1 character

Ext Customer ID

externalIdstringOptional>=1 character

Ext Invoice ID

invoiceNumberstringOptional>=1 character

Invoice Number, must be unique

typestringOptional>=1 character

dueDatedoubleOptional

Invoice due date

statusdoubleOptional

invoice status, noted status will be auto set to 2 when open balance is <= 0

purchaseOrderNumberstringOptional>=1 character

PO Number

detailsobjectOptional

Details that will show on the invoice. When updating this field, the new value will completely replace the existing details. To preserve existing details while making updates, retrieve the current details first, and make your edits to that object before submitting the changes.

sourcedoubleOptional

Mark the source of the invoice, 0 for B2B Edition, 1 for external.

originalBalanceobjectOptional

Invoice original balance

openBalanceobjectOptional

Invoice balance awaiting for payment

createdAtintegerOptional

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. To remove an existing PDF link, use an empty string.

extraFieldslist of objectsOptional

Response

codedouble

dataobject

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/ip/invoices/invoiceId"
4
5	payload = {
6	"customerId": "3",
7	"dueDate": 1619826907,
8	"details": {
9	"header": { "costLines": [
10	{
11	"amount": {
12	"code": "USD",
13	"value": "400.0000"
14	},
15	"description": "Subtotal"
16	},
17	{
18	"amount": {
19	"code": "USD",
20	"value": "0.0000"
21	},
22	"description": "Freight"
23	},
24	{
25	"amount": {
26	"code": "USD",
27	"value": "0.0000"
28	},
29	"description": "Sales Tax"
30	}
31	] },
32	"details": { "lineItems": [
33	{
34	"sku": "CLC",
35	"quantity": "2",
36	"unitPrice": {
37	"code": "USD",
38	"value": "200.0000"
39	},
40	"type": "physical",
41	"comments": "item comments",
42	"description": "[Sample] Canvas Laundry Cart",
43	"customFields": {
44	"key": "Back-ordered",
45	"value": "No"
46	}
47	}
48	] }
49	},
50	"openBalance": {
51	"code": "USD",
52	"value": "12.0000"
53	}
54	}
55	headers = {
56	"X-Auth-Token": "<apiKey>",
57	"Content-Type": "application/json"
58	}
59
60	response = requests.put(url, json=payload, headers=headers)
61
62	print(response.json())

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