/Company

Short Description

Chapter Contents:

Long Description

Supported Methods

GET /Company

Get a list of Company objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

GET /Company/{key}

Get a single Company object.

POST /Company

Insert a new Company object.

PUT /Company/{key}

Update an existing Company. Unchanged properties need not be updated.

Properties

Property	Type	Length	Mandatory	Comments
codeProperty	String	N/A		"companyCode"
voyageCurrency	/Currency
companyCode	String	8	Yes	Code Property
companyName	String	64	Yes
companyRegistrationNo	String	16
subsidiaryOf	String	64
vatNumber	String	24
companyCurrency	/Currency
companyLink	/Company
businessUnits	Array of /BusinessUnit
invoiceToCompany	/Company
defaultLegalText	String	1024
bankAccounts	Array of /BankAccount
defaultSignee	/User
defaultVatRatePayable	/VatRate
defaultVatRateReceivable	/VatRate

Response Body Example

Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)

{
    "key": 1270257,
    "self": "http://localhost:8080/ws/rest/Company/1270257",
    "codeProperty": "companyCode",
    "createdDate": "2013-01-08T15:17:30",
    "modifiedDate": "2013-02-04T14:49:27",
    "voyageCurrency": {
        "currencyCode": "EUR",
        "currencyName": "Euro",
        "key": 400008,
        "self": "http://localhost:8080/ws/rest/Currency/400008"
    },
    "companyCode": "111101",
    "companyName": "Some Company Inc.",
    "companyRegistrationNo": "123456789",
    "subsidiaryOf": null,
    "vatNumber": "NO123456789",
    "companyCurrency": {
        "currencyCode": "EUR",
        "currencyName": "Euro",
        "key": 400008,
        "self": "http://localhost:8080/ws/rest/Currency/400008"
    },
    "companyLink": null,
    "remarks": []
}

Top
Back