Method

Performed As

Request Query

Request Body

Response

POSTAuthenticating User

Retrieve a filtered list of AP Invoices.

Logged in User

-

GridRequestParametersApi

GridResult<GridResult<APInvoiceLine>

Operation

Logged in User

Parameters

Method

Performed As

Request Query

Request Body

Response

GET
Returns AP Invoice and Lines based on APInvoiceIdRetrieve a specific AP Invoice, including its Job Transaction lines.

Admin User

APInvoiceIdAPInvoiceKey

-

APInvoiceJobTransactionApi

POST
Updates Create a new, or update an existing, AP Invoice and related Job Transaction lines.

Admin User

-

APInvoiceJobTransactionApi

APInvoiceJobTransactionApi

Method

Performed As

Request Query

Request Body

Response

GET

Retrieve a specific AP Credit, including its Job Transaction lines.

Admin User

APInvoiceIdAPInvoiceKey

-

APInvoiceJobTransactionApi

POST

Create a new, or update an existing, AP Credit.

Admin User

-

APInvoiceJobTransactionApi

APInvoiceJobTransactionApi

Method

Performed As

Request Query

Request Body

Response

POST
Unapprove an existing AP Invoice or AP Credit.

APInvoiceKey.PersonID (or if null: Admin User)

-

APInvoiceKey

SaveResult

Method

Performed As

Request Query

Request Body

Response

GET

Authenticating User

APInvoiceIdRetrieve a specific AP Invoice, including its Purchase Order lines.

Logged in User

APInvoiceKey

-

APInvoicePurchaseOrderApi

POST
Updates an existing AP Invoice and creates AP Invoice Lines from the selected PO Lines

Admin User

-

APInvoicePurchaseOrderApi

APInvoicePurchaseOrderApi

Key

APProcessingAPInvoiceKey

DialogHeader

APProcessingAPInvoiceDialogHeader

JobTransactions

APProcessingAPInvoiceDialogGrid

POLines

APProcessingPOConfirmationDialogGrid

StoredFile

StoredFilesApiModel

Stored file.

Form

APInvoiceApiModel

Rows

Array [JobTransactionsJobTransactionLine]

ReadonlyMessages

Array [Tuple_String]

Read Only message.

ValidationErrors

Array [MvcValidationError]

Error validation.

WarningMessage

String

Warning message.

SuccessMessage

String

Success message.

ErrorMessage

String

Error message.

APInvoiceId

integer

required

ID of the AP Invoice

PersonId

integer

ID of the Person the operation will be performed as

InvoiceNumberValue

Reference

SupplierValue

Supplier

DateValue

Date

TypeValue

Type

BatchNoValue

Batch No

APStatusValue

Status

AssignedApproverValue

Assigned Approver

ApprovedByValue

Approved By

CurrencyValue

Currency

AmountValue

Amount

ExGstValue

ex GST

GstValue

GST

IncGstValue

inc GST

TotalPaymentValue

Total Payment

TotalCreditInclValue

Total Credit Incl

LastPaymentValue

Last Payment

LastPaymentDate

Last Payment Date

UpdatedDate

Rows

Array [JobTransactionsJobTransactionLine]

JobTransactions

Array [JobTransactionsJobTransactionLine]

StoredFile

StoredFilesApiModel

Form

APInvoiceApiModel

Rows

Array [APProcessingPOConfirmationLine]

ReadonlyMessages

Array [Tuple_String]

ValidationErrors

Array [MvcValidationError]

WarningMessage

String

SuccessMessage

String

ErrorMessage

String

IsReviewed

Boolean

Reviewed status.

IsApproved

Boolean

Approved status.

InvoiceNo

StringViewData

Invoice number.

APReference

StringViewData

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

InvoiceDate

DateViewData

Invoice date.

PaymentDate

DateViewData

Payment date.

Currency

StringViewData

Currency

EditableCurrency

PickerViewData

Rate

DecimalViewData

The cost per item being purchased.

