Invoice API
Get detailed invoice information for orders placed with ABC Supply. Receive invoice history, invoice details, invoice PDFs, and invoice webhooks.
The Get Invoice by Invoice ID endpoint returns invoice information for a specific ABC Supply order. The response includes details from the original order, the accounts associated with the invoice, applicable invoice amounts, and the current payment status of the invoice.
INVOICE API
Get Invoice by Invoice ID
GET /invoice/v1/invoices/{invoiceId}
Get invoice information by invoice ID
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the invoice.read scope.
Request
URI Parameters
The unique identifier {invoiceId} for a specific invoice.
Example Request
Get Invoice by Invoice ID request.
GET /api/invoice/v1/invoices/2007041708-001
HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Get Invoice by Invoice ID response payload.
{
"storeFront": "abc",
"invoiceNumber": "2002683899-001",
"invoiceDate": "2025-11-12T00:00:00.000Z",
"orderNumber": "2002683899",
"orderName": "Test CP 2 Order",
"orderDate": "2025-11-12T00:00:00.000Z",
"purchaseOrderNumber": "123445533",
"salesType": "DELIVERY",
"salesRep": {
"userId": null,
"fullName": "House - Murray"
},
"soldTo": {
"number": "2011865",
"name": "Team Dm Construction",
"addressLine1": "840 N Merno St",
"addressLine2": null,
"addressLine3": null,
"city": "Salt Lake City",
"state": "UT",
"country": "USA",
"postal": "84116-3829"
},
"billTo": {
"number": "2011865-1",
"name": "Team Dm Construction",
"addressLine1": "840 N Merno St",
"addressLine2": null,
"addressLine3": null,
"city": "Salt Lake City",
"state": "UT",
"country": "USA",
"postal": "84116"
},
"shipTo": {
"number": "2011865-2",
"name": "Team Dm Constructionshop",
"addressLine1": "840 N Merno St",
"addressLine2": null,
"addressLine3": null,
"city": "Salt Lake City",
"state": "UT",
"country": "USA",
"postal": "84116"
},
"branch": {
"number": "118",
"name": "118 Murray, UT",
"addressLine1": "5602 S 300 W",
"addressLine2": "PO Box 572545 (zip 84157)",
"city": "Murray",
"state": "UT",
"country": "USA",
"postal": "84107-5901",
"phone": ""
},
"shipment": {
"shipmentDate": "2025-11-12",
"delivery": {
"name": "Test CP 2 Order",
"addressLine1": "300 South Riverside Plaza",
"addressLine2": "Room 123",
"addressLine3": "Bldg. 1 Section 2 Pre Rock",
"city": "Chicago",
"state": "IL",
"country": "USA",
"postal": "60661"
}
},
"subTotal": 137.8,
"taxAmount": 10.54,
"total": 148.34,
"lines": [
{
"id": 1,
"itemNumber": "0170030031",
"itemType": "standard",
"isDimensional": false,
"itemDescription": "0170030031 Paint ABC Roof Acces Dark Brown",
"orderedQty": {
"value": 20,
"uom": "CN"
},
"shippedQty": {
"value": 20,
"uom": "CN"
},
"priceQty": {
"value": 20,
"uom": "CN",
"priceConversionFactor": 1
},
"pricePerUnitAmount": 6.89,
"extendedPriceAmount": 137.8
}
],
"isCreditMemo": false,
"isRebill": false,
"originalInvoiceReference": null,
"creditRebillReason": ""
}Name
Type
Description
storefront
string
The storefront where the order was invoiced (e.g., “abc”, “lw”).
invoiceNumber
string
The unique invoice number for the invoice.
invoiceDate
string
The date the order was invoiced.
orderNumber
string
The order number of the invoiced order.
orderName
string
The order or job name of the invoiced order.
orderDate
string
The date the invoiced order was placed.
purchaseOrderNumber
string
The customer-provided purchase order number of the invoiced order.
salesType
string
The sales type for the order.
salesRep
object
The object describing the sales representative info for the order.
salesRep.userId
string
The unique user ID of the sales representative (null if not assigned).
salesRep.fullName
string
The full name of the sales representative.
soldTo
object
The object describing the customer Sold-To account.
soldTo.number
string
The Sold-To account number.
soldTo.name
string
The Sold-To account name.
soldTo.addressLine1
string
The Sold-To account address line 1.
soldTo.addressLine2
string
The Sold-To account address line 2.
soldTo.addressLine3
string
The Sold-To account address line 3.
soldTo.city
string
The Sold-To account city.
soldTo.state
string
The Sold-To account state.
soldTo.country
string
The Sold-To account country.
soldTo.postal
string
The Sold-To account postal code.
billTo
object
The object describing the customer Bill-To account.
billTo.number
string
The Bill-To account number.
billTo.name
string
The Bill-To account name.
billTo.addressLine1
string
The Bill-To account address line 1.
billTo.addressLine2
string
The Bill-To account address line 2.
billTo.addressLine3
string
The Bill-To account address line 3.
billTo.city
string
The Bill-To account city.
billTo.state
string
The Bill-To account state.
billTo.country
string
The Bill-To account country.
billTo.postal
string
The Bill-To account postal code.
shipTo
object
The object describing the customer Ship-To account.
shipTo.number
string
The Ship-To account number.
shipTo.name
string
The Ship-To account name.
shipTo.addressLine1
string
The Ship-To account address line 1.
shipTo.addressLine2
string
The Ship-To account address line 2.
shipTo.addressLine3
string
The Ship-To account address line 3.
shipTo.city
string
The Ship-To account city.
shipTo.state
string
The Ship-To account state.
shipTo.country
string
The Ship-To account country.
shipTo.postal
string
The Ship-To account postal code.
branch
object
The object describing the ABC Supply branch.
branch.number
string
The ABC Supply branch number.
branch.name
string
The ABC Supply branch name.
branch.addressLine1
string
The ABC Supply branch address line 1.
branch.addressLine2
string
The ABC Supply branch address line 2.
branch.city
string
The ABC Supply branch city.
branch.state
string
The ABC Supply branch state.
branch.country
string
The ABC Supply branch country.
branch.postal
string
The ABC Supply branch postal code.
branch.phone
string
The ABC Supply branch phone number.
shipment
object
The object describing the shipment details.
shipment.shipmentDate
string
The date the order was shipped.
shipment.delivery
object
The object describing the delivery details of the shipment.
shipment.delivery.name
string
The shipment delivery name.
shipment.delivery.addressLine1
string
The shipment delivery address line 1.
shipment.delivery.addressLine2
string
The shipment delivery address line 2.
shipment.delivery.addressLine3
string
The shipment delivery address line 3.
shipment.delivery.city
string
The shipment delivery city.
shipment.delivery.state
string
The shipment delivery state.
shipment.delivery.country
string
The shipment delivery country.
shipment.delivery.postal
string
The shipment delivery postal code.
subTotal
float
The subtotal for the invoice.
taxAmount
float
The tax amount for the invoice.
total
float
The total for the invoice.
lines
array
The list of line items included in the invoice.
lines[].id
integer
The line item id.
lines[].itemNumber
string
The item number for the line item.
lines[].itemType
string
The item type of the line item.
lines[].isDimensional
boolean
A boolean stating whether or not the item is a dimensional item.
lines[].itemDescription
string
The item description of the line item.
lines[].orderedQty
object
The object containing the ordered quantity details for the line item.
lines[].orderedQty.value
integer
The ordered quantity value of the line item.
lines[].orderedQty.uom
string
The ordered quantity unit of measure of the line item.
lines[].shippedQty
object
The object containing the shipped quantity details for the line item.
lines[].shippedQty.value
integer
The shipped quantity value of the line item.
lines[].shippedQty.uom
string
The shipped quantity unit of measure of the line item.
lines[].priceQty
object
The object containing the price quantity details for the line item.
lines[].priceQty.value
float
The price quantity value of the line item.
lines[].priceQty.uom
string
The price quantity unit of measure of the line item.
lines[].priceQty.priceConversionFactor
float
The price quantity price conversion factor of the line item.
lines[].pricePerUnitAmount
float
The price per unit amount of the line item.
lines[].extendedPriceAmount
float
The extended price amount of the line item.
isCreditMemo
boolean
A boolean stating whether or not the invoice is a credit memo.
isRebill
boolean
A boolean stating whether or not the invoice is a rebill for a shipment.
originalInvoiceReference
string
The original invoice number if the order is a credit memo or rebill.
creditRebillReason
string
The provided reason for a rebill invoice, if applicable.
HTTP Status Codes
Code
Status
Description
200
OK
The request and response were successfully sent.
400
Bad Request
Confirm the request body and parameters are formatted correctly.
403
Forbidden
The user account does not have access to view data based on provided request parameters.
404
Not Found
The data requested was not found. Please verify the request parameters are correct.
502
Bad Gateway
The server was unable to complete the request due to upstream errors. Try again shortly.