Snapbooks API

Vendor

Create

Create Vendor Attributes:  * required  * conditionally required

Parameter Data Type Description
 * fullName string Name of the Vendor
* phone string Primary contact Phone number
* email string Primary Email address
* billingAddress string Billing Address 1
* billingAddressTwo string Billing Address 2
* billingCity string Billing City
* billingState string Billing State / Country SubDivision Code
* billingZip string Billing Zip/ Postal Code
* billingCountry string Billing County
notes string Notes about the Vendor

Request

curl -X "POST" "https://snapbooksapi.com/api/v1/vendor" \
     -H 'X-Api-Key: xxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "fullName": "Holland Mutual",
  "phone": "4052321663",
  "email": "mail@email.com",
  "billingAddress": "5512 S. Broadway",
  "billingAddressTwo": "Suite 33",
  "billingCity": "Los Angeles",
  "billingState": "CA",
  "billingZip": "91392",
  "billingCountry":"USA",
  "notes":"This is the prefered Vendor for New Products"
}'

Response

{
  "success": true,
  "type": "Operation",
  "message": "",
  "details": [],
  "id": "62",
  "alreadyExisted": false
}

Update

Update Vendor Attributes: * required * conditionally required

Parameter Data Type Description
* vendorId string Vendor ID in QuickBooks SELECT * FROM Vendor
* fullName string Name of the Vendor
* phone string Primary contact Phone Number
* email string Primary Email address
* billingAddress string Billing Address 1
* billingAddressTwo string Billing Address 2
* billingCity string Billing City
* billingState string Billing State / Country SubDivision Code
* billingZip string Billing Zip/ Postal Code
billingCountry string Billing Country
notes string Notes about the Vendor

Request

curl -X "PUT" "https://snapbooksapi.com/api/v1/vendor" \
     -H 'X-Api-Key: xxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  'vendorId': "45"
  "fullName": "Holland Mutual",
  "phone": "4052321663",
  "email": "mail@email.com",
  "billingAddress": "5512 S. Broadway",
  "billingAddressTwo": "Suite 33",
  "billingCity": "Los Angeles",
  "billingState": "CA",
  "billingZip": "91392",
  "billingCountry": "USA",
  "notes": "Vendor Payment on hold until credit check validated"
}'

Response

{
  "success": true,
  "type": "Operation",
  "message": "",
  "details": [],
}

Create Credit

Create Vendor Credit Attributes: * required * conditionally required

Parameter Data Type Description
* transactionDate string Date of Vendor Credit
* vendorId number Vendor ID
SELECT * FROM Vendor
* docNumber string Document number
* lineItems array Line items defined below

Create Vendor Credit - Line Items Attributes: * required * conditionally required

Parameter Data Type Description
* amount number Amount of Vendor Credit line item
* accountId number Account ID
SELECT * FROM Account
* classId number ClassiD /You will need to do a lookup to get the classID
SELECT * FROM Class
description string Description of the Vendor Credit

Request

curl -X "POST" "https://snapbooksapi.com/api/v1/vendor-credit" \
     -H 'X-Api-Key: xxx' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{   
  "transactionDate": "03/04/2019",
  "vendorId": 62,
  "docNumber": "AP-123456",
  "lineItems": [
    {
      "amount": 10,
      "accountId": 11,
      "classId": 5000000000000112000,
      "description": "My Vendor Credit Description"
    }
  ]
}'

Response

{
  "success": true,
  "type": "Operation",
  "message": "",
  "details": [],
  "id": "147"
}

← Bills →