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 20 Next »

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
Get APInvoice with APInvoiceLines from Trf tables using BatchNo

Sample

 

/batchNo *

 

Inline Model

Inline Model 1

Transfer_APInvoiceLineTrfApiModel

PUT
Update APInvoice with APInvoiceLines in APInvoiceTrf and APInvoice table

Sample

entity *

Transfer_APInvoiceTrfApiModel

Transfer_APInvoiceTrfApiModel

Transfer_APInvoiceLineTrfApiModel

ARInvoiceTrfApi

Get or update AR records for export from AR transfer table.

/api/ARInvoiceTrfApi

Operation

Logged in User

Parameters

Body

Response

GET
Get ARInvoice with ARInvoiceLines from Trf tables using BatchNo.

Sample

 

/batchNo *

 

Inline Model

Inline Model 1

Transfer_ARInvoiceLineTrfApiModel

PUT
Update APInvoice with ARInvoiceLines in ARInvoiceTrf and JobInvoice table.

Sample

entity *

Transfer_ARInvoiceTrfApiModel

Transfer_ARInvoiceTrfApiModel

Transfer_ARInvoiceLineTrfApiModel

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
Update ExportBatch info.

Sample

listOfBatches *
exportUserId *

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
Retrieve Company from CompanyTrf table by CompanyCode

Sample

 

 companyCode*

 

Transfer_CompanyTrfApiModel

POST
Creates Company records to CompanyTrf table.

Sample

Transfer_CompanyTrfApiModel

PUT
Updates Company records to CompanyTrf table.

Sample

Transfer_CompanyTrfApiModel

GLJournalTrfApi

/api/GLJournalTrfApi

Operation

Logged in User

Parameters

Body

Response

GET

Sample

 

 BatchNo *

 

Transfer_GLJournalTrfApiModel

PUT

Sample

Transfer_GLJournalTrfApiModel

JobReceiptTrfApi

Create or Update records in JobReceiptTrftable. 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
Retrieve Job Receipt from JobReceiptTrf table by id

Sample

 

 jobReceiptId*

 

Transfer_JobReceiptTrfApiModel

POST
Creates Job Receipt record to JobReceiptTrf tables.

Sample

Transfer_JobReceiptTrfApiModel

PUT
Updates Job Receipt record to JobReceiptTrf tables

Sample

Transfer_JobReceiptTrfApiModel

LogTrfApi

/api/TransferLogTrf and /api/ExportLogTrf

Operation

Logged in User

Parameters

Body

Response

POST /api/TransferLogTrf

Update ExportBatch info.

Sample

sessionId*
description*
batchNo
type (info, warning,error)

boolean

POST /api/ExportLogTrf

Update ExportBatch info.

Sample

batchNo*
exportId
exportable
message (text)
type (info, warning,error)

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

/api/PaymentTrfApi

Operation

Logged in User

Parameters

Body

Response

GET
Retrieve Payment from PaymentTrf table by id.

Sample

paymentId*

Transfer_PaymentTrfApiModel

POST
Creates Payment record to PaymentTrf tables.

Sample

Transfer_PaymentTrfApiModel

PUT
Updates Payment record to PaymentTrf tables.

Sample

Transfer_PaymentTrfApiModel

Models

 

Inline Model

Syntax

Inline Model [ Inline Model 1]

⬆️ Back to top

Inline Model 1

Field

Type

Description

ID

Integer

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.
if the value is 1 = invoice
if the value is -1 =  credit

BuyerCreated

Boolean

Details

String

Details

ExternalID

String

ForExport

Boolean

For exporting or not.

APInvoiceLinesTrf

Array [Transfer_APInvoiceLineTrfApiModel]

⬆️ Back to top

Transfer_APInvoiceTrfApiModel

Field

Type

Description

ID

Integer

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.
if the value is 1 = invoice
if the value is -1 =  credit

BuyerCreated

Boolean

Details

String

Details

ExternalID

String

ForExport

Boolean

For exporting or not.

APInvoiceLinesTrf