BatchNo

StringViewData

Batch number

Period

StringViewData

Financial period

PONo

PickerViewData

Purchase Order number

APInvoiceId

StringViewData

Code pf AP invoice.

Supplier

PickerViewData

Supplier name.

Status

StringViewData

Status

ReceivedDate

DateViewData

Received date.

ApprovedBy

StringViewData

Approved person.

Date

DateViewData

Date

ApplyToInvoice

PickerViewData

Gst

DecimalViewData

Tax

TotalInclGst

DecimalViewData

Total GST

AssignedReviewer

PickerViewData

Person was assigned as Reviewer.

AssignedApprover

PickerViewData

Person was assigned as Approver.

EnteredBy

StringViewData

Person entered data.

Comments

StringViewData

Note

FinancialCompany

StringViewData

Financial company.

OnHold

BoolViewData

On hold.

DataImportId

Integer

IsNew

Boolean

Is New.

PoCurrencyCode

String

Code of currency in Purchase Order

AllowBciTimesheets

Boolean

DocketPoSelected

Boolean

Docket Purchase Order selected

IsOnHoldVisible

Boolean

InvoiceNumber

String

Invoice number

CreditNumber

String

Credit number.

SupplierId

String

Code of the supplier

Date

String

Date

Type

String

Type

SubContractCode

String

Code of the Subcontract.

APStatus

String

Status

InvoiceNumberValue

CellData

Invoice number.

SupplierValue

CellData

Supplier

DateValue

String

Date.

TypeValue

CellData

Type

BatchNoValue

CellData

Batch number

APStatusValue

CellData

AP status

AssignedApproverValue

CellData

Approver person.

ApprovedByValue

CellData

Approved date.

CurrencyValue

CellData

Currency

AmountValue

CellData

Amount

ExGstValue

CellData

The value of the invoice excluding tax

GstValue

CellData

Tax value.

IncGstValue

CellData

Total value including tax.

TotalPaymentValue

CellData

Total payment value.

TotalCreditInclValue

CellData

Total Credit .

LastPaymentValue

CellData

Last payment value

LastPaymentDate

String

Last payment date.

UpdatedDate

String

Updated date.

Status

String

Status

ReadonlyFlag

Integer

Read only status.

ReadonlyMessage

String

Read only message.

OriginalKey

APProcessingAPInvoiceKey

CurrentKey

APProcessingAPInvoiceKey

Key

APProcessingAPInvoiceKey

Index

Integer

APInvoiceId

Integer

Code of AP invoice.

BatchNo

Integer

Batch number

BatchType

String

Batch type

PONo

Integer

Purchase Order number

CompanyId

Integer

Code of the company

PersonId

Integer

Code of person

IsApCredit

Boolean

AP Credit or not.

FileUrl

String

File URL

Completed

Boolean

Completed status.

ActiveTab

String

The active tab

StoredFileId

Integer

Store file id.

DocketId

Integer

Docket code.

FilterDockets

Boolean

Filter Docket or not.

Layout

Layout

Rows

Array [APProcessingPOConfirmationLine]

PO number

Integer

Purchase Order number.

PurchaseOrderLineId

Integer

Purchase Order line code.

ThisRate

Number

LineCompleted

Boolean

Line completed status.

LogHeaderID

Integer

Log header code.

JobCodeValue

CellData

Job code.

WorkCentreCodeValue

CellData

Code of Work Centre

LineDescriptionValue

CellData

Line description.

DetailsValue

CellData

Details.

UnitRateValue

CellData

Unit rate.

OrderQuantityValue

CellData

Order quantity.

FCOrderCostValue

CellData

Order cost in foreign currency.

ReceivedQuantityValue

CellData

Received quantity.

ReceivedValueValue

CellData

Received value.

FCUnitCostValue

CellData

Unit cost in foreign currency.

ThisQuantityValue

CellData

ThisRateValue

CellData

ThisValueValue

CellData

ThisGSTValue

CellData

