Contacts and products
Look up a contact or a product before you put an id on an invoice.
Sales invoice fields that point at a contact or a product need ids from these lists. Do not invent them.
Contacts
Contacts - List is GET /v1/business/{business_slug}/contacts/.
| Query | Use |
|---|---|
contact_business_id | Exact business contact id, when you know it. |
name_iexact | Exact name, case insensitive. |
is_invoicing_enabled | Contacts that can be invoiced. |
search | The fields named on the reference page. |
Contact - Create requires name. The schema lists contact types, including BUSINESS and PERSON. It says contact_business_id is required for invoicing when the type is BUSINESS. customer_id, when you send it, is unique inside the business. Invoicing addresses (invoicing_email, invoicing_einvoice_address, invoicing_einvoice_operator) are optional fields on that schema. Send them only when you have them.
Products
Products are reusable invoice row templates. Products - List is GET /v1/invoicing/{business_slug}/product/. Use code when you know the product code. code is unique inside the business.
Product - Create requires name, unit, amount, vat_code, and vat_rate. Take vat_code from VAT codes. is_vat_inclusive says whether amount already includes VAT. account_id, when you set it, is an id from Accounts - List, and the schema says product sales post to that account.
Send Idempotency-Key on both creates. See Idempotency.