Sumqo API

A leaked key could add customers or change a customer's email address so invoices go to someone else. Tax IDs can't be set with a key.

• POST /customersCreate a customerRequires Idempotency-Key.

  Field	Required	Notes
  displayName	Yes
  companyName	No
  firstName	No
  lastName	No
  email	No	Main email address
  phone	No
  mobilePhone	No
  fax	No
  altPhone	No
  website	No
  category	No
  notes	No
  paymentTerms	No
  paymentTerms.termsType	Yes	One of: due_on_receipt, net, custom.
  paymentTerms.netDays	No
  paymentTerms.label	No
  billingAddress	No
  billingAddress.line1	No
  billingAddress.line2	No
  billingAddress.city	No
  billingAddress.state	No
  billingAddress.postalCode	No
  billingAddress.country	No
  shippingAddress	No
  shippingAddress.line1	No
  shippingAddress.line2	No
  shippingAddress.city	No
  shippingAddress.state	No
  shippingAddress.postalCode	No
  shippingAddress.country	No
  shippingSameAsBilling	No
  creditLimitCents	No	Credit limit in cents
  contacts[]	No	A list.
  contacts[].name	Yes
  contacts[].role	No
  contacts[].email	No
  contacts[].phone	No
  contacts[].notes	No

• PATCH /customers/{customerId}Change a customerRequires Idempotency-Key.

  Field	Required	Notes
  displayName	No
  companyName	No
  firstName	No
  lastName	No
  email	No	Main email address
  phone	No
  mobilePhone	No
  fax	No
  altPhone	No
  website	No
  category	No
  notes	No
  paymentTerms	No
  paymentTerms.termsType	Yes	One of: due_on_receipt, net, custom.
  paymentTerms.netDays	No
  paymentTerms.label	No
  billingAddress	No
  billingAddress.line1	No
  billingAddress.line2	No
  billingAddress.city	No
  billingAddress.state	No
  billingAddress.postalCode	No
  billingAddress.country	No
  shippingAddress	No
  shippingAddress.line1	No
  shippingAddress.line2	No
  shippingAddress.city	No
  shippingAddress.state	No
  shippingAddress.postalCode	No
  shippingAddress.country	No
  shippingSameAsBilling	No
  creditLimitCents	No	Credit limit in cents

curl -X POST https://connect.sumqo.com/v1/customers \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"displayName":"<displayName>"}'

A leaked key could add vendors or change a vendor's contact details. Tax IDs, 1099 settings and account numbers can't be set with a key.

• POST /vendorsCreate a vendorRequires Idempotency-Key.

  Field	Required	Notes
  displayName	Yes
  companyName	No
  firstName	No
  lastName	No
  email	No	Main email address
  phone	No
  mobilePhone	No
  fax	No
  altPhone	No
  website	No
  category	No
  notes	No
  paymentTerms	No
  paymentTerms.termsType	Yes	One of: due_on_receipt, net, custom.
  paymentTerms.netDays	No
  paymentTerms.label	No
  address	No
  address.line1	No
  address.line2	No
  address.city	No
  address.state	No
  address.postalCode	No
  address.country	No
  defaultAccountId	No	Default expense category

• PATCH /vendors/{vendorId}Change a vendorRequires Idempotency-Key.

  Field	Required	Notes
  displayName	No
  companyName	No
  firstName	No
  lastName	No
  email	No	Main email address
  phone	No
  mobilePhone	No
  fax	No
  altPhone	No
  website	No
  category	No
  notes	No
  paymentTerms	No
  paymentTerms.termsType	Yes	One of: due_on_receipt, net, custom.
  paymentTerms.netDays	No
  paymentTerms.label	No
  address	No
  address.line1	No
  address.line2	No
  address.city	No
  address.state	No
  address.postalCode	No
  address.country	No
  defaultAccountId	No	Default expense category

curl -X POST https://connect.sumqo.com/v1/vendors \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"displayName":"<displayName>"}'

A leaked key could change the names and prices of what you sell.

• POST /itemsCreate a product or serviceRequires Idempotency-Key.

  Field	Required	Notes
  name	Yes
  unitPriceCents	Yes
  description	No
  type	No	One of: service, product.
  incomeAccountId	No	Income category
  taxable	No

• PATCH /items/{itemId}Change a product or serviceRequires Idempotency-Key.

  Field	Required	Notes
  name	No
  unitPriceCents	No
  description	No
  type	No	One of: service, product.
  incomeAccountId	No	Income category
  taxable	No

curl -X POST https://connect.sumqo.com/v1/items \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"name":"<name>","unitPriceCents":"<unitPriceCents>"}'

A leaked key could create invoices (as drafts or issued) that change what your customers owe you. It can never send, void or delete them.

• POST /invoicesCreate an invoiceRequires Idempotency-Key.

  Field	Required	Notes
  customerId	Yes
  txnDate	Yes	Invoice date (YYYY-MM-DD)
  dueDate	No	YYYY-MM-DD; default from the customer’s payment terms
  status	No	draft (default) or sent (issued, not emailed) One of: draft, sent.
  lines[]	Yes	A list.
  lines[].itemId	No
  lines[].description	Yes
  lines[].quantity	Yes
  lines[].rateCents	Yes	Price per unit in cents
  lines[].kind	No	One of: item, discount.
  lines[].taxable	No
  lines[].taxRateBp	No	Tax rate in basis points (825 = 8.25 %)
  lines[].taxFixedCents	No
  taxCents	No
  memo	No	Message shown to the customer
  internalNotes	No