OutstandingQuantityValue

CellData

Outstanding quantity.

OutstandingValueValue

CellData

Outstanding value.

RemainingQuantityValue

CellData

Remaining quantity.

RemainingValueValue

CellData

Remaining value.

ReceiptedQuantityValue

CellData

Receipted quantity.

ReceiptedValueValue

CellData

Receipted value.

Info

CellData

LogHeaderValue

CellData

Log header.

Status

String

Status

ReadonlyFlag

Integer

Read Only status

ReadonlyMessage

String

Read Only message

OriginalKey

APProcessingPOConfirmationKey

CurrentKey

APProcessingPOConfirmationKey

Key

APProcessingPOConfirmationKey

Index

Integer

JobTranId

Integer

Job transaction id.

PersonId

Integer

Person id

JobCode

String

Job code.

FinCoCode

String

Code of financial company

ActivityCode

String

Activity code

ActivityCodeValue

String

Activity code

ActivityType

String

Activity type

ActivitySubType

String

Activity Sub Type

WorkCentreCode

String

Code of Work Centre

WorkCentreCodeValue

String

Code of Work Centre

ItemId

Integer

Code of item.

StockLocationCodeValue

String

Code of Stock location.

CostRateValue

Number

Cost rate

BatchType

String

Batch type

OrderDerivedLine

Boolean

Order delivery line

DocketDerivedLine

Boolean

Docket Delivered line.

StockDerivedLine

Boolean

Stock Delivered line.

Type

String

= ['InwardsGoodsEntry', 'InwardsGoodsEdit', 'Issue', 'Return', 'Transfer', 'Requisition']

PurchaseOrderLineIdValue

Integer

Value of Purchase Order line

LogHeaderId

Integer

Log header code.

KeyName

String

CompanyId

Integer

Code of the company

GSTTypeCodeValue

String

Code of tax

TranDate

String

LogHeaderID

Integer

Log header code.

FcCost

Number

Cost in Foreign currency.

FcRetail

Number

Foreign currency Retail Rate

PurchaseOrderLineId

Integer

Id of Purchase Order line.

StockLocationInactive

Boolean

Unit

String

Unit

EnteredByID

Integer

Person who entered data.

SourceID

Integer

Source

FCGST

Number

Tax code for foreign currency.

JobCodeValue

CellData

Job code.

LogHeader

CellData

Log header.

ActivityCodeValue

CellData

Activity code.

WorkCentreCodeValue

CellData

Work Centre code.

QuantityValue

CellData

Quantity.

FcCostValue

CellData

Foreign currency cost.

CostValue

CellData

Cost.

GSTTypeValue

CellData

Tax type.

GSTTypeCodeValue

CellData

Code of Tax type.

GSTRateValue

CellData

Tax rate.

GSTValue

CellData

Tax value.

NetValueValue

CellData

Net value.

ReferenceValue

CellData

Reference.

FcRetailValue

CellData

Foreign currency Retail Rate

RetailValue

CellData

Retail value.

LineDescriptionValue

CellData

Line description.

DetailsValue

CellData

Details.

FromPONumberValue

CellData

From Purchase Order number.

PurchaseOrderLineIdValue

CellData

Code of Purchase Order line.

ReinstatePOCommitment

Boolean

Purchase Order line commitment.

StockLocationCodeValue

CellData

Code of Stock location.

StockItemCodeValue

CellData

Code of Stock item.

TotalLineCostValue

CellData

Total line cost.

CostRateValue

CellData

Cost rate.

UnitValue

CellData

Unit.

FCGSTValue

CellData

Tax code for foreign currency.

Delete

CellData

Serials

CellData

SerialRows

Array [TabletSerialLine]

Status

String

ReadonlyFlag

Integer

ReadonlyMessage

String

OriginalKey

JobTransactionsJobTransactionDetailKey

CurrentKey

JobTransactionsJobTransactionDetailKey

Key

JobTransactionsJobTransactionDetailKey

Index

Integer