Transaction Management (1.0)

Download OpenAPI specification:Download

Public API that deals with transactions

Authentication

XCompleatApiKey

The header containing compleat api key.

Security Scheme Type

Transactions

Get Transactions

Used to retrieve a collection of transactions

Authorizations:
path Parameters
tenantId
required
string <guid>

The tenant id

pageNumber
required
integer

The page number of results

companyId
required
string <guid>

The company id - optional (pass NULL value when unavailable)

userId
required
string <guid>

The user id - optional (pass NULL value when unavailable)

status
required
string <guid>

The transaction status - optional (pass NULL value when unavailable)

transactionType
required
string <guid>

The transaction type - optional (pass NULL value when unavailable)

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

Response samples

Content type
application/json
{
  • "Transactions":
    [
    ],
  • "PageNumber": 1,
  • "Count": 8,
  • "PageSize": 20,
  • "MetaData":
    {
    }
}

Transaction

Get Transaction

Used to retrieve a transaction

Authorizations:
path Parameters
tenantId
required
string <guid>

The tenant id

transactionId
required
integer

The page number of results

userId
required
string <guid>

The user id - optional (pass NULL value when unavailable)

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

Response samples

Content type
{
  • "Transaction":
    {
    },
  • "MetaData":
    {
    }
}

Create Transaction

Used to create new purchase order, invoice or credit note in iCompleat

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to post transaction into. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the company to post transactions into. Must be a valid company within the tenant.

transactionType
required
string
Enum: "ORD" "INV" "CRD"

The type of transaction being created within the company.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Request Body schema: application/json
LayoutId
required
string <guid>

The unique ID of the layout you wish to create the order against.

TransactionStatus
required
string
Enum: "SAV" "APPR"

The status of transaction being created within the company.

Reference
required
string <= 50 characters

The ID of the order from your accounting software.

PoNumber
string <= 20 characters

The purchase order number associated with the order.

DateCreated
required
string

The date the order was created.

DateApproved
string