Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The object has these properties:

ididentifiers

The unique invoice ID, project ID and other identifiers.

int

isSupplierInvoice

True if the invoice is a supplier invoice.

bool

isClientInvoiceSee Invoice Identifiers Record

object

properties

Main invoice properties such as status, invoice number, dates.

See Invoice Properties Record

bool

lines

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

bool

clientCompanyIdtotals

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

See Invoice Totals Record

int

clientIsInternalattachments

True if the client company is “My Company”.

See Invoice Attachment Record

bool

supplierCompanyIddistribution

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

See Invoice Distribution Record

int

supplierIsInternalaggregation

True if the supplier company is “My Company”.

See Invoice Aggregation Record

bool

projectIdrelated

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?See

int

EXAMPLES

Example payload:

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

...