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.

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

Per diem documentation #374

Merged
merged 18 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
3 changes: 2 additions & 1 deletion reference/admin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2928,6 +2928,7 @@ components:
description: |
It signifies when this expense was made.
This date cannot be in future.
This field is not required for creating Per Diem Expenses
merchant:
type: string
maxLength: 255
Expand Down Expand Up @@ -3442,7 +3443,7 @@ components:
type: integer
nullable: true
description: |
Specific to per diem related expenses, number of days ofr which per diem claim is made.
Specific to per diem related expenses, number of days for which per diem claim is made.
example: 2
started_at:
$ref: '#/components/schemas/timestamptz_utc'
Expand Down
3 changes: 2 additions & 1 deletion reference/approver.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,7 @@ components:
description: |
It signifies when this expense was made.
This date cannot be in future.
This field is not required for creating Per Diem Expenses
merchant:
type: string
maxLength: 255
Expand Down Expand Up @@ -1516,7 +1517,7 @@ components:
type: integer
nullable: true
description: |
Specific to per diem related expenses, number of days ofr which per diem claim is made.
Specific to per diem related expenses, number of days for which per diem claim is made.
example: 2
started_at:
$ref: '#/components/schemas/timestamptz_utc'
Expand Down
17 changes: 16 additions & 1 deletion reference/spender.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1146,6 +1146,7 @@ components:
description: |
It signifies when this expense was made.
This date cannot be in future.
This field is not required for creating Per Diem Expenses
merchant:
type: string
maxLength: 255
Expand Down Expand Up @@ -1660,7 +1661,7 @@ components:
type: integer
nullable: true
description: |
Specific to per diem related expenses, number of days ofr which per diem claim is made.
Specific to per diem related expenses, number of days for which per diem claim is made.
example: 2
started_at:
$ref: '#/components/schemas/timestamptz_utc'
Expand Down Expand Up @@ -2074,6 +2075,20 @@ components:
$ref: '#/components/schemas/locations'
custom_fields:
$ref: '#/components/schemas/custom_fields'
per_diem_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
nullable: true
example: 583
description: |
Specific to per diem related expenses, number of days for which per diem claim is made.
per_diem_num_days:
allOf:
- $ref: '#/components/schemas/fk_integer'
nullable: true
example: 2
description: |
Specific to per diem related expenses, number of days for which per diem claim is made.
expense_add_comment_action_in:
type: object
required:
Expand Down
16 changes: 15 additions & 1 deletion src/components/schemas/expense.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ expense_out:
type: integer
nullable: true
description: |
Specific to per diem related expenses, number of days ofr which per diem claim is made.
Specific to per diem related expenses, number of days for which per diem claim is made.
example: 2
started_at:
$ref: './fields.yaml#/timestamptz_utc'
Expand Down Expand Up @@ -758,6 +758,20 @@ spender_expense_in:
$ref: './fields.yaml#/locations'
custom_fields:
$ref: './fields.yaml#/custom_fields'
per_diem_rate_id:
allOf:
- $ref: './fields.yaml#/fk_integer'
nullable: true
example: 583
description: |
Specific to per diem related expenses, number of days for which per diem claim is made.
per_diem_num_days:
allOf:
- $ref: './fields.yaml#/fk_integer'
nullable: true
example: 2
description: |
Specific to per diem related expenses, number of days for which per diem claim is made.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add note that this is required for per diems


admin_expense_in:
allOf:
Expand Down
1 change: 1 addition & 0 deletions src/components/schemas/fields.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ spent_at:
description: |
It signifies when this expense was made.
This date cannot be in future.
This field is not required for creating Per Diem Expenses
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changing this description here, will show it in each and every API, that is using spent_at, even CCC, Please check it out once, if yes, we'll have to somehow add the description only for expenses API spent_at.


null_field:
type: string
Expand Down