Array [Transfer_APInvoiceLineTrfApiModel]

⬆️ Back to top

Transfer_APInvoiceLineTrfApiModel

Field

Type

Description

ID

Integer

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.

⬆️ Back to top

Transfer_ARInvoiceTrfApiModel

Field

Type

Description

ID

Integer

FinCoCode

String

Financial company code.

InvoiceNo

Integer

AP invoice id

CompanyCode

String

Company code.

BatchNo

Integer

Batch number.

ClaimNo

Integer

Claim number.

ApplyNo

Integer

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.
if the value is 1 = invoice
if the value is -1 =  credit

Details

String

Details

ExternalID

String

ForExport

Boolean

For exporting or not.

AIRnvoiceLinesTrf

Array [Transfer_ARInvoiceLineTrfApiModel]

⬆️ Back to top

Transfer_ARInvoiceLineTrfApiModel

Field

Type

Description

ID

Integer

FinCoCode

String

Financial company code.

InvoiceNo

Integer

AR invoice number.

InvoiceLineID

Integer

Invoice line id.

SalesCode

String

Sales code.

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.

⬆️ Back to top

Transfer_CompanyTrfApiModel

Field

Type

Description

ID

Integer

FinCoCode

String

Financial company code.

CompanyCode

String

Company code.

ClientSupplier

Integer

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

SubContractor

Boolean

The company is a Subcontractor or not.

 ⬆️ Back to top

Transfer_GLJournalTrfApiModel

Field

Type

Description

ID

Integer

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

LineDescription

String

Line description.

Analysis1

String

Analysis2

String

Quantity

Number

Quantity.

Amount

Number

Amount

GST

Number

Tax.

GSTTypeCode

String

Taxe type code.

⬆️ Back to top

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.

⬆️ Back to top

Transfer_PaymentTrfApiModel

Field

Type

Description

ID

Integer

FinCoCode

String

Financial company code.

PaymentID

Integer

Payment id.

ExternalID

String

APInvoiceID

Integer

AP invoices id.

PaymentReference

String

Payment reference.

PaymentDate

String

Payment date.

Amount

Number

Amount.

LineDescription

String

Line description.

⬆️ Back to top

Example

APInvoiceTrfApi GET

 Response
