QuickBooks Online

Manage invoices, customers, payments, and accounts with the QuickBooks Online API.

Create a QuickBooks customer

Create a new customer in QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`display_name`	string	Yes	Customer display name (must be unique)
`given_name`	string	No	Customer first name
`family_name`	string	No	Customer last name
`email`	string	No	Customer email address
`phone`	string	No	Customer phone number
`company_name`	string	No	Customer company name

Response

{
  "Customer": {
    "DisplayName": "New Customer",
    "Id": "123",
    "PrimaryEmailAddr": {
      "Address": "new@example.com"
    }
  }
}

Create a QuickBooks invoice

Create a new invoice in QuickBooks Online with a single line item.

Parameters

Parameter	Type	Required	Description
`customer_id`	string	Yes	QuickBooks customer ID to invoice
`line_amount`	number	Yes	Line item amount
`line_description`	string	No	Line item description
`item_id`	string	No	QuickBooks item (product/service) ID for the line
`due_date`	string	No	Invoice due date (YYYY-MM-DD)
`email_to`	string	No	Email address to send the invoice to

Response

{
  "Invoice": {
    "Balance": 250.0,
    "DocNumber": "1002",
    "Id": "200",
    "TotalAmt": 250.0
  }
}

Create a QuickBooks payment

Record a payment in QuickBooks Online, optionally linked to an invoice.

Parameters

Parameter	Type	Required	Description
`customer_id`	string	Yes	QuickBooks customer ID
`total_amount`	number	Yes	Payment amount
`invoice_id`	string	No	QuickBooks invoice ID to apply the payment to

Response

{
  "Payment": {
    "Id": "300",
    "TotalAmt": 100.0
  }
}

Get a QuickBooks customer

Retrieve a single customer by ID from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`customer_id`	string	Yes	QuickBooks customer ID

Response

{
  "Customer": {
    "DisplayName": "Acme Corp",
    "Id": "1",
    "PrimaryEmailAddr": {
      "Address": "info@acme.com"
    }
  }
}

Get a QuickBooks invoice

Retrieve a single invoice by ID from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`invoice_id`	string	Yes	QuickBooks invoice ID

Response

{
  "Invoice": {
    "Balance": 500.0,
    "DocNumber": "1001",
    "Id": "100",
    "TotalAmt": 500.0
  }
}

List QuickBooks accounts

List accounts (Chart of Accounts) from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of accounts to return (default 100)

Response

{
  "QueryResponse": {
    "Account": [
      {
        "AccountType": "Bank",
        "Id": "1",
        "Name": "Checking"
      },
      {
        "AccountType": "Accounts Receivable",
        "Id": "2",
        "Name": "Accounts Receivable"
      }
    ],
    "maxResults": 2,
    "startPosition": 1
  }
}

List QuickBooks customers

List customers from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of customers to return (default 100)

Response

{
  "QueryResponse": {
    "Customer": [
      {
        "DisplayName": "Acme Corp",
        "Id": "1"
      },
      {
        "DisplayName": "Globex Inc",
        "Id": "2"
      }
    ],
    "maxResults": 2,
    "startPosition": 1
  }
}

List QuickBooks invoices

List invoices from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of invoices to return (default 100)

Response

{
  "QueryResponse": {
    "Invoice": [
      {
        "Balance": 500.0,
        "DocNumber": "1001",
        "Id": "100",
        "TotalAmt": 500.0
      }
    ],
    "maxResults": 1,
    "startPosition": 1
  }
}

List QuickBooks items

List items (products and services) from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of items to return (default 100)

Response

{
  "QueryResponse": {
    "Item": [
      {
        "Id": "1",
        "Name": "Consulting",
        "Type": "Service"
      },
      {
        "Id": "2",
        "Name": "Widget",
        "Type": "Inventory"
      }
    ],
    "maxResults": 2,
    "startPosition": 1
  }
}

List QuickBooks payments

List payments from QuickBooks Online.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of payments to return (default 100)

Response

{
  "QueryResponse": {
    "Payment": [
      {
        "Id": "1",
        "TotalAmt": 100.0
      },
      {
        "Id": "2",
        "TotalAmt": 250.0
      }
    ],
    "maxResults": 2,
    "startPosition": 1
  }
}

QuickBooks Online

On this page