Update Invoice
Last updated
Was this helpful?
Last updated
Was this helpful?
The ID of the invoice to update.
Represents an invoice entity in the billing system.
Platform entity metadata.
Represents the icon linked to the entity, if applicable.
icon.png
The unique identifier of the invoice.
INV-123-456-789
Represents the name associated with the invoice.
Oct 2015
The current status of the invoice.
Active
Represents the various statuses an invoice can have in the billing system.
The type of the invoice.
Debit
Represents the type of an invoice in the billing system.
The billing type associated with the invoice.
Automated
Represents the type of billing process.
PUT /public/v1/billing/invoices/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 5534
{
"$meta": {
"omitted": [
"text"
]
},
"icon": "icon.png",
"audit": {
"created": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"id": "INV-123-456-789",
"name": "Oct 2015",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"blocked": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unblocked": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": "[Circular Reference]"
},
"name": "text",
"status": "Active",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"status": "Active",
"type": "Debit",
"statement": {
"name": "Sample Entity",
"icon": "icon.png",
"id": "SOM-1234-1234-1234-1234-1234"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"billingType": "Automated",
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"erpData": {
"erpId": "ERP-12345",
"documentNo": "DOC-67890",
"documentDate": "2025-04-30T10:00:00.0000000+00:00",
"dueDate": "2025-05-15T23:59:59.0000000+00:00",
"balanceDue": 1500.75,
"invoiceTotal": 2000,
"postingDate": "2025-05-01T10:00:00.0000000+00:00",
"yourReference": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113",
"addresses": {
"billTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"licenseTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"sellTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"shipTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
}
},
"referenceNumber": {
"eInvoiceNo": "text",
"orderNo": "CA-SCO-149880",
"ppqNo": "CA-PPQ-113048",
"quoteNo": "CA-QUO-145988"
},
"payment": {
"methodCode": "BANK",
"termsCode": "30DAYS"
}
},
"price": {
"currency": "EUR",
"markup": 10,
"margin": 13.04,
"totalPP": 100,
"totalSP": 115,
"totalST": 13,
"totalGT": 14.95
},
"lines": [
{
"id": "INL-123-123-123",
"documentNo": "DOC-98765",
"lineNo": 1,
"discountAmount": 15,
"vatBaseAmount": 100,
"unitOfMeasure": "User/Month",
"itemNo": "SKU-001",
"description": "Microsoft 365 Business Standard",
"description2": "Includes Office apps and cloud services",
"quantity": 5,
"unitPrice": 12.5,
"countryOfUsage": "US",
"contractNo": "CONTRACT-456",
"primaryCodeIdentifier": "SUBCODE-001",
"primaryCodeVersion": "v1.0",
"primaryCodeValue": "VALUE-001",
"secondaryCodeIdentifier": "SCODE-002",
"secondaryCodeVersion": "v2.0",
"secondaryCodeValue": "SVAL-002",
"msrp": 15,
"timestamp": 1682937600,
"rowVersion": "v1.0",
"parentItemNo": "BUNDLE-001",
"type": "Subscription",
"responsibilityCenterCode": "RC-001",
"vatCalculationType": "Standard",
"vatPercent": 20,
"varPartnerNo": "PARTNER-001",
"swoPurchaseOrderNo": "PO-12345",
"varAgreementNo": "AGREEMENT-001",
"externalPositionNo": "POS-001",
"dataOrigin": "SystemGenerated",
"primaryKey": "PK-001",
"sellToContactNo": "CONTACT-001",
"externalDocumentNo": "EXTDOC-001",
"externalDocumentNo2": "EXTDOC2-001",
"yourReference": "CUSTREF-001",
"period": {
"start": "2025-01-01T00:00:00.0000000+00:00",
"end": "2025-01-31T23:59:59.0000000+00:00"
},
"purchasePriceLcy": 200,
"purchasePriceTotalLcy": 2000,
"salesMargin": 15,
"salesMarkup": 10,
"amount": 1000,
"lineAmount": 950,
"amountIncludingVat": 1140
}
]
}
{
"$meta": {
"omitted": [
"text"
]
},
"icon": "icon.png",
"audit": {
"created": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-04-30T14:30:00.0000000+00:00",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"id": "INV-123-456-789",
"name": "Oct 2015",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": {
"created": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"blocked": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unblocked": {
"at": "2025-05-10T11:26:10.399Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": "[Circular Reference]"
},
"name": "text",
"status": "Active",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"status": "Active",
"type": "Debit",
"statement": {
"name": "Sample Entity",
"icon": "icon.png",
"id": "SOM-1234-1234-1234-1234-1234"
},
"agreement": {
"id": "text",
"icon": "text",
"status": "New",
"name": "text"
},
"billingType": "Automated",
"client": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"erpData": {
"erpId": "ERP-12345",
"documentNo": "DOC-67890",
"documentDate": "2025-04-30T10:00:00.0000000+00:00",
"dueDate": "2025-05-15T23:59:59.0000000+00:00",
"balanceDue": 1500.75,
"invoiceTotal": 2000,
"postingDate": "2025-05-01T10:00:00.0000000+00:00",
"yourReference": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113",
"addresses": {
"billTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"licenseTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"sellTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
},
"shipTo": {
"name": "Microsoft Corporation",
"name2": "Latin America Collections",
"email": "no-reply@company.com",
"customerNo": "AR-SCU-100064",
"addressLine1": "Cazadores de Coquimbo 2860",
"addressLine2": "Munro",
"addressLine3": "Cuyo 3367",
"city": "Carapachay",
"postCode": "75284-841",
"county": "Buenos Aires",
"country": "AR",
"contactName": "John Smith",
"contactNo": "AR-CON-100260",
"contactEmail": "john.smith@company.com",
"contactPhone": "+541123456789"
}
},
"referenceNumber": {
"eInvoiceNo": "text",
"orderNo": "CA-SCO-149880",
"ppqNo": "CA-PPQ-113048",
"quoteNo": "CA-QUO-145988"
},
"payment": {
"methodCode": "BANK",
"termsCode": "30DAYS"
}
},
"price": {
"currency": "EUR",
"markup": 10,
"margin": 13.04,
"totalPP": 100,
"totalSP": 115,
"totalST": 13,
"totalGT": 14.95
},
"lines": [
{
"id": "INL-123-123-123",
"documentNo": "DOC-98765",
"lineNo": 1,
"discountAmount": 15,
"vatBaseAmount": 100,
"unitOfMeasure": "User/Month",
"itemNo": "SKU-001",
"description": "Microsoft 365 Business Standard",
"description2": "Includes Office apps and cloud services",
"quantity": 5,
"unitPrice": 12.5,
"countryOfUsage": "US",
"contractNo": "CONTRACT-456",
"primaryCodeIdentifier": "SUBCODE-001",
"primaryCodeVersion": "v1.0",
"primaryCodeValue": "VALUE-001",
"secondaryCodeIdentifier": "SCODE-002",
"secondaryCodeVersion": "v2.0",
"secondaryCodeValue": "SVAL-002",
"msrp": 15,
"timestamp": 1682937600,
"rowVersion": "v1.0",
"parentItemNo": "BUNDLE-001",
"type": "Subscription",
"responsibilityCenterCode": "RC-001",
"vatCalculationType": "Standard",
"vatPercent": 20,
"varPartnerNo": "PARTNER-001",
"swoPurchaseOrderNo": "PO-12345",
"varAgreementNo": "AGREEMENT-001",
"externalPositionNo": "POS-001",
"dataOrigin": "SystemGenerated",
"primaryKey": "PK-001",
"sellToContactNo": "CONTACT-001",
"externalDocumentNo": "EXTDOC-001",
"externalDocumentNo2": "EXTDOC2-001",
"yourReference": "CUSTREF-001",
"period": {
"start": "2025-01-01T00:00:00.0000000+00:00",
"end": "2025-01-31T23:59:59.0000000+00:00"
},
"purchasePriceLcy": 200,
"purchasePriceTotalLcy": 2000,
"salesMargin": 15,
"salesMarkup": 10,
"amount": 1000,
"lineAmount": 950,
"amountIncludingVat": 1140
}
]
}