Iplicit API

Attachment

A suite of APIs to manage Attachments..

CreateAttachment

Create a new attachment on a specified source item

Request

POST /api/Attachment/create/{attributeRef}/{sourceId}/AttachmentGroup/{attachmentGroupId}

Parameters

Name	Type	Default	Notes
*attributeRef			Id or name of the attribute
*sourceId			id of the source item to attach to
*attachmentGroupId			Id of the attachment group. Use special value 'other' to get attachments without a group.
*File			Attachment file information
Description			Attachment description
DocumentDate			Attachment document date

Responses

Status Code	Type	Description	Samples
200	string	Success

GetAttachmentsInGroup

Get a list of attachments in an attachment group on a specified source item with a search filter.

Request

GET /api/Attachment/search/{attributeRef}/{sourceId}/AttachmentGroup/{attachmentGroupId}[?createdFrom&fileName&take&skip]

Parameters

Name	Type	Default	Notes
*attributeRef			Id or name of the attribute
*sourceId			Id of the source item
*attachmentGroupId			Id of the attachment group. Use special value 'other' to get attachments without a group.
createdFrom			Filter attachments created after a specific date time
fileName			Filter attachments with a specific file name
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	AttachmentRead[]	Success

DeleteAttachment

Delete an attachment

Request

DELETE /api/Attachment/{attachmentId}

Parameters

Name	Type	Default	Notes
*attachmentId			Id of the attachment

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdateAttachmentDetails

Update attachment details

Request

PATCH /api/Attachment/{attachmentId}

Parameters

Name	Type	Default	Notes
*attachmentId			Id of the attachment
body	AttachmentUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetAttachmentDetails

Get attachment details

Request

GET /api/Attachment/{attachmentId}/Details

Parameters

Name	Type	Default	Notes
*attachmentId			Id of the attachment

Responses

Status Code	Type	Description	Samples
200	AttachmentRead	Success

GetAttachmentFile

Get attachment file

Request

GET /api/Attachment/{attachmentId}/File

Parameters

Name	Type	Default	Notes
*attachmentId			Id of the attachment

Responses

Status Code	Type	Description	Samples
200	string	Success

GetAttachmentGroups

Get a list of attachment groups defined on a specified attribute.

Request

GET /api/Attribute/{attributeRef}/AttachmentGroup

Parameters

Name	Type	Default	Notes
*attributeRef			Id or type name of the attribute

Responses

Status Code	Type	Description	Samples
200	AttachmentGroupRead[]	Success

BankTransaction

A suite of APIs to manage Bank Transactions.

CreateBankTransaction

Create a bank transaction

Request

POST /api/BankTransaction

Parameters

Name	Type	Default	Notes
body	BankTransactionCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

DeleteBankTransaction

Delete a bank transaction

Request

DELETE /api/BankTransaction/{bankTransactionId}

Parameters

Name	Type	Default	Notes
*bankTransactionId			Id of the bank transaction

Responses

Status Code	Type	Description	Samples
200	string	Success

GetBankTransaction

Get a bank transaction

Request

GET /api/BankTransaction/{bankTransactionId}

Parameters

Name	Type	Default	Notes
*bankTransactionId			Id of the bank transaction

Responses

Status Code	Type	Description	Samples
200	BankTransactionRead	Success

UpdateBankTransaction

Update a bank transaction

Request

PATCH /api/BankTransaction/{bankTransactionId}

Parameters

Name	Type	Default	Notes
*bankTransactionId			Id of the bank transaction
body	BankTransactionUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

LockBankTransaction

Lock a bank transaction

Request

POST /api/BankTransaction/{bankTransactionId}/lock

Parameters

Name	Type	Default	Notes
*bankTransactionId			Id of the bank transaction

Responses

Status Code	Type	Description	Samples
200	string	Success

UnlockBankTransaction

Unlock a bank transaction

Request

POST /api/BankTransaction/{bankTransactionId}/unlock

Parameters

Name	Type	Default	Notes
*bankTransactionId			Id of the bank transaction

Responses

Status Code	Type	Description	Samples
200	string	Success

BatchPayment

A suite of APIs to manage Batch Payment.

GetBatchPayments

Get batch payments with a search filter

Request

GET /api/BatchPayment[?BatchNo&BatchPaymentType&LegalEntity&BankAccountId&Description&DescriptionContains&PaymentDateFrom&PaymentDateTo&LastModifiedFrom&LastModifiedTo&LastModifiedBy&IsDraft&IsPosted&IsApproved&IsProcessed&take&skip]

Parameters

Name	Type	Default	Notes
BatchNo			Filter on the batch payment number
BatchPaymentType			Filter on the batch payment type
LegalEntity			Filter on the legal entity
BankAccountId			Filter on the bank account id
Description			Filter on the description
DescriptionContains			Filter on the description that contains
PaymentDateFrom			The batch payment date from
PaymentDateTo			Filter on the batch payment date to
LastModifiedFrom			Filter on the batch payment last modified from date
LastModifiedTo			Filter on the batch payment last modified to date
LastModifiedBy			The user that last modified this item. See UserAccount catalog.
IsDraft			Filter on a flag indicating whether the batch is in draft
IsPosted			Filter on a flag indicating whether the batch is posted
IsApproved			Filter on a flag indicating whether the batch is approved
IsProcessed			Filter on a flag indicating whether the batch is processed
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	BatchPaymentSummary[]	Success

CreateBatchPayment

Create a batch payment

Request

POST /api/BatchPayment

Parameters

Name	Type	Default	Notes
body	BatchPaymentCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdateBatchPayment

Update a batch payment

Request

PATCH /api/BatchPayment/{batchPaymentId}

Parameters

Name	Type	Default	Notes
*batchPaymentId			Batch payment id
body	BatchPaymentUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetBatchPayment

Get a batch payment by id or by document number.

Request

GET /api/BatchPayment/{idOrCode}

Parameters

Name	Type	Default	Notes
*idOrCode			Batch payment id or document number

Responses

Status Code	Type	Description	Samples
200	BatchPaymentDetail	Success

AddBatchPaymentAllocations

Add allocations to the batch payment

Request

POST /api/BatchPayment/{idOrCode}/allocations

Parameters

Name	Type	Default	Notes
*idOrCode			Batch payment id or document number
body	DocAllocationCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

ReplaceBatchPaymentAllocations

Replaces all allocations in the batch payment

Request

PUT /api/BatchPayment/{idOrCode}/allocations

Parameters

Name	Type	Default	Notes
*idOrCode			Batch payment id or document number
body	DocAllocationCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

DeleteBatchPaymentAllocation

Delete an allocation in the batch payment

Request

DELETE /api/BatchPayment/{idOrCode}/allocations/{allocationId}

Parameters

Name	Type	Default	Notes
*idOrCode			Batch payment id or document number
*allocationId			Batch payment allocation id

Responses

Status Code	Type	Description	Samples
200		Success

Catalog

A suite of APIs to manage Catalogs.

GetAllCatalogs

Get a list of all catalogs

Request

GET /api/Catalog

Responses

Status Code	Type	Description	Samples
200	CatalogItem[]	Success

GetCatalog

Get all items in a catalog

Request

GET /api/Catalog/{catalogName}

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog

Responses

Status Code	Type	Description	Samples
200	CatalogItem[]	Success

ReplaceCatalogItems

Replace all items in a catalog

Request

POST /api/Catalog/{catalogName}

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog
body	CatalogItemCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

AddCatalogItem

Add an item to a catalog

Request

PUT /api/Catalog/{catalogName}

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog
body	CatalogItemCreate

Responses

Status Code	Type	Description	Samples
200		Success

DeleteCatalogItem

Delete an item in a catalog

Request

DELETE /api/Catalog/{catalogName}/{idOrCode}

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog
*idOrCode			Id or code of the catalog item

Responses

Status Code	Type	Description	Samples
200		Success

UpdateCatalogItem

Update an item in a catalog

Request

PATCH /api/Catalog/{catalogName}/{idOrCode}

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog
*idOrCode			Id or code of the catalog item
body	CatalogItemUpdate

Responses

Status Code	Type	Description	Samples
200		Success

LockCatalogItem

Lock a catalog item

Request

POST /api/Catalog/{catalogName}/{idOrCode}/lock

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog to update
*idOrCode			Id or code of the catalog item
body	CatalogItem

Responses

Status Code	Type	Description	Samples
200		Success

UnlockCatalogItem

Unlock a catalog item

Request

POST /api/Catalog/{catalogName}/{idOrCode}/unlock

Parameters

Name	Type	Default	Notes
*catalogName			Name of the catalog to update
*idOrCode			Id or code of the catalog item
body	CatalogItem

Responses

Status Code	Type	Description	Samples
200		Success

Contact

A suite of APIs to manage Contacts.

CreateContact

Create a contact

Request

POST /api/Contact

Parameters

Name	Type	Default	Notes
body	ContactCreate

Responses

Status Code	Type	Description	Samples
201	string	Created

DeleteContact

Delete a contact

Request

DELETE /api/Contact/{idOrIntRef}

Parameters

Name	Type	Default	Notes
*idOrIntRef			Id or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200		Success

GetContact

Get a contact

Request

GET /api/Contact/{idOrIntRef}

Parameters

Name	Type	Default	Notes
*idOrIntRef			Id or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200	ContactRead	Success

UpdateContact

Update a contact

Request

PATCH /api/Contact/{idOrIntRef}

Parameters

Name	Type	Default	Notes
*idOrIntRef			Id or internal reference of the contact
body	ContactUpdate

Responses

Status Code	Type	Description	Samples
200		Success

LockContact

Lock the contact

Request

POST /api/Contact/{idOrIntRef}/lock

Parameters

Name	Type	Default	Notes
*idOrIntRef			Id or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200		Success

UnlockContact

Unlock the contact

Request

POST /api/Contact/{idOrIntRef}/unlock

Parameters

Name	Type	Default	Notes
*idOrIntRef			Id or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200		Success

ContactAccount

A suite of APIs to manage ContactAccounts.

GetContactAccounts

Gets a list of contact accounts with a search filter

Request

GET /api/ContactAccount[?Code&IntRef&DescriptionContains&LastModifiedFrom&LastModifiedTo&IsCustomer&IsSupplier&IsResource&include&take&skip]

Parameters

Name	Type	Default	Notes
Code			Code
IntRef			Internal reference
DescriptionContains			Description contains
LastModifiedFrom			Last modified from (UTC)
LastModifiedTo			Last modified until (UTC)
IsCustomer			Include/exclude customers
IsSupplier			Include/exclude suppliers
IsResource			Include/exclude resources
include		customer,supplier	Comma separated list of detail notes to include: customer, supplier, resource, contact, contacts, defaultBankDetails, allBankDetails. If omitted, will default to customer,supplier.
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	ContactAccountRead[]	Success

CreateContactAccount

Create a contact account

Request

POST /api/ContactAccount

Parameters

Name	Type	Default	Notes
body	ContactAccountCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

DeleteContactFromContactAccount

Remove an existing contact from a contact account.

Request

DELETE /api/ContactAccount/{ca}/contactLinks/{cb}

Parameters

Name	Type	Default	Notes
*ca			Id, code or internal reference of the contact account
*cb			Id, code or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200		Success

AddContactToContactAccount

Add an existing contact to a contact account.

Request

POST /api/ContactAccount/{ca}/contactLinks/{cb}

Parameters

Name	Type	Default	Notes
*ca			contact account id or code
*cb			contact id or intRef

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccount

Get a contact account

Request

GET /api/ContactAccount/{contactAccountRef}[?include]

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
include		customer,supplier	Comma separated list of detail notes to include. Permitted values are customer, supplier, resource, contact, contacts, defaultBankDetails, allBankDetails. Default is customer,supplier.

Responses

Status Code	Type	Description	Samples
200	ContactAccountRead	Success

UpdateContactAccount

Update a contact account

Request

PATCH /api/ContactAccount/{contactAccountRef}

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
body	ContactAccountUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetContactAccountBankAccounts

Get all the bank details

Request

GET /api/ContactAccount/{contactAccountRef}/bankDetails

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactBankDetailsRead[]	Success

UpdateContactAccountBankDetails

Replace bank details

Request

PATCH /api/ContactAccount/{contactAccountRef}/bankDetails/default

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
body	ContactBankDetailsUpdateable

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountMainContact

