PayTraq API

Current Version: v2.11
Last Updated: 10 Apr, 2024

Overview

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

Getting Started

To getting started primary user needs to obtain new API credentials for a company profile. API credentials consisted of API Key/Token pair should be used in every API call for authentication and authorization purposes.

APIKey and APIToken should be added either as the query string params or as the headers of the request.

Existing API credentials can be regenerated at any time that will prevent API access by using the previous Key/Token pair. API Access can be blocked at any time by deleting current active credentials.

The transmission of all API requests and responses needs to be made over HTTPS.
There are two type of requests: GET and POST. GET requests are usually used to read the data, POST request are used to add and update the data.
All POST requests should be made in XML format with "Content-Type: application/xml" header.
All success responses are also given in XML format.

Examples

curl -v -X GET https://go.paytraq.com/api/{APICall}?APIToken={APIToken}&APIKey={APIKey}
curl -v https://go.paytraq.com/api/{APICall}?APIToken={APIToken}&APIKey={APIKey} \
-H "Content-Type:application/xml" \
-d "{RequestBody}"

OR
curl -v -X GET https://go.paytraq.com/api/{APICall} \
-H "APIToken:{APIToken}" \
-H "APIKey:{APIKey}"
curl -v https://go.paytraq.com/api/{APICall} \
-H "Content-Type:application/xml" \
-H "APIToken:{APIToken}" \
-H "APIKey:{APIKey}" \
-d "{RequestBody}"

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 Convensions

  • 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 Rate Limit: 1 request per second at an average, with bursts not exceeding 5 requests

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

Get Client List

Request

GET https://go.paytraq.com/api/clients?APIToken={APIToken}&APIKey={APIKey}

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.

Response


<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

Get Client

Request

GET https://go.paytraq.com/api/client/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<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

Get Client By Registration Number

Request

GET https://go.paytraq.com/api/clientByRegNumber/{RegNumber}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
RegNumber Registration number

Response

Please refer to Get Client request

Back to Clients

Add Client

Request

POST https://go.paytraq.com/api/client?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <ClientID></ClientID>
</Response>

Tag Description
<ClientID> Unique system identifier for client

Back to Clients

Update Client (General Data)

Request

POST https://go.paytraq.com/api/client/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Payload


<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


<Response>
   <ClientID></ClientID>
</Response>

Tag Description
<ClientID> Unique system identifier for client

Back to Clients

Update Client (Financial Data)

Request

POST https://go.paytraq.com/api/client/financialData/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Payload


<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


<Response>
   <ClientID></ClientID>
</Response>

Tag Description
<ClientID> Unique system identifier for client

Back to Clients

Get Client Shipping Address List

Request

GET https://go.paytraq.com/api/client/shippingAddresses/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<ShippingAddresses>
   <ShippingAddress>
      <AddressID></AddressID>
      <ShipTo></ShipTo>
      <Address></Address>
      <Zip></Zip>
      <Country></Country>
      <IsDefault></IsDefault>
   </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

Get Client Shipping Address

Request

GET https://go.paytraq.com/api/client/shippingAddress/{ClientID}/{AddressID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
AddressID Unique system identifier for shipping address

Response


<ShippingAddress>
   <AddressID></AddressID>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
</ShippingAddress>

Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Clients

Add Client Shipping Address

Request

POST https://go.paytraq.com/api/client/shippingAddress/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Payload


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

For tags description please refer to Get Client Shipping Address request

Response


<Response>
   <AddressID></AddressID>
</Response>

Tag Description
<AddressID> Unique system identifier for shipping address

Back to Clients

Update Client Shipping Address

Request

POST https://go.paytraq.com/api/client/shippingAddress/{ClientID}/{AddressID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
AddressID Unique system identifier for shipping address

Payload


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

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

Response


<Response>
   <AddressID></AddressID>
</Response>

Tag Description
<AddressID> Unique system identifier for shipping address

Back to Clients

Get Client Contact List

Request

GET https://go.paytraq.com/api/client/contacts/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<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

Get Client Contact

Request

GET https://go.paytraq.com/api/client/contact/{ClientID}/{ContactID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
ContactID Unique system identifier for contact

Response


<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

Add Client Contact

Request

POST https://go.paytraq.com/api/client/contact/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Payload


<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


<Response>
   <ContactID></ContactID>
</Response>

Tag Description
<ContactID> Unique system identifier for contact

Back to Clients

Update Client Contact

Request

POST https://go.paytraq.com/api/client/contact/{ClientID}/{ContactID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
ContactID Unique system identifier for contact

Payload


<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


<Response>
   <ContactID></ContactID>
</Response>

Tag Description
<ContactID> Unique system identifier for contact

