> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/organization-or-billing-addresses.md).

# Organization | Billing Addresses

## GET /v1/organization/billing-addresses

> Retreive all billing addresses for the current organization.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Organization | Billing Addresses"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"BillingAddressResponse":{"required":["self"],"type":"object","properties":{"name":{"type":"string","nullable":true},"isDefault":{"type":"boolean"},"email":{"type":"string","nullable":true},"totalCostCenter":{"type":"integer","format":"int32"},"address":{"$ref":"#/components/schemas/AddressResponse"},"notes":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AddressResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstLine":{"type":"string","nullable":true},"additional":{"type":"string","nullable":true},"administrativeAreaKey":{"type":"string","nullable":true},"administrativeArea":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"countryISO2":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"dependentLocality":{"type":"string","nullable":true},"phonePrimary":{"type":"string","nullable":true}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/organization/billing-addresses":{"get":{"tags":["Organization | Billing Addresses"],"summary":"Retreive all billing addresses for the current organization.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingAddressResponse"}}}}},"204":{"description":"NoContent: Service successfully released."},"400":{"description":"Bad request: Body validation failed. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Creates a new billing address for the organization.

> The created billing address can be retrieved using the M:equipme.api.Controllers.Equipme.V1.Organization.BillingAddressesController.GetById(System.Int32)\
>             method.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Organization | Billing Addresses"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"CreateBillingAddressRequest":{"type":"object","properties":{"name":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/AddressRequest"},"email":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true}},"additionalProperties":false},"AddressRequest":{"type":"object","properties":{"firstLine":{"type":"string","nullable":true},"additional":{"type":"string","nullable":true},"administrativeAreaKey":{"type":"string","nullable":true},"administrativeArea":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"countryISO2":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"dependentLocality":{"type":"string","nullable":true},"phonePrimary":{"type":"string","nullable":true}},"additionalProperties":false},"BillingAddressResponse":{"required":["self"],"type":"object","properties":{"name":{"type":"string","nullable":true},"isDefault":{"type":"boolean"},"email":{"type":"string","nullable":true},"totalCostCenter":{"type":"integer","format":"int32"},"address":{"$ref":"#/components/schemas/AddressResponse"},"notes":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AddressResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstLine":{"type":"string","nullable":true},"additional":{"type":"string","nullable":true},"administrativeAreaKey":{"type":"string","nullable":true},"administrativeArea":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"countryISO2":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"dependentLocality":{"type":"string","nullable":true},"phonePrimary":{"type":"string","nullable":true}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/organization/billing-addresses":{"post":{"tags":["Organization | Billing Addresses"],"summary":"Creates a new billing address for the organization.","description":"The created billing address can be retrieved using the M:equipme.api.Controllers.Equipme.V1.Organization.BillingAddressesController.GetById(System.Int32)\n            method.","requestBody":{"description":"The request model containing the details of the billing address to create.","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CreateBillingAddressRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingAddressRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateBillingAddressRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateBillingAddressRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAddressResponse"}}}},"204":{"description":"NoContent: Service successfully released."},"400":{"description":"Bad request: Body validation failed. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"NotFound: Requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Retrieves the billing address details for the specified billing address ID.

> This method requires the caller to have appropriate authorization to access the\
>             specified billing address.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Organization | Billing Addresses"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"BillingAddressResponse":{"required":["self"],"type":"object","properties":{"name":{"type":"string","nullable":true},"isDefault":{"type":"boolean"},"email":{"type":"string","nullable":true},"totalCostCenter":{"type":"integer","format":"int32"},"address":{"$ref":"#/components/schemas/AddressResponse"},"notes":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AddressResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstLine":{"type":"string","nullable":true},"additional":{"type":"string","nullable":true},"administrativeAreaKey":{"type":"string","nullable":true},"administrativeArea":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"countryISO2":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"dependentLocality":{"type":"string","nullable":true},"phonePrimary":{"type":"string","nullable":true}},"additionalProperties":false},"ResourceLink":{"type":"object","properties":{"href":{"type":"string","nullable":true},"method":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/organization/billing-addresses/{billingAddressId}":{"get":{"tags":["Organization | Billing Addresses"],"summary":"Retrieves the billing address details for the specified billing address ID.","description":"This method requires the caller to have appropriate authorization to access the\n            specified billing address.","parameters":[{"name":"billingAddressId","in":"path","description":"The unique identifier of the billing address to retrieve.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingAddressResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Deletes the specified billing address for the organization.

> This operation requires the caller to have the appropriate authorization to delete\
>             the specified billing address.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Organization | Billing Addresses"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/organization/billing-addresses/{billingAddressId}":{"delete":{"tags":["Organization | Billing Addresses"],"summary":"Deletes the specified billing address for the organization.","description":"This operation requires the caller to have the appropriate authorization to delete\n            the specified billing address.","parameters":[{"name":"billingAddressId","in":"path","description":"The unique identifier of the billing address to delete.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Applies a JSON Patch document to update the billing address with the specified ID.

> This method requires the caller to have authorization to update customer resources.\
>             If the caller lacks the necessary permissions, an System.UnauthorizedAccessException is thrown.\
>             \
> The method validates the provided patchDocument and applies the specified\
>             operations to the billing address. If the model state is invalid, a equipme.api.Exceptions.ModelValidationException\
>             is thrown.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Organization | Billing Addresses"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"Operation":{"type":"object","properties":{"value":{"nullable":true},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/organization/billing-addresses/{billingAddressId}":{"patch":{"tags":["Organization | Billing Addresses"],"summary":"Applies a JSON Patch document to update the billing address with the specified ID.","description":"This method requires the caller to have authorization to update customer resources.\n            If the caller lacks the necessary permissions, an System.UnauthorizedAccessException is thrown.\n            \nThe method validates the provided patchDocument and applies the specified\n            operations to the billing address. If the model state is invalid, a equipme.api.Exceptions.ModelValidationException\n            is thrown.","parameters":[{"name":"billingAddressId","in":"path","description":"The unique identifier of the billing address to be updated.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"A Microsoft.AspNetCore.JsonPatch.JsonPatchDocument`1 containing the operations to apply to the billing address.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/development/api-reference-app/organization-or-billing-addresses.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.