Skip to content

Purchase Payments

Payments allocated to the purchase invoices we generate will be exported from Sage 200 Standard and converted to the Yooz payment feedback JSON data format. The resulting file will then be uploaded to Yooz using the POST /feedbacks API call.

Requirements & Assumptions/Assertions

  • Payments will be transmitted to Yooz once they have been generated in Sage 200 Standard and allocated to a purchase invoice.
  • Sage 200 Standard permits partial payments to be allocated to a purchase invoice, hence there may be multiple payments allocated against each Yooz purchase invoice or non-PO invoice.
  • For instance, if there is a purchase invoice for £10, with two payments of £6 and £4, we will transmit 2 payments to Yooz with the amounts £6 and £4.
  • For Sage 50, Sage 200 on-premise and Sage 200 online only, any credit notes assigned to the purchase invoices we generate in Sage will also be treated similarly to a payment.
  • For instance, if there is a purchase invoice for £10, with a £10 credit note allocated against it, we will transmit a £10 payment to Yooz.
  • There is no requirement to generate separate JSON files for each organisation.
  • The JSON file name format will be {yyyyMMddHHmmssffff}.json
  • The 'yyyyMMddHHmmssffff' represents the timestamp format. An example of a file name would be 202204191529002124.json.
  • The JSON files can contain multiple payment feedbacks, which will be output to the 'documents' array.
  • If an invoice is generated in Sage by Zynk and then deleted, then generated again manually - Zynk will not be able to assign the payment to the original Yooz invoice.

Zynk Process

  • Export purchase payments from Sage 200 Standard, where the allocation amount exceeds 0, and the purchase invoices they are associated with.
  • Convert the Sage purchase payments to the Yooz payment feedback JSON format.
  • Upload the payment feedback JSON file to Yooz via the API.

Data Format

  • The data will be in JSON format. A sample of the expected data format is shown below.
  • The monetary amount format is 0.00
  • The date format is yyyy-MM-dd, e.g. 2022-04-20

Example JSON Format

{
    "documents": [
        {
            "yoozNumber": 15,
            "action": {
                "type": "PAYMENT",
                "paymentDataItems": [
                    {
                        "code": "YZ_AMOUNT_PAID",
                        "value": 500.85
                    },
                    {
                        "code": "YZ_DATE_OF_PAYMENT",
                        "value": "2021-07-07"
                    }
                ]
            }
        }
    ]
}

Scheduling

The default schedule for this solution point is to run daily at midnight and 6am.

Field Mappings

Yooz Field Sage 200 Standard Purchase Payment Field Notes
yoozNumber N/A The yoozNumber will be retrieved from Zynk’s internal database. It will be stored here when non-PO invoices are imported into Sage by Zynk.
type N/A Will always be set to “PAYMENT”
YZ_AMOUNT_PAID Value ---
YZ_DATE_OF_PAYMENT Trans. Date ---