-
Notifications
You must be signed in to change notification settings - Fork 1
Added doc for ledger entry entity for Export API. #44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
19341f6
d2ccab0
3300ff5
9c75567
7a1d53e
a98b396
12971fe
03ec3d1
1670961
e553cbc
949c876
82daa54
db1913b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Export-specific types | ||
|
|
||
| The following types are exposed through [export-related operations](../use-cases/data-export.md) but are not used elsewhere in the Connector API. | ||
|
|
||
| ### Ledger entry | ||
|
|
||
| For `LedgerEntry` entity type. | ||
|
|
||
| > ### Restricted! | ||
| > This entity is currently in beta-test and as such it is subject to change. | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `Id` | string | required | Unique identifier of the entry. | | ||
| | `EnterpriseId` | string | required | Unique identifier of the [Enterprise](enterprises.md#enterprise). | | ||
| | `TransactionId` | string | optional | Unique identifier of the transaction in which the ledger entry was created. `null` for ledger entries created before transaction identifiers were introduced. | | ||
| | `AccountId` | string | required | Unique identifier of the account (for example `Customer`) associated with this ledger entry. | | ||
| | `BillId` | string | optional | Unique identifier of the [Bill](bills.md#bill) associated with this ledger entry. | | ||
| | `AccountingCategoryId` | string | optional | Unique identifier of the [Accounting category](accountingcategories.md#accounting-category) for this ledger entry. | | ||
| | `AccountingItemId` | string | required | Unique identifier of the item linked to this ledger entry. | | ||
| | `AccountingItemType` | [Accounting item type](#accounting-item-type) | required | Type of item linked to this ledger entry. | | ||
| | `LedgerType` | [Accounting ledger type](#accounting-ledger-type) | required | Type of accounting ledger where this entry is recorded. | | ||
| | `LedgerEntryType` | [Accounting ledger entry type](#accounting-ledger-entry-type) | required | Whether this is a debit or credit entry in the ledger. | | ||
| | `PostingDate` | string | required | Date when this entry was posted to the ledger in ISO 8601 format. | | ||
| | `Value` | decimal | required | Monetary value of this ledger entry. Always a positive number. | | ||
| | `NetBaseValue` | decimal | optional | Net value from which tax is calculated. Only populated for entries on the tax ledger. | | ||
| | `TaxRateCode` | string | optional | Code of the tax rate. Only populated for entries on the tax ledger. | | ||
| | `CreatedUtc` | string | required | Date and time when this ledger entry was created in UTC timezone in ISO 8601 format. | | ||
|
|
||
| #### Accounting item type | ||
|
|
||
| * `OrderItem` | ||
| * `OutletItem` | ||
| * `Invoice` | ||
| * `Payment` | ||
| * `DepositBalancingPayment` | ||
| * `CityLedgerBalancingPayment` | ||
| * `DepositItem` | ||
|
|
||
| #### Accounting ledger type | ||
|
|
||
| * `Revenue` | ||
| * `Tax` | ||
| * `Payment` | ||
| * `Deposit` | ||
| * `Guest` | ||
| * `City` | ||
| * `NonRevenue` | ||
|
|
||
| #### Accounting ledger entry type | ||
|
|
||
| * `Debit` | ||
| * `Credit` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ Returns exports for the given `ExportIds`. This operation supports [Portfolio Ac | |
| "Client": "Sample Client 1.0.0", | ||
| "ExportIds": [ | ||
| "3fa85f64-5717-4562-b3fd-2c963f66afa6", | ||
| "09708665-0e31-4b23-b337-b0a000be0df0", | ||
| "5f51c9ef-fc1d-4438-90ad-6b925ab7d7a9", | ||
| "706dc6d5-9511-4751-825e-538ce99da2ce", | ||
| "f776f20a-6f1a-4ddf-93f4-9dae95261415" | ||
| ] | ||
|
|
@@ -64,13 +64,14 @@ Returns exports for the given `ExportIds`. This operation supports [Portfolio Ac | |
| "UpdatedUtc": { | ||
| "StartUtc": "2020-11-04T00:00:00Z", | ||
| "EndUtc": "2020-11-05T00:00:00Z" | ||
| } | ||
| }, | ||
| "LedgerEntryFilters": null | ||
| } | ||
| }, | ||
| { | ||
| "Id": "09708665-0e31-4b23-b337-b0a000be0df0", | ||
| "Id": "5f51c9ef-fc1d-4438-90ad-6b925ab7d7a9", | ||
| "Status": "Pending", | ||
| "EntityType": "Reservation", | ||
| "EntityType": "LedgerEntry", | ||
| "Scope": { | ||
| "EnterpriseIds": [ | ||
| "3fa85f64-5717-4562-b3fc-2c963f66afa6" | ||
|
|
@@ -80,9 +81,12 @@ Returns exports for the given `ExportIds`. This operation supports [Portfolio Ac | |
| "Files": [], | ||
| "ExpiresUtc": null, | ||
| "Filters": { | ||
| "UpdatedUtc": { | ||
| "StartUtc": "2020-11-04T00:00:00Z", | ||
| "EndUtc": "2020-11-05T00:00:00Z" | ||
| "UpdatedUtc": null, | ||
| "LedgerEntryFilters": { | ||
| "Posting": { | ||
| "Start": "2024-01-01", | ||
| "End": "2024-01-31" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
|
|
@@ -189,7 +193,8 @@ Creates a new pending export for all entities of the specified `EntityType`. If | |
| "UpdatedUtc": { | ||
| "StartUtc": "2020-11-04T00:00:00Z", | ||
| "EndUtc": "2020-11-05T00:00:00Z" | ||
| } | ||
| }, | ||
| "LedgerEntryFilters": null | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -230,7 +235,7 @@ Creates a new pending export for all entities of the specified `EntityType`. If | |
| * `AvailabilityAdjustment` | ||
| * `AvailabilityBlock` | ||
| * `ResourceBlock` | ||
| * `LedgerEntry` - Beta testing - subject to change | ||
| * `LedgerEntry` - **Beta testing - subject to change.** See [Ledger entry type](_export-types.md#ledger-entry). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is out of scope for the PR, but I noticed that we don't explicitly map these types to entities, like providing a link here. In case of Reservation entity, it has two versions, so it is a bit unclear which one is returned.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's good point, let's add links to descriptions separately. |
||
|
|
||
| #### Export scope | ||
|
|
||
|
|
@@ -251,3 +256,10 @@ Creates a new pending export for all entities of the specified `EntityType`. If | |
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `UpdatedUtc` | [Time interval](_objects.md#time-interval) | optional | Filters entities by the specified UTC update interval. The end of the interval must be no later than 5 minutes in the past. The maximum interval is 180 days. | | ||
| | `LedgerEntryFilters` | [Export ledger entry data filters](exports.md#export-ledger-entry-data-filters) | optional | Filters specific to the `LedgerEntry` entity type. Required when `EntityType` is `LedgerEntry`. | | ||
|
|
||
| #### Export ledger entry data filters | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `Posting` | [Date interval](_objects.md#date-interval) | required | Filters ledger entries by their posting date within the specified date interval, inclusive of both the start and end dates. | | ||
Uh oh!
There was an error while loading. Please reload this page.