Back to Clients

Get Client Bank Details

Request

GET https://go.paytraq.com/api/client/banks/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<BankDetails>
   <BankInfo>
      <BankInfoID></BankInfoID>
      <BankAccount></BankAccount>
      <BankName></BankName>
      <BankCode></BankCode>
      <PaymentNote></PaymentNote>
      <IsDefault></IsDefault>
   </BankInfo>
</BankDetails>

Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Clients

Get Client Bank Info

Request

GET https://go.paytraq.com/api/client/bank/{ClientID}/{BankInfoID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
BankInfoID Unique system identifier for bank info

Response


<BankInfo>
   <BankInfoID></BankInfoID>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
</BankInfo>

Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Clients

Add Client Bank Info

Request

POST https://go.paytraq.com/api/client/bank/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Payload


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

For tags description please refer to Get Client Bank Info request

Response


<Response>
   <BankInfoID></BankInfoID>
</Response>

Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Clients

Update Client Bank Info

Request

POST https://go.paytraq.com/api/client/bank/{ClientID}/{BankInfoID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client
BankInfoID Unique system identifier for bank info

Payload


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

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

Response


<Response>
   <BankInfoID></BankInfoID>
</Response>

Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Clients

Get Client Groups

Request

GET https://go.paytraq.com/api/clientGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<ClientGroups>
   <ClientGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </ClientGroup>
   ...
</ClientGroups>

Tag Description
<GroupID> Unique system identifier for client group

Back to Clients

Get Default Client Group

Request

GET https://go.paytraq.com/api/clientGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

GET https://go.paytraq.com/api/clientLink/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<Client>
   <BillingSummaryLink>
      <URL></URL>
   </BillingSummaryLink>
</Client>

Back to Clients

Get Client Outstanding Balances

Request

GET https://go.paytraq.com/api/client/outstanding/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client

Response


<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

Suppliers

Get Supplier List

Request

GET https://go.paytraq.com/api/suppliers?APIToken={APIToken}&APIKey={APIKey}

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.

Response


<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

Get Supplier

Request

GET https://go.paytraq.com/api/supplier/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Response


<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

Get Supplier By Registration Number

Request

GET https://go.paytraq.com/api/supplierByRegNumber/{RegNumber}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
RegNumber Registration number

Response

Please refer to Get Supplier request

Back to Suppliers

Add Supplier

Request

POST https://go.paytraq.com/api/supplier?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <SupplierID></SupplierID>
</Response>

Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

Update Supplier (General Data)

Request

POST https://go.paytraq.com/api/supplier/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Payload


<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


<Response>
   <SupplierID></SupplierID>
</Response>

Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

Update Supplier (Financial Data)

Request

POST https://go.paytraq.com/api/supplier/financialData/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Payload


<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


<Response>
   <SupplierID></SupplierID>
</Response>

Tag Description
<SupplierID> Unique system identifier for supplier

Back to Suppliers

Get Supplier Shipping Address List

Request

GET https://go.paytraq.com/api/supplier/shippingAddresses/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Response


<ShippingAddresses>
   <ShippingAddress>
      <AddressID></AddressID>
      <ShipTo></ShipTo>
      <Address></Address>
      <Zip></Zip>
      <Country></Country>
      <IsDefault></IsDefault>
   </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

Get Supplier Shipping Address

Request

