PayTraq
PayTraq.com
API v3.5 · Updated 23 Oct 2026

PayTraq Core API

Connect your app with PayTraq accounting software.

Read the docs
https://go.paytraq.com/api/
InterfaceCore API
PayloadXML
TransportHTTPS

Overview

The PayTraq API is a RESTful web service that is available over HTTPS by using the following endpoint: https://go.paytraq.com/api/

Requests and Responses

All API requests and responses must be transmitted over HTTPS.
The API supports the following HTTP methods: GET and POST.
All POST requests must:

  • send the request body in XML format;
  • include the following header:

HTTP header
Content-Type: application/xml

Unless otherwise specified, successful responses are returned in XML format.

Authentication

Depending on the type of integration, the API supports two authentication methods.

For Public Integrations it is also required to specify the company context.

Private Integrations

Private integrations are developed and maintained by the business itself.

To get started, the primary user must generate API credentials for the company profile.
This can be done from My Paytraq -> API Access section.
API credentials consist of an API Key and an API Token, which must be included in every API request for authentication and authorization.

The APIKey and APIToken can be supplied either:

  • as HTTP request headers; or
  • as query string parameters.
HTTP request headers example
curl -v https://go.paytraq.com/api/{APICall} \
-H "Content-Type:application/xml" \
-H "APIToken:{APIToken}" \
-H "APIKey:{APIKey}" \
-d "{RequestBody}"
query string parameters example
curl -v https://go.paytraq.com/api/{APICall}?APIToken={APIToken}&APIKey={APIKey} \
-H "Content-Type:application/xml" \
-d "{RequestBody}"

API credentials can be regenerated at any time. Regenerating the credentials immediately invalidates the previous API Key/Token pair. API access can also be revoked at any time by deleting the active credentials.

Public Integrations (Third-Party Providers)

Public integrations use OAuth 2.1 and short-lived access tokens for authentication.

PayTraq OAuth 2.1 Authorization Server
https://go.paytraq.com/oauth
authorization server metadata
https://go.paytraq.com/.well-known/oauth-authorization-server/oauth

The following OAuth grant types are supported.

Client Credentials Grant

The Client Credentials grant is intended for server-to-server integrations.

Before requesting an access token, an application must be registered to obtain a client_id and client_secret.
This can be done by a Paytraq user from My Paytraq -> Integrations section.
These credentials are then exchanged for an access token.

Exchange client credentials for a JWT access token
curl -s https://go.paytraq.com/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=client_credentials \
  -d client_id=CLIENT_ID \
  -d client_secret=CLIENT_SECRET

Response

JSON / HTTP
{
    "access_token": ACCESS_TOKEN,
    "token_type": "Bearer",
    "expires_in": 86399,
    "scope": ""
}

The access token must be included in every API request using the following HTTP header:

HTTP header
Authorization: Bearer ACCESS_TOKEN

Authorization Code Grant (PKCE)

The Authorization Code grant is intended for applications acting on behalf of a user and follows the OAuth 2.1 Authorization Code flow with PKCE.

Before initiating the authorization flow, an application must be registered to obtain a client_id.

For security reasons, callback URLs used during dynamic client registration must be whitelisted. If you are developing a new third-party integration, you must contact us and request that your callback URL be added to the whitelist before attempting dynamic client registration.

Register a public client
curl -s https://go.paytraq.com/oauth/register \
  -H 'Content-Type: application/json' \
  -d '{
    "client_name": "Client Application Name",
    "redirect_uris": ["http://localhost:8080/callback"],
    "scope": "api"
  }'

Response

JSON / HTTP
{
    "client_id": "GjAtdC5s7gUXMSEXe0PpZLgc_xNYHD09",
    "client_id_issued_at": 1784645567,
    "client_name": "Client Application Name",
    "redirect_uris": [
        "http://localhost:8080/callback"
      ],
    "grant_types": [
        "authorization_code",
        "refresh_token"
      ],
    "response_types": [
        "code"
      ],
    "token_endpoint_auth_method": "none",
    "scope": "api"
}

The application redirects the user to the authorization endpoint, where the user authenticates and grants consent.
CHALLENGE is a base64url-encoded SHA256 hash of the VERIFIER string, which is a random string generated by the application.

Get user consent
https://go.paytraq.com/oauth/authorize?response_type=code
    &client_id=CLIENT_ID
    &redirect_uri=REDIRECT_URI
    &scope=api
    &code_challenge=CHALLENGE
    &code_challenge_method=S256
    &resource=https://go.paytraq.com/api
    &state=abc123

Response

HTTP
REDIRECT_URI?code=AUTHORIZATION_CODE&state=abc123

After successful authorization, the application receives an authorization code, which can be exchanged for an access token and a refresh token.
Authorization code is valid for 5 minutes and can only be used once.
VERIFIER is the original random string used to generate the code challenge.

Exchange authorization code for a JWT access token and a refresh token
curl -s https://go.paytraq.com/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=authorization_code \
  -d client_id=CLIENT_ID \
  -d redirect_uri=REDIRECT_URI \
  -d code=AUTHORIZATION_CODE \
  -d code_verifier=VERIFIER

Response

JSON / HTTP
{
    "access_token": ACCESS_TOKEN,
    "token_type": "Bearer",
    "expires_in": 86399,
    "scope": "api",
    "refresh_token": REFRESH_TOKEN
}

When the access token expires, the refresh token can be used to obtain a new access token without requiring the user to authenticate again.
Refresh token is valid for 30 days and can only be used once.

Exchange authorization code for a JWT access token and a refresh token
curl -s https://go.paytraq.com/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=refresh_token \
  -d client_id=CLIENT_ID \
  -d refresh_token=REFRESH_TOKEN \
  -d scope=api

Response

JSON / HTTP
{
    "access_token": ACCESS_TOKEN,
    "token_type": "Bearer",
    "expires_in": 86399,
    "scope": "api",
    "refresh_token": REFRESH_TOKEN
}

The access token must be included in every API request using the following HTTP header:

HTTP header
Authorization: Bearer ACCESS_TOKEN

Company Context

Every API request authenticated with an OAuth access token must also specify the target company (tenant) by including the CompanyID header.

HTTP header
CompanyID: COMPANY_ID

To retrieve the list of companies available to the authenticated user or application, call:

HTTP request
GET /api/companies

Response

XML / HTTP
<Companies>
   <Company>
      <CompanyID></CompanyID>
      <CompanyName></CompanyName>
   </Company>
   ...
</Companies>

List of Return Codes and Statuses

Code Status Definition
200 OK The request has succeeded.
400 Bad Request The request could not be understood by the server due to malformed syntax, invalid values or validation issues.
401 Unauthorized API credentials have not been provided or company license key is not valid.
403 Forbidden Request is not permitted and has been forbidden by the server due to incorrect data, validation issues or authorization failure.
404 Not Found The server has not found anything matching the Request-URI.
429 Too Many Requests The user has sent too many requests in a given amount of time ("rate limiting").
500 Internal Server Error The server encountered an unexpected condition which prevented it from fulfilling the request.
501 Not Implemented The method called has not been implemented yet.
503 Service Unavailable The server is currently unable to handle the request due to maintenance of the server. This is a temporary condition which will be alleviated after some delay.

API Conventions

  • Decimal values should be passed with dot separator e.g. 10.90
  • Dates should be passed in the following format YYYY-MM-DD e.g. 2014-01-30
  • Boolean values should be false or true, 0 or 1 is not permitted.

API Limits

  • API Rate Limit: 1 request per second at an average, with bursts not exceeding 5 requests
  • Max 100 requests per minute
  • The daily API limit is 10000 requests per 24 hours.
    If you intend to make additional requests, please reach out to us beforehand by providing a description of your use case (Additional fees may apply).
    Excessive API usage may lead to the disabling of API access.

Optional Parameters

GET requests that are used to retrieve the list of objects can contain some optional parameters:

  • Pagination
    By default only the first 100 records are returned.
    To utilise paging, append a page parameter to the URL e.g. &page=0.
    If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g. &page=1 and continuing this process until no more results are returned.
    Note: Page values start with 0.
  • Filtering
    A filter can be applied to the results by appending a query parameter to the URL e.g. &query=John
    Possible values depend on request and retrieved object types.
    Example:
    List of clients or suppliers can be filtered by name or email.
    List of products or services - by name, SKU or barcode.
    List of documents - by document number or contact name.
     No filters are applied by default.
  • Date Range
    Lists of documents and journals can be filtered by dates by appending the following parameters to the URL:
    - date_from, e.g. &date_from=2014-12-01
    - date_till, e.g. &date_till=2014-12-31
  • Checking for new records and updates
    Available for the following lists of objects: Get Client List, Get Supplier List, Get Employee List, Get Product List, Get Service List, Get Sales Document List, Get Purchase Document List, Get Expense Claims, Get Inventory Movements, Get Payments and Get Journals.

    If you need to get only new records since your last request you can append one of the following parameters to the URL:
    1) A "created_after" UTC timestamp (YYYY-MM-DDTHH:MM:SSZ) e.g. &created_after=2017-01-01T20:00:00Z
    Only records created since this timestamp will be returned.
    By appending this parameter you will also change the default ordering.
    Result list will be sorted by date created in ascending order
    2) A last requested ID e.g. &id_after=999999
    Only records with greater ID values will be returned.
    By appending this parameter you will also change the default ordering.
    Result list will be sorted by id in ascending order

    If you need to get only updated records since the given UTC timestamp (YYYY-MM-DDTHH:MM:SSZ) you can append "updated_after" parameter to the URL e.g. &updated_after=2017-01-01T20:00:00Z
    Only records modified since this timestamp will be returned.
    By appending this parameter you will also change the default ordering.
    Result list will be sorted by date updated in ascending order
  • Sorting Order
    If you need to change the default sorting order you can append a reverse parameter to the URL e.g. &reverse=true
    By appending this parameter an ascending order will be changed to descending and vice versa.
  • Status
    Lists of documents and journals can be filtered by <DocumentStatus> and <JournalStatus> values correspondingly by appending a status parameters to the URL e.g. &status=draft

API Calls

Clients

GETGet Client List

Request

XML / HTTP
GET https://go.paytraq.com/api/clients

By default result list is sorted by client name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by client name or email.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Additional optional parameters are available for this request:
tag - Filter by tag value

Response

XML / HTTP
<Clients>
   <Client>
      <ClientID></ClientID>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <InvoiceInfo />
      <ClientGroup>
         <GroupID />
         <GroupName />
      </ClientGroup>
      <Project>
        <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Client>
   ...
</Clients>
Tag Description
<ClientID> Unique system identifier for client
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 1 - Prospective
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<GroupID> Unique system identifier for client group. See Get Client Groups
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Clients

GETGet Client

Request

XML / HTTP
GET https://go.paytraq.com/api/client/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<Client>
   <ClientID></ClientID>
   <Name />
   <Email />
   <Type></Type>
   <Status></Status>
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country></Country>
   </LegalAddress>
   <Phone />
   <InvoiceInfo />
   <ClientGroup>
      <GroupID />
      <GroupName />
   </ClientGroup>
   <Project>
      <ProjectName />
   </Project>
   <FinancialData>
      <ContractNumber />
      <CreditLimit></CreditLimit>
      <Deposit></Deposit>
      <Discount></Discount>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <TaxKeys>
         <Products>
            <TaxKeyID />
            <TaxKeyName />
         </Products>
         <Services>
            <TaxKeyID />
            <TaxKeyName />
         </Services>
      </TaxKeys>
      <Warehouse>
         <WrhID />
         <WrhName />
      </Warehouse>
      <PriceGroup>
         <PriceGroupID />
         <PriceGroupName />
      </PriceGroup>
   </FinancialData>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
   <Tags>
      <Tag />
   </Tags>
</Client>
Tag Description
<ClientID> Unique system identifier for client
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 1 - Prospective
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<InvoiceInfo> Additional Invoice Info
<GroupID> Unique system identifier for client group. See Get Client Groups
<PayTermType> Possible values:
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<WrhID> Unique system identifier for warehouse. See Get Warehouse
<PriceGroupID> Unique system identifier for price group. See Get Price Group
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Clients

GETGet Client By Registration Number

Request

XML / HTTP
GET https://go.paytraq.com/api/clientByRegNumber/{RegNumber}
Parameter Description
RegNumber Registration number

Response

Please refer to Get Client request

Back to Clients

POSTAdd Client

Request

XML / HTTP
POST https://go.paytraq.com/api/client

Payload

XML / HTTP
<Client>
   <Name />
   <Email />
   <Type />
   <Status />
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <InvoiceInfo />
   <ClientGroup>
      <GroupID />
   </ClientGroup>
   <Project>
      <ProjectName />
   </Project>
</Client>

Only <Name> is required.
For tags description please refer to Get Client request.

Response

XML / HTTP
<Response>
   <ClientID></ClientID>
</Response>
Tag Description
<ClientID> Unique system identifier for client

Back to Clients

POSTUpdate Client (General Data)

Request

XML / HTTP
POST https://go.paytraq.com/api/client/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<Client>
   <Name />
   <Email />
   <Type />
   <Status />
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <InvoiceInfo />
   <ClientGroup>
      <GroupID />
   </ClientGroup>
   <Project>
      <ProjectName />
   </Project>
</Client>

No tags are required.
For tags description please refer to Get Client request.

Response

XML / HTTP
<Response>
   <ClientID></ClientID>
</Response>
Tag Description
<ClientID> Unique system identifier for client

Back to Clients

POSTUpdate Client (Financial Data)

Request

XML / HTTP
POST https://go.paytraq.com/api/client/financialData/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<Client>
   <FinancialData>
      <ContractNumber />
      <CreditLimit></CreditLimit>
      <Deposit></Deposit>
      <Discount></Discount>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <TaxKeys>
         <Products>
            <TaxKeyID />
         </Products>
         <Services>
            <TaxKeyID />
         </Services>
      </TaxKeys>
      <Warehouse>
         <WrhID />
      </Warehouse>
      <PriceGroup>
         <PriceGroupID />
      </PriceGroup>
   </FinancialData>
</Client>

No tags are required.
For tags description please refer to Get Client request.

Response

XML / HTTP
<Response>
   <ClientID></ClientID>
</Response>
Tag Description
<ClientID> Unique system identifier for client

Back to Clients

GETGet Client Shipping Address List

Request

XML / HTTP
GET https://go.paytraq.com/api/client/shippingAddresses/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<ShippingAddresses>
   <ShippingAddress>
      <AddressID></AddressID>
      <ShipTo></ShipTo>
      <Address></Address>
      <Zip></Zip>
      <Country></Country>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </ShippingAddress>
</ShippingAddresses>
Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Clients

GETGet Client Shipping Address

Request

XML / HTTP
GET https://go.paytraq.com/api/client/shippingAddress/{ClientID}/{AddressID}
Parameter Description
ClientID Unique system identifier for client
AddressID Unique system identifier for shipping address

Response

XML / HTTP
<ShippingAddress>
   <AddressID></AddressID>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</ShippingAddress>
Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Clients

POSTAdd Client Shipping Address

Request

XML / HTTP
POST https://go.paytraq.com/api/client/shippingAddress/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<ShippingAddress>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
</ShippingAddress>

For tags description please refer to Get Client Shipping Address request

Response

XML / HTTP
<Response>
   <AddressID></AddressID>
</Response>
Tag Description
<AddressID> Unique system identifier for shipping address

Back to Clients

POSTUpdate Client Shipping Address

Request

XML / HTTP
POST https://go.paytraq.com/api/client/shippingAddress/{ClientID}/{AddressID}
Parameter Description
ClientID Unique system identifier for client
AddressID Unique system identifier for shipping address

Payload

XML / HTTP
<ShippingAddress>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</ShippingAddress>

No tags are required.
For tags description please refer to Get Client Shipping Address request.

Response

XML / HTTP
<Response>
   <AddressID></AddressID>
</Response>
Tag Description
<AddressID> Unique system identifier for shipping address

Back to Clients

GETGet Client Contact List

Request

XML / HTTP
GET https://go.paytraq.com/api/client/contacts/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<Contacts>
   <Contact>
      <ContactID></ContactID>
      <Name></Name>
      <Email></Email>
      <Phone></Phone>
      <AdditionalInfo></AdditionalInfo>
      <IsDefault></IsDefault>
   </Contact>
</Contacts>
Tag Description
<ContactID> Unique system identifier for contact
<IsDefault> Boolean value (false | true)

Back to Clients

GETGet Client Contact

Request

XML / HTTP
GET https://go.paytraq.com/api/client/contact/{ClientID}/{ContactID}
Parameter Description
ClientID Unique system identifier for client
ContactID Unique system identifier for contact

Response

XML / HTTP
<Contact>
  <ContactID></ContactID>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>
Tag Description
<ContactID> Unique system identifier for contact
<IsDefault> Boolean value (false | true)

Back to Clients

POSTAdd Client Contact

Request

XML / HTTP
POST https://go.paytraq.com/api/client/contact/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<Contact>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>

Only <Name></Name> is required.
For tags description please refer to Get Client Contact request

Response

XML / HTTP
<Response>
   <ContactID></ContactID>
</Response>
Tag Description
<ContactID> Unique system identifier for contact

Back to Clients

POSTUpdate Client Contact

Request

XML / HTTP
POST https://go.paytraq.com/api/client/contact/{ClientID}/{ContactID}
Parameter Description
ClientID Unique system identifier for client
ContactID Unique system identifier for contact

Payload

XML / HTTP
<Contact>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>

No tags are required.
For tags description please refer to Get Client Contact request.

Response

XML / HTTP
<Response>
   <ContactID></ContactID>
</Response>
Tag Description
<ContactID> Unique system identifier for contact

Back to Clients

GETGet Client Bank Details

Request

XML / HTTP
GET https://go.paytraq.com/api/client/banks/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<BankDetails>
   <BankInfo>
      <BankInfoID></BankInfoID>
      <BankAccount></BankAccount>
      <BankName></BankName>
      <BankCode></BankCode>
      <PaymentNote></PaymentNote>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </BankInfo>
</BankDetails>
Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Clients

GETGet Client Bank Info

Request

XML / HTTP
GET https://go.paytraq.com/api/client/bank/{ClientID}/{BankInfoID}
Parameter Description
ClientID Unique system identifier for client
BankInfoID Unique system identifier for bank info

Response

XML / HTTP
<BankInfo>
   <BankInfoID></BankInfoID>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</BankInfo>
Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Clients

POSTAdd Client Bank Info

Request

XML / HTTP
POST https://go.paytraq.com/api/client/bank/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<BankInfo>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
</BankInfo>

For tags description please refer to Get Client Bank Info request

Response

XML / HTTP
<Response>
   <BankInfoID></BankInfoID>
</Response>
Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Clients

POSTUpdate Client Bank Info

Request

XML / HTTP
POST https://go.paytraq.com/api/client/bank/{ClientID}/{BankInfoID}
Parameter Description
ClientID Unique system identifier for client
BankInfoID Unique system identifier for bank info

Payload

XML / HTTP
<BankInfo>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</BankInfo>

No tags are required.
For tags description please refer to Get Client Bank Info request.

Response

XML / HTTP
<Response>
   <BankInfoID></BankInfoID>
</Response>
Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Clients

POSTAdd Client Group

Request

XML / HTTP
POST https://go.paytraq.com/api/clientGroup

Payload

XML / HTTP
<ClientGroup>
  <Name></Name>
</ClientGroup>

Response

XML / HTTP
<Response>
   <GroupID></GroupID>
</Response>
Tag Description
<GroupID> Unique system identifier for client group

Back to Clients

GETGet Client Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/clientGroups

Response

XML / HTTP
<ClientGroups>
   <ClientGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </ClientGroup>
   ...
</ClientGroups>
Tag Description
<GroupID> Unique system identifier for client group

Back to Clients

GETGet Client Default Group

Request

XML / HTTP
GET https://go.paytraq.com/api/clientGroupDefaultId

Response

XML / HTTP
<ClientGroup>
   <GroupID></GroupID>
</ClientGroup>
Tag Description
<GroupID> Unique system identifier for client group.
If no default group is found then <GroupID>0</GroupID> will be returned

Back to Clients

Request

XML / HTTP
GET https://go.paytraq.com/api/clientLink/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<Client>
   <BillingSummaryLink>
      <URL></URL>
   </BillingSummaryLink>
</Client>

Back to Clients

GETGet Client Outstanding Balances

Request

XML / HTTP
GET https://go.paytraq.com/api/client/outstanding/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<Client>
  <BillingSummary>
    <Currency></Currency>
    <AmountDue></AmountDue>
    <AmountOverDue></AmountOverDue>
      <Sales>
        <Sale>
          <Header>
            <Document>
              <DocumentID></DocumentID>
              <DocumentDate></DocumentDate>
              <DocumentRef></DocumentRef>
              <DocumentType><DocumentType>
              <DocumentStatus></DocumentStatus>
            </Document>>
          </Header>
          <SaleType></SaleType>
          <Total></Total>
          <DateDue></DateDue>
          <AmountDue></AmountDue>
        </Sale>
      </Sales>
  </BillingSummary>
</Client>
Tag Description
<Currency> Currency code
<DocumentID> Unique system identifier for sales document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
<SaleType> Possible values:
  • sales_invoice - Invoice
  • sales_receipt - Receipt
  • credit_note - Credit Note/Refund

Back to Clients

GETGet Client E-Invoice Sending Option

Request

XML / HTTP
GET https://go.paytraq.com/api/client/einvoice/delivery/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Response

XML / HTTP
<Client>
   <ClientID></ClientID>
   <EInvoiceEnabled></EInvoiceEnabled>
   <DeliveryChannel></DeliveryChannel>
</Client>
Tag Description
<EInvoiceEnabled> Boolean value (false | true)

Back to Clients

POSTUpdate Client E-Invoice Sending Option

Request

XML / HTTP
POST https://go.paytraq.com/api/client/einvoice/delivery/{ClientID}
Parameter Description
ClientID Unique system identifier for client

Payload

XML / HTTP
<Client>
   <EInvoiceEnabled></EInvoiceEnabled>
</Client>
Tag Description
<EInvoiceEnabled> Boolean value (false | true)

Response

XML / HTTP
<Response>
   <ClientID></ClientID>
</Response>
Tag Description
<ClientID> Unique system identifier for client

Back to Clients

Suppliers

GETGet Supplier List

Request

XML / HTTP
GET https://go.paytraq.com/api/suppliers

By default result list is sorted by supplier name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by supplier name or email.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Additional optional parameters are available for this request:
tag - Filter by tag value

Response

XML / HTTP
<Suppliers>
   <Supplier>
      <SupplierID></SupplierID>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <SupplierGroup>
         <GroupID />
         <GroupName />
      </SupplierGroup>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Supplier>
   ...
</Suppliers>
Tag Description
<SupplierID> Unique system identifier for supplier
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<GroupID> Unique system identifier for supplier group. See Get Supplier Groups
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Suppliers

GETGet Supplier

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Response

XML / HTTP
<Supplier>
   <SupplierID></SupplierID>
   <Name />
   <Email />
   <Type></Type>
   <Status></Status>
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country></Country>
   </LegalAddress>
   <Phone />
   <SupplierGroup>
      <GroupID />
      <GroupName />
   </SupplierGroup>
   <Project>
      <ProjectName />
   </Project>
   <FinancialData>
      <ContractNumber />
      <CreditLimit></CreditLimit>
      <Deposit></Deposit>
      <Discount></Discount>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <TaxKeys>
         <Products>
            <TaxKeyID />
            <TaxKeyName />
         </Products>
         <Services>
            <TaxKeyID />
            <TaxKeyName />
         </Services>
      </TaxKeys>
      <Warehouse>
         <WrhID />
         <WrhName />
      </Warehouse>
   </FinancialData>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
   <Tags>
      <Tag />
   </Tags>
</Supplier>
Tag Description
<SupplierID> Unique system identifier for supplier
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<GroupID> Unique system identifier for supplier group. See Get Supplier Groups
<PayTermType> Possible values:
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<WrhID> Unique system identifier for warehouse. See Get Warehouse
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Suppliers

GETGet Supplier By Registration Number

Request

XML / HTTP
GET https://go.paytraq.com/api/supplierByRegNumber/{RegNumber}
Parameter Description
RegNumber Registration number

Response

Please refer to Get Supplier request

Back to Suppliers

POSTAdd Supplier

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier

Payload

XML / HTTP
<Supplier>
   <Name />
   <Email />
   <Type />
   <Status />
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <SupplierGroup>
      <GroupID />
   </SupplierGroup>
   <Project>
      <ProjectName />
   </Project>
</Supplier>

Only <Name> is required.
For tags description please refer to Get Supplier request

Response

XML / HTTP
<Response>
   <SupplierID></SupplierID>
</Response>
Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

POSTUpdate Supplier (General Data)

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Payload

XML / HTTP
<Supplier>
   <Name />
   <Email />
   <Type />
   <Status />
   <RegNumber />
   <VatNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <SupplierGroup>
      <GroupID />
   </SupplierGroup>
   <Project>
      <ProjectName />
   </Project>
</Supplier>

No tags are required.
For tags description please refer to Get Supplier request.

Response

XML / HTTP
<Response>
   <SupplierID></SupplierID>
</Response>
Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

POSTUpdate Supplier (Financial Data)

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/financialData/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Payload

XML / HTTP
<Supplier>
   <FinancialData>
      <ContractNumber />
      <CreditLimit></CreditLimit>
      <Deposit></Deposit>
      <Discount></Discount>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <TaxKeys>
         <Products>
            <TaxKeyID />
         </Products>
         <Services>
            <TaxKeyID />
         </Services>
      </TaxKeys>
      <Warehouse>
         <WrhID />
      </Warehouse>
   </FinancialData>
</Supplier>

No tags are required.
For tags description please refer to Get Supplier request.

Response

XML / HTTP
<Response>
   <SupplierID></SupplierID>
</Response>
Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

GETGet Supplier Shipping Address List

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/shippingAddresses/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Response

XML / HTTP
<ShippingAddresses>
   <ShippingAddress>
      <AddressID></AddressID>
      <ShipTo></ShipTo>
      <Address></Address>
      <Zip></Zip>
      <Country></Country>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </ShippingAddress>
</ShippingAddresses>
Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Suppliers

GETGet Supplier Shipping Address

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}/{AddressID}
Parameter Description
SupplierID Unique system identifier for supplier
AddressID Unique system identifier for shipping address

Response

XML / HTTP
<ShippingAddress>
   <AddressID></AddressID>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</ShippingAddress>
Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Suppliers

POSTAdd Supplier Shipping Address

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Payload

XML / HTTP
<ShippingAddress>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
</ShippingAddress>

For tags description please refer to Get Supplier Shipping Address request

Response

XML / HTTP
<Response>
   <AddressID></AddressID>
</Response>
Tag Description
<AddressID> Unique system identifier for shipping address

Back to Suppliers

POSTUpdate Supplier Shipping Address

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}/{AddressID}
Parameter Description
SupplierID Unique system identifier for supplier
AddressID Unique system identifier for shipping address

Payload

XML / HTTP
<ShippingAddress>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</ShippingAddress>

No tags are required.
For tags description please refer to Get Supplier Shipping Address request.

Response

XML / HTTP
<Response>
   <AddressID></AddressID>
</Response>
Tag Description
<AddressID> Unique system identifier for shipping address

Back to Suppliers

GETGet Supplier Contact List

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/contacts/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Response

XML / HTTP
<Contacts>
   <Contact>
      <ContactID></ContactID>
      <Name></Name>
      <Email></Email>
      <Phone></Phone>
      <AdditionalInfo></AdditionalInfo>
      <IsDefault></IsDefault>
   </Contact>
</Contacts>
Tag Description
<ContactID> Unique system identifier for contact
<IsDefault> Boolean value (false | true)

Back to Suppliers

GETGet Supplier Contact

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/contact/{SupplierID}/{ContactID}
Parameter Description
SupplierID Unique system identifier for supplier
ContactID Unique system identifier for contact

Response

XML / HTTP
<Contact>
  <ContactID></ContactID>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>
Tag Description
<ContactID> Unique system identifier for contact
<IsDefault> Boolean value (false | true)

Back to Suppliers

POSTAdd Supplier Contact

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/contact/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Payload

XML / HTTP
<Contact>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>

Only <Name></Name> is required.
For tags description please refer to Get Supplier Contact request

Response

XML / HTTP
<Response>
   <ContactID></ContactID>
</Response>
Tag Description
<ContactID> Unique system identifier for contact

Back to Suppliers

POSTUpdate Supplier Contact

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/contact/{SupplierID}/{ContactID}
Parameter Description
SupplierID Unique system identifier for supplier
ContactID Unique system identifier for contact

