API Reference Guide

Resources

Activities

Delete a pay invoice session semaphore

DELETE /api/te/payinvoices/sessions/{sessionId}/semaphores/default
Description

Deletes a pay invoice session semaphore.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session ID

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Get an AP Invoice template

GET /api/te/PayInvoices/sessions/invoices/templates/default
Description

Gets the AP invoice template.

Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Update or verify a list of invoices with payment information

PUT /api/te/PayInvoices/sessions/{sessionId}/invoices
Description

In default mode, marks a set of invoices as paid or unpaid, and updates their partial payment information. In validation mode, it returns
a list of all errors and warnings that the input would produce without actually performing the update.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The APInvoice session ID

true

string

BodyParameter

invoiceListJson

The list of invoices to perform the update

true

string

QueryParameter

mode

Optional parameter; when set to "validation," causes the method to run in validation mode

false

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Get the list of all AP invoices

GET /api/te/PayInvoices/sessions/{sessionId}/invoices
Description

Gets a list of all AP invoices in the database.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The APInvoice session id

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Validate an invoice after a partial payment

PUT /api/te/payInvoices/sessions/{sessionId}/invoices/{invoiceId}
Description

Validates the specified invoice after the given partial payment.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session Id.

true

string

PathParameter

invoiceId

The APInvoice session id

true

number (double)

BodyParameter

partialPaymentJson

The partial payment.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

BankReconciliation

Get the bank reconciliation cash accounts

GET /api/activities/bankrecs/cashaccounts
Description

Gets the bank reconciliation cash accounts.

Responses
HTTP Code Description Schema

200

OK

[Object]

Update a bank reconciliation

PUT /api/activities/bankrecs/cashaccounts/{cashAccount}/reconciliations
Description

Updates a bank reconciliation.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The cash account code.

true

string

BodyParameter

bankReconciliationJSON

Bank reconciliation data.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Create a new bank reconciliation

POST /api/activities/bankrecs/cashaccounts/{cashAccount}/reconciliations
Description

Creates a new bank reconciliation record.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The Cash Account

true

string

BodyParameter

bankReconciliationJSON

Bank reconciliation data

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

500

Internal Server Error

No Content

Get a bank reconciliation template

GET /api/activities/bankrecs/templates/default
Description

Gets the bank reconciliation template.

Responses
HTTP Code Description Schema

200

OK

[Object]

Get bank reconciliation records by the account code

GET /api/activities/bankrecs/cashaccounts/{cashAccount}
Description

Gets the bank reconciliation records by the account code.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The cash account code.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Get the second level deposits from a deposit

GET /api/activities/bankrecs/cashaccounts/{cashAccount}/deposits/{date}
Description

Gets the second level deposits from a deposit.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The cash account code.

true

string

PathParameter

date

The deposit date.

true

string (date-time)

QueryParameter

number

The deposit number.

false

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Get a bank reconciliation

GET /api/activities/bankrecs/cashaccounts/{cashAccount}/reconciliations/{id}
Description

Gets a bank reconciliation template.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The cash account code.

true

string

PathParameter

id

The bank reconciliation identifier.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Delete a bank reconciliation

DELETE /api/activities/bankrecs/cashaccounts/{cashAccount}/reconciliations/{id}
Description

Deletes a bank reconciliation.

Parameters
Type Name Description Required Schema Default

PathParameter

cashAccount

The cash account code.

true

string

PathParameter

id

The bank reconciliation identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor doesnt exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Chart Of Accounts

Update an existing account code

PUT /api/coa/segments/{segmentId}/accounts/{accountId}
Description

Updates the account specified by the given segment Id and account Id, using information in the HTTP body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

segmentId

The segment ID

true

integer (int32)

PathParameter

accountId

The account ID

true

string

BodyParameter

acctDefinition

The account definition

true

Account
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (account not found in database)

No Content

409

Conflict

No Content

Get an account

GET /api/coa/segments/{segmentId}/accounts/{accountId}
Description

Gets the account specified by the given segment Id and account Id.

Parameters
Type Name Description Required Schema Default

PathParameter

segmentId

The segment ID

true

integer (int32)

PathParameter

accountId

The account ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (account not found in database)

No Content

Delete an account

DELETE /api/coa/segments/{segmentId}/accounts/{accountId}
Description

