You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: generated/harvest-openapi.yaml
+15-20Lines changed: 15 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -270,7 +270,7 @@ components:
270
270
nullable: true
271
271
event_type:
272
272
type: string
273
-
description: 'The type of invoice event that occurred with the message: send, close, draft, re-open, or view.'
273
+
description: 'The type of invoice event that occurred with the message: close, draft, re-open, or send (marked the invoice as sent). If event_type was omitted in the request, a null value is returned, meaning the invoice was sent.'
274
274
nullable: true
275
275
reminder:
276
276
type: boolean
@@ -6975,19 +6975,19 @@ paths:
6975
6975
schema:
6976
6976
type: integer
6977
6977
post:
6978
-
summary: 'Create an invoice message or change invoice status'
6978
+
summary: 'Create and send an invoice message'
6979
6979
operationId: createInvoiceMessage
6980
-
description: 'Creates a new invoice message object. Returns an invoice message object and a 201 Created response code if the call succeeded.'
6980
+
description: "Creates a new invoice message object and sends it. Returns an invoice message object and a 201 Created response code if the call succeeded.\n\nA note about the optional event_type parameter: If event_type is omitted in a request, its default value of null means the message will be sent. In such a request, if the recipients array is omitted or empty and send_me_a_copy is also omitted or set to false, the request will fail because the message has no recipients. When omitting event_type to create and send a message, be sure to include a recipients array as a parameter or ensure the send_me_a_copy parameter is included and set to true."
description: 'Create an invoice message or change invoice status'
6990
+
description: 'Create and send an invoice message'
6991
6991
content:
6992
6992
application/json:
6993
6993
schema:
@@ -7039,11 +7039,11 @@ paths:
7039
7039
properties:
7040
7040
event_type:
7041
7041
type: string
7042
-
description: 'If provided, runs an event against the invoice. Options: close, draft, re-open, or send.'
7042
+
description: 'Omit when intending to create and send a message. If omitted, the default value is null and the message will be sent. See other sections below for including this parameter with the following options: close, draft, re-open, or send (which marks a draft invoice as sent, it does not send the message).'
7043
7043
nullable: true
7044
7044
recipients:
7045
7045
type: array
7046
-
description: 'Array of recipient parameters. See below for details.'
7046
+
description: 'Array of recipient parameters. See below for more details.'
7047
7047
nullable: true
7048
7048
items:
7049
7049
type: object
@@ -7082,8 +7082,6 @@ paths:
7082
7082
type: boolean
7083
7083
description: 'If set to true, a thank you message email will be sent. Defaults to false.'
7084
7084
nullable: true
7085
-
required:
7086
-
- recipients
7087
7085
'/invoices/{invoiceId}/messages/new':
7088
7086
get:
7089
7087
summary: 'Retrieve invoice message subject and body for specific invoice'
@@ -9548,6 +9546,13 @@ paths:
9548
9546
in: query
9549
9547
schema:
9550
9548
type: string
9549
+
-
9550
+
name: include_fixed_fee
9551
+
description: 'Whether or not to include fixed-fee projects in the response. (Default: true)'
9552
+
required: false
9553
+
in: query
9554
+
schema:
9555
+
type: boolean
9551
9556
-
9552
9557
name: page
9553
9558
description: 'The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)'
@@ -12135,16 +12140,6 @@ paths:
12135
12140
description: 'The number of hours per week this person is available to work in seconds.'
12136
12141
nullable: true
12137
12142
format: int32
12138
-
default_hourly_rate:
12139
-
type: number
12140
-
description: 'The billable rate to use for this user when they are added to a project.'
12141
-
nullable: true
12142
-
format: float
12143
-
cost_rate:
12144
-
type: number
12145
-
description: 'The cost rate to use for this user when calculating a project’s costs vs billable amount.'
12146
-
nullable: true
12147
-
format: float
12148
12143
roles:
12149
12144
type: array
12150
12145
description: 'Descriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest.'
0 commit comments