Articles in this section

Multi-currency: Purchase Endpoints

Avatar
Kotaro Kishimoto
  • Updated
Follow

In order to enable the multi-currency feature for AccountRight Live files, we have released changes to below Purchase endpoints:


Additional properties are introduced to support the Multi-currency feature for those endpoints. In order to be able to use this functionality, there are a few conditions that the AccountRight user must meet:

  • The file must be in version 2019.4.
  • The file must be in the Premier family. 


    For multi-currency enabled records, the value in Local-currency related properties, e.g. Total, UnitPrice, etc. will be ignored. On the other hand, the Multi-currency related properties, e.g. TotalForeign, UnitPriceForeign, etc. will be ignored on Local-currency records as vice-versa.


    Sample Post Requests:

         *Bold     = Added Multi-currency Property.
         *Red Bold = Added Mandatory Multi-currency  Property for Post and Put.
  Local Foreign
Purchase/Bill/Item {
  "Number": 15,
  "Date": "2014-08-11T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 0,
    "MonthlyChargeForLatePayment": 0
  },
  "IsTaxInclusive": true,
  "IsReportable": false,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Cooler Filter Large",
      "BillQuantity": 1000,
      "BackorderQuantity": 0,
      "Total": 19990,
      "UnitPrice": 19.99,
      "Job": null,
      "DiscountPercent": 0,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8",
        "Code": "GST",
        "URI": "{cf_uri}/GeneralLedger/TaxCode/38a37ae8-565c-46f8-ad4a-2a87069607f8"
      },
      "Item": {
        "UID": "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb"
      }
    }
  ],
  "Freight": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "PromisedDate": null,
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "BillDeliveryStatus": "Print",
  "Order": {
    "UID": "0611bdac-9608-47f7-a296-7ad15597da62"
  }
}		 {
  "Number": 15,
  "Date": "2014-08-11T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 0,
    "MonthlyChargeForLatePayment": 0
  },
  "IsTaxInclusive": true,
  "IsReportable": false,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Cooler Filter Large",
      "BillQuantity": 1000,
      "BackorderQuantity": 0,
      "TotalForeign": 19990,
      "UnitPriceForeign": 19.99,
      "Job": null,
      "DiscountPercent": 0,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      },
      "Item": {
        "UID": "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb"
      }
    }
  ],
  "FreightForeign": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "PromisedDate": null,
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "BillDeliveryStatus": "Print",
  "Order": {
    "UID": "0611bdac-9608-47f7-a296-7ad15597da62"
  },
  "ForeignCurrency": {
    "UID": "7a273963-b895-41d8-8009-41fd092cc5b4"
  },
  "CurrencyExchangeRate": 1
}
Purchase/Order/Item {
  "Number": 919,
  "Date": "2014-08-21T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000099899819",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 2
  },
  "IsTaxInclusive": true,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Cooler Filter Large",
      "BillQuantity": 5,
      "UnitPrice": 50.22,
      "DiscountPercent": 0,
      "Total": 251.1,
      "Item": {
        "UID": "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb"
      },
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "IsReportable": false,
  "Freight": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "PromisedDate": null,
  "OrderDeliveryStatus": "Print",
  "BalanceDueAmount": 251.1
}		 {
  "Number": 919,
  "Date": "2014-08-21T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000099899819",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 2
  },
  "IsTaxInclusive": true,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Cooler Filter Large",
      "BillQuantity": 5,
      "UnitPrice": 50.22,
      "UnitPriceForeign": 50.22,
      "DiscountPercent": 0,
      "Total": 251.1,
      "TotalForeign": 251.1,
      "Item": {
        "UID": "ddf9c9b8-5ea4-4495-a9cb-094f3d8846cb"
      },
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "IsReportable": false,
  "Freight": 0,
  "FreightForeign": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "PromisedDate": null,
  "OrderDeliveryStatus": "Print",
  "ForeignCurrency": {
    "UID": "7a273963-b895-41d8-8009-41fd092cc5b4"
  },
  "CurrencyExchangeRate": 1
}
Purchase/Bill/Service {
  "Number": 55,
  "Date": "2014-08-11T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 0,
    "MonthlyChargeForLatePayment": 0
  },
  "IsTaxInclusive": true,
  "IsReportable": false,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Stationery",
      "Account": {
        "UID": "3777c4f0-48f7-40ab-aaea-3cec1433eef0"
      },
      "Total": 75.2,
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "Subtotal": 75.2,
  "Freight": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "PromisedDate": null,
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "BillDeliveryStatus": "Print",
  "Order": null
}		 {
  "Number": 55,
  "Date": "2014-08-11T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 0,
    "MonthlyChargeForLatePayment": 0
  },
  "IsTaxInclusive": true,
  "IsReportable": false,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Stationery",
      "Account": {
        "UID": "3777c4f0-48f7-40ab-aaea-3cec1433eef0"
      },
      "TotalForeign": 75.2,
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "SubtotalForeign": 75.2,
  "FreightForeign": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "TotalTaxForeign": 6.84,
  "TotalAmountForeign": 75.2,
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "PromisedDate": null,
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "BillDeliveryStatus": "Print",
  "Order": null,
  "ForeignCurrency": {
    "UID": "7a273963-b895-41d8-8009-41fd092cc5b4"
  },
  "CurrencyExchangeRate": 1
}
Purchase/Order/Service {
  "Number": 1095,
  "Date": "2014-08-21T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 2
  },
  "IsTaxInclusive": true,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Stationery",
      "Total": 29.7,
      "Account": {
        "UID": "3777c4f0-48f7-40ab-aaea-3cec1433eef0"
      },
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "IsReportable": false,
  "Subtotal": 29.7,
  "Freight": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "PromisedDate": null,
  "OrderDeliveryStatus": "Print"
}		 {
  "Number": 1095,
  "Date": "2014-08-21T00:00:00.0000000+10:00",
  "SupplierInvoiceNumber": "AAA000005899813",
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "ShipToAddress": "Clearwater Pty. Ltd. 25 Spring Street Blackburn VIC 3130",
  "Terms": {
    "PaymentIsDue": "DayOfMonthAfterEOM",
    "DiscountDate": 1,
    "BalanceDueDate": 30,
    "DiscountForEarlyPayment": 2
  },
  "IsTaxInclusive": true,
  "Lines": [
    {
      "Type": "Transaction",
      "Description": "Stationery",
      "Total": 29.7,
      "TotalForeign": 29.7,
      "Account": {
        "UID": "3777c4f0-48f7-40ab-aaea-3cec1433eef0"
      },
      "Job": null,
      "TaxCode": {
        "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
      }
    }
  ],
  "IsReportable": false,
  "Subtotal": 29.7,
  "SubtotalForeign": 29.7,
  "Freight": 0,
  "FreightForeign": 0,
  "FreightTaxCode": {
    "UID": "38a37ae8-565c-46f8-ad4a-2a87069607f8"
  },
  "Category": null,
  "Comment": "Thank you!",
  "ShippingMethod": "Federal Express",
  "JournalMemo": "Purchase; Huston & Huston Packaging",
  "PromisedDate": null,
  "OrderDeliveryStatus": "Print",
  "ForeignCurrency": {
    "UID": "7a273963-b895-41d8-8009-41fd092cc5b4"
  },
  "CurrencyExchangeRate": 1
}
 
  Local Foreign