Deletes the account specified by the given segment Id and account Id.

Parameters
Type Name Description Required Schema Default

PathParameter

segmentId

The segment ID

true

integer (int32)

PathParameter

accountId

The account ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (account not found in database)

No Content

409

Conflict

No Content

Return the list of all COA segments

GET /api/coa/segments
Description

Returns a list of all defined COA segments (account categories).

Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Create an account code

POST /api/coa/segments/{segmentId}/accounts
Description

Creates a new account from information in the HTTP body parameter, and places it in the indicated segment.

Parameters
Type Name Description Required Schema Default

PathParameter

segmentId

The segment ID

true

integer (int32)

BodyParameter

accountDefinition

The account definition

true

Account
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

Return a list of accounts

GET /api/coa/segments/accounts
Description

Returns a list of all defined accounts with their segment codes and other information.

Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get a segment account template

GET /api/coa/segments/{segmentId}/template
Description

Returns the account template associated with the given segment.

Parameters
Type Name Description Required Schema Default

PathParameter

segmentId

The segment ID

true

integer (int32)
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

ConsolidationOrgs

Run the consolidation process

POST /api/consolidationorgs/consolidate
Description

Runs the consolidation process.

Parameters
Type Name Description Required Schema Default

BodyParameter

consolidationID

ID of the consolidation setup

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

500

Internal Server Error

No Content

Customer

Get the field’s metadata information for a customer

GET /api/customers/templates/default
Description

Gets the fields template needed to create or update a customer record.

Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get the transactions for the AR invoices

POST /api/customers/{customerId}/invoices/transactions
Description

Gets the transactios for the selected invoices.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

The customer id.

true

string

BodyParameter

invoices

true

AbstractFieldContainer array
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for the customer id)

No Content

500

Internal Server Error

No Content

Get the specified field values for a customer

POST /api/customers/{customerId}/fields
Description

Gets an object containing a list of "field:value" pairs, where the fields are specified in the request’s
body parameter, and the values are taken from the given customer.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

The customer ID

true

string

BodyParameter

fields

The fields to search

true

FieldsRequest
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get paginated customers

POST /api/customers/pages
Description

Gets the specified sub-list of vendors. For example, if there are 20 vendors in the system that match the
filter conditions, and the offset and limit are set to 10 and 5 respectively, the array of results will
contain the 11 through 15 matching vendors.

Parameters
Type Name Description Required Schema Default

BodyParameter

paginationRequestJson

The pagination request JSON.

true

string
Responses
HTTP Code Description Schema

200

OK - With a JSON object with the paginated customers. For more information about the JSON object structure
please review the {Abila.MIP.Advance.Domain.PaginationLookup} class.

[Object]

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the list of AR invoices

GET /api/customers/{customerId}/invoices
Description

Gets a list of AR invoices for the specified customer.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

The customer id.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for the customer id)

No Content

500

Internal Server Error

No Content

Get the customer invoice template

GET /api/customers/invoices/templates/default
Description

Gets the customer invoice template.

Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Update a customer

PUT /api/customers/{customerId}
Description

Updates the customer

Parameters
Type Name Description Required Schema Default

BodyParameter

customerJSON

The customer json.

true

string

PathParameter

customerId

The customer identifier.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Get the details of a customer

GET /api/customers/{customerId}
Description

Gets database information for the specified customer.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the customer does not exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Delete a customer

DELETE /api/customers/{customerId}
Description

Deletes the specified customer from the database.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

The customer identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor doesnt exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Gets the transaction match document numer lookup.

POST /api/customers/{customerId}/invoices/transactions/lookups/TETRANS_MATCH_DOCNUM
Description

Gets the transactios for the given selected invoices.

Parameters
Type Name Description Required Schema Default

PathParameter

customerId

The customer id.

true

string

BodyParameter

documentNumberList

The document number list.

true

string array
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for the customer id)

No Content

500

Internal Server Error

No Content

Create a customer

POST /api/customers
Description

Creates a customer.

Parameters
Type Name Description Required Schema Default

BodyParameter

customerJson

The customer json.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Get the customers lookup

GET /api/customers/lookups/{lookupsId}
Description

Gets a list of lookups for customers specified by the lookupsId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

lookupsId

The lookups identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Distribution Codes

Get distribution code lookups