Inline Model [
Inline Model 1
]
Inline Model 1 {
ID (integer, optional),
FinCoCode (string, optional),
APInvoiceID (integer, optional),
CompanyCode (string, optional),
SubcontractCode (string, optional),
ClaimNo (integer, optional),
BatchNo (integer, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
InvoiceRef (string, optional),
InvoiceDate (string, optional),
PostingDate (string, optional),
DueDate (string, optional),
CurrencyCode (string, optional),
ExchangeRate (number, optional),
InvoiceCredit (integer, optional),
BuyerCreated (boolean, optional),
Details (string, optional),
ExternalID (string, optional),
ForExport (boolean, optional),
APInvoiceLinesTrf (Array[Transfer_APInvoiceLineTrfApiModel], optional)
}
Transfer_APInvoiceLineTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobTranID (integer, optional),
APInvoiceID (integer, optional),
TranDate (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
DrGLAccount (string, optional),
TaxCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
Quantity (number, optional),
CostRate (number, optional),
Cost (number, optional),
GST (number, optional),
FCCost (number, optional),
FCGST (number, optional),
TaxCategory (string, optional)
}
 Response sample
[
  {
    "ID": 162,
    "FinCoCode": "01",
    "APInvoiceID": 1501,
    "CompanyCode": "20010",
    "SubcontractCode": "6126002",
    "ClaimNo": 1,
    "BatchNo": 224030,
    "YearNo": 2024,
    "PeriodNo": 2,
    "JobCode": "6126",
    "InvoiceRef": "6126002-1",
    "InvoiceDate": "2023-08-31T00:00:00",
    "PostingDate": "2023-08-31T00:00:00",
    "DueDate": "2023-09-28T00:00:00",
    "CurrencyCode": "AUD",
    "ExchangeRate": 1,
    "InvoiceCredit": 1,
    "BuyerCreated": false,
    "Details": "BOC LIMITED2345678921234567893123456789412345678951 - Batch: 224030",
    "ForExport": false,
    "APInvoiceLinesTrf": [
      {
        "ID": 183,
        "FinCoCode": "01",
        "JobTranID": 26399,
        "APInvoiceID": 1501,
        "TranDate": "2023-08-31T00:00:00",
        "YearNo": 2024,
        "PeriodNo": 2,
        "JobCode": "6126",
        "ActivityCode": "6-1000",
        "WorkCentreCode": "LAB",
        "DrGLAccount": "6-1100",
        "TaxCode": "GST",
        "LineDescription": "BOC LIMITED2345678921234567893123456789412345678951; 6126/6-1000/LAB;224030",
        "Analysis2": "6126",
        "Quantity": 5,
        "CostRate": 20,
        "Cost": 100,
        "GST": 10,
        "FCCost": 100,
        "FCGST": 10
      },
      {
        "ID": 184,
        "FinCoCode": "01",
        "JobTranID": 26400,
        "APInvoiceID": 1501,
        "TranDate": "2023-08-31T00:00:00",
        "YearNo": 2024,
        "PeriodNo": 2,
        "JobCode": "ZRET",
        "ActivityCode": "ZRET",
        "WorkCentreCode": "ZRET",
        "DrGLAccount": "1-0000",
        "TaxCode": "INPUT",
        "LineDescription": "BOC LIMITED2345678921234567893123456789412345678951; ZRET/ZRET/ZRET;224030",
        "Analysis2": "6126",
        "Quantity": 1,
        "CostRate": -10,
        "Cost": -10,
        "GST": -1,
        "FCCost": -10,
        "FCGST": -1
      }
    ]
  },
  {
    "ID": 163,
    "FinCoCode": "01",
    "APInvoiceID": 1502,
    "CompanyCode": "20010",
    "SubcontractCode": "6126002",
    "ClaimNo": 2,
    "BatchNo": 224030,
    "YearNo": 2024,
    "PeriodNo": 2,
    "JobCode": "6126",
    "InvoiceRef": "6126002-2",
    "InvoiceDate": "2023-08-31T00:00:00",
    "PostingDate": "2023-08-31T00:00:00",
    "DueDate": "2023-09-28T00:00:00",
    "CurrencyCode": "AUD",
    "ExchangeRate": 1,
    "InvoiceCredit": 1,
    "BuyerCreated": false,
    "Details": "BOC LIMITED2345678921234567893123456789412345678951 - Batch: 224030",
    "ForExport": false,
    "APInvoiceLinesTrf": [
      {
        "ID": 185,
        "FinCoCode": "01",
        "JobTranID": 26401,
        "APInvoiceID": 1502,
        "TranDate": "2023-08-31T00:00:00",
        "YearNo": 2024,
        "PeriodNo": 2,
        "JobCode": "ZRET",
        "ActivityCode": "ZRET",
        "WorkCentreCode": "ZRET",
        "DrGLAccount": "1-0000",
        "TaxCode": "GST",
        "LineDescription": "BOC LIMITED2345678921234567893123456789412345678951; ZRET/ZRET/ZRET;224030",
        "Analysis2": "6126",
        "Quantity": 1,
        "CostRate": 8,
        "Cost": 8,
        "GST": 0.8,
        "FCCost": 8,
        "FCGST": 0.8
      }
    ]
  }
]

APInvoiceTrfApi PUT

 Response
Transfer_APInvoiceTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
APInvoiceID (integer, optional),
CompanyCode (string, optional),
SubcontractCode (string, optional),
ClaimNo (integer, optional),
BatchNo (integer, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
InvoiceRef (string, optional),
InvoiceDate (string, optional),
PostingDate (string, optional),
DueDate (string, optional),
CurrencyCode (string, optional),
ExchangeRate (number, optional),
InvoiceCredit (integer, optional),
BuyerCreated (boolean, optional),
Details (string, optional),
ExternalID (string, optional),
ForExport (boolean, optional),
APInvoiceLinesTrf (Array[Transfer_APInvoiceLineTrfApiModel], optional)
}
Transfer_APInvoiceLineTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobTranID (integer, optional),
APInvoiceID (integer, optional),
TranDate (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
DrGLAccount (string, optional),
TaxCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
Quantity (number, optional),
CostRate (number, optional),
Cost (number, optional),
GST (number, optional),
FCCost (number, optional),
FCGST (number, optional),
TaxCategory (string, optional)
}
 Response sample

ARnvoiceTrfApi GET

 Response
Inline Model [
Inline Model 1
]
Inline Model 1 {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
CompanyCode (string, optional),
BatchNo (integer, optional),
ClaimNo (integer, optional),
ApplyNo (integer, optional),
InvoiceRef (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
InvoiceDate (string, optional),
PostingDate (string, optional),
DueDate (string, optional),
CurrencyCode (string, optional),
ExchangeRate (number, optional),
InvoiceCredit (integer, optional),
Details (string, optional),
ExternalID (string, optional),
ForExport (boolean, optional),
ARInvoiceLinesTrf (Array[Transfer_ARInvoiceLineTrfApiModel], optional)
}
Transfer_ARInvoiceLineTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
InvoiceLineID (integer, optional),
SalesCode (string, optional),
CrGLAccount (string, optional),
TaxCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
JobCode (string, optional),
WorkCentreCode (string, optional),
Quantity (number, optional),
Amount (number, optional),
GST (number, optional),
FCAmount (number, optional),
FCGST (number, optional),
TaxCategory (string, optional)
}
 Response sample
[
  {
    "ID": 142,
    "FinCoCode": "01",
    "InvoiceNo": 100298,
    "CompanyCode": "10002",
    "BatchNo": 723026,
    "YearNo": 2023,
    "PeriodNo": 7,
    "JobCode": "6098",
    "InvoiceDate": "2023-01-16T00:00:00",
    "PostingDate": "2023-01-31T00:00:00",
    "DueDate": "2023-02-15T00:00:00",
    "CurrencyCode": "AUD",
    "ExchangeRate": 1,
    "InvoiceCredit": 1,
    "Details": "Commercialscapes Landscaping",
    "ForExport": false,
    "ARInvoiceLinesTrf": [
      {
        "ID": 167,
        "FinCoCode": "01",
        "InvoiceNo": 100298,
        "InvoiceLineID": 1377,
        "SalesCode": "SALES",
        "CrGLAccount": "4-1000",
        "TaxCode": "GST",
        "LineDescription": "Sales Revenue WB Job: 6098 Final cleaning.",
        "Analysis2": "6098",
        "JobCode": "6098",
        "WorkCentreCode": "03",
        "Quantity": 3,
        "Amount": 210,
        "GST": 21,
        "FCAmount": 210,
        "FCGST": 21
      }
    ]
  },
  {
    "ID": 141,
    "FinCoCode": "01",
    "InvoiceNo": 100303,
    "CompanyCode": "10002",
    "BatchNo": 723026,
    "YearNo": 2023,
    "PeriodNo": 7,
    "JobCode": "6127",
    "InvoiceDate": "2023-01-31T00:00:00",
    "PostingDate": "2023-01-31T00:00:00",
    "DueDate": "2023-03-02T00:00:00",
    "CurrencyCode": "AUD",
    "ExchangeRate": 1,
    "InvoiceCredit": 1,
    "Details": "Myob-AccRight-AR",
    "ForExport": false,
    "ARInvoiceLinesTrf": [
      {
        "ID": 166,
        "FinCoCode": "01",
        "InvoiceNo": 100303,
        "InvoiceLineID": 1387,
        "SalesCode": "SALES",
        "CrGLAccount": "4-1000",
        "TaxCode": "GST",
        "LineDescription": "Sales Revenue WB Job: 6127 ",
        "Analysis2": "6127",
        "JobCode": "6127",
        "WorkCentreCode": "01",
        "Quantity": 5,
        "Amount": 125,
        "GST": 12.5,
        "FCAmount": 125,
        "FCGST": 12.5
      }
    ]
  }
]

ARnvoiceTrfApi PUT

 Response
Transfer_ARInvoiceTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
CompanyCode (string, optional),
BatchNo (integer, optional),
ClaimNo (integer, optional),
ApplyNo (integer, optional),
InvoiceRef (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
InvoiceDate (string, optional),
PostingDate (string, optional),
DueDate (string, optional),
CurrencyCode (string, optional),
ExchangeRate (number, optional),
InvoiceCredit (integer, optional),
Details (string, optional),
ExternalID (string, optional),
ForExport (boolean, optional),
ARInvoiceLinesTrf (Array[Transfer_ARInvoiceLineTrfApiModel], optional)
}
Transfer_ARInvoiceLineTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
InvoiceLineID (integer, optional),
SalesCode (string, optional),
CrGLAccount (string, optional),
TaxCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
JobCode (string, optional),
WorkCentreCode (string, optional),
Quantity (number, optional),
Amount (number, optional),
GST (number, optional),
FCAmount (number, optional),
FCGST (number, optional),
TaxCategory (string, optional)
}
 Response sample