Payload

XML / HTTP
<Contact>
  <Name></Name>
  <Email></Email>
  <Phone></Phone>
  <AdditionalInfo></AdditionalInfo>
  <IsDefault></IsDefault>
</Contact>

No tags are required.
For tags description please refer to Get Supplier Contact request.

Response

XML / HTTP
<Response>
   <ContactID></ContactID>
</Response>
Tag Description
<ContactID> Unique system identifier for contact

Back to Suppliers

GETGet Supplier Bank Details

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/banks/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Response

XML / HTTP
<BankDetails>
   <BankInfo>
      <BankInfoID></BankInfoID>
      <BankAccount></BankAccount>
      <BankName></BankName>
      <BankCode></BankCode>
      <PaymentNote></PaymentNote>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </BankInfo>
</BankDetails>
Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Suppliers

GETGet Supplier Bank Info

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/bank/{SupplierID}/{BankInfoID}

Parameter Description
SupplierID Unique system identifier for supplier
BankInfoID Unique system identifier for bank info

Response

XML / HTTP
<BankInfo>
   <BankInfoID></BankInfoID>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</BankInfo>
Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Suppliers

POSTAdd Supplier Bank Info

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/bank/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Payload

XML / HTTP
<BankInfo>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
</BankInfo>

For tags description please refer to Get Supplier Bank Info request

Response

XML / HTTP
<Response>
   <BankInfoID></BankInfoID>
</Response>
Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Suppliers

POSTUpdate Supplier Bank Info

Request

XML / HTTP
POST https://go.paytraq.com/api/supplier/bank/{SupplierID}/{BankInfoID}

Parameter Description
SupplierID Unique system identifier for supplier
BankInfoID Unique system identifier for bank info

Payload

XML / HTTP
<BankInfo>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</BankInfo>

No tags are required.
For tags description please refer to Get Supplier Bank Info request.

Response

XML / HTTP
<Response>
   <BankInfoID></BankInfoID>
</Response>
Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Suppliers

POSTAdd Supplier Group

Request

XML / HTTP
POST https://go.paytraq.com/api/supplierGroup

Payload

XML / HTTP
<SupplierGroup>
  <Name></Name>
</SupplierGroup>

Response

XML / HTTP
<Response>
   <GroupID></GroupID>
</Response>
Tag Description
<GroupID> Unique system identifier for supplier group

Back to Suppliers

GETGet Supplier Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/supplierGroups

Response

XML / HTTP
<SupplierGroups>
   <SupplierGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </SupplierGroup>
   ...
</SupplierGroups>
Tag Description
<GroupID> Unique system identifier for supplier group

Back to Suppliers

GETGet Supplier Default Group

Request

XML / HTTP
GET https://go.paytraq.com/api/supplierGroupDefaultId

Response

XML / HTTP
<SupplierGroup>
   <GroupID></GroupID>
</SupplierGroup>
Tag Description
<GroupID> Unique system identifier for supplier group.
If no default group is found then <GroupID>0</GroupID> will be returned

Back to Suppliers

GETGet Supplier Outstanding Balances

Request

XML / HTTP
GET https://go.paytraq.com/api/supplier/outstanding/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier

Response

XML / HTTP
<Supplier>
  <BillingSummary>
    <Currency></Currency>
    <AmountDue></AmountDue>
    <AmountOverDue></AmountOverDue>
      <Purchases>
        <Purchase>
          <Header>
            <Document>
              <DocumentID></DocumentID>
              <DocumentDate></DocumentDate>
              <DocumentRef></DocumentRef>
              <DocumentType><DocumentType>
              <DocumentStatus></DocumentStatus>
            </Document>>
          </Header>
          <PurchaseType></PurchaseType>
          <Total></Total>
          <DateDue></DateDue>
          <AmountDue></AmountDue>
        </Purchase>
      </Purchases>
  </BillingSummary>
</Supplier>
Tag Description
<Currency> Currency code
<DocumentID> Unique system identifier for sales document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
<PurchaseType> Possible values:
  • purchase_invoice - Purchase Invoice
  • purchase_receipt - Purchase Receipt
  • debit_note - Credit Note/Refund
  • purchase_voucher - Self-Billed Invoice

Back to Suppliers

Employees

GETGet Employee List

Request

XML / HTTP
GET https://go.paytraq.com/api/employees

By default result list is sorted by employee name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by employee name or email.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Response

XML / HTTP
<Employees>
   <Employee>
      <EmployeeID></EmployeeID>
      <Name />
      <Email />
      <Status></Status>
      <ContractNumber />
      <RegNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <EmployeeGroup>
         <GroupID />
         <GroupName />
      </EmployeeGroup>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Employee>
   ...
</Employees>
Tag Description
<EmployeeID> Unique system identifier for employee
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<GroupID> Unique system identifier for employee group. See Get Employee Groups
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Employees

GETGet Employee

Request

XML / HTTP
GET https://go.paytraq.com/api/employee/{EmployeeID}
Parameter Description
EmployeeID Unique system identifier for employee

Response

XML / HTTP
<Employee>
   <EmployeeID></EmployeeID>
   <Name />
   <Email />
   <Status></Status>
   <ContractNumber />
   <RegNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country></Country>
   </LegalAddress>
   <Phone />
   <EmployeeGroup>
      <GroupID />
      <GroupName />
   </EmployeeGroup>
   <Project>
      <ProjectName />
   </Project>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
</Employee>
Tag Description
<EmployeeID> Unique system identifier for employee
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<GroupID> Unique system identifier for employee group. See Get Employee Groups
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Employees

POSTAdd Employee

Request

XML / HTTP
POST https://go.paytraq.com/api/employee

Payload

XML / HTTP
<Employee>
   <Name />
   <Email />
   <Status />
   <ContractNumber />
   <RegNumber  />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <EmployeeGroup>
      <GroupID />
   </EmployeeGroup>
   <Project>
      <ProjectName />
   </Project>
</Employee>

Only <Name> is required.
For tags description please refer to Get Employee request.

Response

XML / HTTP
<Response>
   <EmployeeID></EmployeeID>
</Response>
Tag Description
<EmployeeID> Unique system identifier for employee

Back to Employees

POSTUpdate Employee (General Data)

Request

XML / HTTP
POST https://go.paytraq.com/api/employee/{EmployeeID}
Parameter Description
EmployeeID Unique system identifier for employee

Payload

XML / HTTP
<Employee>
   <Name />
   <Email />
   <Type />
   <Status />
   <ContractNumber />
   <RegNumber />
   <LegalAddress>
      <Address />
      <Zip />
      <Country />
   </LegalAddress>
   <Phone />
   <EmployeeGroup>
      <GroupID />
   </EmployeeGroup>
   <Project>
      <ProjectName />
   </Project>
</Employee>

No tags are required.
For tags description please refer to Get Employee request.

Response

XML / HTTP
<Response>
   <EmployeeID></EmployeeID>
</Response>
Tag Description
<EmployeeID> Unique system identifier for employee

Back to Employees

GETGet Employee Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/employeeGroups

Response

XML / HTTP
<EmployeeGroups>
   <EmployeeGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </EmployeeGroup>
   ...
</EmployeeGroups>
Tag Description
<GroupID> Unique system identifier for employee group

Back to Employees

GETGet Default Employee Group

Request

XML / HTTP
GET https://go.paytraq.com/api/employeeGroupDefaultId

Response

XML / HTTP
<EmployeeGroup>
   <GroupID></GroupID>
</EmployeeGroup>
Tag Description
<GroupID> Unique system identifier for employee group.
If no default group is found then <GroupID>0</GroupID> will be returned

Back to Employees

Items

GETGet Product List

Request

XML / HTTP
GET https://go.paytraq.com/api/products

Result list is sorted by product name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by product name, SKU or barcode.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Additional optional parameters are available for this request:
GET /api/products? ... &WarehouseID=0 ... &PriceGroupID=0 ... &suppliers=true ... &tag=tag_value
WarehouseID - Unique system identifier for warehouse. See Get Warehouse
PriceGroupID - Unique system identifier for price group. See Get Price Group
suppliers=true - Include information about suppliers
tag - Filter by tag value

Response

XML / HTTP
<Products>
   <Product>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
      <Unit>
         <UnitID></UnitID>
         <UnitName></UnitName>
      </Unit>
      <Description />
      <HasImage />
      <MappingValue />
      <OtherLanguageName />
      <Status></Status>
      <Type></Type>
      <BarCode />
      <Weight></Weight>
      <OrderLeadTime></OrderLeadTime>
      <Cost />
      <StandardCost />
      <Group>
         <GroupID />
         <GroupName />
      </Group>
      <HasLots></HasLots>
      <CountryOrigin></CountryOrigin>
      <CommodityCode></CommodityCode>
      <TaxKeys>
         <SalesTaxKeyID></SalesTaxKeyID>
         <SalesTaxKeyName></SalesTaxKeyName>
         <PurchasesTaxKeyID />
         <PurchasesTaxKeyName />
      </TaxKeys>
      <Inventory>
         <Qty></Qty>
         <InterimAvailable></InterimAvailable>
      </Inventory>
      <Price>
         <GrossAmount></GrossAmount>
         <TaxRate></TaxRate>
         <Currency></Currency>
         <Discount></Discount>
      </Price>
      <Suppliers>
         <Supplier>
            <SupplierName />
            <SupplierProductCode />
            <SupplierProductName />
            <PurchasePrice />
            <PurchasePriceCurrency />
            <PurchasePriceIncludeTax />
            <IsDefault />
         </Supplier>
      </Suppliers>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Product>
   ...
</Products>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<UnitID> Unique system identifier for unit of measure. See Get Unit
<Status> Possible values:
  • 1 - Active
  • 2 - Discontinued
<Type> Possible values:
  • 1 - Stockable
  • 2 - Consumable
  • 3 - Fixed asset
<GroupID> Unique system identifier for product group. See Get Product Groups
<HasLots> Boolean value (false | true)
<CountryOrigin> 2-letter ISO country code
<SalesTaxKeyID> Unique system identifier for tax key on sales. See Get Tax Key
<PurchasesTaxKeyID> Unique system identifier for tax key on purchases. See Get Tax Key
<Qty> Quantity available. If the param WarehouseID is passed in the request then quantity is returned for the given warehouse otherwise total available on all warehouses is returned. See Get Warehouse
<InterimAvailable> Interim available. Does not include quantity in sales orders
<GrossAmount> Gross price (tax incl.). If the param PriceGroupID is passed in the request then price is returned for the given price group otherwise the default price group is taken into account. See Get Price Group
<TaxRate> Tax rate
<Discount> Promo discount in %
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Items

GETGet Product

Request

XML / HTTP
GET https://go.paytraq.com/api/product/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Response

XML / HTTP
<Product>
   <ItemID></ItemID>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
      <UnitName></UnitName>
   </Unit>
   <Description />
   <HasImage />
   <MappingValue />
   <OtherLanguageName />
   <Status></Status>
   <Type></Type>
   <BarCode />
   <Weight></Weight>
   <OrderLeadTime></OrderLeadTime>
   <Cost />
   <StandardCost />
   <Group>
      <GroupID />
      <GroupName />
   </Group>
   <HasLots></HasLots>
   <CountryOrigin></CountryOrigin>
   <CommodityCode></CommodityCode>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
      <SalesTaxKeyName></SalesTaxKeyName>
      <PurchasesTaxKeyID />
      <PurchasesTaxKeyName />
   </TaxKeys>
   <Prices>
      <Price>
         <PriceGroup>
            <PriceGroupID></PriceGroupID>
            <PriceGroupName></PriceGroupName>
            <IncludeTax></IncludeTax>
         </PriceGroup>
         <IsDefault></IsDefault>
         <Amount></Amount>
         <Currency></Currency>
      </Price>
      ...
   </Prices>
   <Accounts>
      <COGAccountID />
      <IncomeAccountID />
      <FixedAssetAccountID />
   </Accounts>
   <Suppliers>
      <Supplier>
         <SupplierName />
         <SupplierProductCode />
         <SupplierProductName />
         <PurchasePrice />
         <PurchasePriceCurrency />
         <PurchasePriceIncludeTax />
         <IsDefault />
      </Supplier>
   </Suppliers>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
   <Tags>
      <Tag />
   </Tags>
</Product>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<UnitID> Unique system identifier for unit of measure. See Get Unit
<Status> Possible values:
  • 1 - Active
  • 2 - Discontinued
<Type> Possible values:
  • 1 - Stockable
  • 2 - Consumable
  • 3 - Fixed asset
<GroupID> Unique system identifier for product group. See Get Product Groups
<HasLots> Boolean value (false | true)
<CountryOrigin> 2-letter ISO country code
<SalesTaxKeyID> Unique system identifier for tax key on sales. See Get Tax Key
<PurchasesTaxKeyID> Unique system identifier for tax key on purchases. See Get Tax Key
<PriceGroupID> Unique system identifier for price group. See Get Price Group
<IsDefault> Boolean value (false | true)
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<COGAccountID> Unique system identifier for cost of goods account. See Get Account
<IncomeAccountID> Unique system identifier for income account. See Get Account
<FixedAssetAccountID> Unique system identifier for fixed asset account. See Get Account
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Items

GETGet Product By Code (SKU)

Request

XML / HTTP
GET https://go.paytraq.com/api/productByCode/{Code}
Parameter Description
Code Product code (SKU)

Response

Please refer to Get Product request

Back to Items

GETGet Product Image

Request

XML / HTTP
GET https://go.paytraq.com/api/productImage/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Response

XML / HTTP
Image (JPEG/PNG)

Back to Items

GETGet Product Price List

Request

XML / HTTP
GET https://go.paytraq.com/api/productPriceList/{PriceGroupID}

Result list is sorted by product name in ascending order.
Optional parameters are available. Results can be filtered by product name, SKU or barcode.

Parameter Description
PriceGroupID Unique system identifier for price group. See Get Price Group.
If 0 then the default price group will be applied.
TaxRate An explicit tax rate can be optionally applied to the request:
GET /api/productPriceList/{PriceGroupID}/{TaxRate}?...
Tax rate to be applied.
If 0 then no tax will be applied.
If {TaxRate} is not provided then the default tax rate of each product will be applied.

Response

XML / HTTP
<Products>
   <Product>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
      <Price>
         <PriceExclTax></PriceExclTax>
         <PriceIncTax></PriceIncTax>
         <Tax></Tax>
         <TaxRate></TaxRate>
         <Currency></Currency>
      </Price>
   </Product>
   ...
</Products>
Tag Description
<ItemID> Unique system identifier for product. See Get Product request.
<Code> Product code (SKU)
<PriceExclTax> Price excluding tax
<PriceIncTax> Price including tax
<Tax> Tax value

Back to Items

POSTAdd Product

Request

XML / HTTP
POST https://go.paytraq.com/api/product

Payload

XML / HTTP
<Product>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
   </Unit>
   <Description />
   <MappingValue />
   <OtherLanguageName />
   <Status></Status>
   <Type></Type>
   <BarCode />
   <Weight></Weight>
   <OrderLeadTime></OrderLeadTime>
   <StandardCost />
   <Group>
      <GroupID />
   </Group>
   <HasLots></HasLots>
   <CountryOrigin></CountryOrigin>
   <CommodityCode></CommodityCode>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
      <PurchasesTaxKeyID />
   </TaxKeys>
</Product>

Only <Name> is required.
For tags description please refer to Get Product request.

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for product

Back to Items

POSTUpdate Product

Request

XML / HTTP
POST https://go.paytraq.com/api/product/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Payload

XML / HTTP
<Product>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
   </Unit>
   <Description />
   <MappingValue />
   <OtherLanguageName />
   <Status></Status>
   <Type></Type>
   <BarCode />
   <Weight></Weight>
   <OrderLeadTime></OrderLeadTime>
   <StandardCost />
   <Group>
      <GroupID />
   </Group>
   <HasLots></HasLots>
   <CountryOrigin></CountryOrigin>
   <CommodityCode></CommodityCode>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
      <PurchasesTaxKeyID />
   </TaxKeys>
</Product>

No tags are required.
For tags description please refer to Get Product request.

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for product

Back to Items

POSTAdd/Update Product Image

Request

XML / HTTP
POST https://go.paytraq.com/api/productImage/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Payload

XML / HTTP
<ProductImage>
      <FileName></FileName>
      <ContentType></ContentType>
      <Content></Content>
</ProductImage>
Tag Description
<FileName> Name of the file
<ContentType> Possible values:
  • image/jpeg
  • image/png
<Content> Base64 encoded file content

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for product

Back to Items

POSTAdd/Update Product Price

Request

XML / HTTP
POST https://go.paytraq.com/api/productPrice/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Payload

XML / HTTP
<Price>
      <PriceGroup>
            <PriceGroupID></PriceGroupID>
      </PriceGroup>
      <IsDefault></IsDefault>
      <Amount></Amount>
      <Currency></Currency>
</Price>

For tags description please refer to Get Product request

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for product

Back to Items

GETGet Product Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/productGroups

Response

XML / HTTP
<Groups>
   <Group>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </Group>
   ...
</Groups>
Tag Description
<GroupID> Unique system identifier for product group

Back to Items

GETGet Default Product Group

Request

XML / HTTP
GET https://go.paytraq.com/api/productGroupDefaultId

Response

XML / HTTP
<Group>
   <GroupID></GroupID>
</Group>
Tag Description
<GroupID> Unique system identifier for product group.
If no default group is found then <GroupID>0</GroupID> will be returned

Back to Items

GETGet Lot List

Request

XML / HTTP
GET https://go.paytraq.com/api/lots

Result list is sorted by lot number in ascending order.
Optional parameters are available. Results can be filtered by product name, SKU or lot number.

Additional optional parameters are available for this request:
GET /api/products? ... &WarehouseID=0
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Response

XML / HTTP
<Lots>
  <Lot>
    <Product>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
    </Product>
    <LotID></LotID>
    <LotNumber></LotNumber>
    <ExpiryDate></ExpiryDate>
    <Description></Description>
    <IsInactive></IsInactive>
    <Inventory>
      <Qty></Qty>
      <InterimAvailable></InterimAvailable>
    </Inventory>
  </Lot>
</Lots>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<LotID> Unique system identifier for lot. See Get Lot
<IsInactive> Boolean value (false | true)

Back to Items

GETGet Lot List By Product

Request

XML / HTTP
GET https://go.paytraq.com/api/product/lots/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Result list is sorted by lot number in ascending order.
Optional parameters are available. Results can be filtered by lot number.

Additional optional parameters are available for this request:
GET /api/products? ... &WarehouseID=0
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Response

XML / HTTP
<Lots>
  <Lot>
    <Product>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
    </Product>
    <LotID></LotID>
    <LotNumber></LotNumber>
    <ExpiryDate></ExpiryDate>
    <Description></Description>
    <IsInactive></IsInactive>
    <Inventory>
      <Qty></Qty>
      <InterimAvailable></InterimAvailable>
    </Inventory>
  </Lot>
</Lots>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<LotID> Unique system identifier for lot. See Get Lot
<IsInactive> Boolean value (false | true)

Back to Items

GETGet Lot

Request

XML / HTTP
GET https://go.paytraq.com/api/lot/{LotID}
Parameter Description
LotID Unique system identifier for lot

Response

XML / HTTP
<Lot>
  <Product>
    <ItemID></ItemID>
    <Name></Name>
    <Code></Code>
  </Product>
  <LotID></LotID>
  <LotNumber></LotNumber>
  <ExpiryDate></ExpiryDate>
  <Description></Description>
  <IsInactive></IsInactive>
</Lot>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<LotID> Unique system identifier for lot. See Get Lot
<IsInactive> Boolean value (false | true)

Back to Items

GETGet Lot By Number

Request

XML / HTTP
GET https://go.paytraq.com/api/lotByNumber/{ItemID}/{LotNumber}
Parameter Description
ItemID Unique system identifier for product
LotNumber Lot number

Response

XML / HTTP
<Lot>
  <Product>
    <ItemID></ItemID>
    <Name></Name>
    <Code></Code>
  </Product>
  <LotID></LotID>
  <LotNumber></LotNumber>
  <ExpiryDate></ExpiryDate>
  <Description></Description>
  <IsInactive></IsInactive>
</Lot>
Tag Description
<ItemID> Unique system identifier for product
<Code> Product code (SKU)
<LotID> Unique system identifier for lot. See Get Lot
<IsInactive> Boolean value (false | true)

Back to Items

POSTAdd Lot

Request

XML / HTTP
POST https://go.paytraq.com/api/product/lot/{ItemID}
Parameter Description
ItemID Unique system identifier for product

Payload

XML / HTTP
<Lot>
  <LotNumber></LotNumber>
  <ExpiryDate></ExpiryDate>
</Lot>

Only <LotNumber> is required.
For tags description please refer to Get Lot request.

Response

XML / HTTP
<Response>
  <LotID></LotID>
</Response>
Tag Description
<LotID> Unique system identifier for lot

Back to Items

POSTUpdate Lot

Request

XML / HTTP
POST https://go.paytraq.com/api/lot/{LotID}
Parameter Description
LotID Unique system identifier for lot

Payload

XML / HTTP
<Lot>
  <LotNumber></LotNumber>
  <ExpiryDate></ExpiryDate>
  <Description></Description>
  <IsInactive></IsInactive>
</Lot>

No tags are required.
For tags description please refer to Get Lot request.

Response

XML / HTTP
<Response>
   <LotID></LotID>
</Response>
Tag Description
<LotID> Unique system identifier for lot

Back to Items

GETGet Service List

Request

XML / HTTP
GET https://go.paytraq.com/api/services

Result list is sorted by service name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by service name or code.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Additional optional parameters are available for this request:
tag - Filter by tag value

Response

XML / HTTP
<Services>
   <Service>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
      <Unit>
         <UnitID></UnitID>
         <UnitName></UnitName>
      </Unit>
      <Description />
      <OtherLanguageName />
      <Status></Status>
      <Group>
         <GroupID />
         <GroupName />
      </Group>
      <TaxKeys>
         <SalesTaxKeyID></SalesTaxKeyID>
         <SalesTaxKeyName></SalesTaxKeyName>
      </TaxKeys>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Service>
   ...
</Services>
Tag Description
<ItemID> Unique system identifier for service
<Code> Service code
<UnitID> Unique system identifier for unit of measure. See Get Unit
<Status> Possible values:
  • 1 - Active
  • 2 - Discontinued
<GroupID> Unique system identifier for service group. See Get Service Groups
<SalesTaxKeyID> Unique system identifier for tax key on sales. See Get Tax Key
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Items

GETGet Service

Request

XML / HTTP
GET https://go.paytraq.com/api/service/{ItemID}
Parameter Description
ItemID Unique system identifier for service

Response

XML / HTTP
<Service>
   <ItemID></ItemID>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
      <UnitName></UnitName>
   </Unit>
   <Description />
   <OtherLanguageName />
   <Status></Status>
   <Group>
      <GroupID />
      <GroupName />
   </Group>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
      <SalesTaxKeyName></SalesTaxKeyName>
   </TaxKeys>
   <Prices>
      <Price>
         <PriceGroup>
            <PriceGroupID></PriceGroupID>
            <PriceGroupName></PriceGroupName>
            <IncludeTax></IncludeTax>
         </PriceGroup>
         <IsDefault></IsDefault>
         <Amount></Amount>
         <Currency></Currency>
      </Price>
      ...
   </Prices>
   <Accounts>
      <IncomeAccountID />
   </Accounts>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
   <Tags>
      <Tag />
   </Tags>
</Service>
Tag Description
<ItemID> Unique system identifier for service
<Code> Service code
<UnitID> Unique system identifier for unit of measure
<Status> Possible values:
  • 1 - Active
  • 2 - Discontinued
<GroupID> Unique system identifier for service group. See Get Service Groups
<SalesTaxKeyID> Unique system identifier for tax key on sales. See Get Tax Key
<PriceGroupID> Unique system identifier for price group. See Get Price Group
<IsDefault> Boolean value (false | true)
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<IncomeAccountID> Unique system identifier for income account. See Get Account
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Items

GETGet Service By Code

Request

XML / HTTP
GET https://go.paytraq.com/api/serviceByCode/{Code}
Parameter Description
Code Service code

Response

Please refer to Get Service request

Back to Items

GETGet Service Price List

Request

XML / HTTP
GET https://go.paytraq.com/api/servicePriceList/{PriceGroupID}

Result list is sorted by service name in ascending order.
Optional parameters are available. Results can be filtered by service name or code.

Parameter Description
PriceGroupID Unique system identifier for price group. See Get Price Group.
If 0 then the default price group will be applied.
TaxRate An explicit tax rate can be optionally applied to the request:
GET /api/servicePriceList/{PriceGroupID}/{TaxRate}?...
Tax rate to be applied.
If 0 then no tax will be applied.
If {TaxRate} is not provided then the default tax rate of each service will be applied.

Response

XML / HTTP
<Services>
   <Service>
      <ItemID></ItemID>
      <Name></Name>
      <Code></Code>
      <Price>
         <PriceExclTax></PriceExclTax>
         <PriceIncTax></PriceIncTax>
         <Tax></Tax>
         <TaxRate></TaxRate>
         <Currency></Currency>
      </Price>
   </Service>
   ...
</Services>
Tag Description
<ItemID> Unique system identifier for service. See Get Service request.
<Code> Service code
<PriceExclTax> Price excluding tax
<PriceIncTax> Price including tax
<Tax> Tax value

Back to Items

POSTAdd Service

Request

XML / HTTP
POST https://go.paytraq.com/api/service

Payload

XML / HTTP
<Service>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
   </Unit>
   <Description />
   <OtherLanguageName />
   <Status></Status>
   <Group>
      <GroupID />
   </Group>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
   </TaxKeys>
</Service>

Only <Name> is required.
For tags description please refer to Get Service request.

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for service

Back to Items

POSTUpdate Service

Request

XML / HTTP
POST https://go.paytraq.com/api/service/{ItemID}
Parameter Description
ItemID Unique system identifier for service

Payload

XML / HTTP
<Service>
   <Name></Name>
   <Code></Code>
   <Unit>
      <UnitID></UnitID>
   </Unit>
   <Description />
   <OtherLanguageName />
   <Status></Status>
   <Group>
      <GroupID />
   </Group>
   <TaxKeys>
      <SalesTaxKeyID></SalesTaxKeyID>
   </TaxKeys>
</Service>

No tags are required.
For tags description please refer to Get Service request.

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for service

Back to Items

POSTAdd/Update Service Price

Request

XML / HTTP
POST https://go.paytraq.com/api/servicePrice/{ItemID}
Parameter Description
ItemID Unique system identifier for service

Payload

XML / HTTP
<Price>
      <PriceGroup>
            <PriceGroupID></PriceGroupID>
      </PriceGroup>
      <IsDefault></IsDefault>
      <Amount></Amount>
      <Currency></Currency>
</Price>

For tags description please refer to Get Service request

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
</Response>
Tag Description
<ItemID> Unique system identifier for service

Back to Items

GETGet Service Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/serviceGroups

Response

XML / HTTP
<Groups>
   <Group>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </Group>
   ...
</Groups>
Tag Description
<GroupID> Unique system identifier for service group

Back to Items

GETGet Default Service Group

Request

XML / HTTP
GET https://go.paytraq.com/api/serviceGroupDefaultId

Response

XML / HTTP
<Group>
   <GroupID></GroupID>
</Group>
Tag Description
<GroupID> Unique system identifier for service group.
If no default group is found then <GroupID>0</GroupID> will be returned

Back to Items

Warehousing

GETGet Warehouse List

Request

XML / HTTP
GET https://go.paytraq.com/api/warehouses

Result list is sorted by warehouse name in ascending order.
Optional parameters are available. Results can be filtered by warehouse name or code.

Response

XML / HTTP
<Warehouses>
   <Warehouse>
      <WarehouseID></WarehouseID>
      <Code />
      <Name></Name>
      <Type></Type>
      <LoadingArea>
         <LoadingAreaID />
         <LoadingAreaName />
      </LoadingArea>
      <PriceMarkup></PriceMarkup>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
      <NegativeStockEnabled></NegativeStockEnabled>
      <Account>
         <AccountID />
         <AccountName />
      </Account>
   </Warehouse>
   ...
</Warehouses>
Tag Description
<WarehouseID> Unique system identifier for warehouse
<Type> Possible values:
  • 1 - Retail
  • 2 - Wholesale
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)
<NegativeStockEnabled> Boolean value (false | true)
<AccountID> Unique system identifier for inventory account. See Get Account

Back to Warehousing