GET /api/dc/lookups/{lookupId}
Description

Gets the list of lookups for distribution code specified by the lookupsId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

lookupId

The identification of the lookup.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (The read process cannot be executed. The distribution code lookup id [{0}] is invalid.)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Get a list of all distribution codes

GET /api/dc
Description

Gets a list of all defined distribution codes.

Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Invalid or missing authorization token

No Content

500

Internal Server Error

No Content

Create a distribution code

POST /api/dc
Description

Creates a new distribution code.

Parameters
Type Name Description Required Schema Default

BodyParameter

distributionCodeJson

The distribution code json.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

Gets the distribution code template.

GET /api/dc/templates/default
Description

Gets the template specific to the ditribution code.

Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Invalid or missing authorization token

No Content

500

Internal Server Error

No Content

Get paginated distribution codes

POST /api/dc/pages
Description

Gets the paginated distribution codes.

Parameters
Type Name Description Required Schema Default

BodyParameter

paginationRequestJson

The JSON pagination request.

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Delete a distribution code

DELETE /api/dc/{dcCode}
Description

Deletes a distribution code from the database.

Parameters
Type Name Description Required Schema Default

PathParameter

dcCode

The dc code.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

401

Forbidden (Invalid token, not authorized.)

No Content

404

The read process cannot be executed. The {Id distribution Code} distribution code does not exist.

No Content

405

Method not allowed, the requested resource does not support HTTP method (name of Verb).

No Content

409

The read process cannot be executed.

No Content

Update a distribution code

PUT /api/dc/{distributionCodeId}
Description

Allows to update a distribution code.

Parameters
Type Name Description Required Schema Default

BodyParameter

distributionCodeJson

The distribution code json.

true

string

PathParameter

distributionCodeId

The distribution code identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor doesnt exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Get distribution code information

GET /api/dc/{distributionCodeId}
Description

Gets information for a distribution code.

Parameters
Type Name Description Required Schema Default

PathParameter

distributionCodeId

The identification of a distribution code

true

string
Responses
HTTP Code Description Schema

404

Not Found (if the vendor doesnt exist)

No Content

Get specified fields values for a distribution code

POST /api/dc/{distributionCodeId}/fields
Description

Gets specified values for a distribution code.

Parameters
Type Name Description Required Schema Default

PathParameter

distributionCodeId

The identification of a distribution code.

true

string

BodyParameter

fields

The specified fields to retrieve information.

true

FieldsRequest
Responses
HTTP Code Description Schema

400

Bad Request (The distribution code {id Distribution Code} does not exist.)

No Content

500

Internal Server Error

No Content

Import

Processes the import data

POST /api/import
Parameters
Type Name Description Required Schema Default

BodyParameter

importData

Import Data that needs to be imported

true

ImportData
Responses
HTTP Code Description Schema

200

OK

[Object]

Player

Create a paginated lookup of players

POST /api/players/pages
Description

Gets the specified sub list of players based on the pagination request.

Parameters
Type Name Description Required Schema Default

BodyParameter

jsonPaginationRequest

A JSON string containing the page size ("limit"),
the page number ("offset", starts with 0), and filter information.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get the specified field values for a player

POST /api/players/{playerId}/fields
Description

Gets an object containing a list of "field:value" pairs, where the fields are specified in the request’s
body parameter, and the values are taken from the given player.

Parameters
Type Name Description Required Schema Default

PathParameter

playerId

The customer ID

true

string

BodyParameter

fields

The fields to search

true

FieldsRequest
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Scheduler

Run the scheduled task

POST /api/scheduler
Description

Runs the scheduled task.

Parameters
Type Name Description Required Schema Default

BodyParameter

taskID

Task ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

500

Internal Server Error

No Content

Security

Set a preference for the current user

PUT /api/security/preferences
Description

Sets the specified preference for the current user.

Parameters
Type Name Description Required Schema Default

BodyParameter

preference

The preference to be set.

true

UserPreferenceValue
Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the list of preferences for the current user

GET /api/security/preferences
Description

Gets the list of configurable user preferences for the current user.

Responses
HTTP Code Description Schema

403

Forbidden (missing or invalid authorization token)

No Content

500

Internal Server Error

No Content

Log a user in

POST /api/security/login
Description

Executes a login request with credentials from the HTTP body parameter.