BatchTrfApi GET

 Response
Inline Model [
Inline Model 1
]
Inline Model 1 {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
CompanyCode (string, optional),
BatchNo (integer, optional),
ClaimNo (integer, optional),
ApplyNo (integer, optional),
InvoiceRef (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
JobCode (string, optional),
InvoiceDate (string, optional),
PostingDate (string, optional),
DueDate (string, optional),
CurrencyCode (string, optional),
ExchangeRate (number, optional),
InvoiceCredit (integer, optional),
Details (string, optional),
ExternalID (string, optional),
ForExport (boolean, optional),
ARInvoiceLinesTrf (Array[Transfer_ARInvoiceLineTrfApiModel], optional)
}
Transfer_ARInvoiceLineTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
InvoiceNo (integer, optional),
InvoiceLineID (integer, optional),
SalesCode (string, optional),
CrGLAccount (string, optional),
TaxCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
JobCode (string, optional),
WorkCentreCode (string, optional),
Quantity (number, optional),
Amount (number, optional),
GST (number, optional),
FCAmount (number, optional),
FCGST (number, optional),
TaxCategory (string, optional)
}
 Response sample

BatchTrfApi POST

 Response
boolean
 Response sample
true

CompanyTrfApi GET

 Response
Transfer_CompanyTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
CompanyCode (string, optional),
ClientSupplier (integer, optional),
CompanyName (string, optional),
AlphaCode (string, optional),
CurrencyCode (string, optional),
PaymentTermsDays (integer, optional),
PaymentTermsType (integer, optional),
GSTNumber (string, optional),
ContactFirstName (string, optional),
ContactSurname (string, optional),
Contact_BusinessPhone (string, optional),
Contact_MobilePhone (string, optional),
Contact_Fax (string, optional),
Contact_EmailAddress (string, optional),
PostalAddress1 (string, optional),
PostalAddress2 (string, optional),
PostalAddress3 (string, optional),
PostalAddress4 (string, optional),
PostalAddress5 (string, optional),
PostalAddress6 (string, optional),
PostalPhone (string, optional),
PostalFax (string, optional),
PostalPostCode (string, optional),
PhysicalAddress1 (string, optional),
PhysicalAddress2 (string, optional),
PhysicalAddress3 (string, optional),
PhysicalAddress4 (string, optional),
PhysicalAddress5 (string, optional),
PhysicalAddress6 (string, optional),
PhysicalPhone (string, optional),
PhysicalFax (string, optional),
PhysicalPostCode (string, optional),
EmailAddress (string, optional),
BankAccountRef1 (string, optional),
BankAccountRef2 (string, optional),
BankAccountRef3 (string, optional),
UseGST (boolean, optional),
BCIFlag (boolean, optional),
Inactive (boolean, optional),
ExternalID (string, optional),
SubContractor (Boolean, optional)
}
 Response sample
{
  "ID": 135,
  "FinCoCode": "02",
  "CompanyCode": "TESTCUST2",
  "ClientSupplier": 1,
  "CompanyName": "Test Customer 2",
  "AlphaCode": "TESTCUST2",
  "PaymentTermsDays": 30,
  "PaymentTermsType": 1,
  "PostalAddress1": "1 Smith Street",
  "PostalAddress2": "Melbourne",
  "PostalAddress5": "Australia",
  "PhysicalAddress1": "1 Smith Street",
  "PhysicalAddress2": "Melbourne",
  "PhysicalAddress5": "Australia",
  "UseGST": false,
  "Inactive": false,
  "ExternalID": "TESTCUST2"
}

