Assert billing readiness for a buyer account
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"billingEntity": {
"legal_name": "<string>",
"vat_id": "<string>",
"tax_id": "<string>",
"registration_number": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"ext": {}
}
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice"
payload = { "billingEntity": {
"legal_name": "<string>",
"vat_id": "<string>",
"tax_id": "<string>",
"registration_number": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"ext": {}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billingEntity: {
legal_name: '<string>',
vat_id: '<string>',
tax_id: '<string>',
registration_number: '<string>',
contacts: [{name: '<string>', email: 'jsmith@example.com', phone: '<string>'}],
ext: {}
}
})
};
fetch('https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"relationshipId": "<string>",
"invoiceParty": "operator",
"billingEntity": {},
"authority": "crm",
"evidence": {
"reference": "<string>",
"note": "<string>"
},
"state": "active",
"validFrom": "<string>",
"validUntil": "<string>",
"supersedesId": "<string>",
"createdAt": "<string>",
"createdBy": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
Assert billing readiness for a buyer account
Assert that the named party (operator or advertiser) is billable for this account relationship (AdCP account-setup dispositions §5). Unblocks any grant awaiting direct-billed activation for the same party, and automatically supersedes any existing active assertion for it. Agent-billed (Interchange-settled) accounts never need this.
POST
/
account-mappings
/
relationships
/
{relationshipId}
/
ready-to-invoice
Assert billing readiness for a buyer account
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"billingEntity": {
"legal_name": "<string>",
"vat_id": "<string>",
"tax_id": "<string>",
"registration_number": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"ext": {}
}
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice"
payload = { "billingEntity": {
"legal_name": "<string>",
"vat_id": "<string>",
"tax_id": "<string>",
"registration_number": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"ext": {}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billingEntity: {
legal_name: '<string>',
vat_id: '<string>',
tax_id: '<string>',
registration_number: '<string>',
contacts: [{name: '<string>', email: 'jsmith@example.com', phone: '<string>'}],
ext: {}
}
})
};
fetch('https://api.interchange.io/api/v2/storefront/account-mappings/relationships/{relationshipId}/ready-to-invoice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"relationshipId": "<string>",
"invoiceParty": "operator",
"billingEntity": {},
"authority": "crm",
"evidence": {
"reference": "<string>",
"note": "<string>"
},
"state": "active",
"validFrom": "<string>",
"validUntil": "<string>",
"supersedesId": "<string>",
"createdAt": "<string>",
"createdBy": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Body
application/json
Assert that the named party is billable for this account relationship, unblocking any grant awaiting direct-billed activation. Superseding an existing active assertion for the same party is automatic.
Available options:
operator, advertiser Show child attributes
Show child attributes
Available options:
crm, erp, finance_staff, external_workflow Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
Assert billing readiness for a buyer account
Available options:
operator, advertiser Show child attributes
Show child attributes
Available options:
crm, erp, finance_staff, external_workflow Show child attributes
Show child attributes
Available options:
active, revoked, expired