Parameters
Type Name Description Required Schema Default

BodyParameter

credentials

The credentials of the user to be logged in

true

Credentials
Responses
HTTP Code Description Schema

400

Bad Request (missing credentials)

No Content

401

Unauthorized (invalid credentials)

No Content

Change the current organization context

PUT /api/security/login/organization
Description

Logs the current user in again with the specified new organization.

Parameters
Type Name Description Required Schema Default

BodyParameter

organization

The organization to be changed to

true

Organization
Responses
HTTP Code Description Schema

400

Bad Request (missing credentials)

No Content

401

Unauthorized (invalid credentials)

No Content

500

Internal Server Error (unexpected internal error)

No Content

Log the user out

POST /api/security/logout
Description

Logs the current user out.

Responses
HTTP Code Description Schema

401

Unauthorized

No Content

500

Internal Server Error

No Content

Get the current version of MIP Fund Accounting

GET /api/security/version
Description

Returns the version number of the current installation of MIP Fund Accounting. This call does not require an authentication token.

Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Get the current user

GET /api/security/current
Description

Gets database information for the current user.

Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

Get a list of all organizations in the system

GET /api/security/organizations
Description

Gets a list of all the organizations currently available in the system. This method does not require an authorization token.

Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Transaction Entry

Apply offsets to document transactions JV (Journal Voucher)

POST /api/te/jv/sessions/{sessionId}/documents/offsets
Description

Applies offsets to the transaction list for the document specified by the sessionId and documentId parameters.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session ID

true

string

BodyParameter

document

The document

true

JVDocument
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get a document template

GET /api/te/{transactionType}/sessions/documents/templates/default
Description

Gets the document template for the transaction entry type specified by the transactionType parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)
Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the sequence of a given item

GET /api/te/{transactionType}/sessions/{sessionId}/sequences/{itemId}
Description

Gets the sequence value of the item specified by the sessionId and itemId parameters.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session identifier.

true

string

PathParameter

itemId

The item identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

409

Conflict (maximum ID reached or session already posted)

No Content

Creates an accounts receivable receipt document.

POST /api/te/arreceipts/sessions/{sessionId}/documents
Description

Creates a new accounts receivable receipt document in the session specified by sessionId.
parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The account receivable receipt document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

201

Created: The create operation completed successfully.

[Object]

400

Bad Request: When the values sent in the JSON object request are incorrect.

No Content

401

Unauthorized: Error response when the provided token is not valid

No Content

403

Forbidden: Error response when the user does not have access rights.

No Content

404

Not Found: Session not found

No Content

409

Conflict: Unable to create document

No Content

500

Internal Server Error

No Content

Validate the vendor in an accounts payable invoice document.

POST /api/te/APInvoices/sessions/{sessionId}/documents/validations/vendor
Description

Checks whether there is another document with the same vendor and the same document identifier.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session ID

true

string

BodyParameter

validationArguments

The validation arguments.

true

AbstractFieldContainer
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

Update a transaction entry session

PUT /api/te/{transactionType}/sessions/{sessionId}
Description

Updates the specified transaction entry session using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

BodyParameter

session

The session object containing update information

true

TESession
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

409

Conflict — unable to update session

No Content

500

Internal Server Error

No Content

Get the details of a session

GET /api/te/{transactionType}/sessions/{sessionId}
Description

Gets the details of the session given its sessionId.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

500

Internal Server Error

No Content

Delete a transaction entry session

DELETE /api/te/{transactionType}/sessions/{sessionId}
Description

Deletes the specified transaction entry session.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

409

Conflict — unable to delete session

No Content

Get a list of document lookup values

GET /api/te/{transactionType}/lookups/documents/{lookupType}
Description

Gets the list of document lookup values for the given transaction type and lookup type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

lookupType

TEDOC_REVERSE (document reverse lookup)
TEDOC_PLAYER_ID (document vendor id list)
{UDF name} (values for specified user-defined field)

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Apply offsets to document transactions

POST /api/te/{transactionType}/sessions/{sessionId}/documents/offsets
Description

Applies offsets to the transaction list for the document specified by the sessionId and documentId parameters.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)
ARInvoices (Account Receivable Invoice)
ARReceipts (Account Receivable Receipt)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

BodyParameter

document

The document

true

TEDocumentUdf
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the list of sessions for a transaction type