CompanyTrfApi POST

 Response
Transfer_CompanyTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
CompanyCode (string, optional),
ClientSupplier (integer, optional),
CompanyName (string, optional),
AlphaCode (string, optional),
CurrencyCode (string, optional),
PaymentTermsDays (integer, optional),
PaymentTermsType (integer, optional),
GSTNumber (string, optional),
ContactFirstName (string, optional),
ContactSurname (string, optional),
Contact_BusinessPhone (string, optional),
Contact_MobilePhone (string, optional),
Contact_Fax (string, optional),
Contact_EmailAddress (string, optional),
PostalAddress1 (string, optional),
PostalAddress2 (string, optional),
PostalAddress3 (string, optional),
PostalAddress4 (string, optional),
PostalAddress5 (string, optional),
PostalAddress6 (string, optional),
PostalPhone (string, optional),
PostalFax (string, optional),
PostalPostCode (string, optional),
PhysicalAddress1 (string, optional),
PhysicalAddress2 (string, optional),
PhysicalAddress3 (string, optional),
PhysicalAddress4 (string, optional),
PhysicalAddress5 (string, optional),
PhysicalAddress6 (string, optional),
PhysicalPhone (string, optional),
PhysicalFax (string, optional),
PhysicalPostCode (string, optional),
EmailAddress (string, optional),
BankAccountRef1 (string, optional),
BankAccountRef2 (string, optional),
BankAccountRef3 (string, optional),
UseGST (boolean, optional),
BCIFlag (boolean, optional),
Inactive (boolean, optional),
ExternalID (string, optional),
SubContractor (Boolean, optional)
}
 Response sample
