Versions Compared

Key

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

...

Name

Data Type

Discussion

InvoiceHeader

see below

One record per invoice

InvoiceTaxes

list of Tax

One record per tax on the invoice

InvoiceMilestones

list of Milestone

One record per milestone on the invoice

InvoiceTimeCards

list of TimeCard

One record per timecard on the invoice

InvoiceCostCards

list of CostCard

One record per costcard on the invoice

InvoicePrepayments

List of Prepayment

One record per engagement on the invoice

InvoiceEngagements

list of Engagement

One record per engagement that has time, cost, or milestones on the invoice

InvoiceProjects

list of Project

One record per project that has time or cost on the invoice

InvoiceClientUdfs

list of ClientUdf

These are the UDFs associated with the invoiced client

InvoiceRoleslist of Role(added 2018-06-07) One record per role on the invoice

InvoiceUdfs

list of InvoiceUdf

UDFs for the invoice. One record per UDF. 


InvoiceHeader


Name

Data Type

Discussion

InvoiceId

int

Internal identifier

InvoiceNumber

string(20)


DraftInvoiceNumber

string(20)


InvoiceStatus

string(1)


InvoiceDate

dateTime


InvoiceName

string


CurrencyName

string


CurrencyCode

string(3)


CultureName

string


PaymentTerms

string


TimeGrossAmtOption

string(1)


CostGrossAmtOption

string(1)


TimeBillingType

string(1)

<D>aily or <H>ourly

InvoiceTemplateName

string(10)


EngagementId

int

Internal ID. Null unless this invoice is an engagement invoice.

ProjectId

int

Internal ID. Null unless this invoice is a project invoice.

PurchaseOrderNumber

string


BillingInstructions

string


AddressAttention

string


AddressCompanyName

string


AddressLine1

string


AddressLine2

string


AddressCity

string


AddressStateOrProvince

string


AddressZipOrPostalCode

string


AddressCountry

string


ClientMessage

string(1000)

A per-invoice message to appear on the invoice. RTF is stripped out if present.

ClientId

int

Internal ID

ClientNumber

string


ClientName

string


CostCenterName

string


CostCenterReferenceSystemId

string


AdjustedRevenueAmountTotal

money


ClientAmountTotal

money


MilestoneAmountTotal

money


TaxAmountTotal

money


AppliedPrepaymentAmountTotal

money


InvoiceAmount

money


...

Name

Data Type

Discussion

EngagementId

int


EngagementName

string


EngagementCode

string


EngagementTypeNamestring
EngagementTypeShortNamestring

MilestoneName

string


AchievedDate

dateTime


MilestoneAmount

money


MilestoneDescriptionstring
ProjectIdint
ProjectNamestring
ProjectCodestring
ProjectTaskIdint
ProjectTaskNamestring
ProjectTaskFullWbsCodestring
ContractLineItemIdint
ContractLineItemNamestring
ContractLineItemCodestring

...

Name

Data Type

Discussion

EngagementId

int


EngagementName

string


EngagementCode

string


EngagementTypeNamestring
EngagementTypeShortNamestring

AppliedPrepaymentAmount

money


UnappliedPrepaymentAmount

money


...

Name

Data Type

Discussion

EngagementId

int


EngagementName

string


EngagementCode

string


EngagementTypeNamestring
EngagementTypeShortNamestring

EngagementUdfs

list of EngagementUdf


...

Name

Data Type

Discussion

ProjectId

int


ProjectName

string


ProjectCode

string


ProjectUdfs

list of ProjectUdf

...


Role


Name

Data Type

Discussion

ProjectRoleId

int


RoleName

string


ProjectCode

string


RoleUdfs

list of RoleUdf

...


RoleUdf

Name

Data Type

Discussion

ProjectRoleId

int


Name

string

role name

DataType

string

D=> : date

I=> : int

R=> : resource (int)

T=> : text (string)

Y=> : Yes/No (string)

L=> : text list (string)

S=> : stoplight

StringValuestringstring value of UDF
IntValueintint value of UDF
DateValuedatedate value of UDF
MonthlyString12Valuestringfor stoplight UDFs
WeeklyString12Valuestringfor stoplight UDFs
MonthlyString6Valuestringfor stoplight UDFs
WeeklyString6Valuestringfor stoplight UDFs

InvoiceUdf

Name

Data Type

Discussion

InvoiceId

int


Name

string

UDF name

DataType

string

D: date

I: int

R: resource (int)

T: text (string)

Y: Yes/No (string)

L: text list (string)

S: stoplight

StringValuestringstring value of UDF
IntValueintint value of UDF
DatetimeValuedatedate value of UDF
ReferenceInfostringresource ID for resource type invoice UDF
MonthlyString12Valuestringfor stoplight UDFs
WeeklyString12Valuestringfor stoplight UDFs
MonthlyString6Valuestringfor stoplight UDFs
WeeklyString6Valuestringfor stoplight UDFs

...