GET /api/te/{transactionType}/sessions
Description

Gets the list of sessions for the specified transaction type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Create a transaction entry session

POST /api/te/{transactionType}/sessions
Description

Creates a transaction entry session for the given transaction type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

BodyParameter

session

The session

true

TESession
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

409

Conflict — unable to create session

No Content

500

Internal Server Error

No Content

Update a cash receipt document

PUT /api/te/cr/sessions/{sessionId}/documents/{documentId}
Description

Updates the cash receipt document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Update an accounts payable invoice document

PUT /api/te/apinvoices/sessions/{sessionId}/documents/{documentId}
Description

Updates the accounts payable invoice document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Create a transaction list using a distribution code

POST /api/te/{transactionType}/dc
Description

Creates a transaction list using the distribution code information from the body parameter. This method does not create database records.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

BodyParameter

distCodeInfo

The document’s distribution code configuration

true

DistributionInfo
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Update a cash disbursement document

PUT /api/te/cd/sessions/{sessionId}/documents/{documentId}
Description

Updates the cash disbursement document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Get a journal voucher document template

GET /api/te/jv/sessions/documents/templates/{docReverseType}
Description

Gets the journal voucher document template for the reverse type specified by the docReverseType parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

docReverseType

RN (reverse no)
RICD (reverse in current document)
RNDCS (reverse in new document, current session)
RNDNS (reverse in new document, new session)

true

enum (RN, RICD, RNDCS, RNDNS, DEFAULT)
Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Validate the vendor in an accounts payable invoice document.

POST /api/te/ARInvoices/sessions/{sessionId}/documents/validations/customer
Description

Checks whether there is another document with the same vendor and the same document identifier.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session ID

true

string

BodyParameter

validationArguments

The validation arguments.

true

AbstractFieldContainer
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

Execute an action in a transaction entry session

PUT /api/te/{transactionType}/sessions/{sessionId}/actions
Description

Executes the given action on the specified transaction entry session.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

BodyParameter

statusAction

The action to be performed

true

TEActionValue
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

409

Conflict — unable to perform action

No Content

501

Not Implemented

No Content

Get the list of session ids for a transaction type

GET /api/te/{transactionType}/sessions/ids
Description

Gets the list of session ids for the specified transaction type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the template for a transaction entry session

GET /api/te/{transactionType}/sessions/templates/default
Description

Gets the template of fields for a transaction entry session of the specified transaction type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)
Responses
HTTP Code Description Schema

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the sequence value of a given item

GET /api/te/{transactionType}/sequences/{itemId}
Description

Gets the sequence value of the item specified in the itemId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

itemId

The item identifier.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (item not found)

No Content

409

Conflict (maximum ID reached)

No Content

Update an accounts receivable invoice document

PUT /api/te/arinvoices/sessions/{sessionId}/documents/{documentId}
Description

Updates the accounts receivable invoice document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Create an Accounts Receivable Invoice document.

POST /api/te/arinvoices/sessions/{sessionId}/documents
Description

Creates a new Accounts Receivable Invoice document in the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The Account Receivable Document

true

TEDocumentUdf
Responses
HTTP Code Description Schema

200

OK

[Object]

Create a cash receipt document

POST /api/te/cr/sessions/{sessionId}/documents
Description

Creates a new cash receipt document in the session specified by sessionId.
parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The account receivable receipt document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

201

Created: The create operation completed successfully.

[Object]

400

Bad Request: When the values sent in the JSON object request are incorrect.

No Content

401

Unauthorized: Error response when the provided token is not valid

No Content

403

Forbidden: Error response when the user does not have access rights.

No Content

404

Not Found: Session not found

No Content

409

Conflict: Unable to create document

No Content

500

Internal Server Error

No Content

Update an accounts receivable receipts document

PUT /api/te/arreceipts/sessions/{sessionId}/documents/{documentId}
Description

Updates the accounts receivable receipts document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

TEDocumentUdf
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Get all document ids for a session

GET /api/te/{transactionType}/sessions/{sessionId}/documents/ids
Description

Gets a list of the ids of all documents for the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session identifier

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

500

Internal Server Error

No Content

Create a cash disbursement document

POST /api/te/cd/sessions/{sessionId}/documents
Description

