GetNextApTransaction
- Thomas Sherman (Deactivated)
- Bettina Borces
Get the next pending AP transaction. If there are no pending transactions, then the ErTransactionNumber in the response will be -1.
After getting the transaction, it will be marked as Transmitted in Projector. You should then use UpdateGeneralLedgerTransactionStatus to mark it Confirmed or Failed. This step is very important as it lets your accounting users know whether further action to correct this AP is needed. If an AP is missing from your accounting system, it is a problem!
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request
The service request contains:
GetNextApTransactionRequest | ||||
|---|---|---|---|---|
Name | Data Type | Required? | Default Value | Discussion |
CompanyNumber | string(20) | no | If not supplied then matches all companies. | |
MaxPeriodCode | string(20) | no | If not supplied then matches all periods. | |
ForceTransDateWithinPeriodFlag | boolean | no | false | If true then alter transaction dates when needed to fall within the accounting period. |
IncludeResourceVendorsFlag | boolean | no | true | True to include AP transactions from resource vendors |
IncludeResourceVendorsFlag | boolean | no | false | See Specified Flags |
IncludeNonResourceVendorsFlag | boolean | no | false | True to include AP transactions from non-resource vendors |
IncludeNonResourceVendorsFlag | boolean | no | false | See Specified Flags |
IncludeCostCardDetailsFlag | boolean | no | false | True to include additional result sets containing cost card and reconciliation item details |
IncludeCostCardDetailsFlag | boolean | no | false | See Specified Flags |
Response
The following data is returned:
GetNextApTransactionResponse | |||
|---|---|---|---|
Name | Data Type | Version | Discussion |
ErTransactionNumber | int | If -1 then there is no pending transaction to return. If -2 then there is at least one pending transaction that cannot be returned because there is no accounting period that it can be associated with. | |
CompanyNumber | string(20) | ||
DisbursedCurrencyCode | string(4) | ||
AccountingPeriodCode | string(20) | ||
TransactionType | string(1) | "A" = Approve | |
SubmittedDate | date | ||
PaymentVoucherNumber | string(30) | ||
ExpenseDocumentNumber | string(20) | ||
ExpenseDocumentName | string(100) | ||
ProjectCode | string(24) | ||
ResourceVendorFlag | boolean | ||
SubmitterVendorId | string(50) | ||
SubmitterEmployeeId | string(20) | ||
SubmitterVendorId | string(50) | ||
VendorName | string(50) | ||
VendorUid | long | ||
ApproverEmployeeId | string(20) | ||
ItemSubtotalAmount | money | ||
CashAdvanceAmount | money | ||
ExpenseReportAmount | money | ||
ApClearingGlCostCenterNumber | string(159) | ||
ApClearingGlAccountNumber | string(20) | ||
CashAdvanceGlCostCenterNumber | string(159) | ||
CashAdvanceGlAccountNumber | string(20) | ||
AccountsPayableGlCostCenterNumber | string(159) | ||
AccountsPayableGlAccountNumber | string(20) | ||
VendorReferenceNumber | string(50) | ||
VendorInvoiceDate | datetime | ||
InvoiceCurrencyCode | string(4) | ||
VoidedApTransactionNumber | string(50) | ||
Notes | string | 4.3.2 | Transaction notes |
CostCardDetails | List of ApTransCostCardDetail | See below | |
ReconciliationItemDetails | List of ApTransReconciliationItemDetail | See below |
This table lists the fields in the cost card details (this will only be populated if IncludeCostCardDetailsFlag was set to true):
ApTransCostCardDetail | ||
|---|---|---|
Name | Data Type | Discussion |
CostCardUid | long | |
ProjectCode | string(24) | |
ProjectUid | long | |
ExpenseDocumentNumber | string(20) | |
ExpenseDocumentType | string(1) | |
ExpenseDocumentName | string(100) | |
VendorInvoiceDate | datetime | |
VendorInvoiceReferenceNumber | string(20) | |
ResourceDisplayName | string(30) | |
ResourceReferenceSystemId | string(20) | |
ResourceUid | long | |
IncurredDate | datetime | |
CostCodeName | string(50) | |
CostCodeUid | long | |
Description | string(4000) | |
Amount | decimal |
This table lists the fields in the reconciliation item details (this will only be populated if IncludeCostCardDetailsFlag was set to true):
ApTransReconciliationItemDetail | ||
|---|---|---|
Name | Data Type | Discussion |
ReconciliationItemUid | long | |
Amount | decimal | |
Notes | string(1000) |
Changelog
A history of changes to this web service
4.3.2 | |
|---|---|
Parameter | Notes |
Notes | Added as GetNextApTransactionResponse parameter |