GET https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}/{AddressID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier
AddressID Unique system identifier for shipping address

Response


<ShippingAddress>
   <AddressID></AddressID>
   <ShipTo></ShipTo>
   <Address></Address>
   <Zip></Zip>
   <Country></Country>
   <IsDefault></IsDefault>
</ShippingAddress>

Tag Description
<AddressID> Unique system identifier for shipping address
<Country> 2-letter ISO country code
<IsDefault> Boolean value (false | true)

Back to Suppliers

Add Supplier Shipping Address

Request

POST https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Payload


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

For tags description please refer to Get Supplier Shipping Address request

Response


<Response>
   <AddressID></AddressID>
</Response>

Tag Description
<AddressID> Unique system identifier for shipping address

Back to Suppliers

Update Supplier Shipping Address

Request

POST https://go.paytraq.com/api/supplier/shippingAddress/{SupplierID}/{AddressID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier
AddressID Unique system identifier for shipping address

Payload


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

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

Response


<Response>
   <AddressID></AddressID>
</Response>

Tag Description
<AddressID> Unique system identifier for shipping address

Back to Suppliers

Get Supplier Contact List

Request

GET https://go.paytraq.com/api/supplier/contacts/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Response


<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

Get Supplier Contact

Request

GET https://go.paytraq.com/api/supplier/contact/{SupplierID}/{ContactID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier
ContactID Unique system identifier for contact

Response


<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

Add Supplier Contact

Request

POST https://go.paytraq.com/api/supplier/contact/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Payload


<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


<Response>
   <ContactID></ContactID>
</Response>

Tag Description
<ContactID> Unique system identifier for contact

Back to Suppliers

Update Supplier Contact

Request

POST https://go.paytraq.com/api/supplier/contact/{SupplierID}/{ContactID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier
ContactID Unique system identifier for contact

Payload


<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


<Response>
   <ContactID></ContactID>
</Response>

Tag Description
<ContactID> Unique system identifier for contact

Back to Suppliers

Get Supplier Bank Details

Request

GET https://go.paytraq.com/api/supplier/banks/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Response


<BankDetails>
   <BankInfo>
      <BankInfoID></BankInfoID>
      <BankAccount></BankAccount>
      <BankName></BankName>
      <BankCode></BankCode>
      <PaymentNote></PaymentNote>
      <IsDefault></IsDefault>
   </BankInfo>
</BankDetails>

Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Suppliers

Get Supplier Bank Info

Request

GET https://go.paytraq.com/api/supplier/bank/{SupplierID}/{BankInfoID}?APIToken={APIToken}&APIKey={APIKey}

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

Response


<BankInfo>
   <BankInfoID></BankInfoID>
   <BankAccount></BankAccount>
   <BankName></BankName>
   <BankCode></BankCode>
   <PaymentNote></PaymentNote>
   <IsDefault></IsDefault>
</BankInfo>

Tag Description
<BankInfoID> Unique system identifier for bank info
<IsDefault> Boolean value (false | true)

Back to Suppliers

Add Supplier Bank Info

Request

POST https://go.paytraq.com/api/supplier/bank/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier

Payload


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

For tags description please refer to Get Supplier Bank Info request

Response


<Response>
   <BankInfoID></BankInfoID>
</Response>

Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Suppliers

Update Supplier Bank Info

Request

POST https://go.paytraq.com/api/supplier/bank/{SupplierID}/{BankInfoID}?APIToken={APIToken}&APIKey={APIKey}

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

Payload


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

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

Response


<Response>
   <BankInfoID></BankInfoID>
</Response>

Tag Description
<BankInfoID> Unique system identifier for bank info

Back to Suppliers

Get Supplier Groups

Request

GET https://go.paytraq.com/api/supplierGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<SupplierGroups>
   <SupplierGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </SupplierGroup>
   ...
</SupplierGroups>

Tag Description
<GroupID> Unique system identifier for supplier group

Back to Suppliers

Get Default Supplier Group

Request

GET https://go.paytraq.com/api/supplierGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Employees

Get Employee List

Request

GET https://go.paytraq.com/api/employees?APIToken={APIToken}&APIKey={APIKey}

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


<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

Get Employee

Request

GET https://go.paytraq.com/api/employee/{EmployeeID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
EmployeeID Unique system identifier for employee

Response


<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

Add Employee

Request

POST https://go.paytraq.com/api/employee?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <EmployeeID></EmployeeID>
</Response>

Tag Description
<EmployeeID> Unique system identifier for employee

Back to Employees

Update Employee (General Data)

Request

POST https://go.paytraq.com/api/employee/{EmployeeID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
EmployeeID Unique system identifier for employee

Payload


<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


<Response>
   <EmployeeID></EmployeeID>
</Response>

Tag Description
<EmployeeID> Unique system identifier for employee

Back to Employees

Get Employee Groups

Request

GET https://go.paytraq.com/api/employeeGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<EmployeeGroups>
   <EmployeeGroup>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </EmployeeGroup>
   ...
</EmployeeGroups>

Tag Description
<GroupID> Unique system identifier for employee group

Back to Employees

Get Default Employee Group

Request

GET https://go.paytraq.com/api/employeeGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Product List

Request

GET https://go.paytraq.com/api/products?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/products? ... &WarehouseID=0&PriceGroupID=0&suppliers=true
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

Response


<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

Get Product

Request

GET https://go.paytraq.com/api/product/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Response


<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

Get Product By Code (SKU)

Request

GET https://go.paytraq.com/api/productByCode/{Code}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
Code Product code (SKU)

Response

Please refer to Get Product request

Back to Items

Get Product Image

Request

GET https://go.paytraq.com/api/productImage/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Response

Image (JPEG/PNG)

Back to Items

Get Product Price List

Request

GET https://go.paytraq.com/api/productPriceList/{PriceGroupID}?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/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


<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

Add Product

Request

POST https://go.paytraq.com/api/product?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for product

Back to Items

Update Product

Request

POST https://go.paytraq.com/api/product/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Payload


<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


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for product

Back to Items

Add/Update Product Image

Request

POST https://go.paytraq.com/api/productImage/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Payload


<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


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for product

Back to Items

Add/Update Product Price

Request

POST https://go.paytraq.com/api/productPrice/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Payload


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

For tags description please refer to Get Product request

Response


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for product

Back to Items

Get Product Groups

Request

GET https://go.paytraq.com/api/productGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<Groups>
   <Group>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </Group>
   ...
</Groups>

Tag Description
<GroupID> Unique system identifier for product group

Back to Items

Get Default Product Group

Request

GET https://go.paytraq.com/api/productGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Lot List

Request

GET https://go.paytraq.com/api/lots?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/products? ... &WarehouseID=0
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Response


<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

Get Lot List By Product

Request

GET https://go.paytraq.com/api/product/lots/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
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 https://go.paytraq.com/api/products? ... &WarehouseID=0
WarehouseID - Unique system identifier for warehouse. See Get Warehouse

Response


<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

Get Lot

Request

GET https://go.paytraq.com/api/lot/{LotID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
LotID Unique system identifier for lot

Response


<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

Get Lot By Number

Request

GET https://go.paytraq.com/api/lotByNumber/{ItemID}/{LotNumber}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product
LotNumber Lot number

Response


<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

Add Lot

Request

POST https://go.paytraq.com/api/product/lot/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product

Payload


<Lot>
  <LotNumber></LotNumber>
  <ExpiryDate></ExpiryDate>
</Lot>

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

Response


<Response>
  <LotID></LotID>
</Response>

Tag Description
<LotID> Unique system identifier for lot

Back to Items

Update Lot

Request

POST https://go.paytraq.com/api/lot/{LotID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
LotID Unique system identifier for lot

Payload


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

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

Response


<Response>
   <LotID></LotID>
</Response>

Tag Description
<LotID> Unique system identifier for lot

Back to Items

Get Service List

Request

GET https://go.paytraq.com/api/services?APIToken={APIToken}&APIKey={APIKey}

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.

Response


<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

Get Service

Request

GET https://go.paytraq.com/api/service/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for service

Response


<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

Get Service By Code

Request

GET https://go.paytraq.com/api/serviceByCode/{Code}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
Code Service code

Response

Please refer to Get Service request

Back to Items

Get Service Price List

Request

GET https://go.paytraq.com/api/servicePriceList/{PriceGroupID}?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/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


<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

Add Service

Request

POST https://go.paytraq.com/api/service?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for service

Back to Items

Update Service

Request

POST https://go.paytraq.com/api/service/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for service

Payload


<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


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for service

Back to Items

Add/Update Service Price

Request

POST https://go.paytraq.com/api/servicePrice/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for service

Payload


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

For tags description please refer to Get Service request

Response


<Response>
   <ItemID></ItemID>
</Response>

Tag Description
<ItemID> Unique system identifier for service

Back to Items

Get Service Groups

Request

GET https://go.paytraq.com/api/serviceGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<Groups>
   <Group>
      <GroupID></GroupID>
      <GroupName></GroupName>
   </Group>
   ...
</Groups>

Tag Description
<GroupID> Unique system identifier for service group

Back to Items

Get Default Service Group

Request

GET https://go.paytraq.com/api/serviceGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Warehouse List

Request

GET https://go.paytraq.com/api/warehouses?APIToken={APIToken}&APIKey={APIKey}

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

Response


<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

Get Warehouse

Request

GET https://go.paytraq.com/api/warehouse/{WarehouseID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
WarehouseID Unique system identifier for warehouse

Response


<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

Get Loading Area List

Request

GET https://go.paytraq.com/api/loadingAreas?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Loading Area

Request

GET https://go.paytraq.com/api/loadingArea/{LoadingAreaID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
LoadingAreaID Unique system identifier for loading area

Response


<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

Get Default Loading Area

Request

GET https://go.paytraq.com/api/loadingAreaDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Shipper List

Request

GET https://go.paytraq.com/api/shippers?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Shipper

Request

GET https://go.paytraq.com/api/shipper/{ShipperID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ShipperID Unique system identifier for shipper

Response


<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

Add Shipper

Request

POST https://go.paytraq.com/api/shipper?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ShipperID Unique system identifier for shipper

Payload


<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


<Response>
   <ShipperID></ShipperID>
</Response>

Tag Description
<ShipperID> Unique system identifier for shipper

Back to Warehousing

Update Shipper

Request

POST https://go.paytraq.com/api/shipper/{ShipperID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ShipperID Unique system identifier for shipper

Payload


<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


<Response>
   <ShipperID></ShipperID>
</Response>

Tag Description
<ShipperID> Unique system identifier for shipper

Back to Warehousing

Get Current Inventory

Request

GET https://go.paytraq.com/api/currentInventory/{WarehouseID}?APIToken={APIToken}&APIKey={APIKey}

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


<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

Get Product Inventory

Request

GET https://go.paytraq.com/api/productInventory/{ItemID}?APIToken={APIToken}&APIKey={APIKey}

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


<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

Sales

Get Sales Document List

Request

GET https://go.paytraq.com/api/sales?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/sales? ... &ClientID=0
ClientID - Unique system identifier for client. See Get Client

Response


<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

Get Sales Document

Request

GET https://go.paytraq.com/api/sale/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for sales document

Response


<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>
         <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>
      </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>
   <Tags>
      <Tag />
   </Tags>
</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

Back to Sales

Add Sales Document

Request

POST https://go.paytraq.com/api/sale?APIToken={APIToken}&APIKey={APIKey}

Payload


<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>
   <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>
      </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.
For tags description please refer to Get Sale Document.

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Update Sales Document

Request

POST https://go.paytraq.com/api/sale/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for sales document

Payload


<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>
   <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>
      </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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Post Sales Document

Request

GET https://go.paytraq.com/api/salePost/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Approve Sales Document

Request

GET https://go.paytraq.com/api/saleApprove/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Void Sales Document

Request

GET https://go.paytraq.com/api/saleVoid/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Create Invoice from Proforma

Request

GET https://go.paytraq.com/api/proformaToSalesInvoice/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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


<Response>
   <DocumentID></DocumentID>
   <AmountDue></AmountDue>
</Response>

Tag Description
<DocumentID> Unique system identifier for created invoice

Back to Sales

Add Direct Payment to Sales Document

Request

POST https://go.paytraq.com/api/salePayment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for sales document

Payload


<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


<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

Offset Invoice with Credit Note

Request

GET https://go.paytraq.com/api/offsetSalesInvoiceWithCreditNote/{InvoiceID}/{CreditNoteID}?APIToken={APIToken}&APIKey={APIKey}
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


<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

Add Overpayment

Request

POST https://go.paytraq.com/api/overpaymentReceived/{ClientID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ClientID Unique system identifier for client. See Get Client

Payload


<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


<Response>
   <ClientID></ClientID>
   <JournalID></JournalID>
</Response>

Tag Description
<ClientID> Unique system identifier for client. See Get Client
<JournalID> Unique system identifier for journal

Back to Sales

Offset Overpayment

Request

GET https://go.paytraq.com/api/offsetOverpaymentReceived/{InvoiceID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
InvoiceID Unique system identifier for invoice

Offset date will be the date of the invoice.

Response


<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Get Sales Document as PDF

Request

GET https://go.paytraq.com/api/salePDF/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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&APIToken={APIToken}&APIKey={APIKey}

Response

PDF (MIME type - application/pdf)

Back to Sales

Get Sales Document as Estonian E-invoice

Request

GET https://go.paytraq.com/api/saleEInvoice/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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&APIToken={APIToken}&APIKey={APIKey}

Response

XML (MIME type - application/xml)

Back to Sales

Get Sales Document as UBL

Request

GET https://go.paytraq.com/api/saleUBL/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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&APIToken={APIToken}&APIKey={APIKey}

Response

XML (MIME type - application/xml)

Back to Sales

Request

GET https://go.paytraq.com/api/saleLink/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for sales document

Response


<Sale>
   <DocumentLink>
      <URL></URL>
   </DocumentLink>
</Sale>

Back to Sales

Send Sales Document

Request

GET https://go.paytraq.com/api/saleSend/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

The document is sent to all available channels.

Parameter Description
DocumentID Unique system identifier for sales document

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Send E-Invoice

Request

GET https://go.paytraq.com/api/saleSendEInvoice/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

The document is sent as e-invoice only.

Parameter Description
DocumentID Unique system identifier for sales document

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for sales document

Back to Sales

Purchases

Get Purchase Document List

Request

GET https://go.paytraq.com/api/purchases?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/purchases? ... &SupplierID=0
SupplierID - Unique system identifier for supplier. See Get Supplier

Response


<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 - Purchase Voucher
  • 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

Get Purchase Document

Request

GET https://go.paytraq.com/api/purchase/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for purchase document

Response


<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>
         <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>
      </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>
   <Tags>
      <Tag />
   </Tags>
</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 - Purchase Voucher
  • 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

Add Purchase Document

Request

POST https://go.paytraq.com/api/purchase?APIToken={APIToken}&APIKey={APIKey}

Payload


<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>
      </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.
For tags description please refer to Get Purchase Document.

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Update Purchase Document

Request

POST https://go.paytraq.com/api/purchase/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for purchase document

Payload


<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>
      </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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Post Purchase Document

Request

GET https://go.paytraq.com/api/purchasePost/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for purchase document

Only documents with status Draft can be posted.

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Approve Purchase Document

Request

GET https://go.paytraq.com/api/purchaseApprove/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Void Purchase Document

Request

GET https://go.paytraq.com/api/purchaseVoid/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for purchase document

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

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Add Direct Payment to Purchase Document

Request

POST https://go.paytraq.com/api/purchasePayment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

Parameter Description
DocumentID Unique system identifier for purchase document

Payload


<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


<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

Offset Invoice with Credit Note

Request

GET https://go.paytraq.com/api/offsetPurchaseInvoiceWithCreditNote/{InvoiceID}/{CreditNoteID}?APIToken={APIToken}&APIKey={APIKey}
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


<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

Add Overpayment

Request

POST https://go.paytraq.com/api/overpaymentMade/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
SupplierID Unique system identifier for supplier. See Get Supplier

Payload


<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


<Response>
   <SupplierID></SupplierID>
   <JournalID></JournalID>
</Response>

Tag Description
<SupplierID> Unique system identifier for supplier. See Get Supplier
<JournalID> Unique system identifier for journal

Back to Purchases

Offset Overpayment

Request

GET https://go.paytraq.com/api/offsetOverpaymentMade/{InvoiceID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
InvoiceID Unique system identifier for invoice

Offset date will be the date of the invoice.

Response


<Response>
   <OffsetAmount></OffsetAmount>
    <Invoice>
        <DocumentID></DocumentID>
        <AmountDue></AmountDue>
    </Invoice>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Get Expense Claims

Request

GET https://go.paytraq.com/api/expenseClaims?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/expenseClaims? ... &EmployeeID=0
EmployeeID - Unique system identifier for employee. See Get Employee

Response


<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 expepse 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

Get Expense Claim

Request

GET https://go.paytraq.com/api/expenseClaim/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for expense claim

Response


<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>
   <Tags>
      <Tag />
   </Tags>
</ExpenseClaim>

Tag Description
<DocumentID> Unique system identifier for expepse 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

Add Expense Claim

Request

POST https://go.paytraq.com/api/expenseClaim?APIToken={APIToken}&APIKey={APIKey}

Payload


<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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for purchase document

Back to Purchases

Update Expense Claim

Request

POST https://go.paytraq.com/api/expenseClaim/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for expense claim

Payload


<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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Purchases

Post Expense Claim

Request

GET https://go.paytraq.com/api/expenseClaimPost/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for expense claim

Only documents with status Waiting for Approval can be posted.

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for expense claim

Back to Purchases

Add Direct Payment to Expense Claim

Request

POST https://go.paytraq.com/api/expenseClaimPayment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for expense claim

Payload


<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


<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

Inventory Moves

Get Inventory Movements

Request

GET https://go.paytraq.com/api/inventoryMovements?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/inventoryMovements? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client or supplier. See Get Client or Get Supplier

Response


<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

Get Inventory Movement

Request

GET https://go.paytraq.com/api/inventoryMovement/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for inventory document

Response


<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>
         <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

Add Shipment

Request

POST https://go.paytraq.com/api/shipment?APIToken={APIToken}&APIKey={APIKey}

Payload


<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>
      </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.
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


<Response>
   <DocumentID></DocumentID>
</Response>

Tag Description
<DocumentID> Unique system identifier for document

Back to Inventory Moves

Update Shipment

Request

POST https://go.paytraq.com/api/shipment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for document

Payload


<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>
      </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


<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

Approve Shipment

Request

GET https://go.paytraq.com/api/shipmentApprove/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for document

Only documents with status Waiting for Approval can be approved.

Response


<Response>
   <DocumentID></DocumentID>
</Response>

Back to Inventory Moves

Payments

Get Payments

Request

GET https://go.paytraq.com/api/payments?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/payments? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee

Response


<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 Payments

Get Payment

Request

GET https://go.paytraq.com/api/payment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for payment document

Response


<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>
   <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 Payments

Add Payment

Request

POST https://go.paytraq.com/api/payment?APIToken={APIToken}&APIKey={APIKey}

This API call is not implemented yet

Response

501 Not Implemented (This call is not implemented yet)

Back to Payments

Update Payment

Request

POST https://go.paytraq.com/api/payment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

This API call is not implemented yet

Response

501 Not Implemented (This call is not implemented yet)

Back to Payments

Post Payment

Request

GET https://go.paytraq.com/api/paymentPost/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}

This API call is not implemented yet

Response

501 Not Implemented (This call is not implemented yet)

Back to Payments

Upload a Bank Statement

Request

POST https://go.paytraq.com/api/bankStatementUpload/{BankAccountID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
BankAccountID Unique system identifier for bank account. See Get Bank Accounts

Payload


<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


<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 Payments

Accounting

Get Tax Keys

Request

GET https://go.paytraq.com/api/taxKeys?APIToken={APIToken}&APIKey={APIKey}

Response


<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>
      </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)
