Skip to content
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.

Sign up for GitHub

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

Add info related to bill master sync batch #92

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add info related to bill master sync batch #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e27bf9
BH-70675 adds bill master sync batch info
alyssabryant Apr 30, 2021
58e6a77
BH-70675 fixes HTTP request url for service
alyssabryant Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion source/includes/_services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,39 @@ curl -X POST \

### HTTP Request

`{corpToken}/services/RevenueRecognition/UpdateTransactionExportStatus`
`{corpToken}/services/BillMasterSyncBatch`

Parameter | Required | Description
------ | -------- | -----
BhRestToken | yes | Token that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header.

## PUT /services/BillMasterSyncBatch

Allows the API user to sync the Invoice Term information for one or more BillMasters.

``` shell
curl -X PUT \
https://rest.bullhorn.com/rest-services/e999/services/BillMasterSyncBatch

# Example Request
{
"billableChargeIds": [1,2,3]
}

# Example Response
{
"changedEntityType": "BillMasterSyncBatch",
"changedEntityId": 123,
"changeType": "INSERT",
"data": {
}
}
```

### HTTP Request

`{corpToken}/services/RevenueRecognition/UpdateTransactionExportStatus`

Parameter | Required | Description
------ | -------- | -----
BhRestToken | yes | Token that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header.
33 changes: 23 additions & 10 deletions source/includes/entityref/paybill/_billmaster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,34 +89,47 @@ Read-only entity that represents a BillMaster record.
<td>X</td>
</tr>
<tr class="even">
<td>billMasterStatus</td>
<td>To-one association</td>
<td>BillMasterStatus. Options are:
<ul>
<li>1 = Syncing</li>
<li>2 = Sync Failed</li>
<li>3 = Synced</li>
</ul>
</td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td>canInvoice</td>
<td>Boolean</td>
<td>Indicates whether can invoice.</td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<tr class="even">
<td>chargeTypeLookup</td>
<td>To-one association</td>
<td>ChargeTypeLookup - options are Timesheet or Expense Report.</td>
<td>X</td>
<td>X</td>
</tr>
<tr class="even">
<tr class="odd">
<td>dateAdded</td>
<td>Timestamp</td>
<td></td>
<td>X</td>
<td>X</td>
</tr>
<tr class="odd">
<tr class="even">
<td>dateLastModified</td>
<td>Timestamp</td>
<td></td>
<td>X</td>
<td>X</td>
</tr>
<tr class="even">
<tr class="odd">
<td>earnCode</td>
<td>To-one association</td>
<td><p>Associated EarnCode.</p>
Expand All @@ -130,14 +143,14 @@ Read-only entity that represents a BillMaster record.
<td></td>
<td>X</td>
</tr>
<tr class="odd">
<tr class="even">
<td>externalID</td>
<td>String (100)</td>
<td></td>
<td></td>
<td>X</td>
</tr>
<tr class="even">
<tr class="odd">
<td>location</td>
<td>To-one association</td>
<td>Location
Expand All @@ -156,14 +169,14 @@ Read-only entity that represents a BillMaster record.
<td></td>
<td>X</td>
</tr>
<tr class="odd">
<tr class="even">
<td>owner</td>
<td>To-one association</td>
<td>CorporateUser</td>
<td></td>
<td>X</td>
</tr>
<tr class="even">
<tr class="odd">
<td>payBillCycle</td>
<td>To-one association</td>
<td>PayBillCycle - this is the associated billing cycle.
Expand All @@ -175,14 +188,14 @@ Read-only entity that represents a BillMaster record.
<td></td>
<td>X</td>
</tr>
<tr class="odd">
<tr class="even">
<td>transactionDate</td>
<td>Date</td>
<td><p>Transaction date</p></td>
<td></td>
<td>X</td>
</tr>
<tr class="even">
<tr class="odd">
<td>transactionStatus</td>
<td>To-one association</td>
<td>TransactionStatus. Options are:
Expand Down
73 changes: 73 additions & 0 deletions source/includes/entityref/paybill/_billmastersyncbatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Pay and Bill - BillMasterSyncBatch

Read-only entity that represents a BillMasterSyncBatch.

<table>
<colgroup>
<col width="20%" />
<col width="20%" />
<col width="20%" />
<col width="20%" />
<col width="20%" />
</colgroup>
<thead>
<tr class="header">
<th>BillMasterSyncBatch fields</th>
<th>Type</th>
<th>Description</th>
<th>Not null</th>
<th>Read-only</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>id</td>
<td>Integer</td>
<td>Unique identifier for this entity.</td>
<td>X</td>
<td>X</td>
</tr>
<tr class="even">
<td>batchStatus</td>
<td><p>To-one association</p></td>
<td>
<p>The associated BatchStatusLookup representing the status of the batch.</p>
<p>Default fields:</p>
<ul>
<li>id</li>
</ul>
</td>
<td>X</td>
<td></td>
</tr>
<tr class="odd">
<td>billMasters</td>
<td><p>To-many association</p></td>
<td>
<p>Associated list of BillMasters.</p>
<p>Default fields:</p>
<ul>
<li>id</li>
</ul>
</td>
<td> </td>
<td>X</td>
</tr>
<tr class="even">
<td>dateAdded</td>
<td>Timestamp</td>
<td>Timestamp representing when this batch was added</td>
<td>X</td>
<td>X</td>
</tr>
<tr class="odd">
<td>dateLastModified</td>
<td>Timestamp</td>
<td>Timestamp representing when this batch was last modified</td>
<td>X</td>
<td>X</td>
</tr>
</tbody>
</table>