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

« Previous Version 15 Next »

Endpoints

APInvoiceListApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

Operation

Logged in User

Parameters

Body

Response

POST

Authenticating User

GridRequestParametersApi

GridResult<APInvoiceLine>

APInvoiceDetailApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

/api/APInvoiceDetailApi

Operation

Logged in User

Parameters

Body

Response

DELETE

GET
Returns AP Invoice and Lines based on APInvoiceId.

Admin User

APInvoiceId

APInvoiceJobTransactionApi

POST
Updates AP Invoice and related Job Transaction lines

Admin User

APInvoiceJobTransactionApi

APInvoiceJobTransactionApi

APCreditDetailApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

Operation

Logged in User

Parameters

Body

Response

GET

Admin User

APInvoiceId

APInvoiceJobTransactionApi

POST

Admin User

APInvoiceJobTransactionApi

APInvoiceJobTransactionApi

APInvoiceApprovalApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

Operation

Logged in User

Parameters

Body

Response

POST

APInvoiceKey.PersonID

APInvoiceKey

SaveResult

APInvoiceUnapprovalApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

Operation

Logged in User

Parameters

Body

Response

POST

APInvoiceKey.PersonID

APInvoiceKey

SaveResult

APInvoicePurchaseOrderDetailApi

Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)

Operation

Logged in User

Parameters

Body

Response

GET

Authenticating User

APInvoiceId

APInvoicePurchaseOrderApi

POST

Admin User

APInvoicePurchaseOrderApi

APInvoicePurchaseOrderApi

Models

APInvoiceApiModel

Property

Data Type

Description

Key

APProcessingAPInvoiceKey

DialogHeader

APProcessingAPInvoiceDialogHeader

JobTransactions

APProcessingAPInvoiceDialogGrid

POLines

APProcessingPOConfirmationDialogGrid

APInvoiceJobTransactionApi

Property

Data Type

Description

StoredFile

StoredFilesApiModel

Form

APInvoiceApiModel

Rows

Array [JobTransactionsJobTransactionLine]

ReadonlyMessages

Array [Tuple_String]

ValidationErrors

Array [MvcValidationError]

WarningMessage

String

SuccessMessage

String

ErrorMessage

String

APInvoiceKey

Property

Data Type

Required

Description

APInvoiceId

integer

required

ID of the AP Invoice

PersonId

integer

ID of the Person the operation will be performed as

APInvoiceLine

Property

Description

InvoiceNumberValue

Reference

SupplierValue

Supplier

DateValue

Date

TypeValue

Type

BatchNoValue

Batch No

APStatusValue

Status

AssignedApproverValue

Assigned Approver

ApprovedByValue

Approved By

CurrencyValue

Currency

AmountValue

ExGstValue

ex GST

GstValue

GST

IncGstValue

inc GST

TotalPaymentValue

Total Payment

TotalCreditInclValue

Total Credit Incl

LastPaymentValue

Last Payment

LastPaymentDate

Last Payment Date

UpdatedDate

APProcessingAPInvoiceDialogGrid

Field

Type

Description

Rows

Array [JobTransactionsJobTransactionLine]

APProcessingAPInvoiceDialogHeader

Field

Type

Description

IsReviewed

Boolean

IsApproved

Boolean

InvoiceNo

StringViewData

APReference

StringViewData

Set AP Reference through the API when you create AP from PO. This field does not work for AP Credits

InvoiceDate

DateViewData

PaymentDate

DateViewData

Currency

StringViewData

EditableCurrency

PickerViewData

Rate

DecimalViewData

BatchNo

StringViewData

Period

StringViewData

PONo

PickerViewData

APInvoiceId

StringViewData

Supplier

PickerViewData

Status

StringViewData

ReceivedDate

DateViewData

ApprovedBy

StringViewData

Date

DateViewData

ApplyToInvoice

PickerViewData

Gst

DecimalViewData

TotalInclGst

DecimalViewData

AssignedReviewer

PickerViewData

AssignedApprover

PickerViewData

EnteredBy

StringViewData

Comments

StringViewData

FinancialCompany

StringViewData

OnHold

BoolViewData

DataImportId

Integer

IsNew

Boolean

PoCurrencyCode

String

AllowBciTimesheets

Boolean

DocketPoSelected

Boolean

IsOnHoldVisible

Boolean

APProcessingAPInvoiceLine

Field

Type

Description

InvoiceNumber

String

CreditNumber

String

SupplierId

String

Date

String

Type

String

SubContractCode

String

APStatus

String

InvoiceNumberValue

CellData

SupplierValue

CellData

DateValue

String

TypeValue

CellData

BatchNoValue

CellData

APStatusValue

CellData

AssignedApproverValue

CellData

ApprovedByValue

CellData

CurrencyValue

CellData

AmountValue

CellData

ExGstValue

CellData

GstValue

CellData

IncGstValue

CellData

TotalPaymentValue

CellData

TotalCreditInclValue

CellData

LastPaymentValue

CellData

LastPaymentDate

String

UpdatedDate

String

Status

String

ReadonlyFlag

Integer

ReadonlyMessage

String

OriginalKey

APProcessingAPInvoiceKey

CurrentKey

APProcessingAPInvoiceKey

Key

APProcessingAPInvoiceKey

Index

Integer

APProcessingAPInvoiceKey

Property

Type

Description

APInvoiceId

Integer

BatchNo

Integer

BatchType

String

PONo

Integer

CompanyId

Integer

PersonId

Integer

IsApCredit

Boolean

FileUrl

String

Completed

Boolean

ActiveTab

String

StoredFileId

Integer

DocketId

Integer

FilterDockets

Boolean

APProcessingPOConfirmationDialogGrid

Property

Type

Description

Layout

Layout

Rows

Array [APProcessingPOConfirmationLine]

JobTransactionsJobTransactionDetailKey

Property

Type

Description

JobTransactionsJobTransactionLine

Property

Type

Description

TranDate

String

LogHeaderID

Integer

FcCost

Number

FcRetail

Number

PurchaseOrderLineId

Integer

StockLocationInactive

Boolean

Unit

String

EnteredByID

Integer

SourceID

Integer

FCGST

Number

JobCodeValue

CellData

LogHeader

CellData

ActivityCodeValue

CellData

WorkCentreCodeValue

CellData

QuantityValue

CellData

FcCostValue

CellData

CostValue

CellData

GSTTypeValue

CellData

GSTTypeCodeValue

CellData

GSTRateValue

CellData

GSTValue

CellData

NetValueValue

CellData

ReferenceValue

CellData

FcRetailValue

CellData

RetailValue

CellData

LineDescriptionValue

CellData

DetailsValue

CellData

FromPONumberValue

CellData

PurchaseOrderLineIdValue

CellData

ReinstatePOCommitment

Boolean

StockLocationCodeValue

CellData

StockItemCodeValue

CellData

TotalLineCostValue

CellData

CostRateValue

CellData

UnitValue

CellData

FCGSTValue

CellData

Delete

CellData

Serials

CellData

SerialRows

Array [TabletSerialLine]

Status

String

ReadonlyFlag

Integer

ReadonlyMessage

String

OriginalKey

JobTransactionsJobTransactionDetailKey

CurrentKey

JobTransactionsJobTransactionDetailKey

Key

JobTransactionsJobTransactionDetailKey

Index

Integer

Example

APInvoiceListApi POST

 Click to view

Request

 

Response

 

Response sample

 

APInvoiceApprovalApi
APInvoiceUnapprovalApi
APInvoiceListApi
APInvoiceDetailApi
APInvoicePurchaseOrderDetailApi

  • No labels