Purchase/SupplierPayment {
  "PayFrom": "Account",
  "Account": {
    "UID": "7772dc25-5ee6-4a61-994e-28c04b8a35fc"
  },
  "Supplier": {
    "UID": "a96f1ee9-af79-4f9e-93bf-6b12e2676b90",
    "DisplayID": "SUPP000003"
  },
  "PayeeAddress": "Curbys Super Stands 67 Mountain Road Leura NSW 2477 Australia",
  "StatementParticulars": "",
  "PaymentNumber": 106,
  "Date": "2013-10-03T00:00:00.0000000+10:00",
  "AmountPaid": 69.95,
  "Memo": "Curbys Super Stands for PJ000009",
  "Lines": [
    {
      "Type": "Bill",
      "Purchase": {
        "UID": "8d757d45-a1c9-41b2-9b02-5c149f7d3979"
      },
      "AmountApplied": 69.95
    }
  ],
  "DeliveryStatus": "Print"
}		 {
  "PayFrom": "Account",
  "Account": {
    "UID": "7772dc25-5ee6-4a61-994e-28c04b8a35fc"
  },
  "Supplier": {
    "UID": "a96f1ee9-af79-4f9e-93bf-6b12e2676b90",
    "DisplayID": "SUPP000003"
  },
  "PayeeAddress": "Curbys Super Stands 67 Mountain Road Leura NSW 2477 Australia",
  "StatementParticulars": "",
  "PaymentNumber": 106,
  "Date": "2013-10-03T00:00:00.0000000+10:00",
  "AmountPaidForeign": 69.95,
  "Memo": "Curbys Super Stands for PJ000009",
  "Lines": [
    {
      "Type": "Bill",
      "Purchase": {
        "UID": "8d757d45-a1c9-41b2-9b02-5c149f7d3979"
      },
      "AmountAppliedForeign": 69.95
    }
  ],
  "DeliveryStatus": "Print",
  "ForeignCurrency": {
    "UID": "7a273963-b895-41d8-8009-41fd092cc5b4"
  },
  "CurrencyExchangeRate": 1
}
Purchase/SupplierPayment/
RecordWithDiscountsAndFees		 {
  "PayFrom": "Account",
  "Account": {
    "UID": "7772dc25-5ee6-4a61-994e-28c04b8a35fc"
  },
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "PaymentNumber": 1569,
  "Date": "2014-11-05T00:00:00.0000000+11:00",
  "Memo": "Payment; Huston & Huston Packaging",
  "Lines": [
    {
      "Purchase": {
        "UID": "874c0837-ed10-4277-ad1c-ab3298b39647"
      },
      "AmountApplied": 69,
      "DiscountApplied": 5,
      "Type": "Bill"
    }
  ]
}		 {
  "PayFrom": "Account",
  "Account": {
    "UID": "7772dc25-5ee6-4a61-994e-28c04b8a35fc"
  },
  "Supplier": {
    "UID": "63b984e5-241e-4c1a-bfe1-7868a69f5e29",
    "DisplayID": "SUPP000004"
  },
  "PaymentNumber": 1569,
  "Date": "2014-11-05T00:00:00.0000000+11:00",
  "Memo": "Payment; Huston & Huston Packaging",
  "Lines": [
    {
      "Purchase": {
        "UID": "874c0837-ed10-4277-ad1c-ab3298b39647"
      },
      "AmountAppliedForeign": 69,
      "DiscountAppliedForeign": 5,
      "Type": "Bill"
    }
  ]
}
 

 

 