Get the main contact details of the contact account

Request

GET /api/ContactAccount/{contactAccountRef}/contact

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactRead	Success

UpdateContactAccountMainContact

Update the main contact details

Request

PATCH /api/ContactAccount/{contactAccountRef}/contact

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
body	ContactUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountRelatedContacts

Get the related contacts

Request

GET /api/ContactAccount/{contactAccountRef}/contacts

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactRead[]	Success

UpdateContactAccountRelatedContacts

Update existing contacts.
Existing contacts are matched to request contacts by ID, IntRef or Description and updated. Existing contacts that do not match any request contact are left unchanged. Request contacts that do not match any existing contact are added.

Request

PATCH /api/ContactAccount/{contactAccountRef}/contacts

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
body	ContactUpdate[]

Responses

Status Code	Type	Description	Samples
200		Success

AddContactAccountContact

Add related contacts

Request

POST /api/ContactAccount/{contactAccountRef}/contacts

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
body	ContactUpdate

Responses

Status Code	Type	Description	Samples
201	string	Created

DeleteContactAccount

Delete a related contact

Request

DELETE /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
*contactRef			Id, code or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountRelatedContact

Get an existing related contact

Request

GET /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
*contactRef			Id, code or internal reference of the contact

Responses

Status Code	Type	Description	Samples
200	ContactRead	Success

UpdateContactAccountContact

Update an existing related contact

Request

PATCH /api/ContactAccount/{contactAccountRef}/contacts/{contactRef}

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account
*contactRef			Id, code or internal reference of the contact
body	ContactUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountCustomerDetails

Get the customer details of the contact account

Request

GET /api/ContactAccount/{contactAccountRef}/customer

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactCustomerRead	Success

LockCustomer

Lock the customer

Request

POST /api/ContactAccount/{contactAccountRef}/customer/lock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

UnlockCustomer

Unlock the customer

Request

POST /api/ContactAccount/{contactAccountRef}/customer/unlock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountDefaultBankAccount

Get the default bank details

Request

GET /api/ContactAccount/{contactAccountRef}/defaultBankDetails

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactBankDetailsRead	Success

LockContactAccount

Request

POST /api/ContactAccount/{contactAccountRef}/lock

Parameters

Name	Type	Default	Notes
*contactAccountRef

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountResource

Get the resource details of the contact account

Request

GET /api/ContactAccount/{contactAccountRef}/resource

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactResourceRead	Success

LockContactAccountResource

Lock the contact account resource

Request

POST /api/ContactAccount/{contactAccountRef}/resource/lock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

UnlockContactAccountResource

Unlock the contact account resource

Request

POST /api/ContactAccount/{contactAccountRef}/resource/unlock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

GetContactAccountSupplierDefaults

Get the supplier details of the contact account

Request

GET /api/ContactAccount/{contactAccountRef}/supplier

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200	ContactSupplierRead	Success

LockSupplier

Lock the supplier

Request

POST /api/ContactAccount/{contactAccountRef}/supplier/lock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

UnlockSupplier

Unlock the supplier

Request

POST /api/ContactAccount/{contactAccountRef}/supplier/unlock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

UnlockContactAccount

Unlock the contact account

Request

POST /api/ContactAccount/{contactAccountRef}/unlock

Parameters

Name	Type	Default	Notes
*contactAccountRef			Id, code or internal reference of the contact account

Responses

Status Code	Type	Description	Samples
200		Success

ContactGroup

A suite of APIs to manage ContactGroups.

GetContactGroup

Get a contact group

Request

GET /api/ContactGroup/{contactGroupRef}[?include]

Parameters

Name	Type	Default	Notes
*contactGroupRef			Id or code of the contact group
include		customer,supplier	Comma separated list of details to include: Permitted values are customer, supplier or customer,supplier (the default)

Responses

Status Code	Type	Description	Samples
200	ContactGroupRead	Success

CostCentre

A suite of APIs to manage CostCentres.

GetCostCentres

Get a list of cost centres with a search filter

Request

GET /api/CostCentre[?descriptionContains&codeContains&parentCostCentre&legalEntity&isActive&includeClosed&take&skip]

Parameters

Name	Type	Default	Notes
descriptionContains			Use to only search cost centres where the description contains the text
codeContains			Use to only search cost centres where the code contains the text
parentCostCentre			Use to only search cost centres with the parent cost centre. Accepts id or code.
legalEntity			Use to only search cost centres with the legal entity. Accepts id or code.
isActive			Use to only search cost centres with the active state
includeClosed			Use to only search cost centres with the open state
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	CostCentreSearch[]	Success

CreateCostCentre

Create a cost centre

Request

POST /api/CostCentre

Parameters

Name	Type	Default	Notes
body	CostCentreCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetCostCentre

Get a cost centre

Request

GET /api/CostCentre/{costCentreRef}[?include]

Parameters

Name	Type	Default	Notes
*costCentreRef			Id or code of the cost centre
include			Comma separated list of detail to include: resources, subCostCentres. Default is no detail returned.

Responses

Status Code	Type	Description	Samples
200	CostCentreRead	Success

UpdateCostCentre

Update a cost centre

Request

PATCH /api/CostCentre/{costCentreRef}

Parameters

Name	Type	Default	Notes
*costCentreRef			Id or code of the cost centre
body	CostCentreUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

LockCostCentre

Lock the cost centre

Request

POST /api/CostCentre/{costCentreRef}/lock

Parameters

Name	Type	Default	Notes
*costCentreRef			Id or code of the cost centre

Responses

Status Code	Type	Description	Samples
200	string	Success

UnlockCostCentre

Unlock the cost centre

Request

POST /api/CostCentre/{costCentreRef}/unlock

Parameters

Name	Type	Default	Notes
*costCentreRef			Id or Code of the cost centre

Responses

Status Code	Type	Description	Samples
200	string	Success

Department

A suite of APIs to manage Departments.

GetDepartments

Get a list of departments with a search filter

Request

GET /api/Department[?descriptionContains&codeContains&parentDepartment&legalEntity&managerResource&isActive&includeClosed&take&skip]

Parameters

Name	Type	Default	Notes
descriptionContains			Use to only search department where the description contains the text
codeContains			Use to only search department where the code contains the text
parentDepartment			Use to only search department with the parent department. Accepts id or code.
legalEntity			Use to only search department with the legal entity. Accepts id or code.
managerResource			Use to only search department with the manager resource. Accepts id or code.
isActive			Use to only search department with the active state
includeClosed			Use to only search department with the open state
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	DepartmentSearch[]	Success

CreateDepartment

Create a department

Request

POST /api/Department

Parameters

Name	Type	Default	Notes
body	DepartmentCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetDepartment

Get a department

Request

GET /api/Department/{departmentRef}[?include]

Parameters

Name	Type	Default	Notes
*departmentRef			Id or Code of the department
include			Comma separated list of detail to include: resources, subDepartments. If omitted, no additional detail will be included.

Responses

Status Code	Type	Description	Samples
200	DepartmentRead	Success

UpateDepartment

Update a department

Request

PATCH /api/Department/{departmentRef}

Parameters

Name	Type	Default	Notes
*departmentRef			Id or code of the department
body	DepartmentUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

LockDepartment

Lock a department

Request

POST /api/Department/{departmentRef}/lock

Parameters

Name	Type	Default	Notes
*departmentRef			Id or code of the department

Responses

Status Code	Type	Description	Samples
200	string	Success

UnlockDepartment

Unlock a department

Request

POST /api/Department/{departmentRef}/unlock

Parameters

Name	Type	Default	Notes
*departmentRef			Id or code of the department

Responses

Status Code	Type	Description	Samples
200	string	Success

Document

A suite of APIs to manage Documents.

GetDocuments

Get a list of documents with a search filter

Request

