Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organization | Billing Addresses

Retreive all billing addresses for the current organization.

get
Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses
200

OK

application/json
namestring · nullableOptional
isDefaultbooleanOptional
emailstring · nullableOptional
totalCostCenterinteger · int32Optional
notesstring · nullableOptional
vatIdstring · nullableOptional

VAT identification number of the billed legal entity (e.g. DE123456789).

idinteger · int32Optional
get/v1/organization/billing-addresses
GET /v1/organization/billing-addresses HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
[
  {
    "name": "text",
    "isDefault": true,
    "email": "text",
    "totalCostCenter": 1,
    "address": {
      "id": 1,
      "firstLine": "text",
      "additional": "text",
      "administrativeAreaKey": "text",
      "administrativeArea": "text",
      "city": "text",
      "countryISO2": "text",
      "street": "text",
      "zip": "text",
      "number": "text",
      "dependentLocality": "text",
      "phonePrimary": "text"
    },
    "notes": "text",
    "vatId": "text",
    "id": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  }
]

Creates a new billing address for the organization.

post

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

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body
namestring · nullableOptional
emailstring · nullableOptional
notesstring · nullableOptional
vatIdstring · nullableOptional

VAT identification number of the billed legal entity (e.g. DE123456789). Max. 30 characters.

Responses
200

OK

application/json
namestring · nullableOptional
isDefaultbooleanOptional
emailstring · nullableOptional
totalCostCenterinteger · int32Optional
notesstring · nullableOptional
vatIdstring · nullableOptional

VAT identification number of the billed legal entity (e.g. DE123456789).

idinteger · int32Optional
post/v1/organization/billing-addresses
POST /v1/organization/billing-addresses HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 299

{
  "name": "text",
  "address": {
    "firstLine": "text",
    "additional": "text",
    "administrativeAreaKey": "text",
    "administrativeArea": "text",
    "city": "text",
    "countryISO2": "text",
    "street": "text",
    "zip": "text",
    "number": "text",
    "dependentLocality": "text",
    "phonePrimary": "text"
  },
  "email": "text",
  "notes": "text",
  "vatId": "text"
}
{
  "name": "text",
  "isDefault": true,
  "email": "text",
  "totalCostCenter": 1,
  "address": {
    "id": 1,
    "firstLine": "text",
    "additional": "text",
    "administrativeAreaKey": "text",
    "administrativeArea": "text",
    "city": "text",
    "countryISO2": "text",
    "street": "text",
    "zip": "text",
    "number": "text",
    "dependentLocality": "text",
    "phonePrimary": "text"
  },
  "notes": "text",
  "vatId": "text",
  "id": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

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

get

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

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
billingAddressIdinteger · int32Required

The unique identifier of the billing address to retrieve.

Responses
200

OK

application/json
namestring · nullableOptional
isDefaultbooleanOptional
emailstring · nullableOptional
totalCostCenterinteger · int32Optional
notesstring · nullableOptional
vatIdstring · nullableOptional

VAT identification number of the billed legal entity (e.g. DE123456789).

idinteger · int32Optional
get/v1/organization/billing-addresses/{billingAddressId}
GET /v1/organization/billing-addresses/{billingAddressId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "name": "text",
  "isDefault": true,
  "email": "text",
  "totalCostCenter": 1,
  "address": {
    "id": 1,
    "firstLine": "text",
    "additional": "text",
    "administrativeAreaKey": "text",
    "administrativeArea": "text",
    "city": "text",
    "countryISO2": "text",
    "street": "text",
    "zip": "text",
    "number": "text",
    "dependentLocality": "text",
    "phonePrimary": "text"
  },
  "notes": "text",
  "vatId": "text",
  "id": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Deletes the specified billing address for the organization.

delete

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

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
billingAddressIdinteger · int32Required

The unique identifier of the billing address to delete.

Responses
200

OK

application/json
integer · int32Optional
delete/v1/organization/billing-addresses/{billingAddressId}
DELETE /v1/organization/billing-addresses/{billingAddressId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
1

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

patch

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.

Authorizations
X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters
billingAddressIdinteger · int32Required

The unique identifier of the billing address to be updated.

Bodyobject · Operation[]
valueany · nullableOptional
pathstring · nullableOptional
opstring · nullableOptional
fromstring · nullableOptional
Responses
200

OK

No content

patch/v1/organization/billing-addresses/{billingAddressId}
PATCH /v1/organization/billing-addresses/{billingAddressId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1099

[
  {
    "op": "add",
    "path": "/name",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/email",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/isDefault",
    "value": true
  },
  {
    "op": "add",
    "path": "/address/id",
    "value": 123
  },
  {
    "op": "add",
    "path": "/address/firstLine",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/street",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/number",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/city",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/zip",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/additional",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/countryISO2",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/administrativeAreaKey",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/administrativeArea",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/dependentLocality",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/address/correlationID",
    "value": "7b6a3b78-22fc-4a6d-a210-9fa7c0039eff"
  },
  {
    "op": "add",
    "path": "/address/phonePrimary",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/notes",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/vatId",
    "value": "stringValue"
  }
]

No content

Last updated

Was this helpful?