Creates a new cash disbursement document in the session specified by sessionId.
parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The Cash Disbursement Document

true

TEDocumentUdf
Responses
HTTP Code Description Schema

200

OK

[Object]

Update a journal voucher document

PUT /api/te/jv/sessions/{sessionId}/documents/{documentId}
Description

Updates the journal voucher document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

PathParameter

documentId

The document identifier.

true

string

BodyParameter

document

The document.

true

JVDocument
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Create a journal voucher document

POST /api/te/jv/sessions/{sessionId}/documents
Description

Creates a new journal voucher document in the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The document.

true

JVDocument
Responses
HTTP Code Description Schema

500

Internal Server Error

No Content

Update a transaction entry document

PUT /api/te/{transactionType}/sessions/{sessionId}/documents/{documentId}
Description

Updates the transaction entry document specified by the sessionId and documentId parameters, using information given in the HTTP request body parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

PathParameter

documentId

The document ID

true

string

BodyParameter

document

The document

true

TEDocument
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found

No Content

409

Conflict — unable to update document

No Content

500

Internal Server Error

No Content

Get the details of a document

GET /api/te/{transactionType}/sessions/{sessionId}/documents/{documentId}
Description

Gets the details of the document specified by the sessionId and documentId parameters.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

PathParameter

documentId

The document ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (document not found)

No Content

500

Internal Server Error

No Content

Delete a transaction entry document

DELETE /api/te/{transactionType}/sessions/{sessionId}/documents/{documentId}
Description

Deletes the transaction entry document specified by the sessionId and documentId parameters.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

PathParameter

documentId

The document ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

409

Conflict — unable to delete document

No Content

Create an Accounts Payable Invoice document.

POST /api/te/apinvoices/sessions/{sessionId}/documents
Description

Creates a new Accounts Payable Invoice document in the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

sessionId

The session identifier.

true

string

BodyParameter

document

The Account Payable Document

true

TEDocumentUdf
Responses
HTTP Code Description Schema

200

OK

[Object]

Get all documents for a session

GET /api/te/{transactionType}/sessions/{sessionId}/documents
Description

Gets a list of all documents for the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session identifier

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (session not found)

No Content

500

Internal Server Error

No Content

Creates a transaction entry document.

POST /api/te/{transactionType}/sessions/{sessionId}/documents
Description

Creates a new transaction entry document in the session specified by the sessionId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session ID

true

string

BodyParameter

document

The document

true

TEDocument
Responses
HTTP Code Description Schema

201

Created: The create operation completed successfully.

[Object]

400

Bad Request: When the values sent in the JSON object request are incorrect.

No Content

401

Unauthorized: Error response when the provided token is not valid

No Content

403

Forbidden: Invalid or missing authorization token

No Content

404

Not Found: Session not found

No Content

409

Conflict: Unable to create document

No Content

500

Internal Server Error

No Content

Get a list of session lookup values

GET /api/te/{transactionType}/lookups/sessions/{lookupType}
Description

Gets the list of session lookup values for the given transaction type and lookup type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

lookupType

SESSION_STATUS (session status options)
SESSION_BUDGET_VERSION (session version options - budget only)

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get a list of transaction lookup values

GET /api/te/{transactionType}/lookups/transactions/{lookupType}
Description

Gets the list of transaction lookup values for the given transaction type and lookup type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

lookupType

TETRANS_ENTRY_TYPE (transaction entry type)
TETRANS_SEGMENT_{N} (segment lookups for segment {N})
{UDF name} (values for specified user-defined field)

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get a list of document lookup values

GET /api/te/{transactionType}/sessions/{sessionId}/documents/lookups/{lookupType}
Description

Gets the list of document lookup values for the given transaction type and lookup type.

Parameters
Type Name Description Required Schema Default

PathParameter

transactionType

JV (Journal Voucher)
BD (Budget)
APInvoices (Accounts Payable Invoice)

true

enum (JV, BD, APInvoices, APCredits, PayInvoices, ARReceipts, ARInvoices, CR, CD)

PathParameter

sessionId

The session Id.

true

string

PathParameter

lookupType

TEDOC_REVERSE (document reverse lookup)
TEDOC_PLAYER_ID (document vendor id list)
{UDF name} (values for specified user-defined field)

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Util

Gets warnings generated by user’s request

