Endpoints

Provides access to AP Invoice and AP Credit related data.

APInvoiceListApi

Provides API access to the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) Web Workbench Screen.

/api/APInvoiceListApi

/api/APInvoiceListApi

Method

Performed As

Request Query

Request Body

Response

POST

Retrieve a filtered list of AP Invoices.

Logged in User

-

GridRequestParametersApi

GridResult<APInvoiceLine>

APInvoiceDetailApi

Provides API access to the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) dialog Web Workbench Screen.

/api/APInvoiceDetailApi

/api/APInvoiceDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific AP Invoice, including its Job Transaction lines.	Admin User	APInvoiceKey	-	APInvoiceJobTransactionApi
POST Create a new, or update an existing, AP Invoice.	Admin User	-	APInvoiceJobTransactionApi	APInvoiceJobTransactionApi

APCreditDetailApi

Provides API access to the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) dialog Web Workbench Screen.

/api/APCreditDetailApi

/api/APCreditDetailApi

Method

Performed As

Request Query

Request Body

Response

GET

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

Admin User

APInvoiceKey

-

APInvoiceJobTransactionApi

POST

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

Admin User

-

APInvoiceJobTransactionApi

APInvoiceApprovalApi

Provides API access to the Approve action of the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) dialog Web Workbench Screen.

/api/APInvoiceApprovalApi

/api/APInvoiceApprovalApi
Method	Performed As	Request Query	Request Body	Response
POST Approve an existing AP Invoice or AP Credit.	APInvoiceKey.PersonID (or if null: Admin User)	-	APInvoiceKey	SaveResult

APInvoiceUnapprovalApi

Provides API access to Unapprove action of the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) dialog Web Workbench Screen.

/api/APInvoiceUnapprovalApi

/api/APInvoiceUnapprovalApi
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

APInvoicePurchaseOrderDetailApi

Provides API access to the ‘Confirm Purchase Order’ dialog of the AP Invoice Enquiry (#/APProcessing/APInvoiceList.aspx) dialog Web Workbench Screen.

/api/APInvoicePurchaseOrderDetailApi

/api/APInvoicePurchaseOrderDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve 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

Models

APInvoiceApiModel

Property	Data Type	Description

Property	Data Type	Description
Key	APProcessingAPInvoiceKey
DialogHeader	APProcessingAPInvoiceDialogHeader
JobTransactions	APProcessingAPInvoiceDialogGrid
POLines	APProcessingPOConfirmationDialogGrid

Back to top

APInvoiceJobTransactionApi

Property	Data Type	Description

Property	Data Type	Description
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.

Back to top

APInvoiceKey

Property	Data Type	Required	Description

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

Back to top

APInvoiceLine

Property	Description

Property	Description
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

Back to top

APProcessingAPInvoiceDialogGrid

Property	Type	Description

Property	Type	Description
Rows	Array [JobTransactionsJobTransactionLine]

Back to top

APInvoicePurchaseOrderApi

Property	Type	Description

Property	Type	Description
JobTransactions	Array [JobTransactionsJobTransactionLine]
StoredFile	StoredFilesApiModel
Form	APInvoiceApiModel
Rows	Array [APProcessingPOConfirmationLine]
ReadonlyMessages	Array [Tuple_String]
ValidationErrors	Array [MvcValidationError]
WarningMessage	String
SuccessMessage	String
ErrorMessage	String

Back to top

APProcessingAPInvoiceDialogHeader

Property	Type	Description

Property	Type	Description
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

Back to top

APProcessingAPInvoiceLine

Property	Type	Description

Property	Type	Description
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