Company

Retrieves information about list of companies.

Endpoint

GET /beta/company

Company Object

{
    "companyId": 1,
    "code": "tenant",
    "name": "Test Company",
    "glCode": "0",
    "gstRate": 10.000
}

Supplier

A supplier, also referred to as a vendor or in AP as a creditor, refers to an external entity or business providing goods or services to the organisation, suppliers submit invoices for approval and processing, payments are made to suppliers based on their agreed payment terms.

Endpoints

GET /beta/company/{companyId}/supplier

GET /beta/company/{companyId}/supplier/{supplierId}

Supplier Object

{
    "id": "1234567",
    "createdOn": "1970-01-01T00:00:00Z",
    "approvedOn": "1970-01-01T00:00:00Z",
    "updatedOn": "1970-01-01T00:00:00Z",
    "registrationNumber": "207 890 345 123",
    "supplierCode": "DJ1",
    "displayName": "John Doe",
    "tradingNames": [
    	"John Doe"
    ],
    "legalName": "John Doe Pty Ltd",
    "country": "AUS",
    "currency": "AUD",
    "isActive": true,
    "isValidated": true,
    "primaryAddress": {
    	"fullAddress": "",
        "address1": "",
        "address2": "",
        "address3": "",
        "suburb": "",
        "city": "",
        "state": "",
        "postCode": "",
        "country": ""
    }
}

Parameters

Project

A project, similar to projects in a customer ERP, are entities used for budgeting, cost allocation and tracking, and approvals of both claims and invoices.

Endpoints

GET /beta/company/{companyId}/project

GET /beta/company/{companyId}/project/{projectId}/wbs

Project Object

{
    "id": "1234567",
    "createdOn": "1970-01-01T00:00:00Z",
    "lastUpdatedOn": "1970-01-01T00:00:00Z",
    "name": "Project X",
    "projectCode": "PRX",
    "portfolio": [
        "789",
        "456"
    ],
    "externalReference": "PRX",
    "costCode": "CC12345",
    "active": true
}

Parameters

Portfolio

A project portfolio is a group of related projects used for reporting, tracking, and approvals of both claims and invoices. Projects can be related to multiple portfolios and portfolios can contain multiple projects.

Endpoints

GET /beta/company/{companyId}/portfolio

GET /beta/company/{companyId}/portfolio/{portfolioId}

Portfolio Object

{
    "id": "789",
    "createdOn": "1970-01-01T00:00:00Z",
    "lastUpdatedOn": "1970-01-01T00:00:00Z",
    "name": "Portfolio A",
    "projects": [
        "1234567",
        "1234568"
    ],
    "active": true
}

Parameters