Versions Compared

Key

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

Overview


Issuing an invoice or credit memo will transmit the invoice or credit memo to the accounts receivable system and will prevent the addition of further adjustments unless the invoice or credit memo is voided.

On issue the following things occur:

...

Element

Data Type

Required?

Default

Description

RequestId

Int32

No


Click here for more information.

SessionTicket

String

Yes


Click here for more information.

AddCommentsToInvoiceMessagesFlag

Boolean

No

false

If set to 'true', the comments associated with the ivnoice will be added to the invoice message.

FullDetailFlag

Boolean

No

false

If set to 'true', include full detailed invoice element in response.

IncludeAdjustmentHistoryFlag

Boolean

No

false

If set to 'true', include adjustment history in response.

IncludeFullAdjustmentHistoryFlag

Boolean

No

false

If set to 'true', include full adjustment history in response.

InvoiceDate

DateTime

No

The date the invoice is issued

Defaults to the date the invoice is actually issued. This can be overridden here or at the time of issue.

This date:

  • determines the accounting period for the AR transaction
  • start date for payment terms such as net 30

InvoiceIdentity

PwsInvoiceRef

Yes


This structure represents the unique key fields associated with identifying an invoice.

InvoiceTimestamp

String

No


This is a Base64 encoded timestamp optionally utilized for invoice locking.

IssuedInvoiceNumber

String

No


The invoice number is a unique identifier for an issued invoice.

LocksToSteal

PwsEntityLockSummary

No


If stealing existing locks, specify lock holders from PwsFault response.

NewInvoiceMessagesStringNo
Invoice messages to include in workflow email. May also be added to invoice messages for the new invoice

NotifyFinanceTeamFlag

Boolean

No

false

True to send an e-mail to the finance team response for finance approval of invoice upon update.

NotifyManagementTeamFlag

Boolean

No

false

True to send an e-mail to the management team response for management approval of invoice upon update.

NotifyPmTeamFlag

Boolean

No

false

True to send an e-mail to the PM team response for project manager approval of invoice upon update.

PostFlag

Boolean

No

false

If true, the invoice will be posted to the workspace of the associated project if allowed

ProjectorLockSetId

Int32

No


A projector lock set id is an identifier for a group of one or more locks held as a unit

SendFlag

Boolean

No

false

True to send an e-mail to the client via invoice distribution

SkipIfIneligibleFlag

Boolean

No

false

True to skip the invoice if is not eligible to be issued

...

Panel
titlePwsIssueInvoice Response

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.


Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.


ExceededContracts

/wiki/spaces/AD/pages/233406465[]



Invoice

PwsInvoiceElement

This structure represents the complete details of a retrieved invoice


InvoiceIdentity

PwsInvoiceRef

This structure represents the unique key fields associated with identifying an invoice. Invoices can be identified by InvoiceNumber or InvoiceUid.


InvoiceTimestamp

String

This is an optimistic locking timestamp for the updated invoice.


PostInvoiceUnavailableReason

String

If an invoice cannot be posted, the reason will be returned here.


SendInvoiceUnavailableReason

String

If an invoice cannot be sent, the reason will be returned here.


StolenLocks

PwsEntityLockSummary

This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.



Response Usage Example(s)

...