GET /api/Document[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success

CreateDocument

Create a document

docClass parameter is no longer used

Request

POST /api/Document[?docClass]

Parameters

Name	Type	Default	Notes
docClass			The document class
body	DocCreate		docClass parameter is no longer used

Responses

Status Code	Type	Description	Samples
201	string	Created

UpdateDocumentDetailLineObsolete

Update a document detail line

Use PATCH /doc/{docRef}/detail/{docDetailRef} instead

Request

PATCH /api/Document/detail/{docDetailId}[?docClass]

Parameters

Name	Type	Default	Notes
*docDetailId			The document detail id
docClass			The document class
body	DocDetailUpdate		Use PATCH /doc/{docRef}/detail/{docDetailRef} instead

Responses

Status Code	Type	Description	Samples
200		Success

GetDocumentByIntRef

Get a document by the internal reference

Request

GET /api/Document/intref/{intRef}[?docClass&include]

Parameters

Name	Type	Default	Notes
*intRef			Internal reference of the document.
docClass			Document class, optional
include			Comma separated list of details to include: details, payments, tax, allocations.

Responses

Status Code	Type	Description	Samples
200	Doc	Success

AddAllocationToDocument

Add an allocation to the document

Request

POST /api/Document/{docIdOrCode}/allocation[?docId&docClass]

Parameters

Name	Type	Default	Notes
docId			The document id
docClass			The document class
*docIdOrCode
body	DocAllocationCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

SubmitDocument

Submit the document for authorisation and posting.

Request

POST /api/Document/{docId}/submit[?docClass]

Parameters

Name	Type	Default	Notes
*docId			Id of the document.
docClass			Document class

Responses

Status Code	Type	Description	Samples
200		Success

AddDocumentDetailLine

Add a document detail line

Request

POST /api/Document/{docRef}/detail[?docClass]

Parameters

Name	Type	Default	Notes
*docRef			The document reference
docClass			The document class
body	DocDetailUpdate

Responses

Status Code	Type	Description	Samples
200		Success

DeleteDocumentDetailLine

Delete a document detail line

Request

DELETE /api/Document/{docRef}/detail/{docDetailRef}[?docClass]

Parameters

Name	Type	Default	Notes
*docRef			The document reference
*docDetailRef			The document detail reference
docClass			The document class

Responses

Status Code	Type	Description	Samples
200		Success

UpdateDocumentDetailLine

Update a document detail line

Request

PATCH /api/Document/{docRef}/detail/{docDetailRef}[?docClass]

Parameters

Name	Type	Default	Notes
*docRef			The document reference
*docDetailRef			The document detail reference
docClass			The document class
body	DocDetailUpdate

Responses

Status Code	Type	Description	Samples
200		Success

ConvertDocumentType

Convert a document to another type

The document must be authorised / posted. The created document will fully match the source document.

Request

POST /api/Document/{fromDocId}/convert/{toDocType}

Parameters

Name	Type	Default	Notes
*fromDocId			The document must be authorised / posted. The created document will fully match the source document.
*toDocType			The document must be authorised / posted. The created document will fully match the source document.

Responses

Status Code	Type	Description	Samples
200	string	Success

GetDocument

Get a document by id or document number

Request

GET /api/Document/{idOrDocNo}[?docClass&include]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id for document number of the document.
docClass			Document class, optional
include			Comma separated list of details to include: details, payments, tax, allocations.

Responses

Status Code	Type	Description	Samples
200	Doc	Success

UpdateDocument

Update a document

Request

PATCH /api/Document/{idOrDocNo}[?docClass]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document
docClass			The document class
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

AbandonDocument

Abandon a draft document.

Request

POST /api/Document/{idOrDocNo}/abandon[?docClassArg]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document.
docClassArg			The document class

Responses

Status Code	Type	Description	Samples
200	integer	Success

AmendDocument

Amend a document

Request

PATCH /api/Document/{idOrDocNo}/amend

Parameters

Name	Type	Default	Notes
*idOrDocNo			Document id or number.
body	DocumentAmend

Responses

Status Code	Type	Description	Samples
200	string	Success

DisputeDocument

Dispute a document

Request

POST /api/Document/{idOrDocNo}/dispute

Parameters

Name	Type	Default	Notes
*idOrDocNo			Document id or number.
body	DocumentDispute

Responses

Status Code	Type	Description	Samples
200	string	Success

GetDocumentMatchDetails

Get document match details.

Request

GET /api/Document/{idOrDocNo}/match/details[?docClass]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document.
docClass			Document class

Responses

Status Code	Type	Description	Samples
200		Success

GetDocumentMatchSummary

Get document match summary (amount only).

Request

GET /api/Document/{idOrDocNo}/match/outstanding/amount[?docClass]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document.
docClass			Document class

Responses

Status Code	Type	Description	Samples
200		Success

GetDocumentMatchReverse

Get document match reverse details.

Request

GET /api/Document/{idOrDocNo}/match/reverse[?docClass]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document.
docClass			Document class

Responses

Status Code	Type	Description	Samples
200		Success

UnauthoriseDocument

Unauthorise an approved document (non GL documents only).

Request

POST /api/Document/{idOrDocNo}/unauthorise[?docClassArg]

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the document.
docClassArg			The document class

Responses

Status Code	Type	Description	Samples
200	integer	Success

UnpostDocument

Unpost a document

Request

POST /api/Document/{idOrDocNo}/unpost

Parameters

Name	Type	Default	Notes
*idOrDocNo			Document id or number.

Responses

Status Code	Type	Description	Samples
200		Success

DocumentAttachment

A suite of APIs to manage DocumentAttachments.

GetDocumentAttachmentsInGroup

Get a list of attachments in an attachment group on a specified document with a search filter.

Request

GET /api/Document/{docRef}/AttachmentGroup/{attachmentGroupId}/Attachment[?createdFrom&fileName&take&skip]

Parameters

Name	Type	Default	Notes
*docRef			Id, document number or internal reference of the document to search
*attachmentGroupId			Id of the attachment group. Use special value 'other' to get attachments without a group.
createdFrom			Filter attachments created after a specific date time
fileName			Filter attachments with a specific file name
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	AttachmentRead[]	Success

CreateDocumentAttachment

Create a new attachment on a sepcified document.

Request

POST /api/Document/{docRef}/AttachmentGroup/{attachmentGroupId}/Attachment

Parameters

Name	Type	Default	Notes
*docRef			Id, document number or internal reference of the document to search
*attachmentGroupId			Id of the attachment group. Use special value 'other' to get attachments without a group.
*File			Attachment file information
Description			Attachment description
DocumentDate			Attachment document date

Responses

Status Code	Type	Description	Samples
200	string	Success

GetDocumentAttachmentGroups

Get a list of attachment groups defined on a specified document type.

Request

GET /api/DocumentType/{docTypeRef}/AttachmentGroup

Parameters

Name	Type	Default	Notes
*docTypeRef			Id or code of the document type

Responses

Status Code	Type	Description	Samples
200	AttachmentGroupRead[]	Success

DocumentType

A suite of APIs to manage DocumentTypes.

GetDocumentType

Get a document type

Request

GET /api/DocumentType/{documentTypeRef}[?include]

Parameters

Name	Type	Default	Notes
*documentTypeRef			Id or code of the document type
include			Additional detail to include. Valid options are doctypesetup. If omitted, will not show additional detail.

Responses

Status Code	Type	Description	Samples
200	DocumentTypeRead	Success

Enquiry

A suite of APIs to manage Enquirys.

RunEnquiry

Run an enquiry that returns a list

Request

POST /api/Enquiry/run/{id}

Parameters

Name	Type	Default	Notes
*id			Id of the enquiry
body

Responses

Status Code	Type	Description	Samples
200	array	Success

RunEnquiryToList

Run an enquiry that returns a list

Request

POST /api/Enquiry/run/{id}/list

Parameters

Name	Type	Default	Notes
*id			Id of the enquiry
body

Responses

Status Code	Type	Description	Samples
200	array	Success

RunEnquiryToTable

Run an enquiry that returns a table

Request

POST /api/Enquiry/run/{id}/table

Parameters

Name	Type	Default	Notes
*id			Id of the enquiry
body

Responses

Status Code	Type	Description	Samples
200	Table	Success

LegalEntity

A suite of APIs to manage LegalEntities.

GetAllLegalEntities

Get all legal entities

Request

GET /api/LegalEntity[?take&skip]

Parameters

Name	Type	Default	Notes
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	LegalEntity[]	Success

Payment

A suite of APIs to manage Payments.

GetPayments

Get a list of payments with a search filter

Request

GET /api/Payment[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreatePayment

Create a payment.

Request

POST /api/Payment

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

AddPaymentAllocation

Add a payment allocation.

Request

POST /api/Payment/{docIdOrCode}/allocation

Parameters

Name	Type	Default	Notes
*docIdOrCode			Id or document number of the payment
body	DocAllocationCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetPayment

Get a payment

Request

GET /api/Payment/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the payment
include			Comma separated list of details to include: details, payments, tax, allocations.

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitPayment

Submit the payment for authorisation and posting.

Request

POST /api/Payment/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id or document number of the payment

Responses

Status Code	Type	Description	Samples
200		Success

Product

A suite of APIs to manage Products.

GetProducts

Get a list of products with a search filter

The results are paginated using the !:skip and !:take parameters.

Request

GET /api/Product[?DescriptionContains&ProductGroupId&IsPurchase&IsSale&LastModifiedFrom&LastModifiedTo&take&skip]

Parameters

Name	Type	Default	Notes
DescriptionContains			The results are paginated using the !:skip and !:take parameters.
ProductGroupId			The results are paginated using the !:skip and !:take parameters.
IsPurchase			The results are paginated using the !:skip and !:take parameters.
IsSale			The results are paginated using the !:skip and !:take parameters.
LastModifiedFrom			The results are paginated using the !:skip and !:take parameters.
LastModifiedTo			The results are paginated using the !:skip and !:take parameters.
take		100	The number of records to return
skip		0	The number of records to skip

Responses

Status Code	Type	Description	Samples
200	ProductSummary[]	Success

CreateProduct

Create a product

Request

POST /api/Product

Parameters

Name	Type	Default	Notes
body	ProductCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetProduct

Get a product

Request

GET /api/Product/{idOrCode}

Parameters

Name	Type	Default	Notes
*idOrCode			Id or code of the product

Responses

Status Code	Type	Description	Samples
200	ProductRead	Success

UpdateProduct

Update a product

Request

PATCH /api/Product/{idOrCode}

Parameters

Name	Type	Default	Notes
*idOrCode			Id or code of the product
body	ProductUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

DeleteProduct

Permanently delete a product

Request

DELETE /api/Product/{id}

Parameters

Name	Type	Default	Notes
*id			Id of the product

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found
default	ProblemDetails	Error

LockProduct

Lock a product

A locked product will mark all aspects (sale, purchase, etc) as inactive.

Request

POST /api/Product/{id}/lock

Parameters

Name	Type	Default	Notes
*id			Id of the product

Responses

Status Code	Type	Description	Samples
200	string	Success

Profile

A suite of APIs to manage Profiles.

GetProfile

Get profile of current session

Can be used to test authentication

Request

GET /api/Profile

Responses

Status Code	Type	Description	Samples
200	ProfileRead	Success

Project

A suite of APIs to manage Projects.

GetProjects

Get a list of projects with a search filter

Request

GET /api/Project[?ProjectGroupCode&ProjectGroupId&ParentProjectCode&ParentProjectId&LegalEntityCode&LegalEntityId&ContactAccountCode&ContactAccountId&LastModifiedFrom&LastModifiedTo&IncludeClosed&IsActive&include&take&skip]

Parameters

Name	Type	Default	Notes
ProjectGroupCode
ProjectGroupId
ParentProjectCode
ParentProjectId
LegalEntityCode
LegalEntityId
ContactAccountCode
ContactAccountId
LastModifiedFrom
LastModifiedTo
IncludeClosed			By default, only active projects will be returned. Set this to true to include closed projects.
IsActive			Search by active status. True=only active projects, False= only closed projects
include			Comma separated list of details to include: address, ext, availability, milestones, subProjects.
take		100	Number of records to select. Default = 100. Max 500.
skip		0	Number of records to skip. Used for pagination.

Responses

Status Code	Type	Description	Samples
200	Project[]	Success

CreateProject

Create a project

Request

POST /api/Project

Parameters

Name	Type	Default	Notes
body	ProjectCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetProject

Get a project

Request

GET /api/Project/{projectRef}[?include]

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
include			Comma separated list of details to include: address, ext, availability, milestones, subProjects.

Responses

Status Code	Type	Description	Samples
200	Project	Success

UpdateProject

Update a project

Request

PATCH /api/Project/{projectRef}

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectUpdate

Responses

Status Code	Type	Description	Samples
200	string	Success

DeleteProjectResourceAvailability

Delete a project resource availability

Request

DELETE /api/Project/{projectRef}/availability

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectAvailabilityCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

GetProjectResourceAvailability

Get a project resource availability

Request

GET /api/Project/{projectRef}/availability

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project

Responses

Status Code	Type	Description	Samples
200	ProjectAvailability[]	Success

AddProjectResourceAvailability

Add a project resource availability

Request

POST /api/Project/{projectRef}/availability

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectAvailabilityCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

ReplaceProjectResourceAvailability

Replace a project resource availability

Request

PUT /api/Project/{projectRef}/availability

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectAvailabilityCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

LockProject

Lock a project

Request

POST /api/Project/{projectRef}/lock

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project

Responses

Status Code	Type	Description	Samples
200		Success

ProjectMilstones

Get a project milestones

Request

GET /api/Project/{projectRef}/milestone

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project

Responses

Status Code	Type	Description	Samples
200	ProjectMilestone[]	Success

ReplaceProjectMilstones

Replace all project milestones

Request

POST /api/Project/{projectRef}/milestone

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectMilestoneCreate[]

Responses

Status Code	Type	Description	Samples
200		Success

AddProjectMilstones

Add a project milestone

Request

PUT /api/Project/{projectRef}/milestone

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
body	ProjectMilestoneCreate

Responses

Status Code	Type	Description	Samples
200		Success

DeleteProjectMilstones

Delete a project milestone

Request

DELETE /api/Project/{projectRef}/milestone/{milestoneIdOrCode}

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project
*milestoneIdOrCode

Responses

Status Code	Type	Description	Samples
200		Success

UnlockProject

Unlock a project

Request

POST /api/Project/{projectRef}/unlock

Parameters

Name	Type	Default	Notes
*projectRef			Id, code or internal reference of the project

Responses

Status Code	Type	Description	Samples
200		Success

PurchaseInvoice

A suite of APIs to manage PurchaseInvoices.

GetPurchaseInvoices

Get a list of purchase invoices with a search filter

Request

GET /api/PurchaseInvoice[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreatePurchaseInvoice

Create a purchase invoice.

Request

POST /api/PurchaseInvoice

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdatePurchaseInvoice

Update a purchase invoice.

Request

PATCH /api/PurchaseInvoice/{idOrDocNo}

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the purchase invoice
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetPurchaseInvoice

Get a purchase invoice

Request

GET /api/PurchaseInvoice/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the purchase invoice
include			Comma separated list of details to include: details, payments, tax, allocations.

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitPurchaseInvoice

Submit a purchase invoice for authorisation and posting.

Request

POST /api/PurchaseInvoice/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the purchase invoice

Responses

Status Code	Type	Description	Samples
200		Success

PurchaseOrder

A suite of APIs to manage PurchaseOrders.

GetPurchaseOrders

Get a list of purchase orders with a search filter

Request

GET /api/PurchaseOrder[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreatePurchaseOrder

Create a purchase order.

Request

POST /api/PurchaseOrder

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdatePurchaseOrder

Update a purchase order.

Request

PATCH /api/PurchaseOrder/{idOrDocNo}

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the purchase order
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetPurchaseOrder

Get a purchase order.

Request

GET /api/PurchaseOrder/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the purchase order
include

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitPurchaseOrder

Submit a purchase order for authorisation.

Request

POST /api/PurchaseOrder/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the purchase order

Responses

Status Code	Type	Description	Samples
200		Success

Receipt

A suite of APIs to manage Receipts.

GetReceipts

Get a list of receipts with a search filter

Request

GET /api/Receipt[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreateReceipt

Create a receipt.

Request

POST /api/Receipt

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

AddReceiptAllocation

Add a receipt allocation.

Request

POST /api/Receipt/{docIdOrCode}/allocation

Parameters

Name	Type	Default	Notes
*docIdOrCode			Id or document number of the receipt
body	DocAllocationCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

GetReceipt

Get a receipt

Request

GET /api/Receipt/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the receipt
include

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitReceipt

Submit a receipt for authorisation and posting.

Request

POST /api/Receipt/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the receipt

Responses

Status Code	Type	Description	Samples
200		Success

Resource

A suite of APIs to manage Resources.

GetResource

Get a resource

Request

GET /api/Resource/{id}

Parameters

Name	Type	Default	Notes
*id			Id of the resource

Responses

Status Code	Type	Description	Samples
200	ResourceRead	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

SaleInvoice

A suite of APIs to manage SaleInvoices.

GetSaleInvoices

Get a list of sale invoices with a search filter

Request

GET /api/SaleInvoice[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreateSaleInvoice

Create a sale invoice.

Request

POST /api/SaleInvoice

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdateSaleInvoice

Update a sale invoice

Request

PATCH /api/SaleInvoice/{idOrDocNo}

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or documnt number of the sale invoice
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetSaleInvoice

Get a sale invoice

Request

GET /api/SaleInvoice/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or documnt number of the sale invoice
include

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitSaleInvoice

Submit a sale invoice for authorisation and posting.

Request

POST /api/SaleInvoice/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the sale invoice

Responses

Status Code	Type	Description	Samples
200		Success

SaleOrder

A suite of APIs to manage SaleOrders.

GetSaleOrders

Get sale orders with a search filter

Request

GET /api/SaleOrder[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreateSaleOrder

Create a sale order.

Request

POST /api/SaleOrder

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdateSaleOrder

Update a sale order

Request

PATCH /api/SaleOrder/{idOrDocNo}

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the sale order
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetSaleOrder

Get a sale order

Request

GET /api/SaleOrder/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the sale order
include

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitSaleOrder

Submit a sale order for authorisation.

Request

POST /api/SaleOrder/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the sale order

Responses

Status Code	Type	Description	Samples
200		Success

SaleQuote

A suite of APIs to manage SaleQuotes.

GetSaleQuotes

Get a list of sale quotes with a search filter

Request

GET /api/SaleQuote[?DocNo&DocType&DocTypeId&ContactAccount&ContactAccountId&LegalEntity&LegalEntityId&Currency&Project&ProjectId&Description&DescriptionContains&TheirRef&IntRef&LegacyRef&TheirDocNo&DocClass&DocDateFrom&DocDateTo&DueDateFrom&DueDateTo&LastModifiedFrom&LastModifiedTo&Outstanding&Unmatched&Draft&Abandoned&Posted&Approved&Reversed&Take&Skip]

Parameters

Name	Type	Default	Notes
DocNo			The document number
DocType			The document type code
DocTypeId			The document type id
ContactAccount			The document contact account code
ContactAccountId			The document contact account id
LegalEntity			The document legal entity code
LegalEntityId			The document legal entity id
Currency			The document currency
Project			The document project code
ProjectId			The document project id
Description			The document description
DescriptionContains			The document description contains
TheirRef			An external reference code
IntRef			The document internal reference
LegacyRef			Alternative / legacy reference code
TheirDocNo			An external document number
DocClass			The document class
DocDateFrom			The document from date
DocDateTo			The document to date
DueDateFrom			The document due from date
DueDateTo			The document due to date
LastModifiedFrom			The document last modified from date
LastModifiedTo			The document last modified to date
Outstanding			The document outstanding flag
Unmatched			The document unmatched flag
Draft			The document draft flag
Abandoned			The document abandoned flag
Posted			The document posted
Approved			The document approved flag
Reversed			The document reversed flag
Take			The number of documents to take
Skip			The number of documents to skip

Responses

Status Code	Type	Description	Samples
200	DocSummary[]	Success
404	ProblemDetails	Not Found
default	ProblemDetails	Error

CreateSaleQuote

Create a sale quote

Request

POST /api/SaleQuote

Parameters

Name	Type	Default	Notes
body	DocCreate

Responses

Status Code	Type	Description	Samples
200	string	Success

UpdateSaleQuote

Update a sale quote

Request

PATCH /api/SaleQuote/{idOrDocNo}

Parameters

Name	Type	Default	Notes
*idOrDocNo			Id or document number of the sale quote
body	DocUpdate

Responses

Status Code	Type	Description	Samples
200		Success

GetSaleQuote

Get a sale quote

Request

GET /api/SaleQuote/{id}[?include]

Parameters

Name	Type	Default	Notes
*id			Id or document number of the sale quote
include

Responses

Status Code	Type	Description	Samples
200	Doc	Success

SubmitSaleQuote

Submit a sale quote for authorisation.

Request

POST /api/SaleQuote/{id}/submit

Parameters

Name	Type	Default	Notes
*id			Id of the sale quote

Responses

Status Code	Type	Description	Samples
200		Success

Session

A suite of APIs to manage Sessions.

CloseSession

Close the session

Request

POST /api/Session/close

Responses

Status Code	Type	Description	Samples
200		Success

CreateSessionAPIKey

Create a session with an API Key.

Request

POST /api/Session/create/api

Parameters

Name	Type	Default	Notes
body	LoginApiCredentials

Responses

Status Code	Type	Description	Samples
200	SessionResultData	Success

Definitions

AttachmentRead

Name	Type	Notes
created	string (date-time)
createdBy	string
description	string	The attachment description
documentDate	string (date-time)	The attachment document date
fileName	string	The attachment file name
fileSize	integer (int64)	The attachment file size
id	string (uuid)	The attachment unique id

AttachmentUpdate

Name	Type	Notes
description	string	The attachment description
documentDate	string (date-time)	The attachment document date

AttachmentGroupRead

Name	Type	Notes
description	string	The attachment group description
id	string (uuid)	The attachment group unique id

BankTransactionCreate

Name	Type	Notes
bankAccountRef	string	The bank transaction bank acccount reference
bankDate	string (date)	The bank transaction bank date
bankReference	string	The bank transaction bank reference
depositAmount	number (double)	The bank transaction deposit amount
description	string	The bank transaction description
merchantName	string	The bank transaction merchant name
paymentMethodRef	string	The bank transaction payment method reference
postDate	string (date)	The bank transaction post date
withdrawalAmount	number (double)	The bank transaction withdrawal amount

BankTransactionRead

Name	Type	Notes
amount	number (double)	The bank transaction amount
bankAccountId	string (uuid)	The bank transaction bank acccount id
bankDate	string (date)	The bank transaction bank date
bankReference	string	The bank transaction bank referencee
bankStatementId	string (uuid)	The bank transaction bank statement id
depositAmount	number (double)	The bank transaction bank deposit amount
description	string	The bank transaction description
id	string (uuid)	The bank transaction unique id
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
merchantName	string	The bank transaction merchant name
paymentMethodCode	string	The bank transaction payment method code
postDate	string (date)	The bank transaction post date
withdrawalAmount	number (double)	The bank transaction bank withdrawal amount

BankTransactionUpdate

Name	Type	Notes
bankDate	string (date)	The bank transaction bank date
bankReference	string	The bank transaction bank reference
depositAmount	number (double)	The bank transaction deposit amount
description	string	The bank transaction description
merchantName	string	The bank transaction merchant name
paymentMethodRef	string	The bank transaction payment method reference
postDate	string (date)	The bank transaction post date
withdrawalAmount	number (double)	The bank transaction withdrawal amount

BatchPaymentSummary

Name	Type	Notes
bankAccountId	string (uuid)	The batch payment bank account id
bankCurrency	string	The batch payment bank currency
bankCurrencyAmount	number (double)	The batch payment bank currency amount
bankCurrencyRate	number (double)	The batch payment bank currency rate
bankRef	string	The batch payment bank reference
batchNo	string	The batch payment batch number
batchPaymentTypeId	string (uuid)	The batch payment unique id
description	string	The batch payment description
id	string (uuid)	The batch payment unique id
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legalEntityId	string (uuid)	The batch payment legal entity id
paymentDate	string (date-time)	The batch payment date
paymentMethodId	string (uuid)	The batch payment method id
periodId	string (uuid)	The batch payment period id
status	integer (int64)	The batch payment status
statusList	array	The batch payment status list

BatchPaymentCreate

Name	Type	Notes
allocations	DocAllocationCreate[]	Payment allocations.
bankAccountId	string	If not specified, the default batch payment bank account of the legal entity will be used.
bankRef	string	If not specified, it defaults to the batch payment number.
batchPaymentTypeId	string	If not specified, the default batch payment type will be used.
description	string	If not specified, it defaults to the batch payment number.
legalEntityId	string	If not specified, the default legal entity will be used. When the bank account is specified, the legal entity can be omitted.
paymentDate	string (date-time)	If not specified, it defaults to today.
paymentMethodId	string	If not specified, it defaults to the default batch payment method of the bank account.
periodId	string	If not specified, it is evaluated based on the payment date.

DocAllocationCreate

Payment allocations.

Name	Type	Notes
allocAmountBase	number (double)	Optional, base allocation amount.
allocAmountCurrency	number (double)	Allocated amount, in the currency of the allocated document.
docId	string	Allocated document (id or doc no)

BatchPaymentUpdate

Name	Type	Notes
bankRef	string	The batch payment bank reference
description	string	The batch payment description
paymentDate	number (double)	The batch payment date

BatchPaymentDetail

Name	Type	Notes
allocations	DocAllocation[]
bankAccountId	string (uuid)
bankCurrency	string
bankCurrencyAmount	number (double)
bankCurrencyRate	number (double)
bankRef	string
batchNo	string
batchPaymentTypeId	string (uuid)
description	string
hasAttachments	boolean
hasNotes	boolean
id	string (uuid)
lastModified	string (date-time)
lastModifiedBy	string
legalEntityId	string (uuid)
paymentDate	string (date-time)
paymentMethodId	string (uuid)
periodId	string (uuid)
status	integer (int64)
statusList	array

DocAllocation

Name	Type	Notes
allocAmountBase	number (double)	Allocated amount, in the base currency of the allocated document.
allocAmountCurrency	number (double)	Allocated amount, in the currency of the allocated document.
allocCurrencyRate	number (double)	Allocated amount, in the base currency of the allocated document.
docId	string (uuid)	Allocated document id
docNo	string	Allocated document no
id	string (uuid)	Allocation id

CatalogItem

Name	Type	Notes
code	string
description	string
id	string (uuid)

CatalogItemCreate

Name	Type	Notes
code	string
description	string	Catalog item description
isActive	boolean	Active or locked (soft delete)

CatalogItemUpdate

Name	Type	Notes
description	string	Catalog item description
isActive	boolean	Active or locked (soft delete)

ContactCreate

Name	Type	Notes
addresses	ContactAddressCreate[]
companyName	string	Company name. (Applicable to both Company and Person contact types)
emails	ContactEmailCreate[]
firstName	string	Person first name. (Applicable to Person contact types only).
intRef	string	Interface reference. (If supplied, must be unique)
jobTitle	string	Person job title. (Applicable to Person contact types only).
lastName	string	Person last name. (Applicable to Person contact types only).
legacyRef	string
middleName	string	Person middle name. (Applicable to Person contact types only).
phones	ContactPhoneCreate[]
title	string	Person title. (Applicable to Person contact types only).

ContactAddressCreate

Name	Type	Notes
address	string	The contact address
city	string	The contact address city
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
county	string	The contact address country
description	string	The contact address description
postCode	string	The contact address postcode
type	string	The contact address type

ContactEmailCreate

Name	Type	Notes
email	string	The contact email address
type	string	Email type (registered, accounts, personal, etc.). See ContactMailType catalog.

ContactPhoneCreate

Name	Type	Notes
phone	string	The contact phone number
type	string	Phone type (work, personal, etc.). See ContactPhoneType catalog.

ContactRead

Name	Type	Notes
addresses	ContactAddressRead[]
companyName	string	Company name. (Applicable to both Company and Person contact types)
contactType	string	Contact type: C: company, P: person
description	string	Contact description
emails	ContactEmailRead[]
firstName	string	Person first name. (Applicable to Person contact types only).
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	Contact id
intRef	string	Interface reference. (If supplied, must be unique)
isActive	boolean	Active or locked (soft delete)
jobTitle	string	Person job title. (Applicable to Person contact types only).
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
lastName	string	Person last name. (Applicable to Person contact types only).
legacyRef	string	Alternative / legacy reference code
middleName	string	Person middle name. (Applicable to Person contact types only).
parentContactId	string (uuid)
phones	ContactPhoneRead[]
title	string	Person title. (Applicable to Person contact types only).

ContactAddressRead

Name	Type	Notes
address	string	Contact address line
city	string	Contact address city
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
county	string	Contact address county
description	string	Contact address description
id	string (uuid)	The contact address unique id
postCode	string	Contact address postcode
type	string	Address type (registered, delivery, etc.). See ContactAddressType catalog.

ContactEmailRead

Name	Type	Notes
email	string	The contact email address
id	string (uuid)
type	string	Email type (registered, accounts, personal, etc.). See ContactMailType catalog.

ContactPhoneRead

Name	Type	Notes
id	string (uuid)
phone	string	The contact phone number
type	string	Phone type (work, personal, etc.). See ContactPhoneType catalog.

ContactUpdate

Name	Type	Notes
addresses	ContactAddressCreate[]	Contact addresses
companyName	string	Contact company name
emails	ContactEmailCreate[]	Contact emails
firstName	string	Contact first name
id	string (uuid)	Contact id
intRef	string	Contact internal reference
jobTitle	string	Contact job title
lastName	string	Contact last name
legacyRef	string	Alternative / legacy reference code
middleName	string	Contact middle name
phones	ContactPhoneCreate[]	Contact phone numbers
suffix	string	Contact suffix
title	string	Contact title

ContactAccountRead

Name	Type	Notes
bankDetails	ContactBankDetailsRead[]	All bank details. (?include=allBankDetails)
code	string	Contact account code
companyNo	string	Company number
contact	ContactRead
contactClassificationId	string (uuid)	Contact classification id
contacts	ContactRead[]	Persons contact details (?include=contacts)
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
createdBy	string	The user that created this item. See UserAccount catalog.
createdDate	string (date-time)	The date and time this item has been created
customer	ContactCustomerRead
defaultBankDetails	ContactBankDetailsRead
description	string	Contact account internal description
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	Contact account id
intRef	string	Interface reference
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legacyRef	string	Alternative / legacy reference code
resource	ContactResourceRead
supplier	ContactSupplierRead
taxNo	string	Tax number
theirRef	string	An external reference code

ContactBankDetailsRead

All bank details. (?include=allBankDetails)

Name	Type	Notes
accountName	string	Optional, account name
accountNo	string	Bank account number
bankAddress	string	Optional, bank branch address
bankId	string	Optional, Bank reference. See Bank catalog.
bankRef	string	Optional, default Bank Ref
bic	string	SWIFT-BIC, BIC, SWIFT ID or SWIFT code (ISO 9362)
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
currency	string	Bank currency code
iban	string	International Bank Account Number (IBAN)
id	string (uuid)
lastModified	string (date-time)
lastModifiedBy	string
legacyRef	string	An optional reference
routingCode	string	ABA routing transit number (ABA RTN) (US only)
sortCode	string	Bank account sort code (UK only)

ContactCustomerRead

Name	Type	Notes
applyDomesticReverseCharge	boolean	When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the customer
contactGroupCustomerId	string (uuid)	The Customer group. See ContactGroupCustomer catalog.
costCentreFixed	boolean	The default cost centre is fixed
costCentreId	string (uuid)	Default cost centre id
creditLimit	number (double)	Credit limit
creditReportDate	string (date-time)	Credit report date
creditScore	number (double)	Credit score
currency	string	Currency code. See Currency catalog. (ISO 4217)
departmentFixed	boolean	The default department is fixed
departmentId	string (uuid)	Default department id
discountRate	number (double)	Discount rate (0 - 100).
ext	object	Custom fields
isActive	boolean	Active or locked
isHold	boolean	Hold for posting
isStop	boolean	Stop all documents
lastStatementDate	string (date-time)	Date and time of the last sent customer statement
payTermId	string (uuid)	Default payment terms. See PayTerm catalog.
paymentMethodId	string (uuid)	Default payment method. See PaymentMethod catalog.
projectId	string (uuid)	Default project.
receiveInvoices	boolean	Include in invoice distribution
receiveReminders	boolean	Include in reminder letter distribution
receiveStatements	boolean	Include in customer statement distribution
reminderGroupId	string (uuid)	Default reminder group. See ReminderGroup catalog.
taxAuthorityId	string (uuid)	Tax authority that the customer belongs to. See TaxAuthority catalog.
taxBandFixed	boolean	The default tax band is fixed
taxBandId	string (uuid)	Default tax band
warningMessage	string	Default warning message

ContactResourceRead

Name	Type	Notes
absenceGroupId	string (uuid)	Resource absence group id
allowExpense	boolean	Resource is allowed expenses
allowTask	boolean	Resource can be allocated tasks
allowTimesheet	boolean	Resource can record timesheets
costCentreId	string (uuid)	Resource cost centre id
currency	string	Currency code. See Currency catalog. (ISO 4217)
departmentId	string (uuid)	Resource department id
expenseProducts	ExpenseProductRead[]	List of resource expense products
ext	object	Custom fields
hasEmployment	boolean	Resource can record employment
hasUmbrella	boolean	Resource can record umbrella supplier
isActive	boolean	Active or locked (soft delete)
isBuyer	boolean	Resource is responsible for purchase orders
isRequestor	boolean	Resource is responsible for requisitions
isSalesperson	boolean	Resource is a sales person
locationId	string (uuid)	Resource location id
managerResourceId	string (uuid)	Resource manager id
nationalInsuranceNo	string	Resource national insurance number
paymentMethodId	string (uuid)	Expense payment method id
paymentTermsId	string (uuid)	Expense payment terms id
resourceEmployments	ResourceEmploymentRead[]	List of resource employment records
resourceGroupId	string (uuid)	Resource group id
resourceUmbrellas	ResourceUmbrellaRead[]	List of resource umbrella supplier records
sendRemittance	boolean	Expense remittance advice produced
timesheetProducts	TimesheetProductRead[]	List of resource timesheet products
uniqueTaxpayerReference	string	Resource tax reference

ExpenseProductRead

List of resource expense products

Name	Type	Notes
productId	string (uuid)	Expense product id

ResourceEmploymentRead

List of resource employment records

Name	Type	Notes
dateFrom	string (date-time)	Resource employment from date
dateTo	string (date-time)	Resource employment to date
employmentTypeId	string (uuid)	Resource employment type id
excludeFromIntermediaryReport	boolean	Resource employment exclude from intermediary report
externalReference	string	Resource employment external reference
jobGrade	string	Resource employment job grade
jobTitle	string	Resource employment job title
legalEntityId	string (uuid)	Resource employment legal entity id
paymentFrequencyId	string (uuid)	Resource employment payment frequency id
previousEmployer	string	Resource employment previous employer
terminationNoticeDays	integer (int32)	Resource employment termination notice days

ResourceUmbrellaRead

List of resource umbrella supplier records

Name	Type	Notes
dateFrom	string (date-time)	Resource umbrella from date
dateTo	string (date-time)	Resource umbrella to date
umbrellaContactAccountId	string (uuid)	Resource umbrella contact account id

TimesheetProductRead

List of resource timesheet products

Name	Type	Notes
contactAccountId	string (uuid)	Timesheet contact account id
costRate	number (double)	Timesheet cost rate
dateFrom	string (date-time)	Timesheet from date
dateTo	string (date-time)	Timesheet to date
productId	string (uuid)	Timesheet product id
rechargeRate	number (double)	Timesheet recharge rate

ContactSupplierRead

Name	Type	Notes
accountId	string (uuid)	Default account id
allowInvoiceDuplication	boolean	Allow repeated invoice numbers for the same supplier
applyDomesticReverseCharge	boolean	When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the supplier
contactGroupSupplierId	string (uuid)	Required, the Supplier group will determine defaults for all the other unspecified supplier fields. See ContactGroupSupplier catalog.
costCentreFixed	boolean	The default cost centre is fixed
costCentreId	string (uuid)	Default cost centre id
creditLimit	number (double)	Agreed credit limit
currency	string	Currency code. See Currency catalog. (ISO 4217)
departmentFixed	boolean	The default department is fixed
departmentId	string (uuid)	Default department id
ext	object	Custom fields
isActive	boolean	Active or locked
payTermId	string (uuid)	Default payment terms. See PayTerm catalog.
paymentMethodId	string (uuid)	Default payment method. See PaymentMethod catalog.
productId	string (uuid)	Default product id
projectId	string (uuid)	Default project.
sendRemittance	boolean	Include in payment remittance distribution
taxAuthorityId	string (uuid)	Tax authority that the supplier belongs to. See TaxAuthority catalog.
taxBandFixed	boolean	The default tax band is fixed
taxBandId	string (uuid)	Default tax band
warningMessage	string	Default warning message

ContactAccountCreate

Name	Type	Notes
bankDetails	ContactBankDetailsUpdateable[]	Bank details
code	string	Optional contact account code. If omitted it is auto-generated. If provided, it must be unique
companyNo	string	Company number
contact	ContactCreate[]
contactClassificationId	string	Optional, Contact classification id or code
contacts	ContactCreate[]	Optional additional related people and their contact details
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
customer	ContactCustomerCreate[]
description	string	Required, the internal contact account description.
intRef	string	Optional interface reference. If provided, it must be unique
legacyRef	string	Alternative / legacy reference code
resource	ContactResourceCreate[]
supplier	ContactSupplierCreate[]
taxNo	string	Tax number
theirRef	string	An external reference code

ContactBankDetailsUpdateable

Bank details

Name	Type	Notes
accountName	string	Optional, account name
accountNo	string	Bank account number
bankAddress	string	Optional, bank branch address
bankId	string	Optional, Bank reference. See Bank catalog.
bankRef	string	Optional, default Bank Ref
bic	string	SWIFT-BIC, BIC, SWIFT ID or SWIFT code (ISO 9362)
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
currency	string	Bank currency code
iban	string	International Bank Account Number (IBAN)
legacyRef	string	An optional reference
routingCode	string	ABA routing transit number (ABA RTN) (US only)
sortCode	string	Bank account sort code (UK only)

ContactCustomerCreate

Name	Type	Notes
applyDomesticReverseCharge	boolean
contactGroupCustomerId	string	Required, the Customer group will determine defaults for all the other unspecified customer fields. See ContactGroupCustomer catalog.
costCentreFixed	boolean
costCentreId	string	Default cost centre id or code
creditLimit	number (double)
creditReportDate	string (date-time)
creditScore	number (double)
currency	string
departmentFixed	boolean
departmentId	string	Default department id or code
discountRate	number (double)
ext	object	Custom fields
isActive	boolean
isHold	boolean	Hold for posting
isStop	boolean	Stop all documents
payTermId	string
paymentMethodId	string
projectId	string
receiveInvoices	boolean
receiveReminders	boolean
receiveStatements	boolean
reminderGroupId	string	Include in invoice distribution
taxAuthorityId	string
taxBandFixed	boolean
taxBandId	string
warningMessage	string	Default warning message

ContactResourceCreate

Name	Type	Notes
absenceGroupId	string	Resource absence group id or code
allowExpense	boolean	Resource is allowed expenses
allowTask	boolean	Resource can be allocated tasks
allowTimesheet	boolean	Resource can record timesheets
costCentreId	string	Resource cost centre id or code
currency	string
departmentId	string	Resource department id or code
ext	object	Custom fields
hasEmployment	boolean	Resource can record employment
hasUmbrella	boolean	Resource can record umbrella supplier
isActive	boolean
isBuyer	boolean	Resource is responsible for purchase orders
isRequestor	boolean	Resource is responsible for requisitions
isSalesperson	boolean	Resource is a sales person
locationId	string	Resource location id or code
managerResourceId	string	Resource manager id or code
nationalInsuranceNo	string	Resource national insurance number
paymentMethodId	string	Expense payment method id or code
paymentTermsId	string	Expense payment terms id or code
resourceEmployments	ResourceEmploymentCreate[]	List of resource employment records
resourceGroupId	string	Required, the Resource group will determine defaults for all the other unspecified resource fields. See ResourceGroup catalog.
resourceUmbrellas	ResourceUmbrellaCreate[]	List of resource umbrella supplier records
sendRemittance	boolean	Expense remittance advice produced
uniqueTaxpayerReference	string	Resource tax reference

ResourceEmploymentCreate

List of resource employment records

Name	Type	Notes
dateFrom	string (date-time)	Resource employment from date
dateTo	string (date-time)	Resource employment to date
employmentTypeId	string	Resource employment type id or code
excludeFromIntermediaryReport	boolean	Resource employment exclude from intermediary report, default false
externalReference	string	Resource employment external reference
jobGrade	string	Resource employment job grade
jobTitle	string	Resource employment job title
legalEntityId	string	Resource employment legal entity id or code
paymentFrequencyId	string	Resource employment payment frequency id or code
previousEmployer	string	Resource employment previous employer
terminationNoticeDays	integer (int32)	Resource employment termination notice days

ResourceUmbrellaCreate

List of resource umbrella supplier records

Name	Type	Notes
dateFrom	string (date-time)	Resource umbrella from date
dateTo	string (date-time)	Resource umbrella to date
umbrellaContactAccountId	string	Resource umbrella contact account id or code

ContactSupplierCreate

Name	Type	Notes
accountId	string	Default account id or code
allowInvoiceDuplication	boolean	Allow repeated invoice numbers for the same supplier
applyDomesticReverseCharge	boolean	When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the supplier
contactGroupSupplierId	string	Required, the Supplier group will determine defaults for all the other unspecified supplier fields. See ContactGroupSupplier catalog.
costCentreFixed	boolean	The default cost centre is fixed
costCentreId	string	Default cost centre id or code
creditLimit	number (double)	Agreed credit limit
currency	string
departmentFixed	boolean	The default department is fixed
departmentId	string	Default department id or code
ext	object	Custom fields
isActive	boolean	Active or locked
payTermId	string	Default payment terms. See PayTerm catalog.
paymentMethodId	string	Default payment method. See PaymentMethod catalog.
productId	string	Default product id or code
projectId	string	Default project.
sendRemittance	boolean	Include in payment remittance distribution
taxAuthorityId	string	Tax authority that the supplier belongs to. See TaxAuthority catalog.
taxBandFixed	boolean	The default tax band is fixed
taxBandId	string	Default tax band
warningMessage	string	Default warning message

ContactAccountUpdate

Name	Type	Notes
bankDetails	ContactBankDetailsUpdateable[]	Bank details
companyNo	string	Company number
contact	ContactCreate[]
contactClassificationId	string	Optional, Contact classification id or code
contacts	ContactCreate[]	Optional additional related people and their contact details
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
customer	ContactCustomerUpdate[]
description	string	Required, the internal contact account description.
intRef	string	ContactAccountCreate.IntRef
legacyRef	string
resource	ContactResourceUpdate[]
supplier	ContactSupplierUpdate[]
taxNo	string	Tax number
theirRef	string

ContactCustomerUpdate

Name	Type	Notes
applyDomesticReverseCharge	boolean	When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the customer
contactGroupCustomerId	string	The Customer group. See ContactGroupCustomer catalog.
costCentreFixed	boolean	The default cost centre is fixed
costCentreId	string	Default cost centre id or code
creditLimit	number (double)	Credit limit
creditReportDate	string (date-time)	Credit report date
creditScore	number (double)	Credit score
currency	string
departmentFixed	boolean	The default department is fixed
departmentId	string	Default department id or code
discountRate	number (double)	Discount rate (0 - 100).
ext	object	Custom fields
isActive	boolean	Active or locked
isHold	boolean	Hold for posting
isStop	boolean	Stop all documents
payTermId	string	Default payment terms. See PayTerm catalog.
paymentMethodId	string	Default payment method. See PaymentMethod catalog.
projectId	string	Default project.
receiveInvoices	boolean	Default reminder group. See ReminderGroup catalog.
receiveReminders	boolean	Include in reminder letter distribution
receiveStatements	boolean	Include in customer statement distribution
reminderGroupId	string	Include in invoice distribution
taxAuthorityId	string	Tax authority that the customer belongs to. See TaxAuthority catalog.
taxBandFixed	boolean	The default tax band is fixed
taxBandId	string	Default tax band
warningMessage	string

ContactResourceUpdate

Name	Type	Notes
absenceGroupId	string	Resource absence group id or code
allowExpense	boolean	Resource is allowed expenses
allowTask	boolean	Resource can be allocated tasks
allowTimesheet	boolean	Resource can record timesheets
costCentreId	string	Resource cost centre id or code
currency	string
departmentId	string	Resource department id or code
ext	object	Custom fields
hasEmployment	boolean	Resource can record employment
hasUmbrella	boolean	Resource can record umbrella supplier
isActive	boolean
isBuyer	boolean	Resource is responsible for purchase orders
isRequestor	boolean	Resource is responsible for requisitions
isSalesperson	boolean	Resource is a sales person
locationId	string	Resource location id or code
managerResourceId	string	Resource manager id or code
nationalInsuranceNo	string	Resource national insurance number
paymentMethodId	string	Expense payment method id or code
paymentTermsId	string	Expense payment terms id or code
resourceGroupId	string	Resource group id
sendRemittance	boolean	Expense remittance advice produced
uniqueTaxpayerReference	string	Resource tax reference

ContactSupplierUpdate

Name	Type	Notes
accountId	string	Default account id or code
allowInvoiceDuplication	boolean
applyDomesticReverseCharge	boolean
contactGroupSupplierId	string	The Supplier group. See ContactGroupSupplier catalog.
costCentreFixed	boolean
costCentreId	string	Default cost centre id or code
creditLimit	number (double)
currency	string
departmentFixed	boolean
departmentId	string	Default department id or code
ext	object	Custom fields
isActive	boolean
payTermId	string
paymentMethodId	string
productId	string	Default product id or code
projectId	string
sendRemittance	boolean
taxAuthorityId	string
taxBandFixed	boolean
taxBandId	string
warningMessage	string

ContactGroupRead

Name	Type	Notes
code	string	Unique Code for the contact group
customer	ContactGroupCustomerRead[]
description	string	Description for the contact group
id	string (uuid)	Unique Id for the contact group
lastModified	string (date-time)
lastModifiedBy	string
supplier	ContactGroupSupplierRead[]

ContactGroupCustomerRead

Name	Type	Notes
costCentreId	string (uuid)	Cost Centre default for the contact group
customFields	CustomField[]	Custom fields
departmentId	string (uuid)	Department default for the contact group
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
paymentMethodId	string (uuid)	Payment method default for the contact group
paymentTermsId	string (uuid)	Payment terms default for the contact group

CustomField

Custom fields

Name	Type	Notes
attribute	string	Custom field attribute name
caption	string	Custom field caption
catalog	string	Custom field catalog name
component	string	Custom field component name
defaultValue	string	Custom field default value
propertyName	string	Custom field unique name
readOnly	boolean	Custom field read only flag
required	boolean	Custom field is required flag

ContactGroupSupplierRead

Name	Type	Notes
costCentreId	string (uuid)	Cost Centre default for the contact group
customFields	CustomField[]	Custom fields
departmentId	string (uuid)	Department default for the contact group
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
paymentMethodId	string (uuid)	Payment method default for the contact group
paymentTermsId	string (uuid)	Payment terms default for the contact group

CostCentreSearch

Name	Type	Notes
code	string
description	string
id	string (uuid)	Unique Id for the cost centre
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
legacyRef	string
legalEntityId	string (uuid)	When supplied, the use of the cost centre can be restricted to the specified Legal Entity.
parentCostCentreId	string (uuid)

CostCentreCreate

Name	Type	Notes
code	string	Unique code for the cost centre
description	string	Description of the cost centre
legacyRef	string	Legacy reference of the cost centre
legalEntityId	string	When supplied, the use of the cost centre can be restricted to the specified Legal Entity. Accepts id or code.
parentCostCentreId	string	The cost centre parent (where specified) can be useful for analytics. Accepts id or code.

CostCentreRead

Name	Type	Notes
code	string	Unique code for the cost centre
description	string	Description of the cost centre
id	string (uuid)	Unique Id for the cost centre
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
legacyRef	string
legalEntityId	string (uuid)	When supplied, the use of the cost centre can be restricted to the specified Legal Entity.
parentCostCentreId	string (uuid)	The cost centre parent (where specified) can be useful for analytics
resources	CostCentreResource[]	The cost centre resources
subCostCentres	CostCentreSummary[]	The cost centre sub cost centres

CostCentreResource

The cost centre resources

Name	Type	Notes
accountName	string	Name on the resource account
code	string	Unique code for the resource
id	string (uuid)	Unique Id for the resource

CostCentreSummary

The cost centre sub cost centres

Name	Type	Notes
code	string	Unique code for the cost centre
description	string	Description of the cost centre
id	string (uuid)	Unique Id for the cost centre

CostCentreUpdate

Name	Type	Notes
description	string	Description of the cost centre
legacyRef	string
legalEntityId	string	When supplied, the use of the cost centre can be restricted to the specified Legal Entity. Accepts id or code.
parentCostCentreId	string	The cost centre parent (where specified) can be useful for analytics. Accepts id or code.

DepartmentSearch

Name	Type	Notes
code	string	Unique code for the department
description	string	Description of the department
id	string (uuid)	Unique id for the department
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
legacyRef	string
legalEntityId	string (uuid)	When specified, the use of the department is restricted to the specified Legal Entity.
managerResourceId	string (uuid)	The resource who is identified as the department manager.
parentDepartmentId	string (uuid)	Description of the department

DepartmentCreate

Name	Type	Notes
code	string	Unique code for the department
description	string	Description of the department
legacyRef	string
legalEntityId	string	When supplied, the use of the department can be restricted to the specified Legal Entity. Accepts id or code.
managerResourceId	string	The resource who is identified as the department manager. Accepts id or code.
parentDepartmentId	string	The Department parent (where specified) can be useful for analytics. Accepts id or code.

DepartmentRead

Name	Type	Notes
code	string	Unique code for the department
description	string	Description of the department
id	string (uuid)	Unique id for the department
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string
legacyRef	string
legalEntityId	string (uuid)	When specified, the use of the department is restricted to the specified Legal Entity.
managerResourceId	string (uuid)	The resource who is identified as the department manager.
parentDepartmentId	string (uuid)	The Department parent (where specified) can be useful for analytics.
resources	ResourceSummary[]	Department resources
subDepartments	DepartmentSummary[]	Department sub departments

ResourceSummary

Department resources

Name	Type	Notes
code	string	Unique code for the resource
description	string	Description of the resource
id	string (uuid)	Unique id for the resource

DepartmentSummary

Department sub departments

Name	Type	Notes
code	string	Unique code for the department
description	string	Description of the department
id	string (uuid)	Unique id for the department

DepartmentUpdate

Name	Type	Notes
description	string	Description of the department
legacyRef	string
legalEntityId	string	When supplied, the use of the department can be restricted to the specified Legal Entity. Accepts id or code.
managerResourceId	string	The resource who is identified as the department manager. Accepts id or code.
parentDepartmentId	string	The Department parent (where specified) can be useful for analytics. Accepts id or code.

DocSummary

Name	Type	Notes
accountId	string (uuid)	The document account id
bankAccountId	string (uuid)	The document bank account id
bankCurrency	string	The document bank currency
bankCurrencyAmount	number (double)	The document bank currency amount
bankCurrencyRate	number (double)	The document bank currency rate
bankRef	string	The document bank reference
baseCurrency	string	The document base currency
contactAccountDescription	string	The document contact account description
contactAccountId	string (uuid)	The document contact account id
createdBy	string	The user that created this item. See UserAccount catalog.
createdDate	string (date-time)	The date and time this item has been created
currency	string	The document currency
currencyRate	number (double)	The document currency rate
description	string	The document description
docClass	string	The document class
docDate	string (date-time)	The document date
docNo	string	The document number
docSerieId	string (uuid)	The document series id
docTypeId	string (uuid)	The document type id
dueDate	string (date-time)	The document due date
ext	object	The document custom fields
fromStockLocationId	string (uuid)	The document from stock location id
grossAmount	number (double)	The document gross amount
grossCurrencyAmount	number (double)	The document gross currency amount
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	The document id
intRef	string	The document internal reference
isDeferredTax	boolean	The document is deferred tax flag
isNetEntry	boolean	The document is net entry flag
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legalEntityId	string (uuid)	The document legal entity id
netAmount	number (double)	The document net amount
netCurrencyAmount	number (double)	The document currency amount
outstandingAmount	number (double)	The document outstanding amount
outstandingCurrencyAmount	number (double)	The document outstanding currency amount
paymentMethodId	string (uuid)	The document payment method id
paymentTermsId	string (uuid)	The document payment terms id
periodId	string (uuid)	The document period id
projectId	string (uuid)	The document project id
responsibleResourceId	string (uuid)	The document responsible resource id
status	integer (int64)	The document status
statusList	array	The document status list
stockDate	string (date-time)	The document stock date
taxAmount	number (double)	The document tax amouunt
taxAuthorityId	string (uuid)	The document tax authority id
taxCurrencyAmount	number (double)	The document tax currency amount
taxDate	string (date-time)	The document tax date
taxReverseAmount	number (double)	The document tax reverse amount
taxReverseCurrencyAmount	number (double)	The document tax reverse currency amount
textFooter	string	The document text footer
textHeader	string	The document text header
theirDocNo	string	An external document number
theirRef	string	An external reference code
toStockLocationId	string (uuid)	The document to stock location id
transDate	string (date-time)	The document transaction date
transNo	integer (int64)	The document transaction number
transTime	string (date-time)	The document transaction time

DocCreate

Name	Type	Notes
accountId	string	The document account id
allocateAuto	boolean	The document automatic allocation flag
allocations	DocAllocationCreate[]	The document allocations
bankAccountId	string	The document bank account id
bankCurrencyAmount	number (double)	The document bank currency amount
bankCurrencyRate	number (double)	The document bank currency rate
bankRef	string	The document bank reference
billingAddress	ContactAddressInline[]
contactAccountId	string	The document contact account id
currency	string	The document currency
currencyAmount	number (double)	The document currency amount
currencyRate	number (double)	The document currency rate
deliveryAddress	ContactAddressInline[]
description	string	The document description
details	DocDetailCreate[]	The document line details
docDate	string (date-time)	The document date
docNo	string	The document number
docSerieId	string	The document series id
docTypeId	string	The document type id
dueDate	string (date-time)	The document due date
explicitAmounts	boolean	When true, all Amount fields must be specified and they will be accepted as is, with no calculations or rounding checks.
ext	object	The document custom fields
fromStockLocationId	string	The document stock from location id
grossAmount	number (double)	The document gross amount
grossCurrencyAmount	number (double)	The document gross currency amount
intRef	string	The document internal reference
isNetEntry	boolean	The document is net entry flag
legacyRef	string	Alternative / legacy reference code
legalEntityId	string	The document legal entity id
netAmount	number (double)	The document net amount
netCurrencyAmount	number (double)	The document net currency amount
paymentMethodId	string	The document payment method id
paymentTermsId	string	The document default payment terms. See PayTerm catalog.
periodId	string	The document peroid id
post	object	The document posting attributes
projectId	string	The document project id
responsibleResourceId	string	The document responsible resource id
stockDate	string (date-time)	The document stock date
taxAmount	number (double)	The document tax amount
taxAuthorityId	string	The document tax authority id
taxCurrencyAmount	number (double)	The document tax currency amount
taxDate	string (date-time)	The document taax date
textFooter	string	The document text footer
textHeader	string	The document text header
theirDocNo	string	An external document number
theirRef	string	An external reference code
toStockLocationId	string	The document stock to location id
transNo	integer (int64)	The document transaction number

ContactAddressInline

Name	Type	Notes
address	string	Contact address line
city	string	Contact address city
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
county	string	Contact address county
description	string	Contact address description
postCode	string	Contact address postcode
type	string	Address type (registered, delivery, etc.). See ContactAddressType catalog.

DocDetailCreate

The document line details

Name	Type	Notes
accountId	string	The document detail account id
currencyUnitPrice	number (double)	The document detail currency unit price
deferredDistribution	DocDetailDeferredCreateUpdate[]
description	string	The document detail description
fromStockLocationId	string	The document detail from stock location id
grossAmount	number (double)	The document detail gross amount
grossCurrencyAmount	number (double)	The document detail gross currency amount
grossCurrencyUnitPrice	number (double)	The document detail gorss currency unit price
intRef	string	The document detail internal reference
isDeferred	boolean	The document detail is deferred flag
isNetEntry	boolean	The document detail is net entry flag
isResale	boolean	The document detail is resale flag
legacyRef	string	Alternative / legacy reference code
lineDate	string (date-time)	The document detail line date
netAmount	number (double)	The document detail net amount
netCurrencyAmount	number (double)	The document detail net currency amount
netCurrencyUnitPrice	number (double)	The document detail net currency unit price
post	object	The document detail posting attributes
productId	string	The document detail product id or code
productSkuId	string	The document detail product sku id or code
productType	string	The document detail product type
projectId	string	The document detail project id
quantity	number (double)	The document detail quantity
skuQuantity	number (double)	The document detail sku quantity
stockDate	string (date-time)	The document detail stock date
taxAmount	number (double)	The document detail tax amount
taxBandId	string	The document detail tax band id
taxCodeId	string	The document detail tax code id
taxCurrencyAmount	number (double)	The document detail tax currency amount
textPost	string	The document detail post text
textPre	string	The document detail pre text
toStockLocationId	string	The document detail to stock location id
uomId	string	The document detail unit of measure id

DocDetailDeferredCreateUpdate

Name	Type	Notes
dateFrom	string (date)	The document detail deferred from date
dateTo	string (date)	The document detail deferred to date
periods	integer (int32)	The document detail deferred period
profileId	string	The document detail deferred profile id. Accepts Id or Code

DocDetailUpdate

Name	Type	Notes
accountId	string	The document detail account id or code
currencyUnitPrice	number (double)	The document detail currency unit price
deferredDistribution	DocDetailDeferredCreateUpdate[]
description	string	The document detail description
fromStockLocationId	string	The document detail from stock location id
grossCurrencyUnitPrice	number (double)	The document detail gross currency unit price
intRef	string	The document detail internal reference
isDeferred	boolean	The document detail is deferred flag
isNetEntry	boolean	The document detail is net entry flag
isResale	boolean	The document detail is resale flag
legacyRef	string	Alternative / legacy reference code
lineDate	string (date-time)	The document detail line date
netCurrencyUnitPrice	number (double)	The document detail net currency unit price
post	object	The document detail posting attributes
productId	string	The document detail product id or code
productSkuId	string	The document detail product sku id or code
projectId	string	The document detail project id or code
quantity	number (double)	The document detail quantity
skuQuantity	number (double)	The document detail Sku quantity
stockDate	string (date-time)	The document detail from stock date
taxBandId	string	The document detail tax band id or code
taxCodeId	string	The document detail tax id or code
textPost	string	The document detail post text
textPre	string	The document detail pre text
toStockLocationId	string	The document detail to stock location id
uomId	string	The document detail unit of measure id or code

Doc

Name	Type	Notes
accountId	string (uuid)	The document account id
allocations	DocAllocation[]	The document allocations
bankAccountId	string (uuid)	The document bank account id
bankCurrency	string	The document bank currency
bankCurrencyAmount	number (double)	The document bank currency amount
bankCurrencyRate	number (double)	The document bank currency rate
bankRef	string	The document bank reference
baseCurrency	string	The document base currency
billingAddress	ContactAddressRead[]
contactAccountId	string (uuid)	The document contact account id
createdBy	string	The user that created this item. See UserAccount catalog.
createdDate	string (date-time)	The date and time this item has been created
currency	string	The document currency
currencyRate	number (double)	The document currency rate
deliveryAddress	ContactAddressRead[]
description	string	The document description
details	DocDetail[]	The document line details
docClass	string	The document class
docDate	string (date-time)	The document date
docNo	string	The document number
docSerieId	string (uuid)	The document series id
docTypeId	string (uuid)	The document type id
dueDate	string (date-time)	The document due date
ext	object	The document custom fields
fromStockLocationId	string (uuid)	The document from stock location id
grossAmount	number (double)	The document gross amount
grossCurrencyAmount	number (double)	The document gross currency amount
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	The document unique id
intRef	string	The document internal reference
isDeferredTax	boolean	The document is deferred tax flag
isNetEntry	boolean	The document is net entry flag
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legalEntityId	string (uuid)	The document legal entity id
netAmount	number (double)	The document net amount
netCurrencyAmount	number (double)	The document net currency amount
outstandingAmount	number (double)	The document outstanding amount
outstandingCurrencyAmount	number (double)	The document outstanding currency amount
paymentMethodId	string (uuid)	The document payment method id
paymentTermsId	string (uuid)	The document payment terms id
periodId	string (uuid)	The document period id
post	object	The document posting fields
projectId	string (uuid)	The document project id
responsibleResourceId	string (uuid)	The document responsible resource id
status	integer (int64)	The document status
statusList	array	The document status list
stockDate	string (date-time)	The document stock date
taxAmount	number (double)	The document tax amount
taxAuthorityId	string (uuid)	The document tax authority id
taxCurrencyAmount	number (double)	The document tax currency amount
taxDate	string (date-time)	The document tax date
taxReverseAmount	number (double)	The document tax reverse amount
taxReverseCurrencyAmount	number (double)	The document tax reverse currency amount
textFooter	string	The document footer text
textHeader	string	The document header text
theirDocNo	string	An external document number
theirRef	string	An external reference code
toStockLocationId	string (uuid)	The document to stock location id
transDate	string (date-time)	The document transaction date
transNo	integer (int64)	The document transaction number
transTime	string (date-time)	The document transaction time

DocDetail

The document line details

Name	Type	Notes
accountId	string (uuid)	The document detail account id
currency	string	The document detail currency
currencyRate	number (double)	The document detail currency rate
deferredDistribution	DocDetailDeferred[]
description	string	The document detail description
docClass	string	The document detail class
docId	string (uuid)	The document detail document id
fromStockLocationId	string (uuid)	The document detail from stock location id
grossAmount	number (double)	The document detail gross amount
grossCurrencyAmount	number (double)	The document detail gross currency amount
grossCurrencyUnitPrice	number (double)	The document detail gross currency unit price
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	The document detail unique id
intRef	string	The document detail internal reference
isDeferred	boolean	The document detail is deferred flag
isNetEntry	boolean	The document detail is net entry
isResale	boolean	The document detail is resale flag
isReverseCharge	boolean	The document detail is reverse charge flag
isTaxAdjustment	boolean	The document detail is tax adjustment flaa
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legacyRef	string	Alternative / legacy reference code
lineDate	string (date-time)	The document detail line date
netAmount	number (double)	The document detail net amount
netCurrencyAmount	number (double)	The document detail net currency amount
netCurrencyUnitPrice	number (double)	The document detail net currency unit price
orderIndex	integer (int32)	The document detail order index
post	object	The document posting fields
productId	string (uuid)	The document detail product id
productType	string	The document detail product type
projectId	string (uuid)	The document detail project id
quantity	number (double)	The document detail quantity
skuQuantity	number (double)	The document detail Sku quantity
status	integer (int64)	The document detail status
stockDate	string (date-time)	The document detail stock date
taxAmount	number (double)	The document detail tax amount
taxBandId	string (uuid)	The document detail tax band id
taxCodeId	string (uuid)	The document detail tax code id
taxCurrencyAmount	number (double)	The document detail tax currency amount
taxDate	string (date-time)	The document detail tax date
taxRate	number (double)	The document detail tax rate
textPost	string	The document detail post tax
textPre	string	The document detail pre tax
toStockLocationId	string (uuid)	The document detail to stock location id
uomId	string (uuid)	The document detail unit of measure id

DocDetailDeferred

Name	Type	Notes
dateFrom	string (date)	The document detail deferred from date
dateTo	string (date)	The document detail deferred to date
periods	integer (int32)	The document detail deferred periods
profileId	string (uuid)	The document detail deferred profile id. Accepts Id or Code

DocUpdate

Name	Type	Notes
accountId	string	The document account id
bankAccountId	string	The document bank account id
bankCurrencyAmount	number (double)	The document bank currency amount
bankCurrencyRate	number (double)	The document bank currency rate
bankRef	string	The document bank reference
billingAddress	ContactAddressInline[]
contactAccountId	string	The document contact account id
currency	string	Currency code. See Currency catalog. (ISO 4217)
currencyRate	number (double)	The document curerncy rate
deliveryAddress	ContactAddressInline[]
description	string	The document description
details	DocDetailUpdate[]	The document detail itemms
docDate	string (date-time)	The document document date
docTypeId	string	The document type id
dueDate	string (date-time)	The document due date
ext	object	Teh document custom fields
fromStockLocationId	string	The document from stock location id
intRef	string	The document internal reference
isNetEntry	boolean	The document is net entry flag
legacyRef	string	Alternative / legacy reference code
legalEntityId	string	The document legal entity id
paymentMethodId	string	The document payment method id
paymentTermsId	string	The document default payment terms. See PayTerm catalog.
periodId	string	The document period id
post	object	The document posting attributes
projectId	string	The document project id
responsibleResourceId	string	The document responsible resource id
stockDate	string (date-time)	The document stock date
taxAuthorityId	string	The document tax authority id
taxDate	string (date-time)	The document tax date
textFooter	string	The document footer text
textHeader	string	The document header text
theirDocNo	string	An external document number
theirRef	string	An external reference code
toStockLocationId	string	The document to stock location id

DocumentAmend

Name	Type	Notes
description	string	Description of the document
dueDate	string (date-time)	Due date of the document
ext	object	Custom fields
paymentMethodId	string	The payment method of the document. Accepts id or code.
tempBankRef	string	The bank ref of the document. Note: For Payments only.
theirDocNo	string	The document's invoice number. Note: For Purchase Invoices only.
theirRef	string	The custom reference of the document.

DocumentDispute

Name	Type	Notes
disputeGroupId	string	Unique dispute group id or code
note	string	Dispute details note

DocumentTypeRead

Name	Type	Notes
author	boolean	Author of the contact group
code	string	Unique Code for the contact group
description	string	Description for the contact group
docTypeSetup	DocumentTypeSetupRead[]
id	string (uuid)	Unique Id for the contact group

DocumentTypeSetupRead

Name	Type	Notes
customFields	CustomField[]	Document type custom fields
isActive	boolean
lastModified	string (date-time)
lastModifiedBy	string

Table

Name	Type	Notes
columns	Column[]
data	array
name	string

Column

Name	Type	Notes
name	string
type	string

LegalEntity

Name	Type	Notes
code	string	The legal entity code
companyNo	string	The legal entity company number
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
currency	string	The legal entity cuurrency
description	string	The legal entity description
id	string (uuid)	The legal entity unique id
isActive	boolean	Active or locked (soft delete)
isInterco	boolean	The legal entity is intercompany flag
legacyRef	string	Alternative / legacy reference code
taxAuthorityId	string (uuid)	The legal entity tax authority id

ProblemDetails

Name	Type	Notes
detail	string
instance	string
status	integer (int32)
title	string
type	string

ProductSummary

Name	Type	Notes
code	string	The product code.
description	string	The product description.
id	string (uuid)	The product id.
isPurchase	boolean	Is product available for purchase transactions
isSale	boolean	Is product available for sale transactions
legacyRef	string	Alternative / legacy reference code
productGroupId	string (uuid)	The product group. See catalog ProductGroup for values.
productType	string	The product type for tax purposes: G: goods, S: services, O: other.
uomGroupId	string (uuid)	Unit of measure group id. See catalog UnitGroup for values
uomId	string (uuid)	Unit of measure id. See catalog Unit for values

ProductCreate

Name	Type	Notes
code	string	The Code must be unique.
description	string	The product description
legacyRef	string	An optional reference
productGroupId	string	Optional Product Group id or code. It can default the other properties below.
productType	string	Optional, specifies if the product is a Goods (G), Services (S) or Other ('O') from a tax point of view. Defaults from the Product Group, if defined.
purchase	ProductPurchaseCreate[]	The purchase aspect of a product.
sale	ProductSaleCreate[]	The sale aspect of a product.
uomGroupId	string	Unit of measure group (id or code). See catalog UnitGroup for possible values. Will be defaulted from Product Group or environment default.
uomId	string	Unit of measure (id or code). See catalog Unit for possible values. Will be defaulted from Product Group or environment default.

ProductPurchaseCreate

The purchase aspect of a product.

Name	Type	Notes
accountId	string	The Chart of Account code or id. Must be a valid purchase account.
isActive	boolean	Active / locked.
setupPost	ProductPostSetup[]	Optional posting attribute rules

ProductPostSetup

Optional posting attribute rules

Name	Type	Notes
attribute	string	Posting attribute
default	string	Default value
defaultParameter	string	Default value parameter. See catalog HashParam
mandatory	boolean	Mandatory or optional
readOnly	boolean	Fixed or editable

ProductSaleCreate

The sale aspect of a product.

Name	Type	Notes
accountId	string	The Chart of Account code or id. Must be a valid sale account.
isActive	boolean	Active / locked.
setupPost	ProductPostSetup[]	Optional posting attribute rules

ProductRead

Name	Type	Notes
code	string	The product code.
description	string	The product description.
id	string (uuid)	The product id.
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legacyRef	string
productGroupId	string (uuid)	The product group. See catalog ProductGroup for values.
productType	string	The product type for tax purposes: G: goods, S: services, O: other.
purchase	ProductPurchaseRead[]
sale	ProductSaleRead[]
uomGroupId	string (uuid)	Unit of measure group id. See catalog UnitGroup for values
uomId	string (uuid)	Unit of measure id. See catalog Unit for values

ProductPurchaseRead

Name	Type	Notes
accountId	string (uuid)	Chart of account. See catalog Account.
isActive	boolean	Active or locked (soft delete)
setupPost	ProductPostSetup[]	Posting attributes rules

ProductSaleRead

Name	Type	Notes
accountId	string (uuid)	Chart of account. See catalog Account.
isActive	boolean	Active or locked (soft delete)
setupPost	ProductPostSetup[]	Posting attributes rules

ProductUpdate

Name	Type	Notes
description	string	The product description
legacyRef	string	An optional reference
productGroupId	string	Optional Product Group id or code. It can default the other properties below.
productType	string	Optional, specifies if the product is a Goods (G), Services (S) or Other ('O') from a tax point of view. Defaults from the Product Group, if defined.
purchase	ProductPurchaseUpdate[]	The purchase aspect of a product.
sale	ProductSaleUpdate[]	The sale aspect of a product.
uomGroupId	string	Unit of measure group (id or code). See catalog UnitGroup for possible values. Will be defaulted from Product Group or environment default.
uomId	string	Unit of measure (id or code). See catalog Unit for possible values. Will be defaulted from Product Group or environment default.

ProductPurchaseUpdate

The purchase aspect of a product.

Name	Type	Notes
accountId	string	The Chart of Account code or id. Must be a valid purchase account.
isActive	boolean	Active / locked.
setupPost	ProductPostSetup[]	Optional posting attribute rules

ProductSaleUpdate

The sale aspect of a product.

Name	Type	Notes
accountId	string	The Chart of Account code or id. Must be a valid sale account.
isActive	boolean	Active / locked.
setupPost	ProductPostSetup[]	Optional posting attribute rules

ProfileRead

Name	Type	Notes
userId	string (uuid)	The profile user id
username	string	The profile username

Project

Name	Type	Notes
address	ProjectAddress
allowTasks	boolean	The project allow tasks flag
allowTimesheets	boolean	The project allow timesheets flag
availability	ProjectAvailability[]	The project availabilities
code	string	The project code
contactAccountId	string (uuid)	The project contact account id
dateFrom	string (date-time)	The project date from
dateTo	string (date-time)	The project date to
description	string	The project description
ext	object	The project additional fields definition
id	string (uuid)	The project unique id
intRef	string	The project internal reference
isActive	boolean	Active or locked (soft delete)
isParent	boolean	The project is parent flag
lastModified	string (date-time)
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legalEntityId	string (uuid)	The project legal entity id
milestones	ProjectMilestone[]	The project milestones
projectGroupId	string (uuid)	The project project group id
responsibleResourceId	string (uuid)	The project responsible resource id
subProjects	ProjectChild[]	The project sub projects

ProjectAddress

Name	Type	Notes
address	string	The project address line
city	string	The project address city
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
county	string	The project address county
description	string	The project address description
postCode	string	The project address postcode

ProjectAvailability

The project availabilities

Name	Type	Notes
resourceGroupId	string (uuid)	The project availabilty resource group id
resourceId	string (uuid)	The project availabilty unique id

ProjectMilestone

The project milestones

Name	Type	Notes
code	string	The project milestone code
dateEnd	string (date-time)	The project milestone end date
dateStart	string (date-time)	The project milestone start date
description	string	The project milestone description
id	string (uuid)	The project milestone unique id

ProjectChild

The project sub projects

Name	Type	Notes
code	string	The child project code
description	string	The child project description
id	string (uuid)	The child project unique id
intRef	string	The child project internal reference

ProjectCreate

Name	Type	Notes
address	ProjectAddressCreate[]
allowTasks	boolean	The project allow tasks flag
allowTimesheets	boolean	The project allow timesheets flag
availability	ProjectAvailabilityCreate[]	The project resource availability
code	string	The project code
contactAccountId	string	The project contact account id
dateFrom	string (date-time)	The project from date
dateTo	string (date-time)	The project to date
description	string	The project description
ext	object	The project custom fields
hasAddress	boolean	The project has address flag
hasMilestones	boolean	The project has milstones flag
hasResources	boolean	The project has resources flag
intRef	string	The project internal reference
isParent	boolean	The project is parent flag
legalEntityId	string	The project legal entity id
milestones	ProjectMilestoneCreate[]	The project milestones
parentProjectId	string	The project parent project id
projectGroupId	string	The project group id
responsibleResourceId	string	The project responsible resource id

ProjectAddressCreate

Name	Type	Notes
address	string	The project address line
city	string	The project address city
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
county	string	The project address county
description	string	The project address description
postCode	string	The project address postcode

ProjectAvailabilityCreate

The project resource availability

Name	Type	Notes
resource	string	The project availabilty resource
resourceGroup	string	The project availability resource group

ProjectMilestoneCreate

The project milestones

Name	Type	Notes
code	string	The project milestone code
dateEnd	string (date-time)	The project milestone end date
dateStart	string (date-time)	The project milestone start date
description	string	The project milestone description

ProjectUpdate

Name	Type	Notes
address	ProjectAddressCreate[]
allowTasks	boolean	The project allow tasks flag
allowTimesheets	boolean	The project allow timesheets flag
availability	ProjectAvailabilityCreate[]	Project availability groups
contactAccountId	string	The project contact account id
dateFrom	string (date-time)	The project from date
dateTo	string (date-time)	The project to date
description	string	The project description
ext	object	Project custom fields
hasAddress	boolean	The project has address flag
hasMilestones	boolean	The project has milestones flag
hasResources	boolean	The project has resources flag
isParent	boolean	The project is parent flag
legalEntityId	string	The project legal entity id
milestones	ProjectMilestoneCreate[]	Project milestones
parentProjectId	string	The project parent project id
projectGroupId	string	The project group id
responsibleResourceId	string	The project responsible resource id

ResourceRead

Name	Type	Notes
bankDetails	ContactBankDetailsRead[]	All bank details. (?include=allBankDetails)
code	string	Contact account code
companyNo	string	Company number
contact	ContactRead[]
contactClassificationId	string (uuid)	Contact classification id
contacts	ContactRead[]	Persons contact details (?include=contacts)
countryCode	string	Country code. See Country catalog. (ISO 3166, ALPHA-2)
createdBy	string	The user that created this item. See UserAccount catalog.
createdDate	string (date-time)	The date and time this item has been created
customer	ContactCustomerRead[]
defaultBankDetails	ContactBankDetailsRead[]
description	string	Contact account internal description
hasAttachments	boolean	Flag indicating whether ther are any documents attached
hasNotes	boolean	Flag indicating whether any notes are available
id	string (uuid)	Contact account id
intRef	string	Interface reference
lastModified	string (date-time)	The date and time this item has been last modified
lastModifiedBy	string	The user that last modified this item. See UserAccount catalog.
legacyRef	string	Alternative / legacy reference code
resource	ContactResourceRead[]
supplier	ContactSupplierRead[]
taxNo	string	Tax number
theirRef	string	An external reference code

LoginApiCredentials

Name	Type	Notes
userApiKey	string	The user API key
username	string	The username

SessionResultData

Name	Type	Notes
apiVer	string	The API version
domain	string	The session domain
sessionToken	string	The session token
tokenDue	string (date-time)	The token due date