Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This exports the expense report header information and disbursements. Expense report details are exported using ExportCostCards.

Request

The service request contains:

Name

Data Type

Required?

Default Value

Discussion

MaxRowsToReturn

int

no

1000

The maximum number of cards to be exported. Values greater than 1000 may fail due to system-enforced transaction time limits.

ExpenseReportNumbersAfter

string(20)

no

 

Export is limited to items whose expense report number comes after this. To avoid skipping or duplicating exported items set this to the last ExpenseReportNumber from the previous result set.

OnlyCountRows

boolean

no

false

If true, then only the RowCount is returned.


Response


For each project in the result set the following data is returned:

Name

Data Type

Discussion

ExpenseReportNumber

string

The document number of the expense report.

ExpenseReportName

string

The document name of the expense report.

DisplayName

string

Name of the resource the expense report is associated with.

EmployeeId

string

This is the resource's reference system ID.

ProjectCode

string

The project code of the project associated with the expense report. If the expense report contains cost cards from multiple projects, this will be unspecified in the result.

Status

string

Consolidated status (see below)

ApprovalWorkflowStatus

string

Approval workflow status (see below)

PaymentWorkflowStatus

string

Payment workflow status (see below)

InvoiceWorkflowStatus

string

Invoice workflow status (see below)

ExpenseReportGrossAmount

double

The total disbursed amount of all cost cards on the expense report.

CashAdvanceReturnAmount

double

The cash advance amount attached to the expense report.

CurrencyCode

string

The disbursing currency code.

ApVoucherNumber

string

If all cost cards on the expense report are on the same payment voucher, and that payment voucher is transmitted, this is the confirmation number. Otherwise it is unspecified.

ApPaymentInformation

string

If all cost cards on the expense report are on the same payment voucher, and that payment voucher is paid, this is the payment information. Otherwise it is unspecified.


The four status fields listed above will have a one or two character code summarizing the status of the items (cost cards) on the expense report, as detailed in the table below.

Status Field

Value

Meaning

Status

D

All cost cards on expense report are in draft state

 

R

All cost cards on expense report are in rejected

 

S

All cost cards on expense report are in submitted

 

A

All cost cards on expense report are in approved, but not approved to pay state

 

F

All cost cards on expense report are in approved to pay state

 

T

All cost cards on expense report are in transmitted

 

P

All cost cards on expense report are in paid state

 

<null>

Not all of the cost cards on the expense report are in the same state

Approval workflow status

D

Draft. All cost cards on expense report are in draft state.

 

R

Rejected. All cost cards are in rejected state.

 

PR

Partially Rejected. At least one cost card is in rejected state.

 

S

Submitted. All cost cards are in submitted state.

 

PS

Partially Submitted. At least one cost card is in submitted state, the rest indraft state.

 

A

Approved. All cost cards are in approved state.

 

PA

Partially Approved. At least one cost card has been approved. The rest are in draft or submitted state.

Payment workflow status

N

Not Approved to Pay. None of the cost cards on the expense report are on payment vouchers that have been approved to pay.

 

F

Approved to Pay. All cost cards are on approved to pay payment vouchers.

 

PF

Partially Approved to Pay. At least one cost card is on an approved to pay payment voucher. The rest are on unapproved payment vouchers.

 

T

Transmitted. All cost cards are on transmitted payment vouchers.

 

PT

Partially Transmitted. At least one cost card is on a transmitted payment voucher. The rest are on unapproved to pay or approved to pay payment vouchers.

 

P

Paid. All cost cards are on paid payment vouchers (not marked received).

 

PP

Partially Paid. At least one cost card is on a paid (but not marked received) payment voucher. The rest are on unapproved to pay, approved to pay or transmitted payment vouchers.

 

R

Received. All cost cards are on paid payment vouchers that have been marked received.

 

PR

Partially Received. At least one cost card is on a payment voucher that has been paid and marked received. The rest are on unapproved to pay, approved to pay, transmitted or paid (not marked received) payment vouchers.

Invoice workflow status

N

Not Approved to Invoice. None of the cost cards on the expense report have been approved to invoice.

 

A

Approved to Invoice. All cost cards have been approved to invoice (but not yet placed on an invoice).

 

PA

Partially Approved to Invoice. At least one cost card has been approved to invoice (but not yet placed on an invoice). The rest have not yet been approved to invoice.

 

D

Draft Invoiced. All cost cards have been approved to invoice and placed on an invoice currently in the draft or approved state.

 

PD

Partially Draft Invoiced. At least one cost card has been approved to invoice and placed on an invoice currently in the draft or approved state. The rest are not approved to invoice or approved but not yet on an invoice.

 

I

Invoiced. All cost cards have been approved to invoice and are on an invoice currently in the issued state.

 

PI

Partially Invoiced. At least one cost card has been approved to invoice and placed on an invoice currently in the issued state. The rest are not approved to invoice, approved but not yet on an invoice or approved and on an invoice currently in the draft or approved state.


  • No labels