<IsInactive> Boolean value (false | true)
<Country> 2-letter ISO country code

Back to Accounting

Get Tax Key

Request

GET https://go.paytraq.com/api/taxKey/{TaxKeyID}?APIToken={APIToken}&APIKey={APIKey}

Parameter Description
TaxKeyID Unique system identifier for tax key

Response


<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>
   </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)
<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

Get Accounts

Request

GET https://go.paytraq.com/api/accounts?APIToken={APIToken}&APIKey={APIKey}

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


<Accounts>
   <Account>
      <AccountID></AccountID>
      <Code></Code>
      <Name></Name>
      <Alias></Alias>
      <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

Get Account

Request

GET https://go.paytraq.com/api/account/{AccountID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
AccountID Unique system identifier for account

Response


<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

Get Account By Code

Request

GET https://go.paytraq.com/api/accountByCode/{Code}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
Code Account Code

Response


<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

Get Bank Accounts

Request

GET https://go.paytraq.com/api/bankAccounts?APIToken={APIToken}&APIKey={APIKey}

Response


<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 Accounting

Get Cash Accounts

Request

GET https://go.paytraq.com/api/cashAccounts?APIToken={APIToken}&APIKey={APIKey}

Response


<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 Accounting

Get Trial Balance

Request

GET https://go.paytraq.com/api/trialBalance?APIToken={APIToken}&APIKey={APIKey}

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