GETGet Warehouse

Request

XML / HTTP
GET https://go.paytraq.com/api/warehouse/{WarehouseID}
Parameter Description
WarehouseID Unique system identifier for warehouse

Response

XML / HTTP
<Warehouse>
   <WarehouseID></WarehouseID>
   <Code />
   <Name></Name>
   <Type></Type>
   <LoadingArea>
      <LoadingAreaID />
      <LoadingAreaName />
   </LoadingArea>
   <PriceMarkup></PriceMarkup>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
   <NegativeStockEnabled></NegativeStockEnabled>
   <Account>
      <AccountID />
      <AccountName />
   </Account>
</Warehouse>
Tag Description
<WarehouseID> Unique system identifier for warehouse
<Type> Possible values:
  • 1 - Retail
  • 2 - Wholesale
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)
<NegativeStockEnabled> Boolean value (false | true)
<AccountID> Unique system identifier for inventory account. See Get Account

Back to Warehousing

GETGet Loading Area List

Request

XML / HTTP
GET https://go.paytraq.com/api/loadingAreas

Response

XML / HTTP
<LoadingAreas>
   <LoadingArea>
      <LoadingAreaID></LoadingAreaID>
      <LoadingAreaName></LoadingAreaName>
      <LoadingAreaAddress>
         <Address></Address>
         <Zip></Zip>
         <Country></Country>
      </LoadingAreaAddress>
      <IsDefault>false</IsDefault>
      <IsInactive>false</IsInactive>
   </LoadingArea>
</LoadingAreas>
Tag Description
<LoadingAreaID> Unique system identifier for loading area
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Warehousing

GETGet Loading Area

Request

XML / HTTP
GET https://go.paytraq.com/api/loadingArea/{LoadingAreaID}
Parameter Description
LoadingAreaID Unique system identifier for loading area

Response

XML / HTTP
<LoadingArea>
   <LoadingAreaID></LoadingAreaID>
   <LoadingAreaName></LoadingAreaName>
   <LoadingAreaAddress>
      <Address></Address>
      <Zip></Zip>
      <Country></Country>
   </LoadingAreaAddress>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</LoadingArea>
Tag Description
<LoadingAreaID> Unique system identifier for loading area
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Warehousing

GETGet Default Loading Area

Request

XML / HTTP
GET https://go.paytraq.com/api/loadingAreaDefaultId

Response

XML / HTTP
<LoadingArea>
   <LoadingAreaID></LoadingAreaID>
</LoadingArea>
Tag Description
<LoadingAreaID> Unique system identifier for loading area.
If no default value is found then <LoadingAreaID>0</LoadingAreaID> will be returned

Back to Warehousing

GETGet Shipper List

Request

XML / HTTP
GET https://go.paytraq.com/api/shippers

Response

XML / HTTP
<Shippers>
   <Shipper>
      <ShipperID></ShipperID>
      <ShipperName></ShipperName>
      <ShipperRegNumber></ShipperRegNumber>
      <ShipperVehicle></ShipperVehicle>
      <ShipperDriver></ShipperDriver>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </Shipper>
  ...
</Shippers>
Tag Description
<ShipperID> Unique system identifier for shipper
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Warehousing

GETGet Shipper

Request

XML / HTTP
GET https://go.paytraq.com/api/shipper/{ShipperID}
Parameter Description
ShipperID Unique system identifier for shipper

Response

XML / HTTP
<Shipper>
   <ShipperID></ShipperID>
   <ShipperName></ShipperName>
   <ShipperRegNumber></ShipperRegNumber>
   <ShipperVehicle></ShipperVehicle>
   <ShipperDriver></ShipperDriver>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</Shipper>
Tag Description
<ShipperID> Unique system identifier for shipper
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Warehousing

POSTAdd Shipper

Request

XML / HTTP
POST https://go.paytraq.com/api/shipper
Parameter Description
ShipperID Unique system identifier for shipper

Payload

XML / HTTP
<Shipper>
   <ShipperName></ShipperName>
   <ShipperRegNumber></ShipperRegNumber>
   <ShipperVehicle></ShipperVehicle>
   <ShipperDriver></ShipperDriver>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</Shipper>

Only <ShipperName> is required.
For tags description please refer to Get Shipper request.

Response

XML / HTTP
<Response>
   <ShipperID></ShipperID>
</Response>
Tag Description
<ShipperID> Unique system identifier for shipper

Back to Warehousing

POSTUpdate Shipper

Request

XML / HTTP
POST https://go.paytraq.com/api/shipper/{ShipperID}
Parameter Description
ShipperID Unique system identifier for shipper

Payload

XML / HTTP
<Shipper>
   <ShipperName></ShipperName>
   <ShipperRegNumber></ShipperRegNumber>
   <ShipperVehicle></ShipperVehicle>
   <ShipperDriver></ShipperDriver>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</Shipper>

No tags are required.
For tags description please refer to Get Shipper request.

Response

XML / HTTP
<Response>
   <ShipperID></ShipperID>
</Response>
Tag Description
<ShipperID> Unique system identifier for shipper

Back to Warehousing

GETGet Current Inventory

Request

XML / HTTP
GET https://go.paytraq.com/api/currentInventory/{WarehouseID}

Result list is sorted by product name, code, lot, warehouse name in ascending order.
Pagination optional parameter is available. Results can not be filtered.

Parameter Description
WarehouseID Unique system identifier for warehouse

Response

XML / HTTP
<Inventory>
   <LineItem>
      <ItemID></ItemID>
      <ItemCode></ItemCode>
      <ItemName></ItemName>
      <ItemBarCode />
      <ItemDescription />
      <LotID />
      <LotNumber />
      <WarehouseID></WarehouseID>
      <WarehouseName></WarehouseName>
      <Qty></Qty>
      <InPO></InPO>
      <Waiting></Waiting>
      <InTransit></InTransit>
      <InSO></InSO>
      <InterimAvailable></InterimAvailable>
      <UnitCost />
   </LineItem>
   ...
</Inventory>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<ItemCode> Product code (SKU)
<LotID> Unique system identifier for lot
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<Qty> Product quantity
<InPO> Quantity in purchase orders
<Waiting> Quantity in unapproved shipments
<InTransit> Quantity in transit
<InSO> Quantity in sales orders
<InterimAvailable> Interim available. Does not include quantity in sales orders

Back to Warehousing

GETGet Product Inventory

Request

XML / HTTP
GET https://go.paytraq.com/api/productInventory/{ItemID}

Result list is sorted by product name, code, lot, warehouse name in ascending order.
Pagination optional parameter is available. Results can not be filtered.

Parameter Description
ItemID Unique system identifier for product

Response

XML / HTTP
<Inventory>
   <LineItem>
      <ItemID></ItemID>
      <ItemCode></ItemCode>
      <ItemName></ItemName>
      <ItemBarCode />
      <ItemDescription />
      <LotID />
      <LotNumber />
      <WarehouseID></WarehouseID>
      <WarehouseName></WarehouseName>
      <Qty></Qty>
      <InPO></InPO>
      <Waiting></Waiting>
      <InTransit></InTransit>
      <InSO></InSO>
      <InterimAvailable></InterimAvailable>
      <UnitCost />
   </LineItem>
   ...
</Inventory>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<ItemCode> Product code (SKU)
<LotID> Unique system identifier for lot
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<Qty> Product quantity
<InPO> Quantity in purchase orders
<Waiting> Quantity in unapproved shipments
<InTransit> Quantity in transit
<InSO> Quantity in sales orders
<InterimAvailable> Interim available. Does not include quantity in sales orders

Back to Warehousing

GETGet Stock Movements

Request

XML / HTTP
GET https://go.paytraq.com/api/stockMovements

Result list is sorted by product name, code, warehouse name in ascending order.
Pagination and Date Range filter can be applied.
GET /api/stockMovements? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Additional optional parameter are available for this request:
GET /api/stockMovements/? ... &ItemID=0&WarehouseID=0
ItemID - Unique system identifier for product. See Get Product
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Response

XML / HTTP
<StockMovements>
      <LineItem>
        <ItemID></ItemID>
        <ItemCode></ItemCode>
        <ItemName></ItemName>
        <ItemBarCode></ItemBarCode>
        <ItemDescription></ItemDescription>
        <WarehouseID></WarehouseID>
        <WarehouseName></WarehouseName>
        <OpeningQty></OpeningQty>
        <In></In>
        <Out></Out>
        <ClosingQty></ClosingQty>
        <Difference></Difference>
        <UnitCost></UnitCost>
        <PurchasePrice></PurchasePrice>
      </LineItem>
      ...
   </StockMovements>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<ItemCode> Product code (SKU)
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<OpeningQty> Product quantity at the beginning of period
<In> Incoming quantity
<Out> Outgoing quantity
<ClosingQty> Product quantity at the end of period
<Difference> Change in quantity

Back to Warehousing

GETGet Product Movements

Request

XML / HTTP
GET https://go.paytraq.com/api/productMovements/{ItemID}

Result list is sorted by document date in ascending order.
Pagination and Date Range filter can be applied.
GET /api/productMovements/{ItemID}? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Additional optional parameter are available for this request:
GET /api/productMovements/{ItemID}/? ... &LotID=0&WarehouseID=0
LotID - Unique system identifier for lot. See Get Lot
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Parameter Description
ItemID Unique system identifier for product

Response

XML / HTTP
<ProductMovements>
    <InventoryMovement>
        <Header>
            <Document>
                <DocumentID></DocumentID>
                <DocumentDate></DocumentDate>
                <DocumentRef></DocumentRef>
                <DocumentType></DocumentType>
                <DocumentStatus></DocumentStatus>
                <BusinessPartner>
                    <BusinessPartnerID></BusinessPartnerID>
                    <BusinessPartnerName></BusinessPartnerName>
                </BusinessPartner>
            </Document>
            <MovementType></MovementType>
            <Operation></Operation>
            <Direction></Direction>
            <Sender></Sender>
            <Receiver>
                <WarehouseID></WarehouseID>
                <WarehouseName></WarehouseName>
            </Receiver>
            <Warehouse>
                <WarehouseID></WarehouseID>
                <WarehouseName></WarehouseName>
            </Warehouse>
            <TimeStamps>
                <Created></Created>
                <Updated></Updated>
            </TimeStamps>
        </Header>
        <MovementLine>
            <Item>
                <ItemID></ItemID>
                <ItemCode></ItemCode>
                <ItemName></ItemName>
            </Item>
            <ItemLot>
                <LotID></LotID>
                <LotNumber></LotNumber>
            </ItemLot>
            <Qty></Qty>
        </MovementLine>
    </InventoryMovement>
    ...
  </ProductMovements>
Tag Description
For <InventoryMovement tags description please refer to Get Inventory Movement

Back to Warehousing

Sales

GETGet Sales Document List

Request

XML / HTTP
GET https://go.paytraq.com/api/sales

By default result list is sorted by document date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by client name or document number.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Document date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:
GET /api/sales? ... &ClientID=0 ... &dueOnly=true ... &tag=tag_value
ClientID - Unique system identifier for client. See Get Client
dueOnly - Boolean, if true then only documents with "Waiting for Payment" and "Partially Paid" status are returned
tag - Filter by tag value

Response

XML / HTTP
<Sales>
   <Sale>
      <Header>
         <Document>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Client>
               <ClientID></ClientID>
               <ClientName></ClientName>
            </Client>
         </Document>
         <SaleType></SaleType>
         <Operation></Operation>
         <Total></Total>
         <AmountDue></AmountDue>
         <DueNoticeEnabled></DueNoticeEnabled>
         <Currency></Currency>
         <BalanceCurrency></BalanceCurrency>
         <CurrencyRate></CurrencyRate>
         <TaxBasis></TaxBasis>
         <IncludeTax></IncludeTax>
         <UseOverpayment></UseOverpayment>
         <DateDue></DateDue>
         <DateApproved></DateApproved>
         <IssuedBy></IssuedBy>
         <Discount></Discount>
         <Deposit></Deposit>
         <Comment></Comment>
         <Signature></Signature>
         <InvoicePeriod>
            <PeriodType></PeriodType>
            <PeriodStart />
            <PeriodEnd />
         </InvoicePeriod>
         <PayTerm>
            <PayTermType></PayTermType>
            <PayTermDays />
         </PayTerm>
         <PaymentMethod></PaymentMethod>
         <AccountID></AccountID>
         <ShippingData>
            <ShippingType></ShippingType>
            <Warehouse>
               <WarehouseID></WarehouseID>
               <WarehouseName></WarehouseName>
            </Warehouse>
            <LoadingArea>
               <LoadingAreaID></LoadingAreaID>
               <LoadingAreaName></LoadingAreaName>
               <LoadingAreaAddress>
                  <Address></Address>
                  <Zip></Zip>
                  <Country></Country>
               </LoadingAreaAddress>
            </LoadingArea>
            <Shipper>
               <ShipperID></ShipperID>
               <ShipperName></ShipperName>
               <ShipperRegNumber></ShipperRegNumber>
               <ShipperVehicle></ShipperVehicle>
               <ShipperDriver></ShipperDriver>
            </Shipper>
            <ShippingAddress>
               <AddressID></AddressID>
               <ShipTo></ShipTo>
               <Address></Address>
               <Zip></Zip>
               <Country></Country>
            </ShippingAddress>
         </ShippingData>
         <Project>
            <ProjectName />
         </Project>
         <TimeStamps>
            <Created />
            <Updated />
         </TimeStamps>
      </Header>
   </Sale>
  ...
</Sales>
Tag Description
<DocumentID> Unique system identifier for sales document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<ClientID> Unique system identifier for client. See Get Client
<SaleType> Possible values:
  • sales_order - Sales Order
  • sales_proforma - Proforma Invoice
  • sales_invoice - Invoice
  • sales_receipt - Receipt
  • sales_estimate - Quote/Estimate
  • credit_note - Credit Note/Refund
<Operation> Possible values:
  • sell_goods - Selling Goods
  • sell_services - Selling Services
  • other_income - Other Income
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<DueNoticeEnabled> Boolean value (false | true)
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<UseOverpayment> Boolean value (false | true)
<Signature> Possible values:
  • 0 - None
  • 1 - Electronic
  • 2 - To be signed by sender
  • 3 - To be signed by recipient
  • 4 - To be signed by both sender and recipient
  • 5 - Scanned signature
<PeriodType> Possible values:
  • 0 - Not Defined
  • 1 - Current Month
  • 2 - Previous Month
  • 3 - Next Month
  • 9 - Other
<PayTermType> Possible values:
  • 0 - Other date
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<PaymentMethod> Possible values:
  • 0 - Not Defined
  • 1 - Bank
  • 2 - Cash
  • 3 - Card
  • 4 - Prepayment
  • 5 - Offsetting
  • 6 - Factoring
<AccountID> Unique system identifier for accounts receivable. See Get Account
<ShippingType> Possible values:
  • 0 - Not Defined
  • 1 - Supply of goods
  • 2 - Movement of goods
  • 3 - Product returns
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<ShipperID> Unique system identifier for shipper. See Get Shipper
<AddressID> Unique system identifier for shipping address. See Get Client Shipping Address
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Sales

GETGet Sales Document

Request

XML / HTTP
GET https://go.paytraq.com/api/sale/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Response

XML / HTTP
<Sale>
   <Header>
      <Document>
         <DocumentID></DocumentID>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <DocumentStatus></DocumentStatus>
         <Client>
            <ClientID></ClientID>
            <ClientName></ClientName>
         </Client>
      </Document>
      <SaleType></SaleType>
      <Operation></Operation>
      <Total></Total>
      <AmountDue></AmountDue>
      <DueNoticeEnabled></DueNoticeEnabled>
      <Currency></Currency>
      <BalanceCurrency></BalanceCurrency>
      <CurrencyRate></CurrencyRate>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <UseOverpayment></UseOverpayment>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <IssuedBy></IssuedBy>
      <Discount></Discount>
      <Deposit />
      <Comment />
      <Signature></Signature>
      <InvoicePeriod>
         <PeriodType></PeriodType>
         <PeriodStart />
         <PeriodEnd />
      </InvoicePeriod>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <AccountID></AccountID>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
            <WarehouseName></WarehouseName>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
            <LoadingAreaName></LoadingAreaName>
            <LoadingAreaAddress>
               <Address></Address>
               <Zip></Zip>
               <Country></Country>
            </LoadingAreaAddress>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
            <ShipperName></ShipperName>
            <ShipperRegNumber />
            <ShipperVehicle />
            <ShipperDriver />
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
            <ShipTo></ShipTo>
            <Address></Address>
            <Zip></Zip>
            <Country></Country>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <LineItems>
      <LineItem>
         <LineItemID></LineItemID>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <Description></Description>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
         <AccountCode></AccountCode>
         <AccountName></AccountName>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
         <TaxKeyName></TaxKeyName>
      </TaxKey>
   </ShippingCharge>
   <Taxes>
      <Tax>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <TaxName></TaxName>
         <GrossAmount></GrossAmount>
         <NetAmount></NetAmount>
         <TaxAmount></TaxAmount>
         <Account>
            <AccountID></AccountID>
            <AccountName></AccountName>
         </Account>
      </Tax>
   </Taxes>
   <Totals>
      <GrossAmount></GrossAmount>
      <NetAmount></NetAmount>
      <Qty></Qty>
   </Totals>
   <InvoiceReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </InvoiceReference>
   <OrderReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </OrderReference>
   <ProformaReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </ProformaReference>
   <MovementReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </MovementReference>
   <Payments>
      <Payment>
         <PaymentDate></PaymentDate>
         <PaymentType></PaymentType>
         <PaymentAmount></PaymentAmount>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <DocumentLink>
            <DocumentID></DocumentID>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
         </DocumentLink>
      </Payment>
      ...
   </Payments>
   <Journals>
      <Journal>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <JournalDate></JournalDate>
         <JournalStatus></JournalStatus>
         <JournalType>
            <JournalTypeID></JournalTypeID>
            <JournalTypeName></JournalTypeName>
         </JournalType>
      </Journal>
      ...
   </Journals>
   <Tags>
      <Tag />
   </Tags>
   <MessageLog>
      <Message>
         <Created></Created>
         <DeliveredBy></DeliveredBy>
         <From></From>
         <To></To>
         <SenderName>></SenderName>
         <RecipientName></RecipientName>
         <Kind></Kind>
         <Subject></Subject>
         <EventType></EventType>
         <EventStatus></EventStatus>
         <BounceReason></BounceReason>
      </Message>
      ...
   </MessageLog>
   <Notes>
      <Note>
         <Created></Created>
         <Text></Text>
      </Note>
      ...
   </Notes>
</Sale>
Tag Description
<DocumentID> Unique system identifier for sales document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<ClientID> Unique system identifier for client. See Get Client
<SaleType> Possible values:
  • sales_order - Sales Order
  • sales_proforma - Proforma Invoice
  • sales_invoice - Invoice
  • sales_receipt - Receipt
  • sales_estimate - Quote/Estimate
  • credit_note - Credit Note/Refund
<Operation> Possible values:
  • sell_goods - Selling Goods
  • sell_services - Selling Services
  • other_income - Other Income
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<DueNoticeEnabled> Boolean value (false | true)
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<UseOverpayment> Boolean value (false | true)
<Signature> Possible values:
  • 0 - None
  • 1 - Electronic
  • 2 - To be signed by sender
  • 3 - To be signed by recipient
  • 4 - To be signed by both sender and recipient
  • 5 - Scanned signature
<PeriodType> Possible values:
  • 0 - Not Defined
  • 1 - Current Month
  • 2 - Previous Month
  • 3 - Next Month
  • 9 - Other
<PayTermType> Possible values:
  • 0 - Other date
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<PaymentMethod> Possible values:
  • 0 - Not Defined
  • 1 - Bank
  • 2 - Cash
  • 3 - Card
  • 4 - Prepayment
  • 5 - Offsetting
  • 6 - Factoring
<AccountID> Unique system identifier for account. See Get Account
<ShippingType> Possible values:
  • 0 - Not Defined
  • 1 - Supply of goods
  • 2 - Movement of goods
  • 3 - Product returns
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<ShipperID> Unique system identifier for shipper. See Get Shipper
<AddressID> Unique system identifier for shipping address. See Get Client Shipping Address
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<ItemID> Unique system identifier for product or service. See Get Product or See Get Service
<ItemCode> Product SKU or service code. See Get Product By Code or See Get Service By Code
<LotID> Unique system identifier for lot
<UnitID> Unique system identifier for unit of measure. See Get Unit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<TypeID> Possible values:
  • charge - Charge
  • discount - Discount
<PctOrAmount> Possible values:
  • pct - Percent
  • amount - Amount
<DeliveredBy> Possible values:
  • email - E-mail
  • direct - Paytraq Direct
  • edi - EDI/E-invoice Operator
<EventStatus> Possible values:
  • sent - Sent
  • delivered - Delivered
  • open - Open
  • not_delivered - Undelivered/Failed

Back to Sales

POSTAdd Sales Document

Request

XML / HTTP
POST https://go.paytraq.com/api/sale

Payload

XML / HTTP
<Sale>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Client>
            <ClientID></ClientID>
            <ClientName></ClientName>
         </Client>
      </Document>
      <SaleType></SaleType>
      <Operation></Operation>
      <DueNoticeEnabled></DueNoticeEnabled>
      <Currency></Currency>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <UseOverpayment></UseOverpayment>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <IssuedBy></IssuedBy>
      <Deposit />
      <Comment />
      <Signature></Signature>
      <InvoicePeriod>
         <PeriodType></PeriodType>
         <PeriodStart />
         <PeriodEnd />
      </InvoicePeriod>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <LineItems>
      <LineItem>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Item>
            <ItemID></ItemID>
         </Item>
         <ItemLot>
            <LotID></LotID>
         </ItemLot>
         <Description></Description>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
      </TaxKey>
   </ShippingCharge>
</Sale>

Only <SaleType> and <Operation> are required.
To add a client <ClientID /> OR <ClientName /> should be provided.
<OrderLineID /> can be provided to link an invoice line with an existing sales order line by LineItemID.
<MovementLineID /> can be provided to link an invoice line with an existing shipment line MovementItemID.
For tags description please refer to Get Sale Document.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

POSTUpdate Sales Document

Request

XML / HTTP
POST https://go.paytraq.com/api/sale/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Payload

XML / HTTP
<Sale>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Client>
            <ClientID></ClientID>
         </Client>
      </Document>
      <DueNoticeEnabled></DueNoticeEnabled>
      <Currency></Currency>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <UseOverpayment></UseOverpayment>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <IssuedBy></IssuedBy>
      <Deposit />
      <Comment />
      <Signature></Signature>
      <InvoicePeriod>
         <PeriodType></PeriodType>
         <PeriodStart />
         <PeriodEnd />
      </InvoicePeriod>
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <LineItems>
      <LineItem>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Item>
            <ItemID></ItemID>
         </Item>
         <ItemLot>
            <LotID></LotID>
         </ItemLot>
         <Description></Description>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
      </TaxKey>
   </ShippingCharge>
</Sale>

Only documents with status Draft can be updated.
No tags are required.
For tags description please refer to Get Sale Document.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

POSTAdd Sales Note

Request

XML / HTTP
POST https://go.paytraq.com/api/addSaleNote/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Payload

XML / HTTP
<Note></Note>
Tag Description
<Note> Text of the note

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETPost Sales Document

Request

XML / HTTP
GET https://go.paytraq.com/api/salePost/{DocumentID}

Parameter Description
DocumentID Unique system identifier for sales document
Sending Option
If you need to additionally send the document by email or as e-invoice within the same request then append a send parameter to the URL e.g. &send=true. The document is sent to all available channels.

Only documents with status Draft can be posted.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETApprove Sales Document

Request

XML / HTTP
GET https://go.paytraq.com/api/saleApprove/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document
Sending Option
If you need to additionally send the document by email or PayTraq Direct within the same request then append a send parameter to the URL e.g. &send=true.

Only documents with status Draft can be approved.
This request is valid for Sales Order and Proforma Invoice only. In case of any other document types please refer to Post Sales Document request.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETApprove Sales Journal

Request

XML / HTTP
GET https://go.paytraq.com/api/approveSaleJournal/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Only documents with status Waiting for Approval can be approved.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETVoid Sales Document

Request

XML / HTTP
GET https://go.paytraq.com/api/saleVoid/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Documents with status Draft (except Estimate), Partially Paid, Paid, Reversed or Done can not be voided.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETCreate Invoice from Proforma

Request

XML / HTTP
GET https://go.paytraq.com/api/proformaToSalesInvoice/{DocumentID}
Parameter Description
DocumentID Unique system identifier for proforma invoice

This request is valid for Proforma Invoice only.
The proforma status should not be Draft or Done.
This request will create an invoice and offset it with received prepayment based on the provided proforma ID.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <AmountDue></AmountDue>
</Response>
Tag Description
<DocumentID> Unique system identifier for created invoice

Back to Sales

POSTAdd Payment to Sales Document

Request

XML / HTTP
POST https://go.paytraq.com/api/salePayment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document

Payload

XML / HTTP
<DirectPayment>
   <MoneyAccountID></MoneyAccountID>
   <PaymentAmount></PaymentAmount>
   <PaymentDate></PaymentDate>
   <Narration></Narration>
   <BankCharge></BankCharge>
</DirectPayment>
Tag Description
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts

Only documents with status Waiting for Payment or Partially Paid can be paid.
<MoneyAccountID> should be in the same currency as sales document.
<Narration> is not required.
<BankCharge> is optional.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <AmountDue></AmountDue>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document. See Get Payment
Is not available for <MoneyAccountID> with Merchant and Credit Card account types

Back to Sales

GETOffset Invoice with Credit Note

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetSalesInvoiceWithCreditNote/{InvoiceID}/{CreditNoteID}
Parameter Description
InvoiceID Unique system identifier for invoice
CreditNoteID Unique system identifier for credit note

Both invoice and credit note status should be either Waiting for Payment or Partially Paid.
Offset date will be the date of the credit note.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
    <CreditNote>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </CreditNote>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

POSTAdd Overpayment

Request

XML / HTTP
POST https://go.paytraq.com/api/overpaymentReceived/{ClientID}
Parameter Description
ClientID Unique system identifier for client. See Get Client

Payload

XML / HTTP
<Overpayment>
   <MoneyAccountID></MoneyAccountID>
   <PaymentAmount></PaymentAmount>
   <PaymentDate></PaymentDate>
   <Narration></Narration>
</Overpayment>
Tag Description
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts
<Narration> is not required.

Response

XML / HTTP
<Response>
   <ClientID></ClientID>
   <JournalID></JournalID>
</Response>
Tag Description
<ClientID> Unique system identifier for client. See Get Client
<JournalID> Unique system identifier for journal. See Get Journal.

Back to Sales

GETOffset Overpayment

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetOverpaymentReceived/{InvoiceID}
Parameter Description
InvoiceID Unique system identifier for invoice

Offset date will be the date of the invoice.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETGet Prepayments (Open Proforma)

Request

XML / HTTP
GET https://go.paytraq.com/api/salesPrepayments/{ClientID}

Parameter Description
ClientID Unique system identifier for client. See Get Client

Response

XML / HTTP
<Prepayments>
    <Prepayment>
        <Client>
            <ClientID></ClientID>
            <ClientName></ClientName>
        </Client>
        <DocumentID></DocumentID>
        <DocumentRef></DocumentRef>
        <DocumentDate></DocumentDate>
        <Currency></Currency>
        <Due></Due>
        <Paid></Paid>
        <Available></Available>
    </Prepayment>
</Prepayments>
Tag Description
<DocumentID> Unique system identifier for sales document (proforma)
<Currency> Currency code
<Due> Proforma due amount
<Paid> Proforma paid amount
<Available> Amount available for offsetting

Back to Sales

GETUse Prepayment

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetSalesInvoiceWithPrepayment/{InvoiceID}/{ProformaID}
Parameter Description
InvoiceID Unique system identifier for invoice
ProformaID Unique system identifier for proforma

Offset date will be the date of the invoice.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
   <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
   </Invoice>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETGet Sales Document as PDF

Request

XML / HTTP
GET https://go.paytraq.com/api/salePDF/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document
Optional Query Parameter Description
lang PDF language. The following values are supported: en, et, lt, lv, ru, es, pt, bg, sk, fi, ar. Example: ?lang=lv

Response

XML / HTTP
PDF (MIME type - application/pdf)

Back to Sales

GETGet Sales Document as Estonian E-invoice

Request

