Data Transfer APIs
These APIs are for data transferring between Workbench and other systems.
Endpoints
APInvoiceTrfApi
Get or update AP records for export from AP transfer table.
/api/APInvoiceTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| /batchNo * |
| Inline Model Transfer_APInvoiceLineTrfApiModel
|
PUT |
| entity * | boolean |
ARInvoiceTrfApi
Get or update AR records for export from AR transfer table.
/api/ARInvoiceTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| /batchNo * |
| |
PUT |
| entity * | boolean |
BatchTrfApi
Update Batch Status. This API calls a stored procedure that checks the logs as the basis for the status associated to each batch number in the call.
/api/BatchTrf | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
| listOfBatches * |
| boolean |
POST Parameters
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
listOfBatches | Required | comma separated list of batches | query | string |
exportUserId | Required | userid of user who initiated export | query | integer |
CompanyTrfApi
Create or Update records in CompanyTrf table. Any records created/updated using this API will be reflected in the Company table and will be available in Web Workbench list of companies
/api/CompanyTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| companyCode* |
| |
POST |
|
| boolean | |
PUT |
|
| boolean |
GLJournalTrfApi
Get Journal entry details for exporting.
/api/GLJournalTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| BatchNo * |
| |
PUT |
|
| boolean |
JobReceiptTrfApi
Use to import Job Receipts to Workbench. Create or Update records in JobReceiptTrf table. Any records created/updated using this API will be reflected in the Job Receipts table and will be available in Web Workbench list of receipts when InvoiceNumber matches Job Invoice.
/api/JobReceiptTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Request Body | Response |
GET |
| jobReceiptId* |
| |
POST |
|
| boolean | |
PUT |
|
| boolean |
LogTrfApi
/api/TransferLogTrf and /api/ExportLogTrf | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST /api/TransferLogTrf Update ExportBatch info. |
| sessionId* |
| boolean |
POST /api/ExportLogTrf Update ExportBatch info. |
| batchNo* |
| boolean |
Parameters /api/TransferLogTrf
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
sessionId |
| export session id | query | string |
description |
| description | query | string |
batchNo |
| batch number | query | integer |
type | Info, Warning, Error | transfer log type | query | string |
Parameters /api/ExportLogTrf
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
batchNo |
| batchNo | query | integer |
exportId |
| id of the object to export | query | integer |
exportTable |
| export table of the batch | query | string |
type | Info, Warning, Error | transfer log type | query | string |
message |
| success or error message | query | string |
PaymentTrfApi
Use to import Payments to Workbench. Create or Update records in PaymenttTrf table. Any records created/updated using this API will be reflected in the Payments table and will be available in the Web Workbench list of payments when APInvoiceID matches an AP Invoice.
/api/PaymentTrfApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| paymentId* |
| |
POST |
|
| boolean | |
PUT |
|
| boolean |
Models
Inline Model
Syntax |
---|
Inline Model [ Inline Model 1] |
Inline Model 1
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
APInvoiceID | Integer | AP invoice id. |
CompanyCode | String | Company code. |
SubcontractCode | String | Subcontract code. |
ClaimNo | Integer | Claim number. |
BatchNo | Integer | Batch number. |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
JobCode | String | Job code. |
InvoiceRef | String | Invoice reference. |
InvoiceDate | String | Invoice date. |
PostingDate | String | Posting date. |
DueDate | String | Due date. |
CurrencyCode | String | Currency code. |
ExchangeRate | Number | Currency exchange rate. |
InvoiceCredit | Integer | Determine whether the Invoice is a Credit or not. |
BuyerCreated | Boolean |
|
Details | String | Details |
ExternalID | String | Record unique identifier from third-party system |
ForExport | Boolean | For exporting or not. |
APInvoiceLinesTrf |
|
Transfer_APInvoiceTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
APInvoiceID | Integer | AP invoice id |
CompanyCode | String | Company code. |
SubcontractCode | String | Subcontract code. |
ClaimNo | Integer | Claim number. |
BatchNo | Integer | Batch number. |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
JobCode | String | Job code. |
InvoiceRef | String | Invoice reference. |
InvoiceDate | String | Invoice date, |
PostingDate | String | Invoice posting date. |
DueDate | String | Due date. |
CurrencyCode | String | Currency code. |
ExchangeRate | Number | Currency exchange rate. |
InvoiceCredit | Integer | Determine whether the Invoice is a Credit or not. |
BuyerCreated | Boolean | Buyer Created |
Details | String | Details |
ExternalID | String | Record unique identifier from third-party system |
ForExport | Boolean | For exporting or not. |
APInvoiceLinesTrf |
|
Transfer_APInvoiceLineTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
JobTranID | Integer | Job transaction id. |
APInvoiceID | Integer | AP invoice id. |
TranDate | String | Transaction date. |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
JobCode | String | Job code. |
ActivityCode | String | Activity code. |
WorkCentreCode | String | Work Centre code. |
DrGLAccount | String | Debit Account General Ledger. |
TaxCode | String | Tax code. |
LineDescription | String | Description of line. |
Analysis1 | String |
|
Analysis2 | String |
|
Quantity | Number | Quantity. |
Cost | Number | Cost. |
GST | Number | Tax amount |
FCCost | Number | Cost in foreign currency. |
FCGST | Number | Foreign currency tax. |
TaxCategory | String | Tax category. |
Transfer_ARInvoiceTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
InvoiceNo | Integer | AP invoice id |
CompanyCode | String | Company code. |
BatchNo | Integer | Batch number. |
ClaimNo | Integer | Claim number. |
ApplyNo | Integer | Invoice No of the Credit is applied to |
InvoiceRef | String | Invoice reference |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
JobCode | String | Job code. |
InvoiceDate | String | Invoice date, |
PostingDate | String | Invoice posting date. |
DueDate | String | Due date. |
CurrencyCode | String | Currency code. |
ExchangeRate | Number | Currency exchange rate. |
InvoiceCredit | Integer | Determine whether the Invoice is a Credit or not. |
Details | String | Details |
ExternalID | String | Record unique identifier from third-party system |
ForExport | Boolean | For exporting or not. |
AIRnvoiceLinesTrf |
|
Transfer_ARInvoiceLineTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
InvoiceNo | Integer | AR invoice number. |
InvoiceLineID | Integer | Invoice line id. |
SalesCode | String | |
CrGLAccount | String | Credit Account General Ledger. |
TaxCode | String | Tax code. |
LineDescription | String | Line description. |
Analysis1 | String |
|
Analysis2 | String |
|
JobCode | String | Job code. |
WorkCentreCode | String | Work Centre code. |
Quantity | Number | Quantity. |
Amount | Number | Amount. |
GST | Number | Tax amount |
FCAmount | Number | Amount in foreign currency. |
FCGST | Number | Foreign currency tax. |
TaxCategory | String | Tax category. |
Transfer_CompanyTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
CompanyCode | String | Company code. |
ClientSupplier | Integer | Use to identify if the Company is a client or supplier 1 = Client 0 = Supplier |
CompanyName | String | Company name. |
AlphaCode | String | The company shorthand code. |
CurrencyCode | String | Currency code. |
PaymentTermsDays | Integer | The numerical value for days. |
PaymentTermsType | Integer | The payment terms for Job Sales Invoices to this company. |
GSTNumber | String | Tax number |
ContactFirstName | String | Contact first name. |
ContactSurname | String | Contact Surname. |
Contact_BusinessPhone | String | Contact business phone. |
Contact_MobilePhone | String | Contact mobile number. |
Contact_Fax | String | Contact fax number. |
Contact_EmailAddress | String | Contact email address. |
PostalAddress1 | String | Postal address fields |
PostalAddress2 | String | |
PostalAddress3 | String | |
PostalAddress4 | String | |
PostalAddress5 | String | |
PostalAddress6 | String | |
PostalPhone | String | Postal phone number. |
PostalFax | String | Postal fax number. |
PostalPostCode | String | Postal Post code. |
PhysicalAddress1 | String | Physical address fields. |
PhysicalAddress2 | String | |
PhysicalAddress3 | String | |
PhysicalAddress4 | String | |
PhysicalAddress5 | String | |
PhysicalAddress6 | String | |
PhysicalPhone | String | Physical address phone |
PhysicalFax | String | Physical address fax. |
PhysicalPostCode | String | Physical address Post code. |
EmailAddress | String | Email address |
BankAccountRef1 | String | Reference fields if needed to store account details. More |
BankAccountRef2 | String | |
BankAccountRef3 | String | |
UseGST | Boolean | Include tax on any sales to this company or not. |
BCIFlag | Boolean | Use Buyer Created Invoice or not. |
Inactive | Boolean | The company is inactive or not. |
ExternalID | String | Record unique identifier from third-party system |
SubContractor | Boolean | The company is a Subcontractor or not. |
Transfer_GLJournalTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
JobTranID | Integer | Job transaction id. |
BatchNo | Integer | Batch number. |
BatchType | String | Batch type. |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
BatchReference | String | Batch reference. |
TranDate | String | Transaction date. |
PostingDate | String | Posting date. |
GLCode | String | GL Account Code |
LineDescription | String | Line description. |
Analysis1 | String |
|
Analysis2 | String |
|
Quantity | Number | Quantity. |
Amount | Number | Amount |
GST | Number | Tax. |
GSTTypeCode | String | Taxe type code. |
Transfer_JobReceiptTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer |
|
FinCoCode | String | Financial company code. |
JobReceiptID | Integer | Job receipt id. |
ExternalID | String |
|
InvoiceNumber | Integer | Invoice number. |
ReceiptNumber | String | Receipt number. |
ReceiptReference | String | Receipt reference. |
ReceiptDate | String | Receipt date. |
BatchNo | Integer | Batch number. |
YearNo | Integer | Year number. |
PeriodNo | Integer | Financial period number. |
Amount | Number | Amount. |
LineDescription | String | Line description. |
Transfer_PaymentTrfApiModel
Field | Type | Description |
---|---|---|
ID | Integer | Record unique identifier |
FinCoCode | String | Financial company code. |
PaymentID | Integer | Payment id. |
ExternalID | String | Record unique identifier from third-party system |
APInvoiceID | Integer | AP invoices id. |
PaymentReference | String | Payment reference. |
PaymentDate | String | Payment date. |
Amount | Number | Amount. |
LineDescription | String | Line description. |
Example
APInvoiceTrfApi GET
APInvoiceTrfApi PUT
ARnvoiceTrfApi GET
ARnvoiceTrfApi PUT
BatchTrfApi POST
CompanyTrfApi GET
CompanyTrfApi POST
CompanyTrfApi PUT
GLJournalTrfApi GET
GLJournalTrfApi PUT
JobReceiptTrfApi GET
JobReceiptTrfApi POST
JobReceiptTrfApi PUT
LogTrfApi POST /api/TransferLogTrf
LogTrfApi POST /api/ExportLogTrf
PaymentTrfApi
Mapping
Mapping of batch types and the corresponding transfer API endpoint to consume.
Batch Types | Transfer API endpoint |
ApInvoice | APInvoiceTrfApi |
ApCredit | |
SubClaim | |
ArInvoice | ARInvoiceTrfApi |
ArCredit | |
Adjustment | GLJournalTrfApi |
WipAccrual | |
CccAccrual | |
PoAccrual | |
Disbursement | |
PlantIssue | |
Docket | |
Timesheet | |
StockReturn | |
StockIssue | |
StockTrf | |
StockAdjust | |
StockQty | |
StockValue |
Diagram
Exporting batches to third-party system via Data transfer API
In this page:
- 1 Endpoints
- 1.1 APInvoiceTrfApi
- 1.2 ARInvoiceTrfApi
- 1.3 BatchTrfApi
- 1.4 CompanyTrfApi
- 1.5 GLJournalTrfApi
- 1.6 JobReceiptTrfApi
- 1.7 LogTrfApi
- 1.8 PaymentTrfApi
- 2 Models
- 2.1 Inline Model
- 2.2 Inline Model 1
- 2.3 Transfer_APInvoiceTrfApiModel
- 2.4 Transfer_APInvoiceLineTrfApiModel
- 2.5 Transfer_ARInvoiceTrfApiModel
- 2.6 Transfer_ARInvoiceLineTrfApiModel
- 2.7 Transfer_CompanyTrfApiModel
- 2.8 Transfer_GLJournalTrfApiModel
- 2.9 Transfer_JobReceiptTrfApiModel
- 2.10 Transfer_PaymentTrfApiModel
- 3 Example
- 3.1 APInvoiceTrfApi GET
- 3.2 APInvoiceTrfApi PUT
- 3.3 ARnvoiceTrfApi GET
- 3.4 ARnvoiceTrfApi PUT
- 3.5 BatchTrfApi POST
- 3.6 CompanyTrfApi GET
- 3.7 CompanyTrfApi POST
- 3.8 CompanyTrfApi PUT
- 3.9 GLJournalTrfApi GET
- 3.10 GLJournalTrfApi PUT
- 3.11 JobReceiptTrfApi GET
- 3.12 JobReceiptTrfApi POST
- 3.13 JobReceiptTrfApi PUT
- 3.14 LogTrfApi POST /api/TransferLogTrf
- 3.15 LogTrfApi POST /api/ExportLogTrf
- 3.16 PaymentTrfApi
- 3.17 Mapping
- 4 Diagram