Versions Compared

Key

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

The “identifiers” node in an invoice document contains the invoice ID and references to related objects, such as project, client, supplier and more.

The object has these properties:

...

id

...

The unique invoice ID.

...

int

...

isSupplierInvoice

...

True if the invoice is a supplier invoice.

...

bool

...

This JSON object represents an invoice or quotation.

The properties are:

...

identifiers

The invoice ID, project ID and other identifiers.

See Invoice Identifiers Record

object

properties

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

See Invoice Properties Record

object

lines

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

bool

clientCompanyIdAn array of Invoice Line Record

object[]

totals

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

int

clientIsInternalSee Invoice Totals Record

object

attachments

True if the client company is “My Company”.

See Invoice Attachment Record

boolobject

supplierCompanyIddistribution

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

See Invoice Distribution Record

intobject

supplierIsInternalaggregation

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

See Invoice Aggregation Record

object

related

Related invoices. Array of Invoice Document Basic Record

There are 2 scenarios:

  • The parent invoice if the invoice is a child and was aggregated.

  • The list of children invoices if the invoice is an aggregation parent.

object[]

EXAMPLES

Example payload with all root nodes:

Code Block
{
    "ididentifiers": 3664,
    "isSupplierInvoice": false{ .... },
    "isClientInvoiceproperties": true{ .... },
    "clientCompanyIdlines": 2003,
    "clientIsInternal": false[ .... ],
    "supplierCompanyIdtotals": 537{ .... },
    "supplierIsInternalattachments": true{ .... },
    "projectIddistribution": 6669{ .... },
    "orderIdaggregation": 3353{ .... },
    "jobIdrelated": null,
    "projectSequenceId": null[ .... ]
}