Skip to content

Add Bulk Invoice GET Endpoint (PHNX-17788) #26

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

Merged
centeredgebot merged 4 commits into from
Mar 27, 2026
Merged

Add Bulk Invoice GET Endpoint (PHNX-17788) #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76c22f3
initial
jacobcox94 Mar 25, 2026
26f81e7
update yardarm version
jacobcox94 Mar 25, 2026
e0530c2
fix typo
jacobcox94 Mar 25, 2026
ca1dc3b
add date-time format
jacobcox94 Mar 25, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
with:
dotnet-version: 6.0.x
- name: Install Yardarm
run: dotnet tool install --global --version 0.3.3 Yardarm.CommandLine
run: dotnet tool install --global --version 0.6.3 Yardarm.CommandLine
- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v0.9.15
with:
Expand Down
148 changes: 89 additions & 59 deletions swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
"security": [{ "api_key": [] }]
}
},
"/api/v3.1/site/addUpdate": {
Copy link
Copy Markdown
Contributor Author

@jacobcox94 jacobcox94 Mar 25, 2026

Choose a reason for hiding this comment

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

We had updated this endpoint to 3.1 while fixing a Hyfin issue, but we didn't end up needing to use it and there are a couple behavioral differences between v2 and v3.1.

"/api/v2/site/addUpdate": {
"post": {
"operationId": "SiteController_addUpdateSite",
"parameters": [],
Expand Down Expand Up @@ -485,6 +485,64 @@
"tags": ["site"],
"security": [{ "api_key": [] }]
}
},
"/api/v3.1/site/{site_id}/invoices": {
"get": {
"operationId": "SiteController_getInvoices",
"parameters": [
{
"name": "site_id",
"required": true,
"in": "path",
"schema": { "type": "string" }
},
{
"name": "updated_after",
"required": true,
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/GetInvoicesResponse" }
}
}
},
"400": {
"description": "Returned on invalid requests",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorResponse" }
}
}
},
"429": {
"description": "Returned when requests are throttled",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorResponse" }
}
}
},
"500": {
"description": "Returned when an error occurs on the Hyfin side",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/ErrorResponse" }
}
}
}
},
"tags": ["site"],
"security": [{ "api_key": [] }]
}
}
},
"info": {
Expand Down Expand Up @@ -665,61 +723,6 @@
},
"required": ["first_name", "last_name", "email"]
},
"PaymentTypeCard": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "This flag represents whether the payment method is active and available to be used or not.",
"default": true
},
"gateway": {
"type": "object",
"description": "The gateway used to process credit/debit card payments.",
"oneOf": [
{ "$ref": "#/components/schemas/Gateway" }
]
}
},
"required": ["gateway"]
},
"PaymentTypeACH": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "This flag represents whether the payment method is active and available to be used or not.",
"default": true
},
"gateway": {
"type": "object",
"description": "The gateway used to process ACH payments.",
"oneOf": [
{ "$ref": "#/components/schemas/Gateway" }
]
}
},
"required": ["gateway"]
},
"PaymentTypes": {
"type": "object",
"properties": {
"payment_card": {
"type": "object",
"description": "Required if you would like to enable credit/debit card transactions.",
"oneOf": [
{ "$ref": "#/components/schemas/PaymentTypeCard" }
]
},
"ach": {
"type": "object",
"description": "Required if you would like to enable ACH transactions.",
"oneOf": [
{ "$ref": "#/components/schemas/PaymentTypeACH" }
]
}
}
},
"Gateway": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -863,9 +866,9 @@
"description": "The main person responsible for the business.",
"allOf": [{ "$ref": "#/components/schemas/Contact" }]
},
"payment_types": {
"description": "The payment methods available to accept payments from customers. At least one payment method is required.",
"allOf": [{ "$ref": "#/components/schemas/PaymentTypes" }]
"gateway": {
"description": "The gateway used to access the processing account.",
"allOf": [{ "$ref": "#/components/schemas/Gateway" }]
},
"site_enterprise": {
"description": "A reference to the site enterprise record.",
Expand Down Expand Up @@ -1363,6 +1366,33 @@
}
}
},
"GetInvoicesResponse": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Whether the query action ran successfully."
},
"records_matched": {
"type": "integer",
"description": "The total number of records that matched the query."
},
"records_returned": {
"type": "integer",
"description": "The number of records that are being returned in the response."
},
"next_updated_after": {
"type": "string",
"format": "date-time",
"description": "The updated_at timestamp to be used in the next request."
},
"records": {
"type": "array",
"items": { "$ref": "#/components/schemas/Invoice"},
"description": "Invoices returned by the query up to 1,000 records."
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
Expand Down
Loading