<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

Get Balance Confirmation

Request

GET https://go.paytraq.com/api/balanceConfirmation/{BusinessPartnerID}?APIToken={APIToken}&APIKey={APIKey}

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


<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>
                    <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

Get Journal Types

Request

GET https://go.paytraq.com/api/journalTypes?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Journals

Request

GET https://go.paytraq.com/api/journals?APIToken={APIToken}&APIKey={APIKey}

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 https://go.paytraq.com/api/journals? ... &BusinessPartnerID=0
BusinessPartnerID - Unique system identifier for client, supplier or employee. See Get Client, Get Supplier or Get Employee

Response


<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
<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

Get Journal

Request

GET https://go.paytraq.com/api/journal/{JournalID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
JournalID Unique system identifier for journal

Response


<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
<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

Add Manual Journal

Request

POST https://go.paytraq.com/api/manualJournal?APIToken={APIToken}&APIKey={APIKey}

Payload


<Journal>
   <JournalDate></JournalDate>
   <JournalType>
      <JournalTypeID></JournalTypeID>
   </JournalType>
   <Narration />
   <ExtReference></ExtReference>
   <BusinessPartner>
      <BusinessPartnerID></BusinessPartnerID>
      <BusinessPartnerName></BusinessPartnerName>
   </BusinessPartner>
   <Project>
      <ProjectName />
   </Project>
   <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>, <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