GET /api/warnings/{warningId}
Parameters
Type Name Description Required Schema Default

PathParameter

warningId

true

string
Responses
HTTP Code Description Schema

200

OK

[Object]

Vendor

Get a list of vendor lookup values

GET /api/vendors/lookups/{lookupType}
Description

Gets the list of lookup values for the vendor lookup type specified by the lookupType parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

lookupType

"VENDOR_1099_TYPE"
"VENDOR_MISC_1099_BOX_NUM" (used with "type" parameter)
"VENDOR_STATUS"
"VENDOR_TYPE"
"VENDOR_TAX_ID_TYPE"

true

string

QueryParameter

type

"MISC"
"DIV"
"INT"
"R"
"W2G"

false

string

QueryParameter

context

Query parameter that is only possible to be combined with the VENDOR_1099_TYPE lookup.
If combined with other lookups, this context filter will not have any effect.
Possible values:
'adjustment': Retrieves VENDOR_1099_TYPE lookup values except the W2G lookup value.
'default', not defined or any other value: Retrieves all the VENDOR_1099_TYPE lookup values.

false

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get the check address or addresses for the vendor

GET /api/vendors/{vendorId}/lookups/{addressType}
Description

Gets a list of all check addresses for the vendor specified by the vendorId parameter.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor id

true

string

PathParameter

addressType

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Create a check address for a vendor

POST /api/vendors/{vendorId}/checkaddresses
Description

Creates the check address for the specified vendor.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor id

true

string

BodyParameter

vendorCheckAddress

The vendor check address object with the new information.

true

VendorCheckAddress
Responses
HTTP Code Description Schema

400

Bad Request (missed required fields or invalid optionval fields in case of "SameAs" feature)

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor doesnt exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Create a paginated lookup of vendors

POST /api/vendors/pages
Description

Gets the specified sublist of vendors. For example, if there are 20 vendors in the system that match the
filter conditions, and the offset and limit are set to 10 and 5 respectively, the array of results will
contain the 11th through 15th matching vendors.

Parameters
Type Name Description Required Schema Default

BodyParameter

jsonPaginationRequest

A json string containing the page size ("limit"),
the page number ("offset", starts with 0), and filter information.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Create or validate a new vendor

POST /api/vendors
Description

Creates database information for the specified vendor.

Parameters
Type Name Description Required Schema Default

BodyParameter

vendorJSON

Vendor Data

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the check address template

GET /api/vendors/checkaddresses/templates/default
Description

Gets the template of fields needed to create or update a check address.

Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter value)

No Content

500

Internal Server Error

No Content

Update or validate an existing vendor

PUT /api/vendors/{vendorId}
Description

Updates database information for the specified vendor.

Parameters
Type Name Description Required Schema Default

BodyParameter

vendorJSON

Vendor Data

true

string

PathParameter

vendorId

The target vendor ID

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

500

Internal Server Error

No Content

Get the details of a vendor

GET /api/vendors/{vendorId}
Description

Gets the database information for the specified vendor. It contains address, payments and terms, 1099 information, and purchase order details.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor ID.

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor does not exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Delete a vendor

DELETE /api/vendors/{vendorId}
Description

Deletes the specified vendor from the database.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor id

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (if the vendor doesnt exist)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Get the check address of a vendor

GET /api/vendors/{vendorId}/checkaddresses/{addressCode}
Description

Gets the check address for the specified vendor.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

Represents the vendor ID

true

string

PathParameter

addressCode

true

string
Responses
HTTP Code Description Schema

404

Not Found (if the vendor doesnt exist)

No Content

Delete a vendor check address

DELETE /api/vendors/{vendorId}/checkaddresses/{addressCode}
Description

Deletes the specified vendor check address from the database.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor identifier.

true

string

PathParameter

addressCode

The address code of the address to be deleted

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (vendor doesnt exist)

No Content

409

Conflict (vendor is currently in use)

No Content

500

Internal Server Error

No Content

Get the vendor data template

GET /api/vendors/templates/default
Description

Gets the template of fields needed to create or update a vendor record.

Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get specified field values for the given vendor

POST /api/vendors/{vendorId}/fields
Description

Gets an object containing a list of field and value parameters as a pair, where the fields are specified in the
body parameter, and the values are taken from the given vendor.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor id

true

string

BodyParameter

fields

the fields to search