true

CompanyTrfApi PUT

 Response
boolean
 Response sample
true

GLJournalTrfApi GET

 Response
Inline Model [
Inline Model 1
]
Inline Model 1 {
ID (integer, optional),
FinCoCode (string, optional),
JobTranID (integer, optional),
BatchNo (integer, optional),
BatchType (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
BatchReference (string, optional),
TranDate (string, optional),
PostingDate (string, optional),
GLCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
Quantity (number, optional),
Amount (number, optional),
GST (number, optional),
GSTTypeCode (string, optional)
}
 Response sample
[
  {
    "ID": 5,
    "FinCoCode": "01",
    "BatchNo": 423014,
    "BatchType": "Adjustment",
    "YearNo": 2023,
    "PeriodNo": 9,
    "BatchReference": "Inwards Goods",
    "TranDate": "2023-03-10T00:00:00",
    "PostingDate": "2023-03-10T00:00:00",
    "LineDescription": "Workbench Adjustment Batch: 423014",
    "Quantity": 0,
    "Amount": 100.8,
    "GST": 0
  },
  {
    "ID": 6,
    "FinCoCode": "01",
    "BatchNo": 423014,
    "BatchType": "Adjustment",
    "YearNo": 2023,
    "PeriodNo": 9,
    "BatchReference": "Inwards Goods",
    "TranDate": "2023-03-10T00:00:00",
    "PostingDate": "2023-03-10T00:00:00",
    "GLCode": "1-1320",
    "LineDescription": "Workbench Adjustment Batch: 423014",
    "Analysis2": "ZYARDSTK",
    "Quantity": 0,
    "Amount": 62.7,
    "GST": 0
  },
  {
    "ID": 7,
    "FinCoCode": "01",
    "BatchNo": 423014,
    "BatchType": "Adjustment",
    "YearNo": 2023,
    "PeriodNo": 9,
    "BatchReference": "Inwards Goods",
    "TranDate": "2023-03-10T00:00:00",
    "PostingDate": "2023-03-10T00:00:00",
    "GLCode": "123456789012345678901234567890Stock Clearing Acct1",
    "LineDescription": "Workbench Adjustment Batch: 423014",
    "Analysis2": "STKCLR",
    "Quantity": 0,
    "Amount": -163.5,
    "GST": 0
  }
]

GLJournalTrfApi PUT

 Response
Transfer_GLJournalTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobTranID (integer, optional),
BatchNo (integer, optional),
BatchType (string, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
BatchReference (string, optional),
TranDate (string, optional),
PostingDate (string, optional),
GLCode (string, optional),
LineDescription (string, optional),
Analysis1 (string, optional),
Analysis2 (string, optional),
Quantity (number, optional),
Amount (number, optional),
GST (number, optional),
GSTTypeCode (string, optional)
}
 Response sample
true

JobReceiptTrfApi GET

 Response
Transfer_JobReceiptTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobReceiptID (integer, optional),
ExternalID (string, optional),
InvoiceNumber (integer, optional),
ReceiptNumber (string, optional),
ReceiptReference (string, optional),
ReceiptDate (string, optional),
BatchNo (integer, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
Amount (number, optional),
LineDescription (string, optional)
}
 Response sample
{
  "ID": 6,
  "FinCoCode": "01",
  "PaymentID": 157,
  "ExternalID": "157-c7c4ee20-9ee5-4a77-98fd-8458d13c62b8",
  "APInvoiceID": 1464,
  "PaymentReference": "MYOB Import",
  "PaymentDate": "2023-08-04T00:00:00",
  "Amount": 47.83,
  "LineDescription": "Payment; BOC LIMITED"
}

JobReceiptTrfApi POST

 Response
Transfer_JobReceiptTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobReceiptID (integer, optional),
ExternalID (string, optional),
InvoiceNumber (integer, optional),
ReceiptNumber (string, optional),
ReceiptReference (string, optional),
ReceiptDate (string, optional),
BatchNo (integer, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
Amount (number, optional),
LineDescription (string, optional)
}
 Response sample
true

JobReceiptTrfApi PUT

 Response
Transfer_JobReceiptTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
JobReceiptID (integer, optional),
ExternalID (string, optional),
InvoiceNumber (integer, optional),
ReceiptNumber (string, optional),
ReceiptReference (string, optional),
ReceiptDate (string, optional),
BatchNo (integer, optional),
YearNo (integer, optional),
PeriodNo (integer, optional),
Amount (number, optional),
LineDescription (string, optional)
}
 Response sample
true

LogTrfApi POST /api/TransferLogTrf

 Response
boolean
 Response sample
true

LogTrfApi POST /api/ExportLogTrf

 Response
boolean
 Response sample
true

PaymentTrfApi

 Response
Transfer_PaymentTrfApiModel {
ID (integer, optional),
FinCoCode (string, optional),
PaymentID (integer, optional),
ExternalID (string, optional),
APInvoiceID (integer, optional),
PaymentReference (string, optional),
PaymentDate (string, optional),
Amount (number, optional),
LineDescription (string, optional)
}
 Response sample
{
  "ID": 16,
  "FinCoCode": "03",
  "PaymentID": 3931,
  "ExternalID": "25358093-e2fa-ee11-a1fd-000d3acc3fc3",
  "APInvoiceID": 1625,
  "PaymentReference": "Fabrikam, Inc.  test ",
  "PaymentDate": "2024-03-15T00:00:00",
  "Amount": 330,
  "LineDescription": "Business Central Import"
}

⬆️ Back to top

Diagram

Exporting batches to third-party system via Data transfer API

⬆️ Back to top

In this page:

wblogo2.png

Resource

Support

  • No labels