<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


<Response>
   <JournalID></JournalID>
</Response>

Tag Description
<JournalID> Unique system identifier for journal

Back to Accounting

Attachments

Upload Document Attachment

Request

POST https://go.paytraq.com/api/documentAttachment/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for document

Payload


<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


<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

Upload Journal Attachment

Request

POST https://go.paytraq.com/api/journalAttachment/{JournalID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
JournalID Unique system identifier for journal

Payload


<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


<Response>
   <AttachmentID></AttachmentID>
   <AttachmentUID></AttachmentUID>
   <JournalID></JournalID>
</Response>

Tag Description
<AttachmentID> Unique system identifier for attachment
<JournalID> Unique system identifier for journal

Back to Attachments

Upload Partner Attachment

Request

POST https://go.paytraq.com/api/partnerAttachment/{BusinessPartnerID}?APIToken={APIToken}&APIKey={APIKey}

Upload Client Attachment:
POST https://go.paytraq.com/api/clientAttachment/{ClientID}?APIToken={APIToken}&APIKey={APIKey}

Upload Supplier Attachment:
POST https://go.paytraq.com/api/supplierAttachment/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}

Upload Employee Attachment:
POST https://go.paytraq.com/api/employeeAttachment/{EmployeeID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Payload


<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


<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

Upload Product/Service Attachment