XML / HTTP
GET https://go.paytraq.com/api/saleEInvoice/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document
Optional Query Parameter Description
lang Embedded PDF language. The following values are supported: en, et, lt, lv, ru, es, pt, bg, sk, fi, ar. Example: ?lang=lv

Response

XML / HTTP
XML (MIME type - application/xml)

Back to Sales

GETGet Sales Document as UBL

Request

XML / HTTP
GET https://go.paytraq.com/api/saleUBL/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document
Optional Query Parameter Description
lang Embedded PDF language. The following values are supported: en, et, lt, lv, ru, es, pt, bg, sk, fi, ar. Example: ?lang=lv

Response

XML / HTTP
XML (MIME type - application/xml)

Back to Sales

Request

XML / HTTP
GET https://go.paytraq.com/api/saleLink/{DocumentID}
Parameter Description
DocumentID Unique system identifier for sales document
Optional Query Parameter Description
lang PDF language. The following values are supported: en, et, lt, lv, ru, es, pt, bg, sk, fi, ar. Example: ?lang=lv

Response

XML / HTTP
<Sale>
   <DocumentLink>
      <URL></URL>
   </DocumentLink>
   <PDFLink>
      <URL></URL>
   </PDFLink>
   <UBLLink>
      <URL></URL>
   </UBLLink>
   <EInvoiceLink>
      <URL></URL>
   </EInvoiceLink>
</Sale>

Back to Sales

GETSend Sales Document

Request

XML / HTTP
GET https://go.paytraq.com/api/saleSend/{DocumentID}

The document is sent to all available channels.

Parameter Description
DocumentID Unique system identifier for sales document

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETSend E-Invoice

Request

XML / HTTP
GET https://go.paytraq.com/api/saleSendEInvoice/{DocumentID}

The document is sent as e-invoice only.

Parameter Description
DocumentID Unique system identifier for sales document

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

GETGet Income By Clients

Request

XML / HTTP
GET https://go.paytraq.com/api/incomeByClients

The result list is sorted by Total in descending order.
Pagination and Date Range filter can be applied.
GET /api/incomeByClients? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<Clients>
      <Client>
        <ClientID></ClientID>
        <Name></Name>
        <Total></Total>
        <Currency></Currency>
      </Client>
    </Clients>
Tag Description
<ClientID> Unique system identifier for client. See Get Client
<Total> Total income for the period

Back to Sales

GETGet Income By Products

Request

XML / HTTP
GET https://go.paytraq.com/api/incomeByProducts

The result list is sorted by Total in descending order.
Pagination and Date Range filter can be applied.
GET /api/incomeByProducts? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<Products>
      <Product>
        <ItemID></ItemID>
        <Name></Name>
        <Code></Code>
        <Total></Total>
        <Currency></Currency>
      </Client>
    </Product>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<Total> Total income for the period

Back to Sales

GETGet Income By Services

Request

XML / HTTP
GET https://go.paytraq.com/api/incomeByServices

The result list is sorted by Total in descending order.
Pagination and Date Range filter can be applied.
GET /api/incomeByServices? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<Services>
      <Service>
        <ItemID></ItemID>
        <Name></Name>
        <Code></Code>
        <Total></Total>
        <Currency></Currency>
      </Service>
    </Service>
Tag Description
<ItemID> Unique system identifier for service. See Get Service
<Total> Total income for the period

Back to Sales

GETList of Products Sold

Request

XML / HTTP
GET https://go.paytraq.com/api/listProductsSold

The result list is sorted by Journal Date in ascending order.
Pagination and Date Range filter can be applied.
GET /api/listProductsSold? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Additional optional parameters are available for this request:
GET /api/listProductsSold? ... &ClientID=0 ... &ItemID=0
ClientID - Unique system identifier for client. See Get Client
ItemID - Unique system identifier for product. See Get Product

Response

XML / HTTP
<Sales>
    <Sale>
        <Document>
            <DocumentID></DocumentID>
            <DocumentDate>></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Client>
                <ClientID></ClientID>
                <ClientName></ClientName>
            </Client>
        </Document>
        <SaleType></SaleType>
        <Journal>
            <JournalID></JournalID>
            <JournalRef></JournalRef>
            <JournalDate></JournalDate>
        </Journal>
        <Product>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
            <Qty></Qty>
            <Total>></Total>
            <Currency></Currency>
        </Product>
    </Sale>
   </Sales>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<Qty> Total qty for document
<Total> Total amount for document

Back to Sales

GETList of Services Sold

Request

XML / HTTP
GET https://go.paytraq.com/api/listServicesSold

The result list is sorted by Journal Date in ascending order.
Pagination and Date Range filter can be applied.
GET /api/listServicesSold? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Additional optional parameters are available for this request:
GET /api/listServicesSold? ... &ClientID=0 ... &ItemID=0
ClientID - Unique system identifier for client. See Get Client
ItemID - Unique system identifier for service. See Get Service

Response

XML / HTTP
<Sales>
    <Sale>
        <Document>
            <DocumentID></DocumentID>
            <DocumentDate>></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Client>
                <ClientID></ClientID>
                <ClientName></ClientName>
            </Client>
        </Document>
        <SaleType></SaleType>
        <Journal>
            <JournalID></JournalID>
            <JournalRef></JournalRef>
            <JournalDate></JournalDate>
        </Journal>
        <Service>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
            <Qty></Qty>
            <Total>></Total>
            <Currency></Currency>
        </Service>
    </Sale>
   </Sales>
Tag Description
<ItemID> Unique system identifier for service. See Get Service
<Qty> Total qty for document
<Total> Total amount for document

Back to Sales

Purchases

GETGet Purchase Document List

Request

XML / HTTP
GET https://go.paytraq.com/api/purchases

By default result list is sorted by document date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by supplier name or document number.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Document date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:
GET /api/purchases? ... &SupplierID=0 ... &dueOnly=true ... &tag=tag_value
SupplierID - Unique system identifier for supplier. See Get Supplier
dueOnly - Boolean, if true then only documents with "Waiting for Payment" and "Partially Paid" status are returned
tag - Filter by tag value

Response

XML / HTTP
<Purchases>
   <Purchase>
      <Header>
         <Document>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Supplier>
               <SupplierID></SupplierID>
               <SupplierName></SupplierName>
            </Supplier>
         </Document>
         <PurchaseType></PurchaseType>
         <Operation></Operation>
         <Total></Total>
         <AmountDue></AmountDue>
         <Currency></Currency>
         <BalanceCurrency></BalanceCurrency>
         <CurrencyRate></CurrencyRate>
         <TaxBasis></TaxBasis>
         <IncludeTax></IncludeTax>
         <DateDue></DateDue>
         <DateApproved></DateApproved>
         <ReceivedBy></ReceivedBy>
         <Discount></Discount>
         <Deposit></Deposit>
         <Comment></Comment>
         <PayTerm>
            <PayTermType></PayTermType>
            <PayTermDays />
         </PayTerm>
         <PaymentMethod></PaymentMethod>
         <AccountID></AccountID>
         <ShippingData>
            <ShippingType></ShippingType>
            <Warehouse>
               <WarehouseID></WarehouseID>
               <WarehouseName></WarehouseName>
            </Warehouse>
            <LoadingArea>
               <LoadingAreaID></LoadingAreaID>
               <LoadingAreaName></LoadingAreaName>
               <LoadingAreaAddress>
                  <Address></Address>
                  <Zip></Zip>
                  <Country></Country>
               </LoadingAreaAddress>
            </LoadingArea>
            <Shipper>
               <ShipperID></ShipperID>
               <ShipperName></ShipperName>
               <ShipperRegNumber></ShipperRegNumber>
               <ShipperVehicle></ShipperVehicle>
               <ShipperDriver></ShipperDriver>
            </Shipper>
            <ShippingAddress>
               <AddressID></AddressID>
               <ShipTo></ShipTo>
               <Address></Address>
               <Zip></Zip>
               <Country></Country>
            </ShippingAddress>
         </ShippingData>
         <Project>
            <ProjectName />
         </Project>
         <TimeStamps>
            <Created />
            <Updated />
         </TimeStamps>
      </Header>
   </Purchase>
  ...
</Purchases>
Tag Description
<DocumentID> Unique system identifier for purchase document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<SupplierID> Unique system identifier for supplier. See Get Supplier
<PurchaseType> Possible values:
  • purchase_order - Purchase Order
  • purchase_proforma - Proforma Invoice
  • purchase_invoice - Invoice
  • purchase_receipt - Receipt
  • purchase_voucher - Self-Billed Invoice
  • debit_note - Credit Note/Refund
<Operation> Possible values:
  • purchase_goods - Purchasing Goods
  • purchase_services - Purchasing Services
  • other_expenses - Other Expenses
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<PayTermType> Possible values:
  • 0 - Other date
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<PaymentMethod> Possible values:
  • 0 - Not Defined
  • 1 - Bank
  • 2 - Cash
  • 3 - Card
  • 4 - Prepayment
  • 5 - Offsetting
  • 6 - Factoring
<AccountID> Unique system identifier for accounts payable. See Get Account
<ShippingType> Possible values:
  • 0 - Not Defined
  • 1 - Supply of goods
  • 2 - Movement of goods
  • 3 - Product returns
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<ShipperID> Unique system identifier for shipper. See Get Shipper
<AddressID> Unique system identifier for shipping address. See Get Supplier Shipping Address
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Purchases

GETGet Purchase Document

Request

XML / HTTP
GET https://go.paytraq.com/api/purchase/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Response

XML / HTTP
<Purchase>
   <Header>
      <Document>
         <DocumentID></DocumentID>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <DocumentStatus></DocumentStatus>
         <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
         </Supplier>
      </Document>
      <PurchaseType></PurchaseType>
      <Operation></Operation>
      <Total></Total>
      <AmountDue></AmountDue>
      <Currency></Currency>
      <BalanceCurrency></BalanceCurrency>
      <CurrencyRate></CurrencyRate>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <ReceivedBy></ReceivedBy>
      <Discount></Discount>
      <Deposit />
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <AccountID></AccountID>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
            <WarehouseName></WarehouseName>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
            <LoadingAreaName></LoadingAreaName>
            <LoadingAreaAddress>
               <Address></Address>
               <Zip></Zip>
               <Country></Country>
            </LoadingAreaAddress>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
            <ShipperName></ShipperName>
            <ShipperRegNumber />
            <ShipperVehicle />
            <ShipperDriver />
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
            <ShipTo></ShipTo>
            <Address></Address>
            <Zip></Zip>
            <Country></Country>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Header>
   <LineItems>
      <LineItem>
         <LineItemID></LineItemID>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <Description></Description>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
         <AccountCode></AccountCode>
         <AccountName></AccountName>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
         <TaxKeyName></TaxKeyName>
      </TaxKey>
   </ShippingCharge>
   <Taxes>
      <Tax>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <TaxName></TaxName>
         <GrossAmount></GrossAmount>
         <NetAmount></NetAmount>
         <TaxAmount></TaxAmount>
         <Account>
            <AccountID></AccountID>
            <AccountName></AccountName>
         </Account>
      </Tax>
   </Taxes>
   <Totals>
      <GrossAmount></GrossAmount>
      <NetAmount></NetAmount>
      <Qty></Qty>
   </Totals>
   <InvoiceReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </InvoiceReference>
   <OrderReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </OrderReference>
   <ProformaReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </ProformaReference>
   <MovementReference>
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
      </DocumentLink>
      ...
   </MovementReference>
   <Payments>
      <Payment>
         <PaymentDate></PaymentDate>
         <PaymentType></PaymentType>
         <PaymentAmount></PaymentAmount>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <DocumentLink>
            <DocumentID></DocumentID>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
         </DocumentLink>
      </Payment>
      ...
   </Payments>
   <Journals>
      <Journal>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <JournalDate></JournalDate>
         <JournalStatus></JournalStatus>
         <JournalType>
            <JournalTypeID></JournalTypeID>
            <JournalTypeName></JournalTypeName>
         </JournalType>
      </Journal>
      ...
   </Journals>
   <Tags>
      <Tag />
   </Tags>
   <Notes>
      <Note>
         <Created></Created>
         <Text></Text>
      </Note>
      ...
   </Notes>
</Purchase>
Tag Description
<DocumentID> Unique system identifier for purchase document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<SupplierID> Unique system identifier for supplier. See Get Supplier
<PurchaseType> Possible values:
  • purchase_order - Purchase Order
  • purchase_proforma - Proforma Invoice
  • purchase_invoice - Invoice
  • purchase_receipt - Receipt
  • purchase_voucher - Self-Billed Invoice
  • debit_note - Credit Note/Refund
<Operation> Possible values:
  • purchase_goods - Purchasing Goods
  • purchase_services - Purchasing Services
  • other_expenses - Other Expenses
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<PayTermType> Possible values:
  • 0 - Other date
  • 1 - Due days
  • 2 - EOM+
  • 3 - Cash on delivery
  • 4 - Open date of payment
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<PaymentMethod> Possible values:
  • 0 - Not Defined
  • 1 - Bank
  • 2 - Cash
  • 3 - Card
  • 4 - Prepayment
  • 5 - Offsetting
  • 6 - Factoring
<AccountID> Unique system identifier for account. See Get Account
<ShippingType> Possible values:
  • 0 - Not Defined
  • 1 - Supply of goods
  • 2 - Movement of goods
  • 3 - Product returns
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<LoadingAreaID> Unique system identifier for loading area. See Get Loading Area
<ShipperID> Unique system identifier for shipper. See Get Shipper
<AddressID> Unique system identifier for shipping address. See Get Supplier Shipping Address
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<ItemID> Unique system identifier for product. See Get Product
<ItemCode> Product SKU. See Get Product By Code
<LotID> Unique system identifier for lot
<UnitID> Unique system identifier for unit of measure. See Get Unit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<TypeID> Possible values:
  • charge - Charge
  • discount - Discount
<PctOrAmount> Possible values:
  • pct - Percent
  • amount - Amount

Back to Purchases

POSTAdd Purchase Document

Request

XML / HTTP
POST https://go.paytraq.com/api/purchase

Payload

XML / HTTP
<Purchase>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
         </Supplier>
      </Document>
      <PurchaseType></PurchaseType>
      <Operation></Operation>
      <Currency></Currency>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <ReceivedBy></ReceivedBy>
      <Deposit />
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <LineItems>
      <LineItem>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Item>
            <ItemID></ItemID>
         </Item>
         <ItemLot>
            <LotID></LotID>
         </ItemLot>
         <Description></Description>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
      </TaxKey>
   </ShippingCharge>
</Purchase>

Only <PurchaseType> and <Operation> are required.
To add a supplier <SupplierID /> OR <SupplierName /> should be provided.
<OrderLineID /> can be provided to link an invoice line with an existing purchase order line by LineItemID.
<MovementLineID /> can be provided to link an invoice line with an existing shipment line MovementItemID.
For tags description please refer to Get Purchase Document.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

POSTUpdate Purchase Document

Request

XML / HTTP
POST https://go.paytraq.com/api/purchase/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Payload

XML / HTTP
<Purchase>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Supplier>
            <SupplierID></SupplierID>
         </Supplier>
      </Document>
      <PurchaseType></PurchaseType>
      <Operation></Operation>
      <Currency></Currency>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <DateDue></DateDue>
      <DateApproved></DateApproved>
      <ReceivedBy></ReceivedBy>
      <Deposit />
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays></PayTermDays>
      </PayTerm>
      <PaymentMethod></PaymentMethod>
      <ShippingData>
         <ShippingType></ShippingType>
         <Warehouse>
            <WarehouseID></WarehouseID>
         </Warehouse>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <LineItems>
      <LineItem>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Item>
            <ItemID></ItemID>
         </Item>
         <ItemLot>
            <LotID></LotID>
         </ItemLot>
         <Description></Description>
         <Qty></Qty>
         <Price></Price>
         <LineDiscount></LineDiscount>
         <LineTotal></LineTotal>
         <Unit>
            <UnitID></UnitID>
         </Unit>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
         <OrderLineID></OrderLineID>
         <MovementLineID></MovementLineID>
      </LineItem>
      ...
   </LineItems>
   <Adjustments>
      <Adjustment>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Amount></Amount>
         <Description />
         <TypeID></TypeID>
         <PctOrAmount></PctOrAmount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Adjustment>
      ...
   </Adjustments>
   <ShippingCharge>
      <Account>
         <AccountID></AccountID>
      </Account>
      <Amount></Amount>
      <TaxKey>
         <TaxKeyID></TaxKeyID>
      </TaxKey>
   </ShippingCharge>
</Purchase>

Only documents with status Draft can be updated.
No tags are required.
For tags description please refer to Get Purchase Document.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

POSTAdd Purchase Note

Request

XML / HTTP
POST https://go.paytraq.com/api/addPurchaseNote/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Payload

XML / HTTP
<Note></Note>
Tag Description
<Note> Text of the note

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETPost Purchase Document

Request

XML / HTTP
GET https://go.paytraq.com/api/purchasePost/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Only documents with status Draft can be posted.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETApprove Purchase Document

Request

XML / HTTP
GET https://go.paytraq.com/api/purchaseApprove/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document
Sending Option
If you need to additionally send the document by email (for Purchase Order only) within the same request then append a send parameter to the URL e.g. &send=true.

Only documents with status Draft can be approved.
This request is valid for Purchase Order and Proforma Invoice only. In case of any other document types please refer to Post Purchase Document request.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETApprove Purchase Journal

Request

XML / HTTP
GET https://go.paytraq.com/api/approvePurchaseJournal/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Only documents with status Waiting for Approval can be approved.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETVoid Purchase Document

Request

XML / HTTP
GET https://go.paytraq.com/api/purchaseVoid/{DocumentID}
Parameter Description
DocumentID Unique system identifier for purchase document

Documents with status Draft, Partially Paid, Paid, Reversed or Done can not be voided.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

POSTAdd Payment to Purchase Document

Request

XML / HTTP
POST https://go.paytraq.com/api/purchasePayment/{DocumentID}

Parameter Description
DocumentID Unique system identifier for purchase document

Payload

XML / HTTP
<DirectPayment>
   <MoneyAccountID></MoneyAccountID>
   <PaymentAmount></PaymentAmount>
   <PaymentDate></PaymentDate>
   <Narration></Narration>
   <BankCharge></BankCharge>
</DirectPayment>
Tag Description
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts

Only documents with status Waiting for Payment or Partially Paid can be paid.
<MoneyAccountID> should be in the same currency as purchase document.
<Narration> is not required.
<BankCharge> is optional.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <AmountDue></AmountDue>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document. See Get Payment
Is not available for <MoneyAccountID> with Merchant and Credit Card account types

Back to Purchases

GETOffset Invoice with Credit Note

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetPurchaseInvoiceWithCreditNote/{InvoiceID}/{CreditNoteID}
Parameter Description
InvoiceID Unique system identifier for invoice
CreditNoteID Unique system identifier for credit note

Both invoice and credit note status should be either Waiting for Payment or Partially Paid.
Offset date will be the date of the credit note.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
    <CreditNote>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </CreditNote>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

POSTAdd Overpayment

Request

XML / HTTP
POST https://go.paytraq.com/api/overpaymentMade/{SupplierID}
Parameter Description
SupplierID Unique system identifier for supplier. See Get Supplier

Payload

XML / HTTP
<Overpayment>
   <MoneyAccountID></MoneyAccountID>
   <PaymentAmount></PaymentAmount>
   <PaymentDate></PaymentDate>
   <Narration></Narration>
</Overpayment>
Tag Description
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts
<Narration> is not required.

Response

XML / HTTP
<Response>
   <SupplierID></SupplierID>
   <JournalID></JournalID>
</Response>
Tag Description
<SupplierID> Unique system identifier for supplier. See Get Supplier
<JournalID> Unique system identifier for journal. See Get Journal.

Back to Purchases

GETOffset Overpayment

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetOverpaymentMade/{InvoiceID}
Parameter Description
InvoiceID Unique system identifier for invoice

Offset date will be the date of the invoice.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETGet Prepayments (Open Proforma)

Request

XML / HTTP
GET https://go.paytraq.com/api/purchasesPrepayments/{SupplierID}

Parameter Description
SupplierID Unique system identifier for supplier. See Get Supplier

Response

XML / HTTP
<Prepayments>
    <Prepayment>
        <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
        </Supplier>
        <DocumentID></DocumentID>
        <DocumentRef></DocumentRef>
        <DocumentDate></DocumentDate>
        <Currency></Currency>
        <Due></Due>
        <Paid></Paid>
        <Available></Available>
    </Prepayment>
</Prepayments>
Tag Description
<DocumentID> Unique system identifier for purchase document (proforma)
<Currency> Currency code
<Due> Proforma due amount
<Paid> Proforma paid amount
<Available> Amount available for offsetting

Back to Purchases

GETUse Prepayment

Request

XML / HTTP
GET https://go.paytraq.com/api/offsetPurchaseInvoiceWithPrepayment/{InvoiceID}/{ProformaID}
Parameter Description
InvoiceID Unique system identifier for invoice
ProformaID Unique system identifier for proforma

Offset date will be the date of the invoice.

Response

XML / HTTP
<Response>
   <OffsetAmount></OffsetAmount>
   <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
   </Invoice>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

GETGet Expense Claims

Request

XML / HTTP
GET https://go.paytraq.com/api/expenseClaims

By default result list is sorted by document date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by employee name or document number.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Document date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:
GET /api/expenseClaims? ... &EmployeeID=0 ... &dueOnly=true ... &tag=tag_value
EmployeeID - Unique system identifier for employee. See Get Employee
dueOnly - Boolean, if true then only documents with "Waiting for Payment" and "Partially Paid" status are returned
tag - Filter by tag value

Response

XML / HTTP
<ExpenseClaims>
   <ExpenseClaim>
      <Header>
         <Document>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Employee>
               <EmployeeID></EmployeeID>
               <EmployeeName></EmployeeName>
            </Employee>
         </Document>
         <Total></Total>
         <AmountDue></AmountDue>
         <Currency></Currency>
         <BalanceCurrency></BalanceCurrency>
         <CurrencyRate></CurrencyRate>
         <TaxBasis></TaxBasis>
         <IncludeTax></IncludeTax>
         <UsePrepayment></UsePrepayment>
         <DateDue></DateDue>
         <Comment />
         <PayTerm>
            <PayTermType></PayTermType>
            <PayTermDays />
         </PayTerm>
         <AccountID></AccountID>
         <Project>
            <ProjectName />
         </Project>
         <TimeStamps>
            <Created />
            <Updated />
         </TimeStamps>
      </Header>
   </ExpenseClaim>
   ...
</ExpenseClaims>
Tag Description
<DocumentID> Unique system identifier for expense claim
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<EmployeeID> Unique system identifier for employee. See Get Employee
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<UsePrepayment> Boolean value (false | true)
<AccountID> Unique system identifier for accounts payable. See Get Account
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Purchases

GETGet Expense Claim

Request

XML / HTTP
GET https://go.paytraq.com/api/expenseClaim/{DocumentID}
Parameter Description
DocumentID Unique system identifier for expense claim

Response

XML / HTTP
<ExpenseClaim>
   <Header>
      <Document>
         <DocumentID></DocumentID>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <DocumentStatus></DocumentStatus>
         <Employee>
            <EmployeeID></EmployeeID>
            <EmployeeName></EmployeeName>
         </Employee>
      </Document>
      <Total></Total>
      <AmountDue></AmountDue>
      <Currency></Currency>
      <BalanceCurrency></BalanceCurrency>
      <CurrencyRate></CurrencyRate>
      <TaxBasis></TaxBasis>
      <IncludeTax></IncludeTax>
      <UsePrepayment></UsePrepayment>
      <DateDue></DateDue>
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays />
      </PayTerm>
      <AccountID></AccountID>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Header>
   <Expenses>
      <Expense>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
         </Supplier>
         <ReceiptDate></ReceiptDate>
         <ReceiptRef></ReceiptRef>
         <Description></Description>
         <Amount></Amount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
      </Expense>
      ...
   </Expenses>
   <Taxes>
      <Tax>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <TaxName></TaxName>
         <GrossAmount></GrossAmount>
         <NetAmount></NetAmount>
         <TaxAmount></TaxAmount>
         <Account>
            <AccountID></AccountID>
            <AccountName></AccountName>
         </Account>
      </Tax>
   </Taxes>
   <Totals>
      <GrossAmount></GrossAmount>
      <NetAmount></NetAmount>
   </Totals>
   <Payments>
      <Payment>
         <PaymentDate></PaymentDate>
         <PaymentType></PaymentType>
         <PaymentAmount></PaymentAmount>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <DocumentLink>
            <DocumentID></DocumentID>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
         </DocumentLink>
      </Payment>
      ...
   </Payments>
   <Journals>
      <Journal>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <JournalDate></JournalDate>
         <JournalStatus></JournalStatus>
         <JournalType>
            <JournalTypeID></JournalTypeID>
            <JournalTypeName></JournalTypeName>
         </JournalType>
      </Journal>
      ...
   </Journals>
   <Tags>
      <Tag />
   </Tags>
</ExpenseClaim>
Tag Description
<DocumentID> Unique system identifier for expense claim
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
  • voided - Voided/Canceled
  • reversed - Reversed
  • done - Done
  • approved - Approved
  • in_process - In Progress
<EmployeeID> Unique system identifier for employee. See Get Employee
<Currency> Currency code
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<UsePrepayment> Boolean value (false | true)
<PayTermType> Possible values:
  • 0 - Other date
  • 1 - Due days
  • 2 - EOM+
<PayTermDays> Number of days. Can be used only with <PayTermType> values 1 and 2
<AccountID> Unique system identifier for account. See Get Account
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<SupplierID> Unique system identifier for supplier. See Get Supplier
<ReceiptRef> Receipt number
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key

Back to Purchases

POSTAdd Expense Claim

Request

XML / HTTP
POST https://go.paytraq.com/api/expenseClaim

Payload

XML / HTTP
<ExpenseClaim>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Employee>
            <EmployeeID></EmployeeID>
            <EmployeeName></EmployeeName>
         </Employee>
      </Document>
      <Currency></Currency>
      <UsePrepayment></UsePrepayment>
      <DateDue></DateDue>
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays />
      </PayTerm>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <Expenses>
      <Expense>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
         </Supplier>
         <ReceiptDate></ReceiptDate>
         <ReceiptRef></ReceiptRef>
         <Description></Description>
         <Amount></Amount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Expense>
      ...
   </Expenses>
</ExpenseClaim>

No tags are required.
To add an employee <EmployeeID /> OR <EmployeeName /> should be provided.
To add a supplier <SupplierID /> OR <SupplierName /> should be provided.
For tags description please refer to Get Expense Claim.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

POSTUpdate Expense Claim

Request

XML / HTTP
POST https://go.paytraq.com/api/expenseClaim/{DocumentID}
Parameter Description
DocumentID Unique system identifier for expense claim

Payload

XML / HTTP
<ExpenseClaim>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <Employee>
            <EmployeeID></EmployeeID>
         </Employee>
      </Document>
      <Currency></Currency>
      <UsePrepayment></UsePrepayment>
      <DateDue></DateDue>
      <Comment />
      <PayTerm>
         <PayTermType></PayTermType>
         <PayTermDays />
      </PayTerm>
      <Project>
         <ProjectName />
      </Project>
   </Header>
   <Expenses>
      <Expense>
         <Account>
            <AccountID></AccountID>
         </Account>
         <Supplier>
            <SupplierID></SupplierID>
            <SupplierName></SupplierName>
         </Supplier>
         <ReceiptDate></ReceiptDate>
         <ReceiptRef></ReceiptRef>
         <Description></Description>
         <Amount></Amount>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </Expense>
      ...
   </Expenses>
</ExpenseClaim>

Only documents with status Draft or Waiting for Approval can be updated.
No tags are required.
To add a supplier <SupplierID /> OR <SupplierName /> should be provided.
For tags description please refer to Get Expense Claim.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Purchases

GETSet Expense Claim to Ready for Approval

Request

XML / HTTP
GET https://go.paytraq.com/api/expenseClaimReady/{DocumentID}
Parameter Description
DocumentID Unique system identifier for expense claim

This call updates the status of expense claim to Waiting for Approval.
Only documents with status Draft can be updated.
Expense claim can be approved and posted by calling Post Expense Claim API call.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Purchases

GETPost Expense Claim

Request

XML / HTTP
GET https://go.paytraq.com/api/expenseClaimPost/{DocumentID}
Parameter Description
DocumentID Unique system identifier for expense claim

Only documents with status Waiting for Approval can be posted.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Purchases

POSTAdd Payment to Expense Claim

Request

