Invoices

get/public/v1/billing/invoices/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/invoices/{id}
  • Auth: none declared

Path parameters

idstring required

Query parameters

selectstring

Response

OK

revisioninteger
idstring

The unique identifier of the invoice.

countryCodestring

The country code.

documentNostring

The document number assigned by the ERP system.

status'Issued' | 'Paid' | 'Overdue'

Represents the various statuses an invoice can have in the billing system.

billingType'Automated' | 'Manual' | 'Consolidated'

Represents the type of billing process.

clientIdstring nullable

The client identifier associated with the invoice, if any.

creditMemoCountinteger

The number of credit memos raised against this invoice.

cloudiqInvoiceReferencestring nullable

Cloud iQ invoice reference.

cloudiqReportLayoutinteger nullable

Cloud iQ report layout.

Example response

{
  "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"
  },
  "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"
  },
  "statement": {
    "id": "SOM-1234-1234-1234-1234-1234"
  },
  "erpData": {
    "erpId": "ERP-12345",
    "documentNo": "DOC-67890",
    "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",
    "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": {
      "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",
      "description": "Microsoft 365 Business Standard",
      "description2": "Includes Office apps and cloud services",
      "documentNo": "DOC-98765",
      "erpData": {
        "msrp": 15,
        "timestamp": 1682937600,
        "sellToContactNo": "CONTACT-001",
        "externalDocumentNo": "EXTDOC-001",
        "externalDocumentNo2": "EXTDOC2-001",
        "yourReference": "CUSTREF-001"
      },
      "itemNo": "SKU-001",
      "lineNo": 1,
      "price": {
        "amount": 1000,
        "amountIncludingVat": 1140,
        "discountAmount": 15,
        "lineAmount": 950,
        "purchasePrice": 10,
        "purchasePriceLcy": 200,
        "purchasePriceTotal": 100,
        "purchasePriceTotalLcy": 2000,
        "salesMarkup": 10,
        "salesMargin": 15,
        "vatBaseAmount": 100
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.