Request

POST https://go.paytraq.com/api/itemAttachment/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product/service

Payload


<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


<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

Get Document Attachments

Request

GET https://go.paytraq.com/api/documentAttachments/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for document

Response


<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
    </Attachment>
    ...
</Attachments>

Tag Description
<AttachmentID> Unique system identifier for attachment

Back to Attachments

Get Journal Attachments

Request

GET https://go.paytraq.com/api/journalAttachments/{JournalID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
JournalID Unique system identifier for journal

Response


<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
    </Attachment>
    ...
</Attachments>

Tag Description
<AttachmentID> Unique system identifier for attachment

Back to Attachments

Get Partner Attachments

Request

GET https://go.paytraq.com/api/partnerAttachments/{BusinessPartnerID}?APIToken={APIToken}&APIKey={APIKey}

Get Client Attachments
GET https://go.paytraq.com/api/clientAttachments/{ClientID}?APIToken={APIToken}&APIKey={APIKey}

Get Supplier Attachments
GET https://go.paytraq.com/api/supplierAttachments/{SupplierID}?APIToken={APIToken}&APIKey={APIKey}

Get Employee Attachments
GET https://go.paytraq.com/api/employeeAttachments/{EmployeeID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Response


<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
    </Attachment>
    ...
</Attachments>

