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:
...
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AcuGfDv7RvA96P5s49CONg== | ||
AddCommentsToInvoiceMessagesFlag | Boolean | No | false | If set to 'true', the comments associated with the ivnoice will be added to the invoice message. | true |
FullDetailFlag | Boolean | No | false | If set to 'true', include full detailed invoice element in response. | true |
IncludeAdjustmentHistoryFlag | Boolean | No | false | If set to 'true', include adjustment history in response. | true |
IncludeFullAdjustmentHistoryFlag | Boolean | No | false | If set to 'true', include full adjustment history in response. | true |
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:
| 2023-02-21T00:00:00.000Z |
InvoiceIdentity | 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 | No | If stealing existing locks, specify lock holders from PwsFault response. | |||
| NewInvoiceMessages | String | No | Invoice messages to include in workflow email. May also be added to invoice messages for the new invoice | Web Services - PwsIssueInvoice | |
NotifyFinanceTeamFlag | Boolean | No | false | True to send an e-mail to the finance team response for finance approval of invoice upon update. | true |
NotifyManagementTeamFlag | Boolean | No | false | True to send an e-mail to the management team response for management approval of invoice upon update. | true |
NotifyPmTeamFlag | Boolean | No | false | True to send an e-mail to the PM team response for project manager approval of invoice upon update. | true |
PostFlag | Boolean | No | false | If true, the invoice will be posted to the workspace of the associated project if allowed | true |
ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit | ||
| RetrieveContractInfoOnCapExceededFlag | Boolean | No | false | If set to false (default), behavior is as it is now. A fault is returned with the error message “CapExceededError”, and no exceeded contract detail is returned. If set to true, the service returns a status of OK, the error is present in Messages, and the exceeded contracts detail is returned. | true |
SendFlag | Boolean | No | false | True to send an e-mail to the client via invoice distribution | true |
SkipIfIneligibleFlag | Boolean | No | false | True to skip the invoice if is not eligible to be issued | true |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:bil="http://projectorpsa.com/DataContracts/Shared/Billing/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsIssueInvoice>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AcuGfDv7RvA96P5s49CONg==</req:SessionTicket>
<bil:AddCommentsToInvoiceMessagesFlag>true</bil:AddCommentsToInvoiceMessagesFlag>
<bil:FullDetailFlag>true</bil:FullDetailFlag>
<bil:IncludeAdjustmentHistoryFlag>true</bil:IncludeAdjustmentHistoryFlag>
<bil:IncludeFullAdjustmentHistoryFlag>true</bil:IncludeFullAdjustmentHistoryFlag>
<bil:InvoiceDate>2023-02-21T00:00:00.000Z</bil:InvoiceDate>
<bil:InvoiceIdentity>
<com:InvoiceNumber>DRAFT00795</com:InvoiceNumber>
</bil:InvoiceIdentity>
<bil:NewInvoiceMessages>Web Services - PwsIssueInvoice</bil:NewInvoiceMessages>
<bil:NotifyFinanceTeamFlag>true</bil:NotifyFinanceTeamFlag>
<bil:NotifyManagementTeamFlag>true</bil:NotifyManagementTeamFlag>
<bil:NotifyPmTeamFlag>true</bil:NotifyPmTeamFlag>
<bil:PostFlag>true</bil:PostFlag>
<bil:RetrieveContractInfoOnCapExceededFlag>true</bil:RetrieveContractInfoOnCapExceededFlag>
<bil:SendFlag>true</bil:SendFlag>
<bil:SkipIfIneligibleFlag>true</bil:SkipIfIneligibleFlag>
</pws:serviceRequest>
</pws:PwsIssueInvoice>
</soapenv:Body>
</soapenv:Envelope> |
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
RequestStatus | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2023-02-21T22:28:15.4891243Z | |
ExceededContracts | This structure represents the complete details of a contract line item in which the time or cost contract cap has been exceeded. | ||
Invoice | This structure represents the complete details of a retrieved invoice. | ||
InvoiceIdentity | 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. | AAAAACM5pCY= |
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 | 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)
...