true

FieldsRequest
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter values)

No Content

500

Internal Server Error

No Content

Get the check address lookup values

GET /api/vendors/checkAddresses/lookups/{lookupType}
Description

Gets a list of all valid values for the specified lookup type for vendor check addresses.

Parameters
Type Name Description Required Schema Default

PathParameter

lookupType

"CHECK_ADDRESS_PREFERRED"
"CHECK_ADDRESS_SAME_AS"
"CHECK_ADDRESS_STATUS"

true

string
Responses
HTTP Code Description Schema

400

Bad Request

No Content

403

Forbidden (invalid or missing authorization token)

No Content

404

Not Found (no results for parameter value)

No Content

500

Internal Server Error

No Content

Update the check address of a vendor

PUT /api/vendors/{vendorId}/checkaddresses/{checkAddressCode}
Description

Updates the check address for the specified vendor.

Parameters
Type Name Description Required Schema Default

PathParameter

vendorId

The vendor ID.

true

string

PathParameter

checkAddressCode

The ID of the check address to update.

true

string

BodyParameter

vendorCheckAddress

The vendor check address object with the new information.

true

VendorCheckAddress
Responses
HTTP Code Description Schema

400

Bad Request (Missed required fields or invalid optional fields in case of "SameAs" feature.)

No Content

403

Forbidden (Invalid or missing authorization token.)

No Content

404

Not Found (If the vendor doesnt exists or the check address does not exists.)

No Content

409

Conflict

No Content

500

Internal Server Error

No Content

Definitions

AbstractFieldContainer

Name Description Required Schema Default

fields

false

FieldValue array

Account

Name Description Required Schema Default

requiredAccounts

false

AbstractFieldContainer array

fields

false

FieldValue array

Credentials

The credentials class

Name Description Required Schema Default

login

Gets or sets the login.

false

string

password

Gets or sets the password.

false

string

org

Gets or sets the org.

false

string

DistributionInfo

Name Description Required Schema Default

fields

false

FieldValue array

FieldValue

Name Description Required Schema Default

key

false

string

value

false

[Object]

FieldsRequest

Name Description Required Schema Default

fields

false

string array

positionFilter

false

PaginationRequest

FilterField

Name Description Required Schema Default

field

false

string

operation

false

enum (StartsWith, Equals, NotEquals, Contains)

value

false

string

ImportData

Name Description Required Schema Default

definition

false

string

dataItems

false

String] array

JVDocument

Name Description Required Schema Default

reverseSetup

false

FieldValue array

userDefinedFields

false

FieldValue array

transactions

false

TransactionEntry array

fields

false

FieldValue array

KeyValuePair[String,String]

Name Description Required Schema Default

key

false

string

value

false

string

Lookup

Name Description Required Schema Default

fields

false

FieldValue array

LookupData

Name Description Required Schema Default

key

false

string

value

false

Lookup array

Organization

Name Description Required Schema Default

name

false

string

description

false

string

PaginationFilter

Name Description Required Schema Default

fields

false

FilterField array

operator

false

enum (Or, And)

filters

false

PaginationFilter

PaginationRequest

Name Description Required Schema Default

offset

false

integer (int32)

limit

false

integer (int32)

filters

false

PaginationFilter

sort

false

SortRequest array

SortRequest

Name Description Required Schema Default

field

false

string

sortOrder

false

enum (Asc, Desc)

TEActionValue

Name Description Required Schema Default

key

false

string

value

false

string

TEDocument

Name Description Required Schema Default

transactions

false

TransactionEntry array

fields

false

FieldValue array

TEDocumentUdf

Name Description Required Schema Default

userDefinedFields

false

FieldValue array

transactions

false

TransactionEntry array

fields

false

FieldValue array

TESession

Name Description Required Schema Default

fields

false

FieldValue array

TransactionEntry

Name Description Required Schema Default

userDefinedFields

false

FieldValue array

segments

false

FieldValue array

fields

false

FieldValue array

UserPreferenceValue

Name Description Required Schema Default

key

false

enum (DEFAULT_ORGANIZATION, UI_TEGRID_LAYOUT, UI_JVDOC_ACTION, CHECK_PRINTING_INFORMATION)

value

false

string

VendorCheckAddress

Name Description Required Schema Default

fields

false

FieldValue array