Tag Description
<AttachmentID> Unique system identifier for attachment

Back to Attachments

Get Product/Service Attachments

Request

GET https://go.paytraq.com/api/itemAttachments/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product/service

Response


<Attachments>
    <Attachment>
        <AttachmentID></AttachmentID>
        <AttachmentUID></AttachmentUID>
        <FileName></FileName>
        <ContentType></ContentType>
        <Description></Description>
        <Link></Link>
    </Attachment>
    ...
</Attachments>

Tag Description
<AttachmentID> Unique system identifier for attachment

Back to Attachments

Download Attachment

Request

GET https://go.paytraq.com/api/attachment/{AttachmentID}/{AttachmentUID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
AttachmentID Unique system identifier for attachment
AttachmentUID Unique identification number for attachment

Response

File (MIME type - ContentType)

Back to Attachments

Tags

Add/Update Document Tags

Request

POST https://go.paytraq.com/api/documentTags/{DocumentID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
DocumentID Unique system identifier for document

Payload


<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>

Tag Description
<Tag> Tag Name

Response


<Response>
   <DocumentID></DocumentID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>

Tag Description
<DocumentID> Unique system identifier for document

Back to Tags

Add/Update Journal Tags

Request

POST https://go.paytraq.com/api/journalTags/{JournalID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
JournalID Unique system identifier for journal

Payload


<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>

Tag Description
<Tag> Tag Name

Response


<Response>
   <JournalID></JournalID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>

Tag Description
<JournalID> Unique system identifier for journal

Back to Tags

Add/Update Partner Tags

Request

POST https://go.paytraq.com/api/partnerTags/{BusinessPartnerID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
BusinessPartnerID Unique system identifier for partner

Payload


<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>

Tag Description
<Tag> Tag Name

Response


<Response>
   <BusinessPartnerID></BusinessPartnerID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>

Tag Description
<BusinessPartnerID> Unique system identifier for partner

Back to Tags

Add/Update Product/Service Tags

Request

POST https://go.paytraq.com/api/itemTags/{ItemID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
ItemID Unique system identifier for product/service

Payload


<Tags>
   <Tag></Tag>
   <Tag></Tag>
</Tags>

Tag Description
<Tag> Tag Name

Response


<Response>
   <ItemID></ItemID>
   <Tags>
      <Tag></Tag>
   </Tags>
</Response>

Tag Description
<ItemID> Unique system identifier for product/service

Back to Tags

Settings

Get Price Groups

Request

GET https://go.paytraq.com/api/priceGroups?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Price Group

Request

GET https://go.paytraq.com/api/priceGroup/{PriceGroupID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
PriceGroupID Unique system identifier for price group

Response


<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

Get Default Price Group

Request

GET https://go.paytraq.com/api/priceGroupDefaultId?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Units

Request

GET https://go.paytraq.com/api/units?APIToken={APIToken}&APIKey={APIKey}

Response


<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

Get Unit

Request

GET https://go.paytraq.com/api/unit/{UnitID}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
UnitID Unique system identifier for unit of measure

Response


<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

Get Unit By Name

Request

GET https://go.paytraq.com/api/unitByName/{Name}?APIToken={APIToken}&APIKey={APIKey}
Parameter Description
Name Unit name

Response


<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

Get Currencies

Request

GET https://go.paytraq.com/api/currencies?APIToken={APIToken}&APIKey={APIKey}

Response


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

Back to Settings