Skip to content

Latest commit

 

History

History
164 lines (131 loc) · 4.04 KB

companies.md

File metadata and controls

164 lines (131 loc) · 4.04 KB
Raw

Companies

German: "Firmen"

Attributes

The company representation contains among default fields the following features:

  • Type ("customer", "supplier", "organization")
  • Tags
  • Custom properties
  • Projects (shortened)
  • User (shortened)
{
  "id": 760253573,
  "type": "customer",
  "name": "Beispiel AG",
  "website": "www.beispiel-ag.com",
  "email": "[email protected]",
  "billing_email_cc": "[email protected]",
  "phone": "+49 30 123 45 67",
  "fax": "+49 30 123 45 66",
  "address": "Beispiel AG\nBeispielstrasse 123\n12345 Beispielstadt",
  "tags": ["Netzwerk", "Druckerei"],
  "user": {
    "id": 933589840,
    "firstname": "Tobias",
    "lastname": "Miesel"
  },
  "info": "",
  "custom_properties": {
    "UID": "1234-UID-4567"
  },
  "identifier": "36",
  "intern": false,
  "billing_tax": 0,
  "currency": "CHF",
  "country_code": "CH",
  "vat_identifier": "DE999999999",
  "default_invoice_due_days": 30,
  "footer": "<div>Footer text</div>",
  "projects": [
    {
      "id": 944504145,
      "identifier": "46",
      "name": "Layoutanpassung",
      "active": false,
      "billable": true
    }
  ],
  "created_at": "2018-10-17T09:33:46Z",
  "updated_at": "2018-10-17T09:33:46Z",
  "debit_number": 10000
}

GET /companies

Retrieve all companies:

curl -X GET \
  'https://{domain}.mocoapp.com/api/v1/companies' \
  -H 'Authorization: Token token=YOUR_API_KEY'

It's also possible to filter:

  • type ("customer", "supplier", "organization")
  • tags "Automotive, Pharma" (comma separated list)
  • identifier "K0405"

This returns an array with the complete company information.

GET /companies/{id}

Retrieve a single company:

curl -X GET \
  'https://{domain}.mocoapp.com/api/v1/companies/123' \
  -H 'Authorization: Token token=YOUR_API_KEY'

This returns a single company's complete represenation.

POST /companies

Create a company:

curl -X POST \
  'https://{domain}.mocoapp.com/api/v1/companies' \
  -H 'Authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Beispiel AG",
        "currency": "EUR"
      }'

Fields for all types of companies. Mandatory fields are marked with a star (*):

  • name* – "Beispiel AG"
  • type* – ("customer", "supplier", "organization")
  • country_code – (ISO Alpha-2 Country Code like "DE" / "CH" / "AT" in upper case - default is account country)
  • vat_identifier – European Union VAT identification numbers (USt-IdNr)
  • website – "http//www.lieferant.com"
  • fax – "+49 30 123 45 67"
  • phone – "+49 30 123 45 67"
  • email – "[email protected]"
  • billing_email_cc - "[email protected]"
  • address – "Lieferant AG\nBeispielstrasse 123\n12345 Berlin"
  • info – "Information for this company..."
  • custom_properties – {"UID": "123-UID-456"}
  • tags – ["Network", "Print"]
  • user_id – 123456 💡(responsible person)
  • footer – "
    some html
    " (appears at the end of invoices)

Additional fields just for companies of type customer:

  • currency* – "EUR"
  • identifier* – "K-123" (only mandatory if not automatically assigned)
  • billing_tax – 19.0
  • default_invoice_due_days – 20
  • debit_number – 10000 if bookkeeping is enabled

Additional fields just for companies of type supplier:

  • iban – CH3908704016075473007
  • credit_number – 70000 if bookkeeping is enabled

PUT /companies/{id}

Update a company.

curl -X PUT \
  'https://{domain}.mocoapp.com/api/v1/companies/{123}' \
  -H 'authorization: Token token=YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Beispiel GmbH"
      }'

Fields are analogous to the POST request.

DELETE /companies/{id}

⚠ Deleting a company is not possible via API!