curl -X POST https://connect.sumqo.com/v1/invoices \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"customerId":"<customerId>","txnDate":"<txnDate>","lines":[{"description":"<description>","quantity":"<quantity>","rateCents":"<rateCents>"}]}'

A leaked key could mark invoices as paid. Keys with this permission only work from the addresses you list.

• POST /paymentsRecord a paymentRequires Idempotency-Key.

  Field	Required	Notes
  customerId	Yes
  txnDate	Yes	Date received (YYYY-MM-DD)
  amountCents	Yes
  method	No	One of: cash, check, card, bank_transfer, other.
  referenceNumber	No
  instrumentDate	No	Date written on the check or transfer order (YYYY-MM-DD), reference only
  memo	No
  depositTo	No	One of: account, undeposited.
  appliedTo[]	No	Invoices the payment pays A list.
  appliedTo[].invoiceId	Yes
  appliedTo[].amountCents	Yes

• POST /sales-receiptsCreate a sales receiptRequires Idempotency-Key.Also needs: invoices:write

  Field	Required	Notes
  customerId	No	Default: the walk-in customer
  txnDate	Yes
  lines[]	Yes	A list.
  lines[].itemId	No
  lines[].description	Yes
  lines[].quantity	Yes
  lines[].rateCents	Yes	Price per unit in cents
  lines[].kind	No	One of: item, discount.
  lines[].taxable	No
  lines[].taxRateBp	No	Tax rate in basis points (825 = 8.25 %)
  lines[].taxFixedCents	No
  taxCents	No
  memo	No
  payment	Yes
  payment.method	Yes	One of: cash, check, card, bank_transfer, other.
  payment.date	No
  payment.depositTo	No	One of: account, undeposited.
  payment.reference	No

curl -X POST https://connect.sumqo.com/v1/payments \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"customerId":"<customerId>","txnDate":"<txnDate>","amountCents":"<amountCents>"}'

A leaked key could add expenses that change your profit and your taxes.

• POST /expensesCreate an expenseRequires Idempotency-Key.

  Field	Required	Notes
  accountId	Yes	Expense category
  vendorId	No
  txnDate	Yes
  amountCents	Yes
  paymentMethod	No	One of: cash, check, card, bank_transfer, other.
  paymentMethodLabel	No
  referenceNumber	No
  memo	No
  classId	No
  locationId	No

curl -X POST https://connect.sumqo.com/v1/expenses \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"accountId":"<accountId>","txnDate":"<txnDate>","amountCents":"<amountCents>"}'

A leaked key could add bills you owe. It can never pay or approve them.

• POST /billsCreate a billRequires Idempotency-Key.

  Field	Required	Notes
  vendorId	Yes
  txnDate	Yes
  dueDate	Yes
  billNumber	No
  memo	No
  lines[]	Yes	A list.
  lines[].accountId	Yes	Expense category
  lines[].description	No
  lines[].amountCents	Yes
  lines[].itemId	No
  lines[].quantity	No
  lines[].classId	No
  lines[].locationId	No

curl -X POST https://connect.sumqo.com/v1/bills \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"vendorId":"<vendorId>","txnDate":"<txnDate>","dueDate":"<dueDate>","lines":[{"accountId":"<accountId>","amountCents":"<amountCents>"}]}'

A leaked key could upload files into your workspace. They are kept without reading unless you turn on reading, and never posted.

• POST /documentsUpload a documentRequires Idempotency-Key.

  Field	Required	Notes
  fileName	Yes
  mimeType	Yes	One of: application/pdf, image/jpeg, image/png, image/webp, image/heic, image/heif.
  contentBase64	Yes	The file, base64-encoded (at most 4 MB)
  processing	No	store_only (default): keep the file without reading it; review: read it and put it in Documents to review — only when the workspace turned on reading of documents uploaded with keys (at most 30 a day per key) One of: review, store_only.
  note	No

curl -X POST https://connect.sumqo.com/v1/documents \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"fileName":"<fileName>","mimeType":"application/pdf","contentBase64":"<contentBase64>"}'

A leaked key could send notices about your new invoices, payments and other records to an address of its choice. Notices carry ids and amounts, never names or contact details.

• POST /hooksSubscribe to eventsRequires Idempotency-Key.

  Field	Required	Notes
  url	Yes	https address that receives the events
  events[]	No	Event types (see Webhooks) A list.
  event	No	One event type (Zapier style)

• DELETE /hooks/{hookId}Unsubscribe from events

curl -X POST https://connect.sumqo.com/v1/hooks \
  -H "Authorization: Bearer sumqo_live_EXAMPLEkeyEXAMPLEkeyEXAMPLEke_a1B2c3" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f0c9a52-6e1b-4d7a-b8c2-9e4f1a7d2b60" \
  -d '{"url":"<url>"}'