POST request method for Purchase/SupplierPayment/CalculateDiscounts endpoint hasn't changed, though the response varies as below:

       *Bold = Added Multi-currency Property.

  Local Foreign
Response {
  "Items": [
    {
      "RequestID": 1,
      "Purchase": {
        "UID": "abdfba11-8988-4109-b0ac-a731588fa0c4",
        "Type": "Bill"
      },
      "PaymentDate": "2013-11-04T00:00:00.0000000+11:00",
      "Discount": 105,
      "DiscountExpiryDate": "2014-02-01T00:00:00.0000000+11:00",
      "BalanceDueDate": "2014-02-28T00:00:00.0000000+11:00",
      "BalanceDue": 1069
    }
  ]
}		 {
  "Items": [
    {
      "RequestID": 1,
      "Purchase": {
        "UID": "abdfba11-8988-4109-b0ac-a731588fa0c4",
        "Type": "Bill"
      },
      "PaymentDate": "2013-11-04T00:00:00.0000000+11:00",
      "Discount": 105,
      "DiscountForeign": 105,
      "DiscountExpiryDate": "2014-02-01T00:00:00.0000000+11:00",
      "BalanceDueDate": "2014-02-28T00:00:00.0000000+11:00",
      "BalanceDue": 1069,
      "BalanceDueForeign": 1069,
      "ForeignCurrency": {
        "UID": "7a273963-b895-41d8-8009-41fd092cc5b4",
        "Code": "HRK",
        "Name": "Croatian Kuna",
        "URI": "{cf_uri}/GeneralLedger/Currency/7a273963-b895-41d8-8009-41fd092cc5b4"
      },
      "CurrencyExchangeRate": 1
    }
  ]
}
 

Related articles

Comments

0 comments

Article is closed for comments.