XML / HTTP
POST https://go.paytraq.com/api/expenseClaimPayment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for expense claim

Payload

XML / HTTP
<DirectPayment>
   <MoneyAccountID></MoneyAccountID>
   <PaymentAmount></PaymentAmount>
   <PaymentDate></PaymentDate>
   <Narration></Narration>
</DirectPayment>
Tag Description
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts

Only documents with status Waiting for Payment or Partially Paid can be paid.
<MoneyAccountID> should be in the same currency as expense claim.
<Narration> is not required.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <AmountDue></AmountDue>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document. See Get Payment
Is not available for <MoneyAccountID> with Merchant and Credit Card account types

Back to Purchases

GETGet Expenses By Suppliers

Request

XML / HTTP
GET https://go.paytraq.com/api/expensesBySuppliers

The result list is sorted by Total in descending order.
Pagination and Date Range filter can be applied.
GET /api/expensesBySuppliers? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<Suppliers>
      <Supplier>
        <SupplierID></SupplierID>
        <Name></Name>
        <Total></Total>
        <Currency></Currency>
      </Supplier>
    </Suppliers>
Tag Description
<SupplierID> Unique system identifier for supplier. See Get Supplier
<Total> Total income for the period

Back to Purchases

GETGet Expenses By Products

Request

XML / HTTP
GET https://go.paytraq.com/api/expensesByProducts

The result list is sorted by Total in descending order.
Pagination and Date Range filter can be applied.
GET /api/expensesByProducts? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<Products>
      <Product>
        <ItemID></ItemID>
        <Name></Name>
        <Code></Code>
        <Total></Total>
        <Currency></Currency>
      </Client>
    </Product>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<Total> Total income for the period

Back to Purchases

GETList of Products Purchased

Request

XML / HTTP
GET https://go.paytraq.com/api/listProductsPurchased

The result list is sorted by Journal Date in ascending order.
Pagination and Date Range filter can be applied.
GET /api/listProductsPurchased? ... &page=0&date_from=2025-01-01&date_till=2025-01-31

Additional optional parameters are available for this request:
GET /api/listProductsPurchased? ... &SupplierID=0 ... &ItemID=0
SupplierID - Unique system identifier for supplier. See Get Supplier
ItemID - Unique system identifier for product. See Get Product

Response

XML / HTTP
<Purchases>
    <Purchase>
        <Document>
            <DocumentID></DocumentID>
            <DocumentDate>></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <Supplier>
                <SupplierID></SupplierID>
                <SupplierName></SupplierName>
            </Supplier>
        </Document>
        <PurchaseType></PurchaseType>
        <Journal>
            <JournalID></JournalID>
            <JournalRef></JournalRef>
            <JournalDate></JournalDate>
        </Journal>
        <Product>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
            <Qty></Qty>
            <Total>></Total>
            <Currency></Currency>
        </Product>
    </Purchase>
   </Purchases>
Tag Description
<ItemID> Unique system identifier for product. See Get Product
<Qty> Total qty for document
<Total> Total amount for document

Back to Purchases

POSTUpload File to Purchase Inbox

Request

XML / HTTP
POST https://go.paytraq.com/api/purchaseInbox/upload

The request should be sent as form-data with "file" param containing files
For XML files (Peppol/UBL, Estonian E-invoice or Paytraq XML) Paytraq Direct channel should be enabled

Parameter Description
file Files (form-data)

Response


   OK 200

Back to Purchases

GETGet Messages form Purchase Inbox

Request

XML / HTTP
GET https://go.paytraq.com/api/purchaseInbox

The result list is sorted by Date Received in descending order.
Pagination and Sorting Order filter can be applied.
GET /api/purchaseInbox? ... &page=0&reverse=true

Response

XML / HTTP
<PurchaseInbox>
      <Message>
        <Header>
            <MessageID></MessageID>
            <Received></Received>
            <Channel>
                <ChannelName></ChannelName>
                <ChannelType></ChannelType>
                <InboxAddress></InboxAddress>
            </Channel>
            <IsEInvoice></IsEInvoice>
            <Recipient></Recipient>
            <Sender></Sender>
            <IsDigitised></IsDigitised>
            <Subject></Subject>
        </Header>
        <Body>
            <Operation></Operation>
            <PurchaseType></PurchaseType>
            <DocumentID></DocumentID>
            <Employee>
              <EmployeeID></EmployeeID>
              <EmployeeName></EmployeeName>
            </Employee>
            <Supplier>
                <SupplierID></SupplierID>
                <SupplierName></SupplierName>
            </Supplier>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <ReceiptDate></ReceiptDate>
            <ReceiptRef></ReceiptRef>
            <Total>
                <Amount></Amount>
                <Currency></Currency>
            </Total>
        </Body>
        <Attachment>
            <AttachmentID></AttachmentID>
            <AttachmentUID></AttachmentUID>
            <ContentType></ContentType>
            <SignedURL></SignedURL>
        </Attachment>
      </Message>
      ...
</PurchaseInbox>

PurchaseType is not available with Operation equals "expense_claim".
DocumentID, Employee information, ReceiptDate and ReceiptRef are only available with Operation equals "expense_claim".
Recipient and Sender are only available when IsEInvoice is true.
AttachmentID, AttachmentUID, ContentType and SignedURL are only available when IsEInvoice is false.

Tag Description
<MessageID> Unique system identifier for message in purchase inbox
<Received> Date received UTC timestamp
<IsEInvoice> Boolean value (false | true)
<IsDigitised> Boolean value (false | true)
<Operation> Possible values:
  • expense_claim - Expense Claim
  • purchase_goods - Purchasing Goods
  • purchase_services - Purchasing Services
  • other_expenses - Other Expenses
<PurchaseType> Possible values:
  • purchase_order - Purchase Order
  • purchase_proforma - Proforma Invoice
  • purchase_invoice - Invoice
  • purchase_receipt - Receipt
  • debit_note - Credit Note/Refund
<DocumentID> Unique system identifier for expense claim
<SignedURL> Web link to download attachment. Valid for 15 minutes.

Back to Purchases

POSTUpdate Message in Purchase Inbox

Request

XML / HTTP
POST https://go.paytraq.com/api/purchaseInbox/update/{MessageID}
Parameter Description
MessageID Unique system identifier for message in purchase inbox

Payload

XML / HTTP
<Message>
    <Body>
       <Operation></Operation>
       <DocumentID></DocumentID>
       <PurchaseType></PurchaseType>
    </Body>        
</Message>

Only Operation and PurchaseType fields can be updated. For expense claim it is also required to specified DocumentID as Expense Claim ID where the expense will be added. Expense Claim should be in status Draft.
For expense claim PurchaseType is not required and will be ignored if provided.

Any other fields can be updated once the message is processed and converted to a document in Paytraq. For example, if the message is converted to an expense claim, the expense claim can be updated using Update Expense Claim API call or if the message is converted to a purchase invoice, the purchase invoice can be updated using Update Purchase Document API call.

Tag Description
<Operation> Possible values:
  • expense_claim - Expense Claim
  • purchase_goods - Purchasing Goods
  • purchase_services - Purchasing Services
  • other_expenses - Other Expenses
<PurchaseType> Possible values:
  • purchase_order - Purchase Order
  • purchase_proforma - Proforma Invoice
  • purchase_invoice - Invoice
  • purchase_receipt - Receipt
  • debit_note - Credit Note/Refund
<DocumentID> Unique system identifier for expense claim

Response

XML / HTTP
<Response>
        <MessageID></MessageID>
        <Operation></Operation>
        <PurchaseType></PurchaseType>
        <DocumentID></DocumentID>
</Response>

PurchaseType is not available with Operation equals "expense_claim".
DocumentID is only available with Operation equals "expense_claim".

Tag Description
<MessageID> Unique system identifier for message in purchase inbox

Back to Purchases

GETGet E-Invoice from Purchase Inbox Message

Request

XML / HTTP
GET https://go.paytraq.com/api/purchaseInbox/einvoice/{MessageID}

This API call is only available for messages with IsEInvoice equals true.
The request will return the content of the e-invoice in XML format.

Parameter Description
MessageID Unique system identifier for message in purchase inbox

Response


   XML (MIME type - application/xml)

Back to Purchases

GETProcess Message in Purchase Inbox

Request

XML / HTTP
GET https://go.paytraq.com/api/purchaseInbox/process/{MessageID}
Parameter Description
MessageID Unique system identifier for message in purchase inbox

This API call will process the message and convert it to a purchase document or an expense claim in Paytraq. The response will contain the unique system identifier for the created document or expense claim.

Response (if the message has been processed as a purchase document)

XML / HTTP
<Response>
    <Purchase>
      <DocumentID></DocumentID>
    </Purchase>
</Response>

Response (if the message has been processed as an expense claim)

XML / HTTP
<Response>
    <ExpenseClaim>
      <DocumentID></DocumentID>
    </ExpenseClaim>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document or expense claim

Back to Purchases

DELETEDelete Message from Purchase Inbox

Request

XML / HTTP
DELETE https://go.paytraq.com/api/purchaseInbox/{MessageID}
Parameter Description
MessageID Unique system identifier for message in purchase inbox

Response


   HTTP 204 No Content

Back to Purchases

Inventory Moves

GETGet Inventory Movements

Request

XML / HTTP
GET https://go.paytraq.com/api/inventoryMovements

By default result list is sorted by document date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by document number or by source or destination name.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Document date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:
GET /api/inventoryMovements? ... &BusinessPartnerID=0 ... &tag=tag_value
BusinessPartnerID - Unique system identifier for client or supplier. See Get Client or Get Supplier
tag - Filter by tag value

Response

XML / HTTP
<InventoryMovements>
   <InventoryMovement>
      <Header>
         <Document>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <BusinessPartner>
               <BusinessPartnerID></BusinessPartnerID>
               <BusinessPartnerName></BusinessPartnerName>
            </BusinessPartner>
         </Document>
         <MovementType></MovementType>
         <Operation></Operation>
         <Direction></Direction>
         <Sender>
            <WarehouseID></WarehouseID>
            <WarehouseName></WarehouseName>
         </Sender>
         <Receiver>
            <WarehouseID></WarehouseID>
            <WarehouseName></WarehouseName>
         </Receiver>
         <Warehouse>
            <WarehouseID></WarehouseID>
            <WarehouseName></WarehouseName>
         </Warehouse>
         <TimeStamps>
            <Created />
            <Updated />
         </TimeStamps>
      </Header>
   </InventoryMovement>
   ...
</InventoryMovements>
Tag Description
<DocumentID> Unique system identifier for inventory document
<DocumentRef> Document number
<DocumentType> Possible values:
  • out_shipment - Outgoing Shipment
  • in_shipment - Incoming Shipment
  • inventory - Inventory Adjustment
<DocumentStatus> Possible values:
  • wait_approve - Waiting for Approval
  • wait_invoice - Waiting for Invoice
  • wait_refund - Waiting for Refund
  • wait_delivery - Waiting for Delivery
  • in_transit - In Transit
  • issued_client - Issued to Client
  • wait_return - Waiting for Return
  • done - Done
  • in_production - In Production
  • in_process - In Progress
<BusinessPartnerID> Unique system identifier for client or supplier. See Get Client or Get Supplier
<MovementType> Possible values:
  • shipment - Shipment
  • adjustment - Inventory Adjustment
<Operation> Possible values:
  • sales_invoice - Sales Invoice
  • purchase_invoice - Purchase Invoice
  • sales_return - Sales Return/Credit Note
  • purchase_return - Purchase Return/Credit Note
  • internal - Internal Shipment
  • external - External Shipment
  • receipt - Inventory Receipt
  • write_off - Intentory Write-off
  • inventory - Physical Inventory
  • revaluation - Revaluation
  • order - Production Order
<Direction> Possible values:
  • out - Outgoing
  • in - Incoming
  • in/out - Incoming/Outgoing
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Inventory Moves

GETGet Inventory Movement

Request

XML / HTTP
GET https://go.paytraq.com/api/inventoryMovement/{DocumentID}
Parameter Description
DocumentID Unique system identifier for inventory document

Response

XML / HTTP
<InventoryMovement>
   <Header>
      <Document>
         <DocumentID></DocumentID>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <DocumentStatus></DocumentStatus>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
         </BusinessPartner>
      </Document>
      <MovementType></MovementType>
      <Operation></Operation>
      <Direction></Direction>
      <Sender>
         <WarehouseID></WarehouseID>
         <WarehouseName></WarehouseName>
      </Sender>
      <Receiver>
         <WarehouseID></WarehouseID>
         <WarehouseName></WarehouseName>
      </Receiver>
      <Warehouse>
         <WarehouseID></WarehouseID>
         <WarehouseName></WarehouseName>
      </Warehouse>
      <ShippingData>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
            <LoadingAreaName></LoadingAreaName>
            <LoadingAreaAddress>
               <Address></Address>
               <Zip></Zip>
               <Country></Country>
            </LoadingAreaAddress>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
            <ShipperName></ShipperName>
            <ShipperRegNumber />
            <ShipperVehicle />
            <ShipperDriver />
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
            <ShipTo></ShipTo>
            <Address></Address>
            <Zip></Zip>
            <Country></Country>
         </ShippingAddress>
      </ShippingData>
      <Comment />
      <Invoice>
         <DocumentLink>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
         </DocumentLink>
      </Invoice>
      <InitShipment />
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <MovementLines>
      <MovementLine>
         <MovementLineID></MovementLineID>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <UnitCost />
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
         <Direction></Direction>
         <Status></Status>
         <ActualQty />
         <InitQty />
      </MovementLine>
   </MovementLines>
   <Totals>
      <TotalCost></TotalCost>
      <Qty></Qty>
   </Totals>
   <Tags>
      <Tag />
   </Tags>
</InventoryMovement>
Tag Description
<DocumentID> Unique system identifier for document
<DocumentRef> Document number
<DocumentType> Possible values:
  • out_shipment - Outgoing Shipment
  • in_shipment - Incoming Shipment
  • inventory - Inventory Adjustment
<DocumentStatus> Possible values:
  • wait_approve - Waiting for Approval
  • wait_invoice - Waiting for Invoice
  • wait_refund - Waiting for Refund
  • wait_delivery - Waiting for Delivery
  • in_transit - In Transit
  • issued_client - Issued to Client
  • wait_return - Waiting for Return
  • done - Done
  • in_production - In Production
  • in_process - In Progress
<BusinessPartnerID> Unique system identifier for client or supplier. See Get Client or Get Supplier
<MovementType> Possible values:
  • shipment - Shipment
  • adjustment - Inventory Adjustment
<Operation> Possible values:
  • sales_invoice - Sales Invoice
  • purchase_invoice - Purchase Invoice
  • sales_return - Sales Return/Credit Note
  • purchase_return - Purchase Return/Credit Note
  • internal - Internal Shipment
  • external - External Shipment
  • receipt - Inventory Receipt
  • write_off - Intentory Write-off
  • inventory - Physical Inventory
  • revaluation - Revaluation
  • order - Production Order
<Direction> Possible values:
  • out - Outgoing
  • in - Incoming
  • in/out - Incoming/Outgoing
<WarehouseID> Unique system identifier for warehouse. See Get Warehouse
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<ItemID> Unique system identifier for product. See Get Product
<ItemCode> Product SKU. See Get Product By Code
<LotID> Unique system identifier for lot
<UnitID> Unique system identifier for unit of measure. See Get Unit

Back to Inventory Moves

POSTAdd Shipment

Request

XML / HTTP
POST https://go.paytraq.com/api/shipment

Payload

XML / HTTP
<InventoryMovement>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
         </BusinessPartner>
      </Document>
      <Operation></Operation>
      <Receiver>
         <WarehouseID></WarehouseID>
      </Receiver>
      <Warehouse>
         <WarehouseID></WarehouseID>
      </Warehouse>
      <ShippingData>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Comment />
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <MovementLines>
      <MovementLine>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <UnitCost />
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
         <OrderLineID></OrderLineID>
      </MovementLine>
   </MovementLines>
</InventoryMovement>

Only <DocumentType> and <Operation> are required.
To add a partner <BusinessPartnerID /> OR <BusinessPartnerName /> should be provided.
To add an item <ItemID /> OR <ItemCode /> OR <ItemName /> should be provided.
To add a lot <LotID /> OR <LotNumber /> should be provided.
To add a unit <UnitID /> OR <UnitName /> should be provided.
<Receiver /> is required for Internal Transfer only.
<OrderLineID /> can be provided to link a shipment line with an existing sales or purchase order line by LineItemID.
For tags description please refer to Get Inventory Movement.

Tag Description
<DocumentType> Possible values:
  • out_shipment - Outgoing Shipment
  • in_shipment - Incoming Shipment
<Operation> Possible values:
  • sales_invoice - Sales Invoice
  • purchase_invoice - Purchase Invoice
  • sales_return - Sales Return/Credit Note
  • purchase_return - Purchase Return/Credit Note
  • internal - Internal Shipment
  • external - External Shipment

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for document

Back to Inventory Moves

POSTUpdate Shipment

Request

XML / HTTP
POST https://go.paytraq.com/api/shipment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Payload

XML / HTTP
<InventoryMovement>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
         </BusinessPartner>
      </Document>
      <Receiver>
         <WarehouseID></WarehouseID>
      </Receiver>
      <Warehouse>
         <WarehouseID></WarehouseID>
      </Warehouse>
      <ShippingData>
         <LoadingArea>
            <LoadingAreaID></LoadingAreaID>
         </LoadingArea>
         <Shipper>
            <ShipperID></ShipperID>
         </Shipper>
         <ShippingAddress>
            <AddressID></AddressID>
         </ShippingAddress>
      </ShippingData>
      <Comment />
   </Header>
   <CustomData>
      <CustomField>
         <FieldName></FieldName>
         <FieldValue></FieldValue>
      </CustomField>
      ...
   </CustomData>
   <MovementLines>
      <MovementLine>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <UnitCost />
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
         <OrderLineID></OrderLineID>
      </MovementLine>
   </MovementLines>
</InventoryMovement>

Only documents with status Waiting for Approval can be updated.
No tags are required.
For tags description please refer to Get Inventory Movement.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

GETApprove Shipment

Request

XML / HTTP
GET https://go.paytraq.com/api/shipmentApprove/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Only documents with status Waiting for Approval can be approved.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

POSTAdd Inventory Adjustment

Request

XML / HTTP
POST https://go.paytraq.com/api/inventoryAdjustment

Payload

XML / HTTP
<InventoryMovement>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
      </Document>
      <Operation></Operation>
      <Warehouse>
         <WarehouseID></WarehouseID>
      </Warehouse>
      <Comment />
      <OpeningBalances></OpeningBalances>
   </Header>
   <MovementLines>
      <MovementLine>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <ActualQty></ActualQty>
         <UnitCost />
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
      </MovementLine>
   </MovementLines>
</InventoryMovement>

Only <Operation> are required.
To add an item <ItemID /> OR <ItemCode /> OR <ItemName /> should be provided.
To add a lot <LotID /> OR <LotNumber /> should be provided.
To add a unit <UnitID /> OR <UnitName /> should be provided.

For Physical Inventory <ActualQty /> is required. It should be provided in place of <Qty />.

<OpeningBalances /> can be only provided for Inventory Receipt or Physical Inventory. It can be set to true to indicate that the document is an opening balance document. It can be set to false or omitted for all other operations.

Production Order is added in 2 steps. First, the outgoing part (product write-off) is added. Then the Inventory Adjustment approval is required. The status will be updated to In Production. After that, the incoming part (product receipt) can be added. Then the next Inventory Adjustment approval will update the status to Done.

For tags description please refer to Get Inventory Movement.

Tag Description
<Operation> Possible values:
  • receipt - Inventory Receipt
  • write_off - Inventory Write-off
  • inventory - Physical Inventory
  • order - Production Order

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for document

Back to Inventory Moves

POSTUpdate Inventory Adjustment

Request

XML / HTTP
POST https://go.paytraq.com/api/inventoryAdjustment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Payload

XML / HTTP
<InventoryMovement>
   <Header>
      <Document>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
      </Document>
      <Warehouse>
         <WarehouseID></WarehouseID>
      </Warehouse>
      <Comment />
      <OpeningBalances></OpeningBalances>
   </Header>
   <MovementLines>
      <MovementLine>
         <Item>
            <ItemID></ItemID>
            <ItemCode />
            <ItemName></ItemName>
         </Item>
         <ItemLot>
            <LotID></LotID>
            <LotNumber></LotNumber>
         </ItemLot>
         <ItemDescription></ItemDescription>
         <Qty></Qty>
         <ActualQty></ActualQty>
         <UnitCost />
         <Unit>
            <UnitID></UnitID>
            <UnitName></UnitName>
         </Unit>
      </MovementLine>
   </MovementLines>
</InventoryMovement>

Only documents with status Waiting for Approval can be updated except for Production Order which can be also updated when status is In Production (for the incoming part).
No tags are required.
For tags description please refer to Get Inventory Movement.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

GETApprove Inventory Adjustment

Request

XML / HTTP
GET https://go.paytraq.com/api/inventoryAdjustmentApprove/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Only documents with status Waiting for Approval can be approved except for Production Order which can be also approved when status is In Production (for the incoming part).

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

Money

GETGet Bank Accounts

Request

XML / HTTP
GET https://go.paytraq.com/api/bankAccounts

Response

XML / HTTP
<BankAccounts>
   <BankAccount>
      <BankAccountID></BankAccountID>
      <Name></Name>
      <Currency></Currency>
      <GLAccount>
         <AccountID></AccountID>
         <AccountCode />
         <AccountName></AccountName>
      </GLAccount>
      <Type></Type>
      <BankAccountNumber />
      <BankName />
      <BankCode />
      <IsInactive></IsInactive>
      <IsDefault></IsDefault>
      <Balance></Balance>
   </BankAccount>
   ...
</BankAccounts>
Tag Description
<BankAccountID> Unique system identifier for money account
<Currency> Currency code
<AccountID> Unique system identifier for account. See Get Account
<Type> Possible values:
  • bank - Bank Account
  • card - Credit Card
  • merchant - Merchant Account
  • paypal - PayPal Account
  • other - Other Money Account
<IsInactive> Boolean value (false | true)
<IsDefault> Boolean value (false | true)

Back to Money

GETGet Cash Accounts

Request

XML / HTTP
GET https://go.paytraq.com/api/cashAccounts

Response

XML / HTTP
<CashAccounts>
   <CashAccount>
      <CashAccountID></CashAccountID>
      <Name></Name>
      <Currency></Currency>
      <GLAccount>
         <AccountID></AccountID>
         <AccountCode />
         <AccountName></AccountName>
      </GLAccount>
      <Type></Type>
      <IsInactive></IsInactive>
      <IsDefault></IsDefault>
      <Balance />
   </CashAccount>
   ...
</CashAccounts>
Tag Description
<CashAccountID> Unique system identifier for money account
<Currency> Currency code
<AccountID> Unique system identifier for account. See Get Account
<Type> Possible values:
  • cashbook - Cashbook
  • pos - Point of Sale / Cash Account
  • other - Other Money Account
<IsInactive> Boolean value (false | true)
<IsDefault> Boolean value (false | true)

Back to Money

GETGet Money Account Transactions

Request

XML / HTTP
GET https://go.paytraq.com/api/money/transactions/{MoneyAccountID}
Parameter Description
MoneyAccountID Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts

Pagination and Date Range filter can be applied.
GET /api/money/transactions/{MoneyAccountID}? ... &page=0 ... &date_from=2025-01-01&date_till=2025-01-31

Additional optional parameter are available for this request:
GET /api/money/transactions/{MoneyAccountID}? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee

Response

XML / HTTP
<Transactions>
   <Transaction>
      <TransactionDate></TransactionDate>
      <JournalID></JournalID>
      <JournalRef></JournalRef>
      <JournalStatus></JournalStatus>
      <JournalType>
         <JournalTypeID></JournalTypeID>
         <JournalTypeName></JournalTypeName>
      </JournalType>
      <Narration />
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
         <DocumentDate></DocumentDate>
      </DocumentLink>
      <ExtReference></ExtReference>
      <BusinessPartner>
         <BusinessPartnerID></BusinessPartnerID>
         <BusinessPartnerName></BusinessPartnerName>
      </BusinessPartner>
      <IsApproved></IsApproved>
      <IsManual></IsManual>
      <IsCompressed></IsCompressed>
      <Description></Description>
      <TransactionAmount></TransactionAmount>
      <IsReconciled></IsReconciled>
      <BankTransaction>
         <BankStatementLineID />
         <BankTransactionID />
         <BankTransactionDetails />
      </BankTransaction>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Transaction>
   ...
</Transactions>
Tag Description
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<JournalStatus> Possible values:
  • P - Posted
  • R - Reversed
  • V - Voided
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<BusinessPartnerID> Unique system identifier for business partner e.g. client, supplier or employee. See Get Client, Get Supplier or Get Employee
<IsApproved> Boolean value (false | true)
<IsManual> Boolean value (false | true)
<IsCompressed> Boolean value (false | true)
<TransactionAmount> Transaction amount (Money In / Money Out)
<IsReconciled> Boolean value (false | true)
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Money

GETGet Payments

Request

XML / HTTP
GET https://go.paytraq.com/api/payments

By default result list is sorted by document date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by document number or business partner name.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Payment date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:
GET /api/payments? ... &BusinessPartnerID=0 ... &tag=tag_value
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee
tag - Filter by tag value

Response

XML / HTTP
<Payments>
   <Payment>
      <Header>
         <Document>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
            <DocumentStatus></DocumentStatus>
            <BusinessPartner>
               <BusinessPartnerID></BusinessPartnerID>
               <BusinessPartnerName></BusinessPartnerName>
               <BankInfo>
                  <BankAccount></BankAccount>
                  <BankName></BankName>
                  <BankCode></BankCode>
               </BankInfo>
            </BusinessPartner>
         </Document>
         <PaymentType></PaymentType>
         <Operation></Operation>
         <PaymentAmount></PaymentAmount>
         <BalanceAmount><lt;/BalanceAmount>
         <PaymentCurrency></PaymentCurrency>
         <BalanceCurrency></BalanceCurrency>
         <CurrencyRate></CurrencyRate>
         <MoneyAccount>
            <MoneyAccountID></MoneyAccountID>
            <MoneyAccountName></MoneyAccountName>
            <MoneyAccountCurrency></MoneyAccountCurrency>
            <GLAccount>
               <AccountID></AccountID>
               <AccountCode />
               <AccountName>Bank</AccountName>
            </GLAccount>
            <Type></Type>
            <BankAccountNumber />
            <BankName />
            <BankCode />
         </MoneyAccount>
         <IsBankCharge></IsBankCharge>
         <IsTransfer></IsTransfer>
         <Narration></Narration>
         <TimeStamps>
            <Created />
            <Updated />
         </TimeStamps>
      </Header>
   </Payment>
   ...
</Payments>
Tag Description
<DocumentID> Unique system identifier for payment document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • done - Done
<BusinessPartnerID> Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee
<PaymentType> Possible values:
  • bank_in - Incoming Bank Payment
  • bank_out - Outgoing Bank Payment
  • cash_in - Incoming Cash Payment
  • cash_out - Outgoing Cash Payment
  • cash_dr_voucher - Cash Debit Voucher
  • cash_cr_voucher- Cash Credit Voucher
<Operation> Possible values:
  • out - Outgoing
  • in - Incoming
<PaymentCurrency> Currency code
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts
<Type> Possible values:
  • bank - Bank Account
  • card - Credit Card
  • merchant - Merchant Account
  • paypal - PayPal Account
  • cashbook - Cashbook
  • pos - Point of Sale / Cash Account
  • other - Other Money Account
<IsBankCharge> Boolean value (false | true)
<IsTransfer> Boolean value (false | true)
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Money

GETGet Payment

Request

XML / HTTP
GET https://go.paytraq.com/api/payment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for payment document

Response

