- Created by Bao TRINH, last modified on Apr 21, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 21 Next »
Endpoints
APCreditDetailApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APCreditDetailApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET | Admin User | APInvoiceId | ||
POST | Admin User |
APInvoiceApprovalApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APInvoiceApprovalApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST | APInvoiceKey.PersonID | SaveResult |
APInvoiceDetailApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APInvoiceDetailApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET | Admin User | APInvoiceId | ||
POST | Admin User |
APInvoiceListApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APInvoiceListApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST | Authenticating User | GridRequestParametersApi | GridResult<APInvoiceLine> |
APInvoicePurchaseOrderDetailApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APInvoicePurchaseOrderDetailApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET | Authenticating User | APInvoiceId | ||
POST | Admin User |
APInvoiceUnapprovalApi
Web Workbench Screen: “AP Invoice Enquiry“ (#/APProcessing/APInvoiceList.aspx)
/api/APInvoiceUnapprovalApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST | APInvoiceKey.PersonID | SaveResult |
Models
APInvoiceApiModel
Property | Data Type | Description |
---|---|---|
Key | ||
DialogHeader | ||
JobTransactions | ||
POLines |
⬆️ Back to top
APInvoiceJobTransactionApi
Property | Data Type | Description |
---|---|---|
StoredFile | Stored file. | |
Form | ||
Rows | ||
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 |
---|---|---|---|
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 |
---|---|
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 |
---|---|---|
Rows |
⬆️ Back to top
APInvoicePurchaseOrderApi
Property | Type | Description |
---|---|---|
JobTransactions | ||
StoredFile | ||
Form | ||
Rows | Array [APProcessingPOConfirmationLine] | |
ReadonlyMessages | Array [Tuple_String] | |
ValidationErrors | Array [MvcValidationError] | |
WarningMessage | String | |
SuccessMessage | String | |
ErrorMessage | String |
⬆️ Back to top
APProcessingAPInvoiceDialogHeader
Property | Type | Description |
---|---|---|
IsReviewed | Boolean | Reviewed status. |
IsApproved | Boolean | Approved status. |
InvoiceNo | Invoice number. | |
APReference | Set AP Reference through the API when you create AP from PO. This field does not work for AP Credits | |
InvoiceDate | Invoice date. | |
PaymentDate | Payment date. | |
Currency | Currency | |
EditableCurrency | ||
Rate | The cost per item being purchased. | |
BatchNo | Batch number | |
Period | Financial period | |
PONo | Purchase Order number | |
APInvoiceId | Code pf AP invoice. | |
Supplier | Supplier name. | |
Status | Status | |
ReceivedDate | Received date. | |
ApprovedBy | Approved person. | |
Date | Date | |
ApplyToInvoice | ||
Gst | Tax | |
TotalInclGst | Total GST | |
AssignedReviewer | Person was assigned as Reviewer. | |
AssignedApprover | Person was assigned as Approver. | |
EnteredBy | Person entered data. | |
Comments | Note | |
FinancialCompany | Financial company. | |
OnHold | 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 |
---|---|---|
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 | Invoice number. | |
SupplierValue | Supplier | |
DateValue | String | Date. |
TypeValue | Type | |
BatchNoValue | Batch number | |
APStatusValue | AP status | |
AssignedApproverValue | Approver person. | |
ApprovedByValue | Approved date. | |
CurrencyValue | Currency | |
AmountValue | Amount | |
ExGstValue | The value of the invoice excluding tax | |
GstValue | Tax value. | |
IncGstValue | Total value including tax. | |
TotalPaymentValue | Total payment value. | |
TotalCreditInclValue | Total Credit . | |
LastPaymentValue | 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 | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
APProcessingAPInvoiceKey
Property | Type | Description |
---|---|---|
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. |
⬆️ Back to top
APProcessingPOConfirmationDialogGrid
Property | Type | Description |
---|---|---|
Layout | Layout | |
Rows | Array [APProcessingPOConfirmationLine] |
⬆️ Back to top
APProcessingPOConfirmationKey
Property | Type | Description |
---|---|---|
PO number | Integer | Purchase Order number. |
PurchaseOrderLineId | Integer | Purchase Order line code. |
⬆️ Back to top
APProcessingPOConfirmationLine
Property | Type | Description |
---|---|---|
ThisRate | Number | |
LineCompleted | Boolean | Line completed status. |
LogHeaderID | Integer | Log header code. |
JobCodeValue | Job code. | |
WorkCentreCodeValue | Code of Work Centre | |
LineDescriptionValue | Line description. | |
DetailsValue | Details. | |
UnitRateValue | Unit rate. | |
OrderQuantityValue | Order quantity. | |
FCOrderCostValue | Order cost in foreign currency. | |
ReceivedQuantityValue | Received quantity. | |
ReceivedValueValue | Received value. | |
FCUnitCostValue | Unit cost in foreign currency. | |
ThisQuantityValue | ||
ThisRateValue | ||
ThisValueValue | ||
ThisGSTValue | ||
OutstandingQuantityValue | Outstanding quantity. | |
OutstandingValueValue | Outstanding value. | |
RemainingQuantityValue | Remaining quantity. | |
RemainingValueValue | Remaining value. | |
ReceiptedQuantityValue | Receipted quantity. | |
ReceiptedValueValue | Receipted value. | |
Info | ||
LogHeaderValue | Log header. | |
Status | String | Status |
ReadonlyFlag | Integer | Read Only status |
ReadonlyMessage | String | Read Only message |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
JobTransactionsJobTransactionDetailKey
Property | Type | Description |
---|---|---|
JobTranId | Integer | Job transaction id. |
PersonId | Integer | Person id |
JobCode | String | Job code. |
FinCoCode | String | Code of financial company |
ActivityCode | String | |
ActivityCodeValue | String | |
ActivityType | String | |
ActivitySubType | String | |
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 |
⬆️ Back to top
JobTransactionsJobTransactionLine
Property | Type | Description |
---|---|---|
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 | Job code. | |
LogHeader | Log header. | |
ActivityCodeValue | ||
WorkCentreCodeValue | Work Centre code. | |
QuantityValue | Quantity. | |
FcCostValue | Foreign currency cost. | |
CostValue | Cost. | |
GSTTypeValue | Tax type. | |
GSTTypeCodeValue | Code of Tax type. | |
GSTRateValue | Tax rate. | |
GSTValue | Tax value. | |
NetValueValue | Net value. | |
ReferenceValue | Reference. | |
FcRetailValue | Foreign currency Retail Rate | |
RetailValue | Retail value. | |
LineDescriptionValue | Line description. | |
DetailsValue | Details. | |
FromPONumberValue | From Purchase Order number. | |
PurchaseOrderLineIdValue | Code of Purchase Order line. | |
ReinstatePOCommitment | Boolean | Purchase Order line commitment. |
StockLocationCodeValue | Code of Stock location. | |
StockItemCodeValue | Code of Stock item. | |
TotalLineCostValue | Total line cost. | |
CostRateValue | Cost rate. | |
UnitValue | Unit. | |
FCGSTValue | Tax code for foreign currency. | |
Delete | ||
Serials | ||
SerialRows | Array [TabletSerialLine] | |
Status | String | |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
Example
APInvoiceListApi POST
Request
Response
Response sample
⬆️ Top of page
- No labels