For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
      • Management
        • Overview
          • Addresses
          • Authentication
          • Channels
          • Company
          • Invoice Management
              • GETGet Invoice Detail
              • PUTUpdate Invoice
              • DELDelete Invoice
              • GETList Invoices
              • POSTCreate Invoice
              • POSTCreate Invoice from Order
              • GETDownload Invoice PDF
              • GETGet Invoice Extra Field Configs
          • Orders
          • Payment
          • Quotes
          • Sales Staff
          • Shopping List
          • Super Admin
          • Users
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BManagementInvoice ManagementInvoice

Get Invoice Detail

GET
https://api-b2b.bigcommerce.com/api/v3/io/ip/invoices/:invoiceId
GET
/api/v3/io/ip/invoices/:invoiceId
$curl https://api-b2b.bigcommerce.com/api/v3/io/ip/invoices/invoiceId \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "meta": {
3    "message": "Invoice retrieved successfully"
4  },
5  "code": 200,
6  "data": {
7    "id": 12345,
8    "customerId": "CUST-98765",
9    "externalCustomerId": "EXT-COMP-54321",
10    "externalId": "INV-EXT-20240601",
11    "invoiceNumber": "INV-2024-000123",
12    "type": "Standard",
13    "dueDate": 1711929600,
14    "status": 1,
15    "orderNumber": "ORD-2024-456789",
16    "purchaseOrderNumber": "PO-789456123",
17    "details": {
18      "type": "InvoiceDetails",
19      "header": {
20        "costLines": [
21          {
22            "amount": {
23              "code": "USD",
24              "value": "1500.00"
25            },
26            "description": "Subtotal"
27          },
28          {
29            "amount": {
30              "code": "USD",
31              "value": "150.00"
32            },
33            "description": "Tax"
34          },
35          {
36            "amount": {
37              "code": "USD",
38              "value": "50.00"
39            },
40            "description": "Shipping"
41          }
42        ],
43        "orderDate": 1711344000,
44        "billingAddress": {
45          "city": "Austin",
46          "state": "TX",
47          "country": "USA",
48          "street1": "123 Commerce St",
49          "street2": "Suite 400",
50          "zipCode": "78701",
51          "lastName": "Johnson",
52          "firstName": "Emily",
53          "customFields": {
54            "key": "TaxExemptID",
55            "value": "TX123456789"
56          }
57        },
58        "customerFields": {
59          "key": "AccountManager",
60          "value": "Michael Smith"
61        },
62        "shippingAddresses": [
63          {
64            "city": "Austin",
65            "state": "TX",
66            "country": "USA",
67            "street1": "456 Distribution Ave",
68            "street2": "Dock 3",
69            "zipCode": "78702",
70            "lastName": "Johnson",
71            "firstName": "Emily",
72            "customFields": {
73              "key": "DeliveryInstructions",
74              "value": "Leave at loading dock"
75            }
76          }
77        ]
78      },
79      "details": {
80        "shipments": [
81          {
82            "addressIndex": "0",
83            "shipDate": "2024-04-25T10:00:00Z",
84            "shipVia": "FedEx Ground",
85            "trackingNumber": "1234567890FEDX",
86            "comments": "Handle with care",
87            "customFields": {
88              "key": "ShipmentType",
89              "value": "Standard"
90            }
91          }
92        ],
93        "lineItems": [
94          {
95            "sku": "PROD-00123",
96            "type": "Physical",
97            "comments": "Fragile item",
98            "quantity": "10",
99            "unitPrice": {
100              "code": "USD",
101              "value": "150.00"
102            },
103            "description": "Wireless Keyboard",
104            "customFields": {
105              "key": "Warranty",
106              "value": "2 years"
107            },
108            "unitDiscount": {
109              "code": "USD",
110              "value": "10.00"
111            }
112          },
113          {
114            "sku": "PROD-00456",
115            "type": "Physical",
116            "comments": "Includes extra batteries",
117            "quantity": "5",
118            "unitPrice": {
119              "code": "USD",
120              "value": "300.00"
121            },
122            "description": "Wireless Mouse",
123            "customFields": {
124              "key": "Color",
125              "value": "Black"
126            },
127            "unitDiscount": {
128              "code": "USD",
129              "value": "20.00"
130            }
131          }
132        ]
133      }
134    },
135    "isPendingPayment": 1,
136    "source": 0,
137    "originalBalance": {
138      "code": "USD",
139      "value": "1700.00"
140    },
141    "openBalance": {
142      "code": "USD",
143      "value": "500.00"
144    },
145    "customerName": "Corporate Clients Group",
146    "createdAt": "2024-04-01T08:30:00Z",
147    "updatedAt": "2024-04-15T12:00:00Z",
148    "channelId": "CH-1001",
149    "channelName": "Online Store",
150    "termsConditions": "Payment due within 30 days. Late payments subject to 5% fee.",
151    "extraFields": [
152      {
153        "fieldName": "CustomField1",
154        "fieldValue": "CustomValue1"
155      }
156    ]
157  }
158}
get invoice detail
Was this page helpful?
Previous

Invoice Management

Next

Update Invoice

Built with

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

invoiceIdstringRequired
invoice id

Response

OK
metaobject
codedouble
dataobject

Errors

404
Not Found Error