Move invoice to a balance

curl --request POST \
  --url https://b.anny.co/api/v1/invoices/{invoice_id}/move-to-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balanceable_type": "customers",
  "balanceable_id": "12345"
}
'

{
  "data": {
    "id": "<string>",
    "type": "invoices",
    "attributes": {
      "number": "<string>",
      "formatted_number": "<string>",
      "currency": "<string>",
      "is_cancellation": true,
      "is_credit": true,
      "has_payment": true,
      "show_transfer_note": true,
      "vat_number": "<string>",
      "notes": "<string>",
      "recipient": "<string>",
      "invoicing_party": "<string>",
      "total": 123,
      "net_amount": 123,
      "tax_amount": 123,
      "is_processing": true,
      "access_token": "<string>",
      "issued_at": "<string>",
      "due_date": "<string>",
      "created_at": "<string>"
    },
    "links": {
      "self": "<string>"
    },
    "relationships": {
      "order": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        },
        "links": {
          "self": "<string>"
        }
      },
      "items": {
        "data": [
          {
            "type": "<string>",
            "id": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "payments": {
        "data": [
          {
            "type": "<string>",
            "id": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "organization": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        },
        "links": {
          "self": "<string>"
        }
      }
    }
  }
}

POST

api

invoices

{invoice_id}

move-to-balance

curl --request POST \
  --url https://b.anny.co/api/v1/invoices/{invoice_id}/move-to-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balanceable_type": "customers",
  "balanceable_id": "12345"
}
'

{
  "data": {
    "id": "<string>",
    "type": "invoices",
    "attributes": {
      "number": "<string>",
      "formatted_number": "<string>",
      "currency": "<string>",
      "is_cancellation": true,
      "is_credit": true,
      "has_payment": true,
      "show_transfer_note": true,
      "vat_number": "<string>",
      "notes": "<string>",
      "recipient": "<string>",
      "invoicing_party": "<string>",
      "total": 123,
      "net_amount": 123,
      "tax_amount": 123,
      "is_processing": true,
      "access_token": "<string>",
      "issued_at": "<string>",
      "due_date": "<string>",
      "created_at": "<string>"
    },
    "links": {
      "self": "<string>"
    },
    "relationships": {
      "order": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        },
        "links": {
          "self": "<string>"
        }
      },
      "items": {
        "data": [
          {
            "type": "<string>",
            "id": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "payments": {
        "data": [
          {
            "type": "<string>",
            "id": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "organization": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        },
        "links": {
          "self": "<string>"
        }
      }
    }
  }
}

Autorisierungen

Authorization

string

header

erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Header

Authorization

string

erforderlich

Bearer Token

Pfadparameter

invoice_id

string<uuid>

erforderlich

UUID of the invoice

Abfrageparameter

string

Organization ID

Body

application/json

balanceable_type

enum<string>

erforderlich

Type of the target entity that owns the balance.

Verfügbare Optionen:

customers,

businesses

balanceable_id

string

erforderlich

UUID of the target customer or business.

issued_at

string<date>

Optional future issue date. Must be today or later.

Antwort

data

Invoice · object

An invoice generated for an order, containing line items and payment status.

Show child attributes