Account API
Access your account information, including account hierarchies, billing and shipping addresses, contacts and other key customer attributes. The Account API lets you update jobsite contacts, so key team members receive pertinent delivery updates.
Get Bill-To endpoint returns bill-to account information, such as name, number, addresses, default branches, and sold-to account information. You can specify the bill-to account number in the resource URL.
Account API
Get Bill-To
GET /billtos/{billToNumber}
Get bill-to account details by bill-to account number
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the account.read scope.
Request
Example Request
Sample request for a given Bill-to.
URI Parameter
The URI parameter “{billToNumber}” is the bill-to account number.
GET /api/account/v1/billtos/298462 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN> Response
Example Response
Sample response for a given bill-to.
{
"billTo": {
"name": "ABC Billing Center",
"number": "12345678-1",
"status": "active",
"address": {
"line1": "1 ABC Parkway",
"line2": "Billing Center Building",
"line3": "",
"city": " Beloit",
"state": "WI",
"postal": "53511",
"country": "USA"
},
"billingInstructions": [
{
"code": "N",
"description": "Do not print on the invoice"
}
],
"branches": [
{
"number": "409",
"name": "ABC Supply - Hyattsville, UT",
"storefront": "ABC",
"status": "active",
"type": "PRIMARY",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/409"
}
},
{
"number": "030",
"name": "ABC Supply - Aurora, IL",
"storefront": "ABC",
"status": "active",
"type": "APPROVED",
"links": {
"self": "https://partners.abcsupply.com/mock/location/v1/branches/030"
}
}
],
"soldTo": {
"number": "12345678",
"name": "ABC CONSTRUCTION",
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/api/accounts/v1/soldtos/12345678"
}
}
}
}Name
Type
Description
billTo
array
The object describing the Bill-to account information.
billTo.name
string
The name of the Bill-to account.
billTo.number
string
The unique identification number of the Bill-to account.
billTo.status
string
The current status of the Bill-to account (e.g., “active”, “inactive”).
billTo.address
object
The object describing the Bill-to account address.
billTo.address.line1
string
The first line of the Bill-to address, usually including the street number and name.
billTo.address.line2
string
The second line of the Bill-to address, usually including the street number and name.
billTo.address.line3
string
The third line of the Bill-to address, usually including the street number and name.
billTo.address.city
string
The city of the Bill-to address.
billTo.address.state
string
The state of the Bill-to address.
billTo.address.postal
object
The zip code of the Bill-to address.
billTo.address.country
string
The country of the Bill-to address.
billTo.billingInstruction
array
The object describing the billing instructions for the Bill-to account.
billTo.billingInstruction[].code
string
The code for the billing instruction.
billTo.billingInstruction[].description
string
The description of the billing instruction.
billTo.branches
array
The list of information about the Bill-to ABC Supply branches.
billTo.branches[].number
string
The ABC Supply branch number.
billTo.branches[].name
string
The name of the branch.
billTo.branches[].storefront
string
The physical storefront or location of the branch (e.g., “ABC”).
billTo.branches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
billTo.branches[].type
string
The specific type of the branch (e.g., “PRIMARY”, “APPROVED”).
billTo.branches[].links
object
The object describing the link to the ABC Supply branch details.
billTo.branches[].links.self
string
The URL of the self-referencing link to the branch details.
billTo.soldTo
object
The object describing the Sold-to account information of the Bill-to account.
billTo.soldTo.number
string
The Sold-to account number.
billTo.soldTo.name
string
The name of the Sold-to account.
billTo.soldTo.status
string
The current status of the Sold-to account (e.g. “active”, “inactive”).
billTo.soldTo.links
object
The object describing the link to the Sold-to account details.
billTo.soldTo.links.self
string
The URL of the self-referencing link to the Sold-to account details.
HTTP Status Codes
Name
Type
Description
400
Bad Request
Check the Request to make sure the Request Body and Parameters are passed correctly based on the API documentation.
404
Object Not Found
The request returned empty or no object. Please check the object identifier.