Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

Contains the invoice ID and references to related objects, such as project, client, supplier and more. Contained in Invoice Document Record

The object has these properties:

id

The unique invoice ID.

int

isSupplierInvoice

True if the invoice is a supplier invoice.

bool

isClientInvoice

True if the invoice is a client invoice.
Equals (not isSupplierInvoice).

bool

clientCompanyId

The client company ID. With supplier invoices, this will always be the platform’s company (My Company).

int

clientIsInternal

True if the client company is “My Company”.

bool

supplierCompanyId

The supplier company ID. With client invoices, this will always be the platform’s company (My Company).

int

supplierIsInternal

True if the supplier company is “My Company”.

bool

projectId

The project ID. Note that an invoice is always linked to a project, even an aggregation parent is attached to a project.

int

orderId

Optional order to which this invoice is linked.

int?

jobId

Optional Standard Project job to which this invoice is linked. Only used with supplier invoices. Note that with Codyt, the pointer is the other way round: The Codyt job contains the reference to an invoice.

int?

projectSequenceId

Used with certain configurations. A sequential number assigned to an invoice within a project. For example, when a project contains 10 client invoices then those will be numbered from 1 to 10. Supplier invoices are numbered in the same manner.

int?

flexTransactionId

Used with Wordbee Flex projects only. Contains the transaction that is costed. This node is only added to payload if not null. Wordbee Flex Workflows

string?

EXAMPLES

Example payload:

{
    "id": 3664,
    "isSupplierInvoice": false,
    "isClientInvoice": true,
    "clientCompanyId": 2003,
    "clientIsInternal": false,
    "supplierCompanyId": 537,
    "supplierIsInternal": true,
    "projectId": 6669,
    "orderId": 3353,
    "jobId": null,
    "projectSequenceId": null
}

  • No labels