MYOB Endpoint: ProfitAndLossSummaryReportMultiPeriodTable

From OdataLink
Jump to navigation Jump to search

Overview

The MYOB ProfitAndLossSummaryReportMultiPeriodTable endpoint provides the net movement values between a start date and an end date. This report only includes detail accounts and excludes header accounts.

This endpoint allows you to query multiple profit and loss values broken down either by Month, Quarter or Year. Because of this, it is the recommended endpoint to generate Profit and Loss data for MYOB.

Note this endpoint is an alternate format of the ProfitAndLossSummaryReport endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

It is a function that accepts a series of parameters.


Parameters

The ProfitAndLossSummaryReportMultiPeriodTable endpoint is a function that accepts the following parameters.

StartDate
A date field that determines the start date for which to produce values.
If omitted, it will use the first date of the last calendar month.
EndDate
A date field that determines the end date for which to produce values.
If omitted, it will use the last date of the last calendar month.
Period
A text field that determines the periods that will be queried
If omitted, it will be set to Month.
Possible values are:
  • Month
  • Quarter
  • Year
ReportingBasis
A text field that determines the way the values will be calculated.
Possible values are:
  • Accrual: Indicates values should be on an accrual basis (based on invoice dates).
  • Cash: Indicates values should be on a cash basis (based on payment dates).
YearEndAdjust
A true/false field that determines if year end adjustment should be included or excluded.


Fields

The following fields are available for the ProfitAndLossSummaryReportMultiPeriodTable endpoint.

DataFileID
A guid field that provides the id of the xero data file as setup in OdataLink.
DataFileName
A text field provides the name of the xero data file as setup in OdataLink.
DataFileCode
A text field provides the code of the xero data file as setup in OdataLink.
StartDate
A date field that indicates the start date for which to produce values.
This will match the StartDate entered as parameter.
EndDate
A date field that indicates the end date for which to produce values.
This will match the EndDate entered as parameter.
Period
A text field that indicates the periods that are being queried.
Possible values are:
  • Month
  • Quarter
  • Year
ReportingBasis
A text field that indicates the way the values will be calculated.
This will match the ReportingBasis entered as parameter.
YearEndAdjust
A true/false field that indicates if year end adjustment should be included or excluded.
This will match the YearEndAdjust entered as parameter.
AccountUID
A GUID field representing the internal id of an account. This field can be used to link to other endpoints.
AccountName
A text field used as the account name.
AccountDisplayID
A text field used as the account number.
AccountTotal
A decimal field that provides the total for a given account.


MYOB API

For a detailed run through of the endpoint, you can see the MYOB API.


Related Fields

None


Related Endpoints

BalanceSheetSummaryReport
BalanceSheetSummaryReportTable
BalanceSheetSummaryReportMultiPeriodTable
ProfitAndLossSummaryReport
ProfitAndLossSummaryReportTable


Related Topics

MYOB Models
MYOB Endpoints