OK
Represents an invoice entity in the billing system.
The unique identifier of the invoice.
INV-123-456-789The country code.
IEThe document number assigned by the ERP system.
DOC-67890Statement identifier.
SOM-6707-9575-2243-2374Bill to customer identifier.
BUY-1366-0012Agreement identifier.
AGR-0027-6450-2635The date when the invoice was posted.
2025-05-01T10:00:00+00:00The date when the document was created.
2025-04-30T10:00:00+00:00The external document number associated with the invoice.
OC 4500355450The second external document number associated with the invoice.
4540599242Can be the custom reference (free text) or the statement ID (fixed format).
Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113The due date for the invoice payment.
2025-05-15T23:59:59+00:00The order number associated with the invoice. Also known as "Sales Order ID".
CA-SCO-149880The quote number associated with the invoice.
CA-QUO-145988Represents the various statuses an invoice can have in the billing system.
The unique identifier of the statement.
SOM-1234-1234-1234-1234-1234Represents the type of billing process.
The client identifier associated with the invoice, if any.
The ERP system identifier for the invoice.
ERP-12345The document number assigned by the ERP system.
DOC-67890The country code of the credit memo.
The date when the document was created.
2025-04-30T10:00:00+00:00The due date for the invoice payment.
2025-05-15T23:59:59+00:00The external document number associated with the invoice.
OC 4500355450The second external document number associated with the invoice.
4540599242The remaining balance due on the invoice.
1500.75The total amount of the invoice.
2000The date when the invoice was posted.
2025-05-01T10:00:00+00:00The revision of the invoice, used for versioning control.
The row version of the invoice, used for concurrency control.
Can be the custom reference (free text) or the statement ID (fixed format).
Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The primary name associated with the address.
Microsoft CorporationThe secondary name associated with the address.
Latin America CollectionsThe email associated with the address.
no-reply@company.comThe customer number associated with the address.
AR-SCU-100064The first line of the address.
Cazadores de Coquimbo 2860The second line of the address.
MunroThe third line of the address.
Cuyo 3367The city of the address.
CarapachayThe postal code of the address.
75284-841The county/state/region of the address.
Buenos AiresThe country of the address.
ARThe contact name associated with the address.
John SmithThe contact number associated with the address.
AR-CON-100260The contact email associated with the address.
john.smith@company.comThe contact phone number associated with the address.
+541123456789The code associated with the address.
CON-100333The e-invoice number associated with the invoice.
The order number associated with the invoice. Also known as "Sales Order ID".
CA-SCO-149880The PPQ number associated with the invoice.
CA-PPQ-113048The quote number associated with the invoice.
CA-QUO-145988Gets or sets the payment method code.
BANKGets or sets the payment terms code.
30DAYSThe currency used for the invoice pricing.
EURThe factor applied to the currency, used for conversion or adjustments.
The second factor applied to the currency, used for conversion or adjustments.
The markup applied to the invoice, visible to operations.
10The margin applied to the invoice, visible to operations.
13.04The total purchase price, visible to operations.
100The total selling price, visible to clients or operations.
115The total sales tax, visible to clients or operations.
13The total gross amount, visible to clients or operations.
14.95The unique identifier of the invoice line.
INL-123-123-123The primary description of the line item.
Microsoft 365 Business StandardThe secondary description of the line item, if any.
Includes Office apps and cloud servicesThe document number associated with the invoice line.
DOC-98765The contract number associated with the line.
The country of usage for the line.
The data origin for the line.
The external position number for the line.
The Navision country code for the line.
The parent item number for the line.
The unique identifier for the ERP code.
The value of the ERP code.
The version of the ERP code.
The unique identifier for the ERP code.
The value of the ERP code.
The version of the ERP code.
The row version of the line item for concurrency control.
The responsibility center code for the line.
The SWO purchase order number for the line.
The type of the line.
The unit of measure for the line.
The VAR agreement number for the line.
The VAR partner number for the line.
The manufacturer's suggested retail price (MSRP) for the line item.
15The timestamp of the line item for concurrency control.
1682937600The contact number for the sell-to party, if any.
CONTACT-001The external document number associated with the line item.
EXTDOC-001An additional external document number, if any.
EXTDOC2-001The reference provided by the customer for the line item.
CUSTREF-001The item number associated with the line item.
SKU-001The line number within the invoice.
1The start date and time of the period.
2025-01-01T00:00:00+00:00The end date and time of the period.
2025-01-31T23:59:59+00:00The net amount of the invoice line, visible to clients or operations.
1000The total amount including VAT, visible to clients or operations.
1140The discount amount applied to the invoice line, visible to clients or operations.
15The total line amount after applying discounts, visible to clients or operations.
950The currency used for the purchase price, visible only to operations.
The factor applied to the purchase currency, visible only to operations.
The purchase price, visible only to operations.
10The purchase price in local currency, visible only to operations.
200The total purchase price, visible only to operations.
100The total purchase price in local currency, visible only to operations.
2000The quantity for the credit memo line.
The sales markup percentage for the invoice line, visible only to operations.
10The sales margin percentage for the invoice line, visible only to operations.
15The unit price for the credit memo line.
The base amount used for VAT calculation.
100The VAT calculation type for the line.
The VAT percentage for the line.
Cloud iQ tenant.
Specifies the status of an analytics operation.
Cloud iQ invoice reference.
Cloud iQ report layout.
Not Found
GET /public/v1/billing/invoices/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"issued": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"paid": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"overdue": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"id": "INV-123-456-789",
"countryCode": "IE",
"documentNo": "DOC-67890",
"externalIds": {
"statement": "SOM-6707-9575-2243-2374",
"customer": "BUY-1366-0012",
"agreement": "AGR-0027-6450-2635"
},
"buyer": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"attributes": {
"postingDate": "2025-05-01T10:00:00+00:00",
"documentDate": "2025-04-30T10:00:00+00:00",
"externalDocumentNo": "OC 4500355450",
"externalDocumentNo2": "4540599242",
"yourReference": "Custom reference: US-PSI-1525628 RITM55345369 Wrong SCU; Statement ID: SOMM-8224-9785-1293-2113",
"dueDate": "2025-05-15T23:59:59+00:00",
"orderNo": "CA-SCO-149880",
"quoteNo": "CA-QUO-145988"
},
"status": "Active",
"statement": {
"revision": 1,
"id": "SOM-1234-1234-1234-1234-1234"
},
"agreement": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"status": "New"
},
"billingType": "Automated",
"client": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"clientId": "text",
"licensee": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"erpData": {
"erpId": "ERP-12345",
"documentNo": "DOC-67890",
"countryCode": "text",
"documentDate": "2025-04-30T10:00:00+00:00",
"dueDate": "2025-05-15T23:59:59+00:00",
"externalDocumentNo": "OC 4500355450",
"externalDocumentNo2": "4540599242",
"balanceDue": 1500.75,
"invoiceTotal": 2000,
"postingDate": "2025-05-01T10:00:00+00:00",
"revision": 1,
"rowVersion": 1,
"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",
"code": "CON-100333"
},
"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",
"code": "CON-100333"
},
"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",
"code": "CON-100333"
},
"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",
"code": "CON-100333"
}
},
"referenceNumber": {
"eInvoiceNo": "text",
"orderNo": "CA-SCO-149880",
"ppqNo": "CA-PPQ-113048",
"quoteNo": "CA-QUO-145988"
},
"payment": {
"methodCode": "BANK",
"termsCode": "30DAYS"
}
},
"price": {
"currency": "EUR",
"currencyFactor": 1,
"currencyFactor2": 1,
"markup": 10,
"margin": 13.04,
"totalPP": 100,
"totalSP": 115,
"totalST": 13,
"totalGT": 14.95
},
"lines": [
{
"id": "INL-123-123-123",
"description": "Microsoft 365 Business Standard",
"description2": "Includes Office apps and cloud services",
"documentNo": "DOC-98765",
"erpData": {
"contractNo": "text",
"countryOfUsage": "text",
"dataOrigin": 1,
"externalPositionNo": "text",
"navisionCountryCode": "text",
"parentItemNo": "text",
"primary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"secondary": {
"identifier": "text",
"value": "text",
"version": "text"
},
"rowVersion": 1,
"responsibilityCenterCode": "text",
"swoPurchaseOrderNo": "text",
"type": 1,
"unitOfMeasure": "text",
"varAgreementNo": "text",
"varPartnerNo": "text",
"msrp": 15,
"timestamp": 1682937600,
"sellToContactNo": "CONTACT-001",
"externalDocumentNo": "EXTDOC-001",
"externalDocumentNo2": "EXTDOC2-001",
"yourReference": "CUSTREF-001"
},
"itemNo": "SKU-001",
"lineNo": 1,
"period": {
"start": "2025-01-01T00:00:00+00:00",
"end": "2025-01-31T23:59:59+00:00"
},
"price": {
"amount": 1000,
"amountIncludingVat": 1140,
"discountAmount": 15,
"lineAmount": 950,
"purchaseCurrencyCode": "text",
"purchaseCurrencyFactor": 1,
"purchasePrice": 10,
"purchasePriceLcy": 200,
"purchasePriceTotal": 100,
"purchasePriceTotalLcy": 2000,
"quantity": 1,
"salesMarkup": 10,
"salesMargin": 15,
"unitPrice": 1,
"vatBaseAmount": 100,
"vatCalculationType": 1,
"vatPercent": 1
},
"cloudiqTenant": "text"
}
],
"analytics": {
"status": "Pending"
},
"cloudiqInvoiceReference": "text",
"cloudiqReportLayout": 1
}