XML / HTTP
<Payment>
   <Header>
      <Document>
         <DocumentID></DocumentID>
         <DocumentDate></DocumentDate>
         <DocumentRef></DocumentRef>
         <DocumentType></DocumentType>
         <DocumentStatus></DocumentStatus>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
            <BankInfo>
               <BankAccount></BankAccount>
               <BankName></BankName>
               <BankCode></BankCode>
            </BankInfo>
         </BusinessPartner>
      </Document>
      <PaymentType></PaymentType>
      <Operation></Operation>
      <PaymentAmount></PaymentAmount>
      <BalanceAmount></BalanceAmount>
      <PaymentCurrency></PaymentCurrency>
      <BalanceCurrency></BalanceCurrency>
      <CurrencyRate></CurrencyRate>
      <MoneyAccount>
         <MoneyAccountID></MoneyAccountID>
         <MoneyAccountName></MoneyAccountName>
         <MoneyAccountCurrency></MoneyAccountCurrency>
         <GLAccount>
            <AccountID></AccountID>
            <AccountCode />
            <AccountName></AccountName>
         </GLAccount>
         <Type></Type>
         <BankAccountNumber />
         <BankName />
         <BankCode />
      </MoneyAccount>
      <IsBankCharge></IsBankCharge>
      <IsTransfer></IsTransfer>
      <Narration></Narration>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Header>
   <PaymentLines>
      <PaymentLine>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <PaymentAmount></PaymentAmount>
         <BalanceAmount></BalanceAmount>
         <PaymentCurrency></PaymentCurrency>
         <BalanceCurrency></BalanceCurrency>
         <Description></Description>
         <DocumentLink>
            <DocumentID></DocumentID>
            <DocumentDate></DocumentDate>
            <DocumentRef></DocumentRef>
            <DocumentType></DocumentType>
         </DocumentLink>
      </PaymentLine>
      ...
   </PaymentLines>
   <Journals>
      <Journal>
         <JournalID></JournalID>
         <JournalRef></JournalRef>
         <JournalDate></JournalDate>
         <JournalStatus></JournalStatus>
         <JournalType>
            <JournalTypeID></JournalTypeID>
            <JournalTypeName></JournalTypeName>
         </JournalType>
      </Journal>
      ...
   </Journals>
   <Tags>
      <Tag />
   </Tags>
</Payment>
Tag Description
<DocumentID> Unique system identifier for document
<DocumentRef> Document number
<DocumentStatus> Possible values:
  • draft - Draft
  • done - Done
<BusinessPartnerID> Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee
<PaymentType> Possible values:
  • bank_in - Incoming Bank Payment
  • bank_out - Outgoing Bank Payment
  • cash_in - Incoming Cash Payment
  • cash_out - Outgoing Cash Payment
  • cash_dr_voucher - Cash Debit Voucher
  • cash_cr_voucher- Cash Credit Voucher
<Operation> Possible values:
  • out - Outgoing
  • in - Incoming
<PaymentCurrency> Currency code
<MoneyAccountID> Unique system identifier for bank or cash account. See Get Bank Accounts and Get Cash Accounts
<Type> Possible values:
  • bank - Bank Account
  • card - Credit Card
  • merchant - Merchant Account
  • paypal - PayPal Account
  • cashbook - Cashbook
  • pos - Point of Sale / Cash Account
  • other - Other Money Account
<IsBankCharge> Boolean value (false | true)
<IsTransfer> Boolean value (false | true)
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<AccountID> Unique system identifier for account. See Get Account

Back to Money

POSTAdd Payment

Request

XML / HTTP
POST https://go.paytraq.com/api/payment

Payload

XML / HTTP
<Payment>
   <Header>
      <Document>
         <DocumentDate><DocumentDate>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
            <BankInfo>
              <BankInfoID></BankInfoID>
            </BankInfo>
         </BusinessPartner>
      </Document>
      <Operation></Operation>
      <PaymentAmount></PaymentAmount>
      <MoneyAccount>
         <MoneyAccountID></MoneyAccountID>
      </MoneyAccount>
      <Narration></Narration>
      <Project>
         <ProjectName />
      </Project>
   </Header>       
   <PaymentLines>
      <PaymentLine>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
         </Account>
         <PaymentAmount></PaymentAmount>
         <PaymentCurrency></PaymentCurrency>
         <Description></Description>
         <DocumentLink>
            <DocumentID>></DocumentID>
         </DocumentLink>
      </PaymentLine>
      ...
   </PaymentLines>
</Payment>

Only <MoneyAccountID>, <Operation> and <PaymentAmount> are required.
Document level PaymentCurrency is inherited from money account. Payment line level PaymentCurrency is inherited from document, passed explicitly or inherited from money account if not defined and payment line is not based on document.
Operation - Possible values: in - Incoming, out - Outgoing
Normally PaymentAmount should be positive. If payment line is based on documents, <PaymentAmount> should be equal or less than the document due amount.
To add a business partner <BusinessPartnerID /> OR <BusinessPartnerName /> should be provided.
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee
If the payment line is based on documents, <DocumentID /> should be provided in <DocumentLink>. Account and PaymentCurrency is inherited from the document and can be left blank. Description will be ignored. Provided document should be issued to the same business partner as payment document.
If the payment is based on GL accounts, <AccountID /> OR <AccountCode /> should be provided in <Account>. DocumentLink should not be provided. Description is optional. PaymentCurrency can be left blank and will be inherited from the payment document.

For other tags description please refer to Get Payment.

For payments with multiple currencies, balance amounts are calculated automatically in the balance currency based on the system currency rate. Balance amount of the payment document should be equal to the sum of balance amounts of all payment lines. Otherwise the response will return <Unbalanced> / <PaymentAmount> which can be added to the payment lines as a new line with a corresponding account for correction by calling Update Payment request.

Response (Balanced)

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>

Response (Unbalanced)

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <Unbalanced>
        <PaymentAmount></PaymentAmount>
        <PaymentCurrency><PaymentCurrency>
   </Unbalanced>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document

Back to Money

POSTUpdate Payment

Request

XML / HTTP
POST https://go.paytraq.com/api/payment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for payment document

Payload

XML / HTTP
<Payment>
   <Header>
      <Document>
         <DocumentDate><DocumentDate>
         <BusinessPartner>
            <BusinessPartnerID></BusinessPartnerID>
            <BusinessPartnerName></BusinessPartnerName>
            <BankInfo>
              <BankInfoID></BankInfoID>
            </BankInfo>
         </BusinessPartner>
      </Document>
      <PaymentAmount></PaymentAmount>
      <Narration></Narration>
      <Project>
         <ProjectName />
      </Project>
   </Header>       
   <PaymentLines>
      <PaymentLine>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
         </Account>
         <PaymentAmount></PaymentAmount>
         <PaymentCurrency></PaymentCurrency>
         <Description></Description>
         <DocumentLink>
            <DocumentID>></DocumentID>
         </DocumentLink>
      </PaymentLine>
      ...
   </PaymentLines>
</Payment>

Only documents with status Draft can be updated.
MoneyAccount and Operation cannot be updated.
No tags are required.

Please see Add Payment for description of the payload.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document

Back to Money

GETPost Payment

Request

XML / HTTP
GET https://go.paytraq.com/api/paymentPost/{DocumentID}

Parameter Description
DocumentID Unique system identifier for payment document

Only documents with status Draft can be posted.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for payment document

Back to Money

POSTUpload a Bank Statement

Request

XML / HTTP
POST https://go.paytraq.com/api/bankStatementUpload/{BankAccountID}
Parameter Description
BankAccountID Unique system identifier for bank account. See Get Bank Accounts

Payload

XML / HTTP
<BankStatement>
   <Transactions>
      <Transaction>
         <Date></Date>
         <TransactionID></TransactionID>
         <Counterparty>
            <Name></Name>
            <LegalID></LegalID>
            <AccountNumber></AccountNumber>
         </Counterparty>
         <PaymentDetails></PaymentDetails>
         <Amount></Amount>
      </Transaction>
      ...
   </Transactions>
</BankStatement>
Tag Description
<TransactionID> Bank transaction reference
<Amount> Positive or negative transaction amount. Amount should be in the same currency as the currency of the provided bank account

Only <Date> and <Amount> are required.

Response

XML / HTTP
<Response>
   <TotalTransactions></TotalTransactions>
   <MoneyOut></MoneyOut>
   <MoneyIn></MoneyyIn>
</Response>
Tag Description
<TotalTransactions> Total number of uploaded transactions
<MoneyOut> Total amount of outgoing transactions
<MoneyIn> Total amount of incoming transactions

Back to Money

GETGet Bank Statement Lines

Request

XML / HTTP
GET https://go.paytraq.com/api/bank/statement/transactions/{BankAccountID}
Parameter Description
BankAccountID Unique system identifier for bank account. See Get Bank Accounts

Pagination and Date Range filter can be applied.
Results can be filtered by payment details, counterpary name or counterparty account by applying &query parameter.
GET /api/bank/statement/transactions/{BankAccountID}? ... &page=0& ... date_from=2025-01-01&date_till=2025-01-31 ... &query=PaymentDetails

Additional optional parameter are available for this request:
GET /api/bank/statement/transactions/{BankAccountID}? ... &is_reconciled=false
is_reconciled - Filter by reconciled or unreconciled bank statement lines. Boolean value (false | true).

Response

XML / HTTP
<BankStatement>
  <Transactions>
    <Transaction>
      <BankStatementLineID></BankStatementLineID>
      <Date></Date>
      <TransactionID></TransactionID>
      <Counterparty>
          <Name></Name>
          <LegalID></LegalID>
          <AccountNumber><AccountNumber>
      </Counterparty>
      <PaymentDetails></PaymentDetails>
      <Amount></Amount>
      <Reconciliation>
          <IsReconciled></IsReconciled>
          <JournalID></JournalID>
          <JournalRef></JournalRef>
      </Reconciliation>
      <isBankCharge></isBankCharge>
      <CPartyLabel></CPartyLabel>
      <InitialFormat></InitialFormat>
      <TimeStamps>
          <Created />
      </TimeStamps>
    </Transaction>
    ...
  </Transactions>
</BankStatement>
Tag Description
<BankStatementLineID> Unique system identifier for bank statement line
<TransactionID> Bank transaction reference
<Amount> Positive or negative transaction amount
<Amount> Positive or negative transaction amount
<IsReconciled> Reconciled status. Boolean value (false | true)
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<Created> Date uploaded UTC timestamp

Back to Money

GETGet Bank Statement Line

Request

XML / HTTP
GET https://go.paytraq.com/api/bank/statement/transaction/{BankStatementLineID}
Parameter Description
BankStatementLineID Unique system identifier for bank statement line

Response

XML / HTTP
<BankStatement>
    <Transaction>
      <BankStatementLineID></BankStatementLineID>
      <Date></Date>
      <TransactionID></TransactionID>
      <Counterparty>
          <Name></Name>
          <LegalID></LegalID>
          <AccountNumber><AccountNumber>
      </Counterparty>
      <PaymentDetails></PaymentDetails>
      <Amount></Amount>
      <Reconciliation>
          <IsReconciled></IsReconciled>
          <JournalID></JournalID>
          <JournalRef></JournalRef>
      </Reconciliation>
      <isBankCharge></isBankCharge>
      <CPartyLabel></CPartyLabel>
      <InitialFormat></InitialFormat>
      <TimeStamps>
          <Created />
      </TimeStamps>
    </Transaction>
</BankStatement>
Tag Description
<BankStatementLineID> Unique system identifier for bank statement line
<TransactionID> Bank transaction reference
<Amount> Positive or negative transaction amount
<Amount> Positive or negative transaction amount
<IsReconciled> Reconciled status. Boolean value (false | true)
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<Created> Date uploaded UTC timestamp

Back to Money

GETStart Auto-Reconciliation

Request

XML / HTTP
GET https://go.paytraq.com/api/bank/start/reconciliation/{BankAccountID}
Parameter Description
BankAccountID Unique system identifier for bank account. See Get Bank Accounts

Response

XML / HTTP

     <Process>
       <ProcessID></ProcessID>
       <Status>running</Status>
       <Type>reconciliation</Type>
     </Process>
Tag Description
<ProcessID> Unique system identifier for started system process
<Status> System process status. Possible values: running, done
Reconciliation current status can be checked by calling Get System Process API call.

Back to Money

Accounting

GETGet Business Partners

Request

XML / HTTP
GET https://go.paytraq.com/api/businessPartners

By default result list is sorted by partner name in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by partner name or email.
This result list can be checked for new records and updates. See Optional parameters for additional info.

Additional optional parameters are available for this request:
tag - Filter by tag value

Response

XML / HTTP
<BusinessPartners>
   <BusinessPartner>
      <BusinessPartnerID></BusinessPartnerID>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <RelationTypes>
         <IsClient />
         <IsSupplier />
         <IsEmployee />
         <IsBank />
         <IsTaxingAuthority />
         <IsOther />
      </RelationTypes>
      <ReconciliationName />
      <HasStructuredReference />
      <Project>
        <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </BusinessPartner>
   ...
</BusinessPartners>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

GETGet Business Partner

Request

XML / HTTP
GET https://go.paytraq.com/api/businessPartners/{BusinessPartnerID}
Parameter Description
BusinessPartnerID Unique system identifier for business partner

Response

XML / HTTP
<BusinessPartner>
      <BusinessPartnerID></BusinessPartnerID>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <RelationTypes>
         <IsClient />
         <IsSupplier />
         <IsEmployee />
         <IsBank />
         <IsTaxingAuthority />
         <IsOther />
      </RelationTypes>
      <ReconciliationName />
      <HasStructuredReference />
      <Project>
        <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
     <Tags>
      <Tag />
     </Tags>
</BusinessPartner>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner
<Type> Possible values:
  • 1 - Individual
  • 2 - Corporate
<Status> Possible values:
  • 2 - Active
  • 3 - Inactive
<Country> 2-letter ISO country code
<InvoiceInfo> Additional Invoice Info
<IsClient> Indicates if the business partner is a client. Boolean value (false | true)
See Get Client Request
<IsSupplier> Indicates if the business partner is a supplier. Boolean value (false | true)
See Get Supplier Request
<IsEmployee> Indicates if the business partner is an employee. Boolean value (false | true)
See Get Employee Request
<IsBank> Indicates if the business partner is a bank. Boolean value (false | true)
<IsTaxingAuthority> Indicates if the business partner is a taxing authority. Boolean value (false | true)
<IsOther> Indicates if the business partner is another type. Boolean value (false | true)
<HasStructuredReference> Structured reference in payment export. Boolean value (false | true). Default is false.
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

POSTAdd Business Partner

Request

XML / HTTP
POST https://go.paytraq.com/api/businessPartner

Payload

XML / HTTP
<BusinessPartner>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <RelationTypes>
         <IsClient />
         <IsSupplier />
         <IsEmployee />
         <IsBank />
         <IsTaxingAuthority />
         <IsOther />
      </RelationTypes>
      <ReconciliationName />
      <HasStructuredReference />
      <Project>
        <ProjectName />
      </Project>
</BusinessPartner>

Only <Name> is required.
For tags description please refer to Get Business Partner request.

Response

XML / HTTP
<Response>
   <BusinessPartnerID></BusinessPartnerID>
</Response>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner

Back to Accounting

POSTUpdate Business Partner

Request

XML / HTTP
POST https://go.paytraq.com/api/businessPartner/{BusinessPartnerID}
Parameter Description
BusinessPartnerID Unique system identifier for business partner

Payload

XML / HTTP
<BusinessPartner>
      <Name />
      <Email />
      <Type></Type>
      <Status></Status>
      <RegNumber />
      <VatNumber />
      <LegalAddress>
         <Address />
         <Zip />
         <Country></Country>
      </LegalAddress>
      <Phone />
      <RelationTypes>
         <IsClient />
         <IsSupplier />
         <IsEmployee />
         <IsBank />
         <IsTaxingAuthority />
         <IsOther />
      </RelationTypes>
      <ReconciliationName />
      <HasStructuredReference />
      <Project>
        <ProjectName />
      </Project>
</BusinessPartner>

No tags are required.
For tags description please refer to Get Business Partner request.

Response

XML / HTTP
<Response>
   <BusinessPartnerID></BusinessPartnerID>
</Response>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner

Back to Accounting

GETGet Tax Keys

Request

XML / HTTP
GET https://go.paytraq.com/api/taxKeys

Response

XML / HTTP
<TaxKeys>
   <TaxKey>
      <TaxKeyID></TaxKeyID>
      <Name></Name>
      <TaxName />
      <EffectiveRate></EffectiveRate>
      <IsDefault></IsDefault>
      <TaxGroup>
         <TaxGroupID></TaxGroupID>
         <TaxGroupName></TaxGroupName>
         <IsInput></IsInput>
         <IsOutput></IsOutput>
         <IsECSales></IsECSales>
         <IsECPurchases></IsECPurchases>
         <IsImport></IsImport>
         <IsOSS></IsOSS>
         <IsCrossBorder></IsCrossBorder>
         <IsStandardRate></IsStandardRate>
      </TaxGroup>
      <Description />
      <IsInactive></IsInactive>
      <Country></Country>
      <TaxNumber></TaxNumber>
   </TaxKey>
   ...
</TaxKeys>
Tag Description
<TaxKeyID> Unique system identifier for tax key
<EffectiveRate> Effective Tax Rate
<IsDefault> Boolean value (false | true)
<TaxGroupID> Unique system identifier for tax group
<IsInput> Boolean value (false | true)
<IsOutput> Boolean value (false | true)
<IsECSales> Boolean value (false | true)
<IsECPurchases> Boolean value (false | true)
<IsImport> Boolean value (false | true)
<IsOSS> Boolean value (false | true)
<IsCrossBorder> Boolean value (false | true)
<IsStandardRate> Boolean value (false | true)
<IsInactive> Boolean value (false | true)
<Country> 2-letter ISO country code

Back to Accounting

GETGet Tax Key

Request

XML / HTTP
GET https://go.paytraq.com/api/taxKey/{TaxKeyID}

Parameter Description
TaxKeyID Unique system identifier for tax key

Response

XML / HTTP
<TaxKey>
   <TaxKeyID></TaxKeyID>
   <Name></Name>
   <TaxName />
   <EffectiveRate></EffectiveRate>
   <IsDefault></IsDefault>
   <TaxGroup>
      <TaxGroupID></TaxGroupID>
      <TaxGroupName></TaxGroupName>
      <IsInput></IsInput>
      <IsOutput></IsOutput>
      <IsECSales></IsECSales>
      <IsECPurchases></IsECPurchases>
      <IsImport></IsImport>
      <IsOSS></IsOSS>
      <IsCrossBorder></IsCrossBorder>
      <IsStandardRate></IsStandardRate>
   </TaxGroup>
   <Description />
   <IsInactive></IsInactive>
   <Country></Country>
   <TaxNumber></TaxNumber>
   <Rates>
      <Rate>
         <RateID></RateID>
         <TaxName></TaxName>
         <TaxRate></TaxRate>
         <IsReverseTax></IsReverseTax>
         <SysTaxName></SysTaxName>
         <TaxAccountID></TaxAccountID>
         <TaxHoldAccountID></TaxHoldAccountID>
         <TaxExpenseAccountID />
      </Rate>
   </Rates>
</TaxKey>
Tag Description
<TaxKeyID> Unique system identifier for tax key
<EffectiveRate> Effective Tax Rate
<IsDefault> Boolean value (false | true)
<TaxGroupID> Unique system identifier for tax group
<IsInput> Boolean value (false | true)
<IsOutput> Boolean value (false | true)
<IsECSales> Boolean value (false | true)
<IsECPurchases> Boolean value (false | true)
<IsImport> Boolean value (false | true)
<IsOSS> Boolean value (false | true)
<IsCrossBorder> Boolean value (false | true)
<IsStandardRate> Boolean value (false | true)
<IsInactive> Boolean value (false | true)
<Country> 2-letter ISO country code
<IsReverseTax> Boolean value (false | true)
<TaxAccountID> Unique system identifier for tax payable account. See Get Account
<TaxHoldAccountID> Unique system identifier for tax holding account. See Get Account

Back to Accounting

GETGet Accounts

Request

XML / HTTP
GET https://go.paytraq.com/api/accounts

Result list is sorted by account code and account name in ascending order.
Optional query parameters is available. Results can be filtered by account code or account name. Pagination is not needed.

Response

XML / HTTP
<Accounts>
   <Account>
      <AccountID></AccountID>
      <Code></Code>
      <Name></Name>
      <Alias></Alias>
      <ENName></ENName>
      <AccountGroup>
         <AccountGroupID></AccountGroupID>
         <AccountGroupType></AccountGroupType>
         <AccountGroupBalanceType></AccountGroupBalanceType>
         <AccountGroupBalanceSubType></AccountGroupBalanceSubType>
      </AccountGroup>
      <AccountType></AccountType>
      <IsInactive></IsInactive>
   </Account>
   ...
</Accounts>
Tag Description
<AccountID> Unique system identifier for account
<Code> Account Code
<AccountGroupID> Unique system identifier for account group
<AccountGroupBalanceType> Possible values:
  • A - Assets
  • L - Liabilities
  • N - Nominal
<AccountType> Possible values:
  • DR - Debit
  • CR - Credit
<IsInactive> Boolean value (false | true)

Back to Accounting

GETGet Account

Request

XML / HTTP
GET https://go.paytraq.com/api/account/{AccountID}
Parameter Description
AccountID Unique system identifier for account

Response

XML / HTTP
<Account>
   <AccountID></AccountID>
   <Code></Code>
   <Name></Name>
   <Alias></Alias>
   <ENName></ENName>
   <AccountGroup>
      <AccountGroupID></AccountGroupID>
      <AccountGroupType></AccountGroupType>
      <AccountGroupBalanceType></AccountGroupBalanceType>
      <AccountGroupBalanceSubType></AccountGroupBalanceSubType>
   </AccountGroup>
   <AccountType></AccountType>
   <IsInactive></IsInactive>
</Account>
Tag Description
<AccountID> Unique system identifier for account
<Code> Account Code
<AccountGroupID> Unique system identifier for account group
<AccountGroupBalanceType> Possible values:
  • A - Assets
  • L - Liabilities
  • N - Nominal
<AccountType> Possible values:
  • DR - Debit
  • CR - Credit
<IsInactive> Boolean value (false | true)

Back to Accounting

GETGet Account By Code

Request

XML / HTTP
GET https://go.paytraq.com/api/accountByCode/{Code}
Parameter Description
Code Account Code

Response

XML / HTTP
<Account>
   <AccountID></AccountID>
   <Code></Code>
   <Name></Name>
   <Alias></Alias>
   <AccountGroup>
      <AccountGroupID></AccountGroupID>
      <AccountGroupType></AccountGroupType>
      <AccountGroupBalanceType></AccountGroupBalanceType>
      <AccountGroupBalanceSubType></AccountGroupBalanceSubType>
   </AccountGroup>
   <AccountType></AccountType>
   <IsInactive></IsInactive>
</Account>
Tag Description
<AccountID> Unique system identifier for account
<Code> Account Code
<AccountGroupID> Unique system identifier for account group
<AccountGroupBalanceType> Possible values:
  • A - Assets
  • L - Liabilities
  • N - Nominal
<AccountType> Possible values:
  • DR - Debit
  • CR - Credit
<IsInactive> Boolean value (false | true)

Back to Accounting

GETGet Account Journals

Request

XML / HTTP
GET https://go.paytraq.com/api/accountJournals/{AccountID}
Parameter Description
AccountID Unique system identifier for account. See Get Account

Pagination and Date Range filter can be applied.
GET /api/accountJournals/{AccountID}? ... &page=0& ... date_from=2025-01-01&date_till=2025-01-31

Additional optional parameters are available for this request:
GET /api/accountJournals/{AccountID}? ... &BusinessPartnerID=0&currency=USD
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee
currency - Currency code

Response

XML / HTTP
<Journals>
   <Journal>
      <JournalID></JournalID>
      <JournalRef></JournalRef>
      <JournalDate></JournalDate>
      <JournalStatus></JournalStatus>
      <JournalType>
         <JournalTypeID></JournalTypeID>
         <JournalTypeName></JournalTypeName>
      </JournalType>
      <Currency></Currency>
      <Narration />
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
         <DocumentDate></DocumentDate>
      </DocumentLink>
      <ExtReference></ExtReference>
      <BusinessPartner>
         <BusinessPartnerID></BusinessPartnerID>
         <BusinessPartnerName></BusinessPartnerName>
      </BusinessPartner>
      <IsApproved></IsApproved>
      <IsManual></IsManual>
      <IsCompressed></IsCompressed>
      <JournalEntry>
         <Description></Description>
         <Amounts>
            <AmountJournal></AmountJournal>
            <CurrencyJournal></CurrencyJournal>
            <AmountBalance></AmountBalance>
            <CurrencyBalance></CurrencyBalance>
            <Rate></Rate>
         </Amounts>
         <Operation></Operation>
         <TaxKey>
             <TaxKeyID></TaxKeyID>
             <TaxKeyName></TaxKeyName>
         </TaxKey>
         <DocumentLink>
             <DocumentID />
             <DocumentRef />
             <DocumentDate />
         </DocumentLink>
      </JournalEntry>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Journal>
   ...
</Journals>
Tag Description
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<JournalStatus> Possible values:
  • P - Posted
  • R - Reversed
  • V - Voided
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<Currency> Currency code
<BusinessPartnerID> Unique system identifier for business partner e.g. client, supplier or employee. See Get Client, Get Supplier or Get Employee
<IsApproved> Boolean value (false | true)
<IsManual> Boolean value (false | true)
<IsCompressed> Boolean value (false | true)
<Operation> Possible values:
  • DR - Debit
  • CR - Credit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

GETGet Trial Balance

Request

XML / HTTP
GET https://go.paytraq.com/api/trialBalance

Optional query parameters

Parameter Description
date As of date (YYYY-MM-DD)
en_locale Boolean value (false | true)
gl_types Boolean value (false | true)
if enabled the GL account types will be included in the result set.

Response

XML / HTTP
<TrialBalance>
   <Account>
      <GLAccount>
         <AccountID></AccountID>
         <Code />
         <Name></Name>
         <GLType></GLType>
      </GLAccount>
      <DR></DR>
      <CR></CR>
      <Balance></Balance>
   </Account>
</TrialBalance>
Tag Description
<AccountID> Unique system identifier for account. See Get Account
<Code> Account Code

Back to Accounting

GETGet Balance Confirmation

Request

XML / HTTP
GET https://go.paytraq.com/api/balanceConfirmation/{BusinessPartnerID}

Parameter Description
BusinessPartnerID Unique system identifier for business partner e.g. client or supplier. See Get Client or Get Supplier

Optional query parameters

Parameter Description
date As of date (YYYY-MM-DD)
by_documents Boolean value (false | true)
acc_id Unique system identifier for account. See Get Account

Response

XML / HTTP
<BalanceConfirmation>
    <BusinessPartner>
        <BusinessPartnerID></BusinessPartnerID>
        <BusinessPartnerName></BusinessPartnerName>
    </BusinessPartner>
    <Date></Date>
    <Balances>
        <Balance>
            <Account>
                <AccountID></AccountID>
                <AccountCode></AccountCode>
                <AccountName></AccountName>
            </Account>
            <DR></DR>
            <CR></CR>
            <Currency></Currency>
            <Documents>
                <Document>
                    <DocumentID></DocumentID>
                    <DocumentRef></DocumentRef>
                    <DocumentDate></DocumentDate>
                    <DocumentType></DocumentType>
                    <DR></DR>
                    <CR></CR>
                    <Currency></Currency>
                </Document>
            </Documents>
        </Balance>
    </Balances>
</BalanceConfirmation>
Tag Description
<AccountID> Unique system identifier for account. See Get Account
<AccountCode> Account Code
<DR> Debit Balance
<CR> Credit Balance

Back to Accounting

GETGet Partner Balances

Request

XML / HTTP
GET https://go.paytraq.com/api/partnerBalances

Optional query parameters

Parameter Description
date As of date (YYYY-MM-DD)
BusinessPartnerID Unique system identifier for business partner e.g. client or supplier. See Get Client or Get Supplier
AccountID Unique system identifier for account. See Get Account
by_docs Boolean value (false | true)
page Pagination
By default only the first 100 records are returned.
To utilise paging, append a page parameter to the URL e.g. &page=0.
If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g. &page=1 and continuing this process until no more results are returned.
Note: Page values start with 0.

Response

XML / HTTP
<PartnerBalances>
    <BusinessPartner>
        <BusinessPartnerID></BusinessPartnerID>
        <BusinessPartnerName></BusinessPartnerName>
        <Balance></Balance>
        <Accounts>
            <Account>
                <AccountID></AccountID>
                <AccountCode></AccountCode>
                <AccountName></AccountName>
                <Balance></Balance>
                <DR></DR>
                <CR></CR>
                <Currency></Currency>
                <ForeignCurrencyBalances>
                    <ForeignCurrencyBalance>
                        <DR></DR>
                        <CR></CR>
                        <Balance></Balance>
                        <ForeignCurrency></ForeignCurrency>
                        <EQ>
                            <DR></DR>
                            <CR></CR>
                            <Balance></Balance>
                            <Currency></Currency>
                        </EQ>
                    </ForeignCurrencyBalance>
                </ForeignCurrencyBalances>
                <Documents>
                    <Document>
                        <DocumentID></DocumentID>
                        <DocumentRef></DocumentRef>
                        <DocumentDate></DocumentDate>
                        <DocumentType></DocumentType>
                        <DR></DR>
                        <CR></CR>
                        <Currency></Currency>
                    </Document>
                </Documents>
            </Account>
        </Accounts>
    </BusinessPartner>
 </PartnerBalances>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner e.g. client or supplier. See Get Client or Get Supplier
