Carbon

Company Accounts Receivable Billing Address

The company accounts receivable billing address resource.

Basehttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
GET/companyAccountsReceivableBillingAddress

List company accounts receivable billing addresss

Retrieve a paginated list of company accounts receivable billing addresss. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
curl --request GET \
  --url 'https://rest.carbon.ms/companyAccountsReceivableBillingAddress?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string"
  }
]
GET/companyAccountsReceivableBillingAddress

Retrieve a company accounts receivable billing address

Fetch a single company accounts receivable billing address by filtering on `id`.

Query parameters

idstring

Match on the company accounts receivable billing address's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
curl --request GET \
  --url 'https://rest.carbon.ms/companyAccountsReceivableBillingAddress?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string"
}
POST/companyAccountsReceivableBillingAddress

Create a company accounts receivable billing address

Create a new company accounts receivable billing address.

Body parameters

namestring
addressLine1string
addressLine2string
citystring
statestring
postalCodestring
countryCodestring
phonestring
faxstring
emailstring
POSThttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
curl --request POST \
  --url https://rest.carbon.ms/companyAccountsReceivableBillingAddress \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string"
}
PATCH/companyAccountsReceivableBillingAddress

Update a company accounts receivable billing address

Update an existing company accounts receivable billing address, matched on `id`.

Body parameters

namestring
addressLine1string
addressLine2string
citystring
statestring
postalCodestring
countryCodestring
phonestring
faxstring
emailstring
PATCHhttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
curl --request PATCH \
  --url 'https://rest.carbon.ms/companyAccountsReceivableBillingAddress?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string"
}
DELETE/companyAccountsReceivableBillingAddress

Delete a company accounts receivable billing address

Delete a company accounts receivable billing address, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the company accounts receivable billing address to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/companyAccountsReceivableBillingAddress
curl --request DELETE \
  --url 'https://rest.carbon.ms/companyAccountsReceivableBillingAddress?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content