List of contacts
GET
https://api.sandbox-billit.xyz/v1
/contacts
A list of contacts
query Parameters
qstringIf you want to list customers by a search term. Lookup is on Company name, VatID, Telephone,Email.
Example: Testing S.A.unpaidbooleanIf you want to list only customer with unpaid invoices
Example: 1tagidstringIf you want to filter by a Tag, fill in the Tag ID
Example: 24withRelationsstringIf you want to load model relationships as well with one call.
Example: 1per_pagestringSet the results per page limit. Default is 25.
Example: 100
Headers
Acceptstringapplication/json
Responses
OK
dataobjectlinksobjectmetaobject
Create a contact
POST
https://api.sandbox-billit.xyz/v1
/contacts
Create a contact
customerType options
| Option | Description |
|---|---|
| 1 | Domestic customer |
| 2 | Intra-community customer (EU-VIES) |
| 3 | Foreign customer |
| 4 | Private individual |
contactType options
| Option | Description |
|---|---|
| 1 | Customer |
| 2 | Supplier |
| 3 | Customer & Supplier |
Request Body
isCompanyboolean · requiredIf customer is company, make that true
companystring · requiredThe company name
customerTypenumber · requiredcountrystring · required
langstringthe language that you want the customer to receive his invoices. "el" or "en"
professionstringinChargestringvatIdstringtaxOfficestringstreetAddressstringaliasstringskipVatIdUniquenessbooleanpostalCodestringcitystringmobilestringphonestringfaxstringinfostringpublicNotestringaddressesobject[] · uniquecontactTypestringcurrencystringtagsarraydefaultVatIdnumber
Responses
Created
dataobject
Update a customer
PUT
https://api.sandbox-billit.xyz/v1
/contacts/{id}
Update a contact
In case the contact is NOT set as a company, the only valid option is 4 (Private individual)
customerType options
| Option | Description |
|---|---|
| 1 | Domestic customer |
| 2 | Intra-community customer (EU) |
| 3 | Foreign customer |
| 4 | Private individual |
path Parameters
idstring · requiredThe customer's iD
Request Body
isCompanyboolean · requiredcompanystring · minLength: 1 · requiredlangstring · minLength: 1 · requiredprofessionstring · minLength: 1 · requiredinChargestring · minLength: 1 · requiredvatIdstring · minLength: 1 · requiredtaxOfficestring · minLength: 1 · requiredstreetAddressstring · minLength: 1 · requiredaliasstring · minLength: 1 · requiredcustomerTypenumber · requiredpostalCodestring · minLength: 1 · requiredcitystring · minLength: 1 · requiredcountrystring · minLength: 1 · requiredmobilestring · minLength: 1 · requiredphonestring · minLength: 1 · requiredfaxstring · minLength: 1 · requiredinfostring · minLength: 1 · requiredpublicNotestring · minLength: 1 · requiredaddressesarray · minItems: 1 · unique · required
Responses
OK
No data returned