<AccountID> Unique system identifier for account. See Get Account
<AccountCode> Account Code
<DR> Debit Balance
<CR> Credit Balance

Back to Accounting

GETGet Balance Sheet

Request

XML / HTTP
GET https://go.paytraq.com/api/balanceSheet

Optional query parameters

Parameter Description
period "year" or "month", default is "year", example &period=month
year Reporting year for the current period, default is current financial year, example: &year=2026
month Reporting month for the current period, default is current month, can be provided only if period=month, example: &month=4
by_accounts Boolean value (false | true), if true then detailed balance sheet is returned, default is false, example: &by_accounts=true
prev_periods Number of previous periods, default is "1", maximum number is "12", example: &prev_periods=3

Response

XML / HTTP
<BalanceSheet>
    <Line>
        <LineID></LineID>
        <LineName></LineName>
        <LineNameEN>></LineNameEN>
        <IsHeader></IsHeader>
        <LineType></LineType>
        <ParentLine>
            <ParentLineID></ParentLineID>
            <ParentLineName></ParentLineName>
        </ParentLine>
        <Path></Path>
        <ExportCode></ExportCode>
        <PeriodBalances>
            <PeriodBalance>
                <Period></Period>
                <Balance></Balance>
            </PeriodBalance>
            <PeriodBalance>
                <Period></Period>
                <Balance></Balance>
            </PeriodBalance>
            ...
        </PeriodBalances>
        <Accounts>
            <Account>
                <AccountID></AccountID>
                <AccountCode></AccountCode>
                <AccountName></AccountName>
                <PeriodBalances>
                    <PeriodBalance>
                        <Period></Period>
                        <Balance></Balance>
                    </PeriodBalance>
                    <PeriodBalance>
                        <Period></Period>
                        <Balance></Balance>
                    </PeriodBalance>
                    ...
                </PeriodBalances>
            </Account>
            ...
        </Accounts>
    </Line>
    ...
 <BalanceSheet>
Tag Description
<LineName> Balance line name
<IsHeader> Header line
<Period> Reporting period, either YYYY or YYYY/MM depending on "period" param
<Balance> Line balance for the period
<AccountID> Unique system identifier for account. See Get Account

Back to Accounting

GETGet Profit and Loss Statement

Request

XML / HTTP
GET https://go.paytraq.com/api/profitLoss

Optional query parameters

Parameter Description
period "year" or "month", default is "year", example &period=month
year Reporting year for the current period, default is current financial year, example: &year=2026
month Reporting month for the current period, default is current month, can be provided only if period=month, example: &month=4
by_accounts Boolean value (false | true), if true then detailed P/L Statement is returned, default is false, example: &by_accounts=true
prev_periods Number of previous periods, default is "1", maximum number is "12", example: &prev_periods=3

Response

XML / HTTP
<ProfitLoss>
    <Line>
        <LineID></LineID>
        <LineName></LineName>
        <LineNameEN>></LineNameEN>
        <IsHeader></IsHeader>
        <IsSubTotal></IsSubTotal>
        <LineType></LineType>
        <ParentLine>
            <ParentLineID></ParentLineID>
            <ParentLineName></ParentLineName>
        </ParentLine>
        <Path></Path>
        <ExportCode></ExportCode>
        <PeriodBalances>
            <PeriodBalance>
                <Period></Period>
                <Balance></Balance>
            </PeriodBalance>
            <PeriodBalance>
                <Period></Period>
                <Balance></Balance>
            </PeriodBalance>
            ...
        </PeriodBalances>
        <Accounts>
            <Account>
                <AccountID></AccountID>
                <AccountCode></AccountCode>
                <AccountName></AccountName>
                <PeriodBalances>
                    <PeriodBalance>
                        <Period></Period>
                        <Balance></Balance>
                    </PeriodBalance>
                    <PeriodBalance>
                        <Period></Period>
                        <Balance></Balance>
                    </PeriodBalance>
                    ...
                </PeriodBalances>
            </Account>
            ...
        </Accounts>
    </Line>
    ...
 <ProfitLoss>
Tag Description
<LineName> P/L line name
<IsHeader> Header line
<IsSubtotal> Subtotal line
<Period> Reporting period, either YYYY or YYYY/MM depending on "period" param
<Balance> Line balance for the period
<AccountID> Unique system identifier for account. See Get Account

Back to Accounting

GETGet Journal Types

Request

XML / HTTP
GET https://go.paytraq.com/api/journalTypes

Response

XML / HTTP
<JournalTypes>
   <JournalType>
      <JournalTypeID></JournalTypeID>
      <JournalTypeName></JournalTypeName>
      <Narration></Narration>
      <SysCode></SysCode>
      <IsInactive></IsInactive>
      <IsDefault></IsDefault>
      <IsSystem></IsSystem>
   </JournalType>
   ...
</JournalTypes>
Tag Description
<JournalTypeID> Unique system identifier for journal type
<IsInactive> Boolean value (false | true)
<IsDefault> Boolean value (false | true)
<IsSystem> Boolean value (false | true)

Back to Accounting

GETGet Journals

Request

XML / HTTP
GET https://go.paytraq.com/api/journals

By default result list is sorted by journal date in descending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by journal number or business partner name.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Journal date range filter can be applied.
Status filter can be applied.

Additional optional parameters are available for this request:

GET /api/journals? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee

GET /api/journals? ... &DocumentID=0
DocumentID - Unique system identifier for document. See Get Sales Document, Get Purchase Document, Get Expense Claim, Get Payment or Get Payroll

GET /api/journals? ... &is_approved=false
is_approved - Filter by journal approval status. Possible values: true or false

GET /api/journals? ... &is_manual=true
is_manual - Filter by manual journal status. Possible values: true or false

GET /api/journals? ... &tag=tag_value
tag - Filter by tag value

Response

XML / HTTP
<Journals>
   <Journal>
      <JournalID></JournalID>
      <JournalRef></JournalRef>
      <JournalDate></JournalDate>
      <JournalStatus></JournalStatus>
      <JournalType>
         <JournalTypeID></JournalTypeID>
         <JournalTypeName></JournalTypeName>
      </JournalType>
      <Currency></Currency>
      <Narration />
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
         <DocumentDate></DocumentDate>
         <DocumentType></DocumentType>
      </DocumentLink>
      <ExtReference></ExtReference>
      <BusinessPartner>
         <BusinessPartnerID></BusinessPartnerID>
         <BusinessPartnerName></BusinessPartnerName>
      </BusinessPartner>
      <IsApproved></IsApproved>
      <IsManual></IsManual>
      <IsCompressed></IsCompressed>
      <JournalEntries>
         <JournalEntry>
            <Account>
               <AccountID></AccountID>
               <AccountCode></AccountCode>
               <AccountName></AccountName>
            </Account>
            <Description></Description>
            <Amounts>
               <AmountJournal></AmountJournal>
               <CurrencyJournal></CurrencyJournal>
               <AmountBalance></AmountBalance>
               <CurrencyBalance></CurrencyBalance>
               <Rate></Rate>
            </Amounts>
            <Operation></Operation>
            <TaxKey>
               <TaxKeyID></TaxKeyID>
               <TaxKeyName></TaxKeyName>
            </TaxKey>
            <ItemID />
            <DocumentLink>
               <DocumentID />
               <DocumentRef />
               <DocumentDate />
               <DocumentType />
            </DocumentLink>
         </JournalEntry>
         ...
      </JournalEntries>
      <TotalDR></TotalDR>
      <TotalCR></TotalCR>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Journal>
   ...
</Journals>
Tag Description
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<JournalStatus> Possible values:
  • P - Posted
  • R - Reversed
  • V - Voided
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<Currency> Currency code
<DocumentType> Possible values:
  • sale - Sale
  • purchase - Purchase
  • expense_claim - Expence Claim
  • in_shipment - Incoming Shipment
  • out_shipment - Outgoing Shipment
  • inventory - Inventory Adjustment
  • payment - Payment
  • payroll - Payroll Run
  • product_cost - Product Cost Calculation
  • fixed_asset - Fixed Asset
  • loan - Loan
<BusinessPartnerID> Unique system identifier for business partner e.g. client, supplier or employee. See Get Client, Get Supplier or Get Employee
<IsApproved> Boolean value (false | true)
<IsManual> Boolean value (false | true)
<IsCompressed> Boolean value (false | true)
<AccountID> Unique system identifier for account. See Get Account
<AccountCode> Account Code
<Operation> Possible values:
  • DR - Debit
  • CR - Credit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

GETGet Journal

Request

XML / HTTP
GET https://go.paytraq.com/api/journal/{JournalID}
Parameter Description
JournalID Unique system identifier for journal. See Get Journal.

Response

XML / HTTP
<Journal>
   <JournalID></JournalID>
   <JournalRef></JournalRef>
   <JournalDate></JournalDate>
   <JournalStatus></JournalStatus>
   <JournalType>
      <JournalTypeID></JournalTypeID>
      <JournalTypeName></JournalTypeName>
   </JournalType>
   <Currency></Currency>
   <Narration />
   <DocumentLink>
      <DocumentID></DocumentID>
      <DocumentRef></DocumentRef>
      <DocumentDate></DocumentDate>
      <DocumentType></DocumentType>
   </DocumentLink>
   <ExtReference></ExtReference>
   <BusinessPartner>
      <BusinessPartnerID></BusinessPartnerID>
      <BusinessPartnerName></BusinessPartnerName>
   </BusinessPartner>
   <IsApproved></IsApproved>
   <IsManual></IsManual>
   <IsCompressed></IsCompressed>
   <JournalEntries>
      <JournalEntry>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <Description></Description>
         <Amounts>
            <AmountJournal></AmountJournal>
            <CurrencyJournal></CurrencyJournal>
            <AmountBalance></AmountBalance>
            <CurrencyBalance></CurrencyBalance>
            <Rate></Rate>
         </Amounts>
         <Operation></Operation>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <ItemID />
         <DocumentLink>
            <DocumentID />
            <DocumentRef />
            <DocumentDate />
            <DocumentType />
         </DocumentLink>
      </JournalEntry>
      ...
   </JournalEntries>
   <JournalTaxes>
      <Tax>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
            <TaxKeyName></TaxKeyName>
         </TaxKey>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
            <AccountName></AccountName>
         </Account>
         <TaxableAmount></TaxableAmount>
         <TaxAmount></TaxAmount>
         <Rate></Rate>
      </Tax>
      ...
   </JournalTaxes>
   <TotalDR></TotalDR>
   <TotalCR></TotalCR>
   <Project>
      <ProjectName />
   </Project>
   <TimeStamps>
      <Created />
      <Updated />
   </TimeStamps>
   <Tags>
      <Tag />
   </Tags>
</Journal>
Tag Description
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<JournalStatus> Possible values:
  • P - Posted
  • R - Reversed
  • V - Voided
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<Currency> Currency code
<DocumentType> Possible values:
  • sale - Sale
  • purchase - Purchase
  • expense_claim - Expence Claim
  • in_shipment - Incoming Shipment
  • out_shipment - Outgoing Shipment
  • inventory - Inventory Adjustment
  • payment - Payment
  • payroll - Payroll Run
  • product_cost - Product Cost Calculation
  • fixed_asset - Fixed Asset
  • loan - Loan
<BusinessPartnerID> Unique system identifier for business partner e.g. client, supplier or employee. See Get Client, Get Supplier or Get Employee
<IsApproved> Boolean value (false | true)
<IsManual> Boolean value (false | true)
<IsCompressed> Boolean value (false | true)
<AccountID> Unique system identifier for account. See Get Account
<AccountCode> Account Code
<Operation> Possible values:
  • DR - Debit
  • CR - Credit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

GETApprove Journal

Request

XML / HTTP
GET https://go.paytraq.com/api/approveJournal/{JournalID}
Parameter Description
JournalID Unique system identifier for journal. See Get Journal.

Response

XML / HTTP
<Response>
   <JournalID></JournalID>
</Response>
Tag Description
<JournalID> Unique system identifier for journal

Back to Accounting

POSTAdd Manual Journal

Request

XML / HTTP
POST https://go.paytraq.com/api/manualJournal

Payload

XML / HTTP
<Journal>
   <JournalDate></JournalDate>
   <JournalType>
      <JournalTypeID></JournalTypeID>
   </JournalType>
   <Narration />
   <ExtReference></ExtReference>
   <BusinessPartner>
      <BusinessPartnerID></BusinessPartnerID>
      <BusinessPartnerName></BusinessPartnerName>
   </BusinessPartner>
   <Project>
      <ProjectName />
   </Project>
   <IsApproved></IsApproved>
   <JournalEntries>
      <JournalEntry>
         <Account>
            <AccountID></AccountID>
            <AccountCode></AccountCode>
         </Account>
         <Description></Description>
         <Amounts>
            <AmountJournal></AmountJournal>
            <CurrencyJournal></CurrencyJournal>
            <AmountBalance></AmountBalance>
         </Amounts>
         <Operation></Operation>
         <TaxKey>
            <TaxKeyID></TaxKeyID>
         </TaxKey>
      </JournalEntry>
      ...
   </JournalEntries>
  </Journal>

To add a business partner <BusinessPartnerID /> OR <BusinessPartnerName /> should be provided.
To add an account <AccountID /> OR <AccountCode /> should be provided.

<JournalDate>, <JournalTypeID>, <IsApproved>, <Narration />, <ExtReference>, <Description>, <CurrencyJournal>, <AmountBalance> and <TaxKeyID> are optional

Tag Description
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<CurrencyJournal> Currency code
<BusinessPartnerID> Unique system identifier for business partner e.g. client, supplier or employee. See Get Client, Get Supplier or Get Employee
<IsApproved> Boolean value (false | true); Default is true
<AccountID> Unique system identifier for account. See Get Account
<AccountCode> Account Code
<Operation> Possible values:
  • DR - Debit
  • CR - Credit
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key

For other tags description please refer to Get Journal.

Response

XML / HTTP
<Response>
   <JournalID></JournalID>
</Response>
Tag Description
<JournalID> Unique system identifier for journal. See Get Journal.

Back to Accounting

GETGet Business Snapshot

Request

XML / HTTP
GET https://go.paytraq.com/api/businessSnapshot

Response

XML / HTTP
<BusinessSnapshot>
    <AsOfDate></AsOfDate>
    <Currency></Currency>
    <AccountsReceivable></AccountsReceivable>
    <AccountsPayable></AccountsPayable>
    <Money></Money>
    <Taxes></Taxes>
    <IncomeYTD></IncomeYTD>
    <ExpensesYTD></ExpensesYTD>
    <OperatingProfitYTD>></OperatingProfitYTD>
   </BusinessSnapshot>
Tag Description
<AsOfDate> Current date
<AccountsReceivable> Balance of Accounts Receivable
<AccountsPayable> Balance of Accounts Payable
<Money> Balance of Money Accounts
<Taxes> Due Taxes
<IncomeYTD> Income for the current financial year
<ExpensesYTD> Expenses for the current financial year
<OperatingProfitYTD> Operating profit for the current financial year

Back to Accounting

GETGet Unprocessed Entries

Request

XML / HTTP
GET https://go.paytraq.com/api/checkUnprocessedEntries

Response

XML / HTTP
<UnprocessedEntries>
    <SalesInbox></SalesInbox>
    <PurchaseInbox></PurchaseInbox>
    <UnreconciledBank></UnreconciledBank>
    <UnapprovedJournals></UnapprovedJournals>
   </UnprocessedEntries>
Tag Description
<SalesInbox> Number of unprocessed messages in sales inbox
<PurchaseInbox> Number of unprocessed messages in purchase inbox
<UnreconciledBank> Number of unreconciled bank transactions
<UnapprovedJournals> Number of journals in the "Waiting for approval" status

Back to Accounting

GETGet Tax Key Report

Request

XML / HTTP
GET https://go.paytraq.com/api/taxKeyReport

Date Range filter can be applied.
GET /api/taxKeyReport? ... &date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<TaxKeys>
    <TaxKey>
        <TaxKeyID></TaxKeyID>
        <Name></Name>
        <TaxName></TaxName>
        <SysTaxName></SysTaxName>
        <TaxGroup>
            <TaxGroupID></TaxGroupID>
            <TaxGroupName></TaxGroupName>
            <IsInput></IsInput>
            <IsOutput></IsOutput>
            <IsECSales></IsECSales>
            <IsECPurchases></IsECPurchases>
            <IsImport></IsImport>
            <IsOSS></IsOSS>
            <IsCrossBorder></IsCrossBorder>
            <IsStandardRate></IsStandardRate>
            <RateType></RateType>
        </TaxGroup>
        <TaxableAmount></TaxableAmount>
        <TaxAmount></TaxAmount>
        <TaxRate></TaxRate>
        <Account>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </Account>
    </TaxKey>
    ...
    </TaxKeys>
Tag Description
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<AccountID> Unique system identifier for account. See Get Account

Back to Accounting

GETGet Tax Key Journals

Request

XML / HTTP
GET https://go.paytraq.com/api/taxKeyJournals/{TaxKeyID}

Result list is sorted by journal date in ascending order.
Pagination and Date Range filter can be applied.
GET /api/taxKeyJournals/{TaxKeyID}? ... &page=0 ... &date_from=2025-01-01&date_till=2025-01-31

Additional optional parameter is available for this request:
GET /api/taxKeyJournals/{TaxKeyID}? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client or supplier. See Get Client or Get Supplier

Parameter Description
TaxKeyID Unique system identifier for tax key. See Get Tax Key

Response

XML / HTTP
<Journals>
   <Journal>
      <JournalID></JournalID>
      <JournalRef></JournalRef>
      <JournalDate></JournalDate>
      <JournalStatus></JournalStatus>
      <JournalType>
         <JournalTypeID></JournalTypeID>
         <JournalTypeName></JournalTypeName>
      </JournalType>
      <Currency></Currency>
      <Narration />
      <DocumentLink>
         <DocumentID></DocumentID>
         <DocumentRef></DocumentRef>
         <DocumentDate></DocumentDate>
      </DocumentLink>
      <ExtReference></ExtReference>
      <BusinessPartner>
         <BusinessPartnerID></BusinessPartnerID>
         <BusinessPartnerName></BusinessPartnerName>
      </BusinessPartner>
      <IsApproved></IsApproved>
      <IsManual></IsManual>
      <IsCompressed></IsCompressed>
      <TaxKey>
            <TaxKeyID></TaxKeyID>
            <Name></Name>
            <TaxableAmount></TaxableAmount>
            <TaxAmount></TaxAmount>
            <TaxRate></TaxRate>
      </TaxKey>
      <Project>
         <ProjectName />
      </Project>
      <TimeStamps>
         <Created />
         <Updated />
      </TimeStamps>
   </Journal>
   ...
</Journals>
Tag Description
For <Journal> tags description please refer to Get Journal.
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key
<TaxableAmount> Amount applied by the tax key in the journal
<TaxAmount> Tax amount in the journal

Back to Accounting

GETGet Billing Statement

Request

XML / HTTP
GET https://go.paytraq.com/api/partnerStatement/{BusinessPartnerID}

Result list is sorted by journal date in ascending order.
Date Range filter can be applied.
GET /api/partnerStatement/{BusinessPartnerID}? ... &date_from=2025-01-01&date_till=2025-01-31

Additional optional parameter is available for this request:
GET /api/partnerStatement/{BusinessPartnerID}? ... &currency=USD
currency - Currency code

Parameter Description
BusinessPartnerID Unique system identifier for client or supplier. See Get Client or Get Supplier

Response

XML / HTTP
<BillingStatement>
    <BusinessPartner>
        <BusinessPartnerID></BusinessPartnerID>
        <BusinessPartnerName></BusinessPartnerName>
    </BusinessPartner>
    <PeriodFrom></PeriodFrom>
    <PeriodTill></PeriodTill>
    <Currency></Currency>
    <OpeningBalance></OpeningBalance>
    <ClosingBalance></ClosingBalance>
    <ClosingBalanceDetails>
        <TotalOutstanding></TotalOutstanding>
        <Prepayment></Prepayment>
        <Overpayment></Overpayment>
    </ClosingBalanceDetails>
    <Transactions>
        <Transaction>
            <JournalID></JournalID>
            <JournalRef></JournalRef>
            <JournalDate></JournalDate>
            <JournalType>
                <JournalTypeID></JournalTypeID>
                <JournalTypeName></JournalTypeName>
            </JournalType>
            <DocumentType></DocumentType>
            <DocumentLink>
                <DocumentID></DocumentID>
                <DocumentRef></DocumentRef>
                <DocumentDate></DocumentDate>
            </DocumentLink>
            <PaymentLineType><PaymentLineType>
            <PaymentLine>
                <DocumentID></DocumentID>
                <DocumentRef></DocumentRef>
                <DocumentDate></DocumentDate>
            </PaymentLine>
            <AccountGroupType></AccountGroupType>
            <JrType></JrType>
            <PaymentType></PaymentType>
            <Description></Description>
            <TransactionType></TransactionType>
            <AmountDue></AmountDue>
            <PaymentAmount></PaymentAmount>
            <RunningTotal></RunningTotal>
        </Transaction>
        ...
    </Transactions>
<BillingStatement>
Tag Description
<BusinessPartnerID> Unique system identifier for business partner e.g. client or supplier. See Get Client or Get Supplier
<PeriodFrom> Period start date
<PeriodTill> Period end date
<Currency> Currency code
<OpeningBalance> Balance at the begining pf period
<ClosingBalance> Balance at the end of period
<TotalOutstanding> Due amount included in the ClosingBalance
<Prepayment> Prepayment included in the ClosingBalance
<Overpayment> Overpayment included in the ClosingBalance
<JournalID> Unique system identifier for journal. See Get Journal.
<JournalRef> System journal number (reference)
<JournalStatus> Possible values:
  • P - Posted
  • R - Reversed
  • V - Voided
<JournalTypeID> Unique system identifier for journal type. See Get Journal Types
<DocumentType> Possible values:
  • sale - Sale
  • purchase - Purchase
  • payment - Payment
<DocumentID> Unique system identifier for document. See Get Sales Document, Get Purchase Document or Get Payment

Back to Accounting

GETGet Payroll List

Request

XML / HTTP
GET https://go.paytraq.com/api/payrolls

By default result list is sorted by document date in descending order.
Optional parameters are available. Results can be filtered by employee name or document number.
Pagination and document date range filter can be applied.
Status filter can be applied.
Default ordering can be changed by passing &reverse=true param to the request.

Additional optional parameter is available for this request:
GET /api/payrolls? ... &EmployeeID=0 ... &tag=tag_value
EmployeeID - Unique system identifier for employee. See Get Employee
tag - Filter by tag value

Response

XML / HTTP
<Payrolls>
      <Payroll>
        <Header>
            <PayrollID></PayrollID>
            <PeriodFrom></PeriodFrom>
            <PeriodTill></PeriodTill>
            <Document>
                <DocumentID></DocumentID>
                <DocumentDate></DocumentDate>
                <DocumentRef></DocumentRef>
                <DocumentType></DocumentType>
                <Employee>
                  <EmployeeID></EmployeeID>
                  <Name></Name>
                >/Employee>
            </Document>
            <PayrollStatus></PayrollStatus>
            <PayrollCurrency></PayrollCurrency>
            <BalanceCurrency></BalanceCurrency>
            <CurrencyRate></CurrencyRate>
            <GrossAmount></GrossAmount>
            <TaxableAmount></TaxableAmount>
            <NetAmount></NetAmount>
            <Contributions></Contributions>
            <Total></Total>
            <AmountDue></AmountDue>
            <WorkingHours></WorkingHours>
            <Narration><Narration>
            <Project>
              <ProjectName />
            </Project>
            <TimeStamps>
              <Created />
              <Updated />
            </TimeStamps>
        </Header>
      </Payroll>
      ...
     </Payrolls>
Tag Description
<PayrollID> Unique system identifier for period payroll run
<DocumentID> Unique system identifier for employee payroll
<DocumentRef> Document number
<EmployeeID> Unique system identifier for employee. See Get Employee
<PayrollStatus> Possible values:
  • draft - Draft
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp

Back to Accounting

GETGet Payroll

Request

XML / HTTP
GET https://go.paytraq.com/api/payroll/{PayrollID}/{DocumentID}
Parameter Description
PayrollID Unique system identifier for period payroll run
DocumentID Unique system identifier for employee payroll

Response

XML / HTTP
<Payroll>
        <Header>
            <PayrollID></PayrollID>
            <PeriodFrom></PeriodFrom>
            <PeriodTill></PeriodTill>
            <Document>
                <DocumentID></DocumentID>
                <DocumentDate></DocumentDate>
                <DocumentRef></DocumentRef>
                <DocumentType></DocumentType>
                <Employee>
                  <EmployeeID></EmployeeID>
                  <Name></Name>
                >/Employee>
            </Document>
            <PayrollStatus></PayrollStatus>
            <PayrollCurrency></PayrollCurrency>
            <BalanceCurrency></BalanceCurrency>
            <CurrencyRate></CurrencyRate>
            <GrossAmount></GrossAmount>
            <TaxableAmount></TaxableAmount>
            <NetAmount></NetAmount>
            <Contributions></Contributions>
            <Total></Total>
            <AmountDue></AmountDue>
            <WorkingHours></WorkingHours>
            <Narration><Narration>
            <Project>
              <ProjectName />
            </Project>
            <TimeStamps>
              <Created />
              <Updated />
            </TimeStamps>
        </Header>
        <PayItems>
         <PayItem>
            <PayItemType></PayItemType>
            <PayItemTypeName></PayItemTypeName>
            <IsTax></IsTax>
            <IsAllowance></IsAllowance>
            <IsContribution></IsContribution>
            <Name></Name>
            <Code></Code>
            <Formula></Formula>
            <Amount></Amount>
          </PayItem>
          ...
        </PayItems>
      </Payroll>
Tag Description
<PayrollID> Unique system identifier for period payroll run
<DocumentID> Unique system identifier for employee payroll
<DocumentRef> Document number
<EmployeeID> Unique system identifier for employee. See Get Employee
<PayrollStatus> Possible values:
  • draft - Draft
  • wait_payment - Waiting for Payment
  • part_paid - Partially Paid
  • paid - Paid
<Created> Date created UTC timestamp
<Updated> Date updated UTC timestamp
<PayItemType> Possible values:
  • salary - Wages and Salaries
  • payment - Additional Payments
  • deduction - Deductions
  • tax - Taxes
  • post_tax_deduction - Post Tax Deductions
  • contribution - Employer Contributions and Duties
  • allowance - Withholding Allowances
  • post_tax_income - Post Tax Reimbursements

Back to Accounting

GETGet Fixed Assets

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAssets

By default result list is sorted by purchase date in ascending order.
There are several options to change the default ordering by passing additional parameters to the request.
Optional parameters are available. Results can be filtered by fixed asset number or product name.
This result list can be checked for new records and updates. See Optional parameters for additional info.
Pagination and status filter can be applied.
Date range filter is not available for this request.

Additional optional parameters are available for this request:
ItemID - Filter by product unique system identifier. See Get Product
activeOnly - Any status except disposed. Possible values: true or false
tag - Filter by tag value

Response

XML / HTTP
<FixedAssets>
    <FixedAsset>
        <FixedAssetID></FixedAssetID>
        <FixedAssetNo></FixedAssetNo>
        <PurchaseDate></PurchaseDate>
        <Product>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
        </Product>
        <Status></Status>
        <AssetAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </AssetAccount>
        <DepreciationAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </DepreciationAccount>
        <DepreciationExpenseAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </DepreciationExpenseAccount>
        <GrossValue></GrossValue>
        <AccumulatedDepreciation></AccumulatedDepreciation>
        <NetValue></NetValue>
        <LastDepreciationDate></LastDepreciationDate>
        <OpeningBalances></OpeningBalances>
        <Comment></Comment>
        <Project>
            <ProjectName></ProjectName>
        </Project>
        <TimeStamps>
            <Created></Created>
            <Updated></Updated>
        </TimeStamps>
    </FixedAsset>
</FixedAssets>
Tag Description
<PurchaseDate> Date when the fixed asset was purchased. In case of opening balances the conversion date is used.
<ItemID> Unique system identifier for product.
<OpeningBalances> Indicates that the fixed asset is added as an opening balance. Boolean value.
<Status> Status of the fixed asset.
Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • approved - Approved/Registered
  • disposed - Disposed/Sold

Back to Accounting

GETGet Fixed Asset

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAsset/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset

Response

XML / HTTP
<FixedAsset>
        <FixedAssetID></FixedAssetID>
        <FixedAssetNo></FixedAssetNo>
        <PurchaseDate></PurchaseDate>
        <Product>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
        </Product>
        <Status></Status>
        <AssetAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </AssetAccount>
        <DepreciationAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </DepreciationAccount>
        <DepreciationExpenseAccount>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
        </DepreciationExpenseAccount>
        <GrossValue></GrossValue>
        <AccumulatedDepreciation></AccumulatedDepreciation>
        <NetValue></NetValue>
        <LastDepreciationDate></LastDepreciationDate>
        <OpeningBalances></OpeningBalances>
        <Comment></Comment>
        <Project>
            <ProjectName></ProjectName>
        </Project>
        <TimeStamps>
            <Created></Created>
            <Updated></Updated>
        </TimeStamps>
        <DepreciationSchedule>
         <Depreciation>
            <JournalID></JournalID>
            <Date></Date>
            <DepreciationStatus></DepreciationStatus>
            <Formula></Formula>
            <DepreciationAmount></DepreciationAmount>
            <NetValue></NetValue>
         </Depreciation>
        </DepreciationSchedule>
        <BookValueChanges>
          <BookValueChange>
            <JournalID></JournalID>
            <Date></Date>
            <Type></Type>
            <GrossValue></GrossValue>
            <DepreciationAmount></DepreciationAmount>
            <NetValue></NetValue>
          </BookValueChange>
          <Total>
            <GrossValue></GrossValue>
            <DepreciationAmount></DepreciationAmount>
            <NetValue></NetValue>
          </Total>
       </BookValueChanges>
       <Tags>
         <Tag></Tag>
       </Tags>
</FixedAsset>
Tag Description
<PurchaseDate> Date when the fixed asset was purchased. In case of opening balances the conversion date is used.
<ItemID> Unique system identifier for product.
<OpeningBalances> Indicates that the fixed asset is added as an opening balance. Boolean value.
<Status> Status of the fixed asset.
Possible values:
  • draft - Draft
  • wait_approve - Waiting for Approval
  • approved - Approved/Registered
  • disposed - Disposed/Sold
<DepreciationStatus> Status of the scheduled depreciation.
Possible values:
  • pending - Pending
  • scheduled - Scheduled
  • done - Posted
<Type> Type of the book value change.
Possible values:
  • purchase - Purchase
  • depreciation - Depreciation
  • revaluation - Revaluation
  • disposal - Disposal

Back to Accounting

POSTAdd Fixed Asset

Request

XML / HTTP
POST https://go.paytraq.com/api/fixedAsset

Payload

XML / HTTP
<FixedAsset>
    <FixedAssetNo></FixedAssetNo>
        <PurchaseDate></PurchaseDate>
    <Product>
        <ItemID></ItemID>
    </Product>
    <AssetAccount>
        <AccountID></AccountID>
    </AssetAccount>
    <DepreciationAccount>
        <AccountID></AccountID>
    </DepreciationAccount>
    <DepreciationExpenseAccount>
        <AccountID></AccountID>
    </DepreciationExpenseAccount>
    <GrossValue></GrossValue>
    <AccumulatedDepreciation></AccumulatedDepreciation>
    <OpeningBalances></OpeningBalances>
    <Comment></Comment>
    <Project>
        <ProjectName />
    </Project>
</FixedAsset>

Only <ItemID> is required.

Tag Description
PurchaseDate Date when the fixed asset was purchased. In case of opening balances the conversion date is used. If not specified the current date is used.
FixedAssetNo Unique system identifier for the fixed asset. If not specified, a new ID will be generated.
ItemID Unique system identifier for product. The product should be created before creating a fixed asset. The product type should be "Fixed asset" (Type = 3).
AssetAccount Account used to record the fixed asset. Optional. If not specified, the default asset account will be used. If provided, it must belong to one of the following account groups - Tangible Fixed Assets or Intangible Fixed Assets
DepreciationAccount Account used to record the depreciation of the fixed asset. Optional. If not specified, the default depreciation account will be used. If provided, it must belong to one of the following account groups - Depreciation of Tangible Assets or Amortization of Intangible Assets
DepreciationExpenseAccount Account used to record the depreciation expense of the fixed asset. Optional. If not specified, the default depreciation expense account will be used. If provided, it must belong to the following account group - Depreciation Expenses
<GrossValue> The initial cost of the fixed asset.
<AccumulatedDepreciation> The total amount of depreciation recorded for the fixed asset. Should be provided only if the asset is added as an opening balance.
<OpeningBalances> Indicates that the fixed asset is added as an opening balance. Boolean value.

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

POSTUpdate Fixed Asset

Request

XML / HTTP
POST https://go.paytraq.com/api/fixedAsset/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset. See Get Fixed Asset.

Payload

XML / HTTP
<FixedAsset>
    <FixedAssetNo></FixedAssetNo>
    <PurchaseDate></PurchaseDate>
    <AssetAccount>
        <AccountID></AccountID>
    </AssetAccount>
    <DepreciationAccount>
        <AccountID></AccountID>
    </DepreciationAccount>
    <DepreciationExpenseAccount>
        <AccountID></AccountID>
    </DepreciationExpenseAccount>
    <GrossValue></GrossValue>
    <AccumulatedDepreciation></AccumulatedDepreciation>
    <OpeningBalances></OpeningBalances>
    <Comment></Comment>
    <Project>
        <ProjectName />
    </Project>
</FixedAsset>

Only documents with status Waiting for Approval can be updated.
No tags are required.
ItemID cannot be updated.
For tags description please refer to Add Fixed Asset.

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

GETApprove Fixed Asset

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAssetApprove/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset. See Get Fixed Asset.

Fixed Asset with status Waiting for Approval can be approved

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

POSTAdd Fixed Asset Depreciation Schedule

Request

XML / HTTP
POST https://go.paytraq.com/api/fixedAssetDepreciationSchedule/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset. See Get Fixed Asset.

Payload

XML / HTTP
<FixedAsset>
    <DepreciationSchedule>
        <StartDate></StartDate>
        <Formula></Formula>
        <Period></Period>
        <ResidualAmount></ResidualAmount>
    </DepreciationSchedule>    
</FixedAsset>

Depreciation schedules can only be added to documents with status Approved.

Tag Description
StartDate The date of the first depreciation
Formula The formula used to calculate monthly depreciation
Available Placeholders
  • G - Gross Value
  • N - Net Value
Example
G*20/100*1/12 - Straight-line Depreciation, 20%/year
G/36 - Straight-line Depreciation, 3 years
N*40/100*1/12 - Declining Balance Depreciation, 40%/year
Period The period for which the depreciation is calculated. Ether Monthly or Monthly(EOM). If not specified, the default value is Monthly.
Possible values:
  • 2 - Monthly - Depreciation is calculated on the same day of each month based on the start date
  • 6 - Monthly(EOM) - Depreciation is calculated on the last day of each month
ResidualAmount The residual amount of the fixed asset once the depreciation is complete. Optional. If not specified, the default residual amount is 0.

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
   <DepreciationSchedule>
         <Depreciation>
            <JournalID></JournalID>
            <Date></Date>
            <DepreciationStatus></DepreciationStatus>
            <Formula></Formula>
            <DepreciationAmount></DepreciationAmount>
            <NetValue></NetValue>
         </Depreciation>
   </DepreciationSchedule>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

GETApprove Fixed Asset Depreciation Schedule

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAssetApproveDepreciationSchedule/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset. See Get Fixed Asset.

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
   <DepreciationSchedule>
         <Depreciation>
            <JournalID></JournalID>
            <Date></Date>
            <DepreciationStatus></DepreciationStatus>
            <Formula></Formula>
            <DepreciationAmount></DepreciationAmount>
            <NetValue></NetValue>
         </Depreciation>
   </DepreciationSchedule>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

GETReset Fixed Asset Depreciation Schedule

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAssetResetDepreciationSchedule/{FixedAssetID}
Parameter Description
FixedAssetID Unique system identifier for fixed asset. See Get Fixed Asset.

Response

XML / HTTP
<Response>
   <FixedAssetID></FixedAssetID>
   <DepreciationSchedule></DepreciationSchedule>
</Response>
Tag Description
<FixedAssetID> Unique system identifier for fixed asset. See Get Fixed Asset.

Back to Accounting

GETGet Fixed Assets Reconciliation

Request

XML / HTTP
GET https://go.paytraq.com/api/fixedAssetsReconciliation

Date Range filter can be applied.
GET /api/fixedAssetsReconciliation? ... &date_from=2025-01-01&date_till=2025-01-31

Response

XML / HTTP
<FixedAssets>
    <FixedAsset>
        <FixedAssetID></FixedAssetID>
        <FixedAssetNo></FixedAssetNo>
        <Product>
            <ItemID></ItemID>
            <Name></Name>
            <Code></Code>
        </Product>
        <OpeningBalance></OpeningBalance>
        <Changes></Changes>
        <ClosingBalance></ClosingBalance>
        <GrossValue>
            <OpeningBalance></OpeningBalance>
            <Changes></Changes>
            <ClosingBalance></ClosingBalance>
        </GrossValue>
        <AccumulatedDepreciation>
            <OpeningBalance></OpeningBalance>
            <Changes></Changes>
            <ClosingBalance></ClosingBalance>
        </AccumulatedDepreciation>
        <Currency></Currency>
    </FixedAsset>
   </FixedAssets>
Tag Description
ItemID Unique system identifier for product
<OpeningBalance> Balance at the begining pf period
<ClosingBalance> Balance at the end of period

Back to Accounting

Attachments

POSTUpload Document Attachment

Request

XML / HTTP
POST https://go.paytraq.com/api/documentAttachment/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Payload

XML / HTTP
<Attachment>
      <FileName></FileName>
      <ContentType></ContentType>
      <Description></Description>
      <Content></Content>
</Attachment>
Tag Description
<FileName> Name of the file
<ContentType> MIME Content Type
<Description> File description
<Content> Base64 encoded file content

Response

XML / HTTP
<Response>
   <AttachmentID></AttachmentID>
   <AttachmentUID></AttachmentUID>
   <DocumentID></DocumentID>
</Response>
Tag Description
<AttachmentID> Unique system identifier for attachment
<DocumentID> Unique system identifier for document

Back to Attachments

POSTUpload Journal Attachment

Request

XML / HTTP
POST https://go.paytraq.com/api/journalAttachment/{JournalID}
Parameter Description
JournalID Unique system identifier for journal. See Get Journal.

Payload

XML / HTTP
<Attachment>
      <FileName></FileName>
      <ContentType></ContentType>
      <Description></Description>
      <Content></Content>
</Attachment>
Tag Description
<FileName> Name of the file
<ContentType> MIME Content Type
<Description> File description
<Content> Base64 encoded file content

Response

XML / HTTP
<Response>
   <AttachmentID></AttachmentID>
   <AttachmentUID></AttachmentUID>
   <JournalID></JournalID>
</Response>
Tag Description
<AttachmentID> Unique system identifier for attachment
<JournalID> Unique system identifier for journal. See Get Journal.

Back to Attachments

POSTUpload Partner Attachment

Request

XML / HTTP
POST https://go.paytraq.com/api/partnerAttachment/{BusinessPartnerID}

Upload Client Attachment

XML / HTTP
POST https://go.paytraq.com/api/clientAttachment/{ClientID}

Upload Supplier Attachment

XML / HTTP
POST https://go.paytraq.com/api/supplierAttachment/{SupplierID}

Upload Employee Attachment

XML / HTTP
POST https://go.paytraq.com/api/employeeAttachment/{EmployeeID}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Payload

XML / HTTP
<Attachment>
      <FileName></FileName>
      <ContentType></ContentType>
      <Description></Description>
      <Content></Content>
</Attachment>
Tag Description
<FileName> Name of the file
<ContentType> MIME Content Type
<Description> File description
<Content> Base64 encoded file content

Response

XML / HTTP
<Response>
   <AttachmentID></AttachmentID>
   <AttachmentUID></AttachmentUID>
   <BusinessPartnerID></BusinessPartnerID>
</Response>
Tag Description
<AttachmentID> Unique system identifier for attachment
<BusinessPartnerID> Unique system identifier for partner

Back to Attachments

POSTUpload Product/Service Attachment

Request

XML / HTTP
POST https://go.paytraq.com/api/itemAttachment/{ItemID}
Parameter Description
ItemID Unique system identifier for product/service

Payload

XML / HTTP
<Attachment>
      <FileName></FileName>
      <ContentType></ContentType>
      <Description></Description>
      <Content></Content>
</Attachment>
Tag Description
<FileName> Name of the file
<ContentType> MIME Content Type
<Description> File description
<Content> Base64 encoded file content

Response

XML / HTTP
<Response>
   <AttachmentID></AttachmentID>
   <AttachmentUID></AttachmentUID>
   <ItemID></ItemID>
</Response>
Tag Description
<AttachmentID> Unique system identifier for attachment
<ItemID> Unique system identifier for product/service

Back to Attachments

GETGet Document Attachments

Request

XML / HTTP
GET https://go.paytraq.com/api/documentAttachments/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Response

XML / HTTP
<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
        <SignedURL></SignedURL>
    </Attachment>
    ...
</Attachments>
Tag Description
<AttachmentID> Unique system identifier for attachment
<SignedURL> Web link to download attachment. Valid for 15 minutes.

Back to Attachments

GETGet Journal Attachments

Request

XML / HTTP
GET https://go.paytraq.com/api/journalAttachments/{JournalID}
Parameter Description
JournalID Unique system identifier for journal. See Get Journal.

Response

XML / HTTP
<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
        <SignedURL></SignedURL>
    </Attachment>
    ...
</Attachments>
Tag Description
<AttachmentID> Unique system identifier for attachment
<SignedURL> Web link to download attachment. Valid for 15 minutes.

Back to Attachments

GETGet Partner Attachments

Request

XML / HTTP
GET /api/partnerAttachments/{BusinessPartnerID}

Get Client Attachments

XML / HTTP
GET /api/clientAttachments/{ClientID}

Get Supplier Attachments

XML / HTTP
GET /api/supplierAttachments/{SupplierID}

Get Employee Attachments

XML / HTTP
GET /api/employeeAttachments/{EmployeeID}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Response

XML / HTTP
<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
        <SignedURL></SignedURL>
    </Attachment>
    ...
</Attachments>
Tag Description
<AttachmentID> Unique system identifier for attachment
<SignedURL> Web link to download attachment. Valid for 15 minutes.

Back to Attachments

GETGet Product/Service Attachments

Request

XML / HTTP
GET https://go.paytraq.com/api/itemAttachments/{ItemID}
Parameter Description
ItemID Unique system identifier for product/service

Response

XML / HTTP
<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
        <SignedURL></SignedURL>
    </Attachment>
    ...
</Attachments>
Tag Description
<AttachmentID> Unique system identifier for attachment
<SignedURL> Web link to download attachment. Valid for 15 minutes.

Back to Attachments

GETDownload Attachment

Request

XML / HTTP
GET https://go.paytraq.com/api/attachment/{AttachmentID}/{AttachmentUID}
Parameter Description
AttachmentID Unique system identifier for attachment
AttachmentUID Unique identification number for attachment

Response

XML / HTTP
File (MIME type - ContentType)

Back to Attachments

Tags

POSTAdd/Update Document Tags

Request

XML / HTTP
POST https://go.paytraq.com/api/documentTags/{DocumentID}
Parameter Description
DocumentID Unique system identifier for document

Payload

XML / HTTP
<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>
Tag Description
<Tag> Tag Name

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>
Tag Description
<DocumentID> Unique system identifier for document

Back to Tags

POSTAdd/Update Journal Tags

Request

XML / HTTP
POST https://go.paytraq.com/api/journalTags/{JournalID}
Parameter Description
JournalID Unique system identifier for journal. See Get Journal.

Payload

XML / HTTP
<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>
Tag Description
<Tag> Tag Name

Response

XML / HTTP
<Response>
   <JournalID></JournalID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>
Tag Description
<JournalID> Unique system identifier for journal

Back to Tags

POSTAdd/Update Partner Tags

Request

XML / HTTP
POST https://go.paytraq.com/api/partnerTags/{BusinessPartnerID}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Payload

XML / HTTP
<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>
Tag Description
<Tag> Tag Name

Response

XML / HTTP
<Response>
   <BusinessPartnerID></BusinessPartnerID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>
Tag Description
<BusinessPartnerID> Unique system identifier for partner

Back to Tags

POSTAdd/Update Product/Service Tags

Request

XML / HTTP
POST https://go.paytraq.com/api/itemTags/{ItemID}
Parameter Description
ItemID Unique system identifier for product/service

Payload

XML / HTTP
<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>
Tag Description
<Tag> Tag Name

Response

XML / HTTP
<Response>
   <ItemID></ItemID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>
Tag Description
<ItemID> Unique system identifier for product/service

Back to Tags

Settings

GETGet Price Groups

Request

XML / HTTP
GET https://go.paytraq.com/api/priceGroups

Response

XML / HTTP
<PriceGroups>
   <PriceGroup>
      <PriceGroupID></PriceGroupID>
      <Name></Name>
      <Currency></Currency>
      <IncludeTax></IncludeTax>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </PriceGroup>
   ...
</PriceGroups>
Tag Description
<PriceGroupID> Unique system identifier for price group
<Currency> Currency code
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Settings

GETGet Price Group

Request

XML / HTTP
GET https://go.paytraq.com/api/priceGroup/{PriceGroupID}
Parameter Description
PriceGroupID Unique system identifier for price group

Response

XML / HTTP
<PriceGroup>
   <PriceGroupID></PriceGroupID>
   <Name></Name>
   <Currency></Currency>
   <IncludeTax></IncludeTax>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</PriceGroup>
Tag Description
<PriceGroupID> Unique system identifier for price group
<Currency> Currency code
<IncludeTax> Boolean value (false | true)
Shows that amounts are tax inclusive
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Settings

GETGet Default Price Group

Request

XML / HTTP
GET https://go.paytraq.com/api/priceGroupDefaultId

Response

XML / HTTP
<PriceGroup>
   <PriceGroupID></PriceGroupID>
</PriceGroup>
Tag Description
<PriceGroupID> Unique system identifier for price group.
If no default price group is found then <PriceGroupID>0</PriceGroupID> will be returned

Back to Settings

GETGet Units

Request

XML / HTTP
GET https://go.paytraq.com/api/units

Response

XML / HTTP
<Units>
   <Unit>
      <UnitID></UnitID>
      <Name></Name>
      <IsDefault></IsDefault>
      <IsInactive></IsInactive>
   </Unit>
   ...
</Units>
Tag Description
<UnitID> Unique system identifier for unit of measure
<Name> Unit name
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Settings

GETGet Unit

Request

XML / HTTP
GET https://go.paytraq.com/api/unit/{UnitID}
Parameter Description
UnitID Unique system identifier for unit of measure

Response

XML / HTTP
<Unit>
   <UnitID></UnitID>
   <Name></Name>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</Unit>
Tag Description
<UnitID> Unique system identifier for unit of measure
<Name> Unit name
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Settings

GETGet Unit By Name

Request

XML / HTTP
GET https://go.paytraq.com/api/unitByName/{Name}
Parameter Description
Name Unit name

Response

XML / HTTP
<Unit>
   <UnitID></UnitID>
   <Name></Name>
   <IsDefault></IsDefault>
   <IsInactive></IsInactive>
</Unit>
Tag Description
<UnitID> Unique system identifier for unit of measure
<Name> Unit name
<IsDefault> Boolean value (false | true)
<IsInactive> Boolean value (false | true)

Back to Settings

GETGet Currencies

Request

XML / HTTP
GET https://go.paytraq.com/api/currencies

Response

XML / HTTP
<Currencies>
   <Currency>
      <Code></Code>
      <Name></Name>
   </Currency>
   ...
</Currencies>

Back to Settings

GETGet Company Details

Request

XML / HTTP
GET https://go.paytraq.com/api/companyDetails

Response

XML / HTTP

   <CompanyDetails>
    <CompanyID></CompanyID>
    <CompanyName></CompanyName>
    <RegistrationNumber></RegistrationNumber>
    <VATNumber></VATNumber>
    <LegalAddress></LegalAddress>
    <Country></Country>
    <BankAccounts>
      <BankAccount>
          <AccountNumber></AccountNumber>
          <BankName></BankName>
          <BankCode></BankCode>
          <IsDefault></IsDefault>
      </BankAccount>
    </BankAccounts>
    <LogoURL></LogoURL>
    <PayTraqInbox>
        <InboundEmailAddress></InboundEmailAddress>
    </PayTraqInbox>
    <InventorySettings>
        <CostingMethod></CostingMethod>
        <SystemOfInventory>
          <SystemID></SystemID>
          <SystemName></SystemName>
          <Account>
            <AccountID></AccountID>
            <Code></Code>
            <Name></Name>
          </Account>
        </SystemOfInventory>
        <LotTrackingEnabled></LotTrackingEnabled>
    </InventorySettings>
    <BalanceCurrency></BalanceCurrency>
    <FinancialYearEndMonth></FinancialYearEndMonth>
    <PeriodLockDate></PeriodLockDate>
    <DefaultAccounts>
      <DefaultAccount>
        <ID></ID>
        <Name></Name>
        <Code></Code>
        <Account>
          <AccountID></AccountID>
          <Code></Code>
          <Name></Name>
          <AccountGroup>
            <AccountGroupID></AccountGroupID>
            <AccountGroupType></AccountGroupType>
            <AccountGroupTypeLocalName></AccountGroupTypeLocalName>
          </AccountGroup>
        </Account>
      </DefaultAccount>
    </DefaultAccounts>    
   </CompanyDetails>

Back to Settings

GETGet System Process

Request

XML / HTTP
GET https://go.paytraq.com/api/process/{ProcessID}
Parameter Description
ProcessID Unique system identifier for system process

Response

XML / HTTP

     <Process>
       <ProcessID></ProcessID>
       <Status></Status>
       <Type></Type>
     </Process>
Tag Description
<ProcessID> Unique system identifier for started system process
<Status> System process status. Possible values: running, done

Back to Settings

Opening Balances

GETGet Conversion Settings

Request

XML / HTTP
GET https://go.paytraq.com/api/opening/balances/conversionSettings

Response

XML / HTTP
<OpeningBalances>
    <ConversionDate></ConversionDate>
    <Account>
        <AccountID></AccountID>
        <Code></Code>
        <Name></Name>
    </Account>
</OpeningBalances>
Tag Description
<ConversionDate> The date on which all opening journal entries will be posted. This date should be set before entering opening balances.
<Account> Opening balance account

Back to Opening Balances

POSTSet Conversion Date

Request

XML / HTTP
POST https://go.paytraq.com/api/opening/balances/setConversionDate

Payload

XML / HTTP
<OpeningBalances>
    <ConversionDate></ConversionDate>
</OpeningBalances>
Tag Description
<ConversionDate> The date on which all opening journal entries will be posted.

Response

XML / HTTP
<Response>
   <ConversionDate></ConversionDate>
</Response>
Tag Description
<ConversionDate> The date on which all opening journal entries will be posted.

Back to Opening Balances

POSTAdd Unpaid Sale or Received Prepayment

Request

XML / HTTP
POST https://go.paytraq.com/api/opening/balances/sale

This API call is used to add an unpaid sale or received prepayment to the opening balances.
The sale can be a prepaid proforma invoice, unpaid sales invoice or unpaid sales credit note.
The date of the journal entry will be the conversion date set in the system.
The document will be posted automatically, no additional call is required to post the document.

Payload

XML / HTTP
<OpeningBalances>
 <Sale>   
  <SaleType></SaleType>   
  <DocumentDate></DocumentDate>
  <DocumentRef></DocumentRef>
  <DateDue></DateDue>
  <Client>
    <ClientID></ClientID>
    <ClientName></ClientName>
  </Client>
  <Project>
    <ProjectName></ProjectName>
  </Project>
  <Amount></Amount>
  <Currency></Currency>
  <CurrencyRate></CurrencyRate>
  <Description></Description>
  <TaxBasis></TaxBasis>
  <TaxKey>
   <TaxKeyID></TaxKeyID>
  </TaxKey>
  <Comment></Comment>
 </Sale> 
</OpeningBalances>

Only <SaleType> is required.
To add a client <ClientID /> OR <ClientName /> should be provided.

Tag Description
<SaleType> Possible values:
  • sales_proforma - Proforma Invoice (Received Prepayment)
  • sales_invoice - Unpaid Sales Invoice
  • credit_note - Unpaid Sales Credit Note
<Amount> Remaining Due amount for Invoice and Credit note, prepaid amount for Proforma.
<Currency> Currency code
<CurrencyRate> Indirect exchange rate for the currency. Should be provided only if the currency is not equal to the company balance currency.
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
If not provided, the default tax basis will be used.
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key. Sould be provided only if tax basis is cash.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for sales document

Back to Opening Balances

POSTAdd Unpaid Purchase or Paid Prepayment

Request

XML / HTTP
POST https://go.paytraq.com/api/opening/balances/purchase

This API call is used to add an unpaid purchase or paid prepayment to the opening balances.
The purchase can be a paid proforma invoice, unpaid purchase invoice or unpaid purchase credit note.
The date of the journal entry will be the conversion date set in the system.
The document will be posted automatically, no additional call is required to post the document.

Payload

XML / HTTP
<OpeningBalances>
 <Purchase>   
  <PurchaseType></PurchaseType>   
  <DocumentDate></DocumentDate>
  <DocumentRef></DocumentRef>
  <DateDue></DateDue>
  <Supplier>
    <SupplierID></SupplierID>
    <SupplierName></SupplierName>
  </Supplier>
  <Project>
    <ProjectName></ProjectName>
  </Project>
  <Amount></Amount>
  <Currency></Currency>
  <CurrencyRate></CurrencyRate>
  <Description></Description>
  <TaxBasis></TaxBasis>
  <TaxKey>
   <TaxKeyID></TaxKeyID>
  </TaxKey>
  <Comment></Comment>
 </Purchase> 
</OpeningBalances>

Only <PurchaseType> is required.
To add a supplier <SupplierID /> OR <SupplierName /> should be provided.

Tag Description
<PurchaseType> Possible values:
  • purchase_proforma - Proforma Invoice (Paid Prepayment)
  • purchase_invoice - Unpaid Purchase Invoice
  • debit_note - Unpaid Purchase Credit Note
<Amount> Remaining Due amount for Invoice and Credit note, prepaid amount for Proforma.
<Currency> Currency code
<CurrencyRate> Indirect exchange rate for the currency. Should be provided only if the currency is not equal to the company balance currency.
<TaxBasis> Possible values:
  • 1 - Accrual
  • 2 - Cash
If not provided, the default tax basis will be used.
<TaxKeyID> Unique system identifier for tax key. See Get Tax Key. Sould be provided only if tax basis is cash.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Opening Balances

POSTAdd Unpaid Expense Claim

Request

XML / HTTP
POST https://go.paytraq.com/api/opening/balances/expenseClaim

This API call is used to add an unpaid expense claim to the opening balances.
The date of the journal entry will be the conversion date set in the system.
The document will be posted automatically, no additional call is required to post the document.

Payload

XML / HTTP
<OpeningBalances>
 <ExpenseClaim>   
  <DocumentDate></DocumentDate>
  <DocumentRef></DocumentRef>
  <DateDue></DateDue>
  <Employee>
    <EmployeeID></EmployeeID>
    <EmployeeName></EmployeeName>
  </Employee>
  <Project>
    <ProjectName></ProjectName>
  </Project>
  <Amount></Amount>
  <Currency></Currency>
  <CurrencyRate></CurrencyRate>
  <Description></Description>
  <Comment></Comment>
 </ExpenseClaim> 
</OpeningBalances>

To add an employee <EmployeeID /> OR <EmployeeName /> should be provided.

Tag Description
<Amount> Remaining Due amount
<Currency> Currency code
<CurrencyRate> Indirect exchange rate for the currency. Should be provided only if the currency is not equal to the company balance currency.

Response

XML / HTTP
<Response>
   <DocumentID></DocumentID>
</Response>
Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Opening Balances

Copied to clipboard